Documentation

IPropertyFlags extends ISet

NO_INSERT	This property may never be inserted	'noinsert'
NO_UPDATE	This property may never be updated.	'noupdate'
REQUIRED	This property requires a value	'required'
USE_NULL	Property value may include null	'null'
PRIMARY	Primary key (one per property set)	'primary'
SUBCONFIG	The default implementation does not use this flag, but it is here in case some property is loaded from some sub/third party config and you want to do something with those.	'subconfig'
WRITE_EMPTY	Calling setValue() on the model will throw a ValidationException if the stored value is not empty.	'writeempty'
NO_ARRAY_OUTPUT	Set this flag to prevent the property from being printed during a call to IModel::toArray().	'noarrayoutput'

NO_INSERT

This property may never be inserted


        public
        mixed
        $NO_INSERT
        = 'noinsert'

NO_UPDATE

This property may never be updated.


        public
        mixed
        $NO_UPDATE
        = 'noupdate'

This can also be considered as "read only".

REQUIRED

This property requires a value


        public
        mixed
        $REQUIRED
        = 'required'

USE_NULL

Property value may include null


        public
        mixed
        $USE_NULL
        = 'null'

PRIMARY

Primary key (one per property set)


        public
        mixed
        $PRIMARY
        = 'primary'

SUBCONFIG

The default implementation does not use this flag, but it is here in case some property is loaded from some sub/third party config and you want to do something with those.


        public
        mixed
        $SUBCONFIG
        = 'subconfig'

WRITE_EMPTY

Calling setValue() on the model will throw a ValidationException if the stored value is not empty.


        public
        mixed
        $WRITE_EMPTY
        = 'writeempty'

NO_ARRAY_OUTPUT

Set this flag to prevent the property from being printed during a call to IModel::toArray().


        public
        mixed
        $NO_ARRAY_OUTPUT
        = 'noarrayoutput'

toArray() is used to copy and save models, and not all properties should be read. ie: the property connects to some api on read and the returned value should not be saved anywhere.