InfoModel
- Type
- Class
- Namespace
- Craft
- Inherits
- Craft\InfoModel » Craft\BaseModel » CModel (opens new window) » CComponent (opens new window)
- Implements
- ArrayAccess (opens new window), IteratorAggregate (opens new window)
- Since
- 1.0
Class InfoModel
See also http://craftcms.com
View source (opens new window)
# Protected Properties
Property | Description |
---|---|
$classSuffix | string (opens new window) |
$strictAttributes | boolean (opens new window) – Whether this model should be strict about only allowing values to be set on defined attributes |
# Public Methods
Method | Description |
---|---|
__call() | Magic __call() method, used for chain-setting attribute values. |
__construct() | Constructor |
__get() | PHP getter magic method. |
__isset() | Treats attributes defined by defineAttributes() as properties. |
__set() | PHP setter magic method. |
__unset() (opens new window) | Sets a component property to be null. |
addError() (opens new window) | Adds a new error to the specified attribute. |
addErrors() (opens new window) | Adds a list of errors. |
asa() (opens new window) | Returns the named behavior object. |
attachBehavior() (opens new window) | Attaches a behavior to this component. |
attachBehaviors() (opens new window) | Attaches a list of behaviors to the component. |
attachEventHandler() (opens new window) | Attaches an event handler to an event. |
attributeLabels() | Returns the attribute labels. |
attributeNames() | Returns the list of this model's attribute names. |
behaviors() (opens new window) | Returns a list of behaviors that this model should behave as. |
canGetProperty() (opens new window) | Determines whether a property can be read. |
canSetProperty() (opens new window) | Determines whether a property can be set. |
clearErrors() (opens new window) | Removes errors for all attributes or a single attribute. |
copy() | Returns a copy of this model. |
createValidators() (opens new window) | Creates validator objects based on the specification in {@link rules}. |
detachBehavior() (opens new window) | Detaches a behavior from the component. |
detachBehaviors() (opens new window) | Detaches all behaviors from the component. |
detachEventHandler() (opens new window) | Detaches an existing event handler. |
disableBehavior() (opens new window) | Disables an attached behavior. |
disableBehaviors() (opens new window) | Disables all behaviors attached to this component. |
enableBehavior() (opens new window) | Enables an attached behavior. |
enableBehaviors() (opens new window) | Enables all behaviors attached to this component. |
evaluateExpression() (opens new window) | Evaluates a PHP expression or callback under the context of this component. |
generateAttributeLabel() | Generates a user friendly attribute label. |
getAllErrors() | Returns all errors in a single, flattened list, devoid of attribute names. |
getAttribute() | Gets an attribute’s value. |
getAttributeConfigs() | Returns this model's normalized attribute configs. |
getAttributeLabel() (opens new window) | Returns the text label for the specified attribute. |
getAttributes() | Returns an array of attribute values. |
getClassHandle() | Get the class name, sans namespace and suffix. |
getError() (opens new window) | Returns the first error of the specified attribute. |
getErrors() (opens new window) | Returns the errors for all attribute or a single attribute. |
getEventHandlers() (opens new window) | Returns the list of attached event handlers for an event. |
getExtraAttributeNames() | Returns a list of the names of the extra attributes that have been saved on this model, if it's not strict. |
getIterator() (opens new window) | Returns an iterator for traversing the attributes in the model. |
getSafeAttributeNames() (opens new window) | Returns the attribute names that are safe to be massively assigned. |
getScenario() (opens new window) | Returns the scenario that this model is used in. |
getValidatorList() (opens new window) | Returns all the validators declared in the model. |
getValidators() (opens new window) | Returns the validators applicable to the current {@link scenario}. |
hasErrors() (opens new window) | Returns a value indicating whether there is any validation error. |
hasEvent() (opens new window) | Determines whether an event is defined. |
hasEventHandler() (opens new window) | Checks whether the named event has attached handlers. |
hasProperty() (opens new window) | Determines whether a property is defined. |
isAttributeRequired() (opens new window) | Returns a value indicating whether the attribute is required. |
isAttributeSafe() (opens new window) | Returns a value indicating whether the attribute is safe for massive assignments. |
offsetExists() | Treats attributes defined by defineAttributes() as array offsets. |
offsetGet() (opens new window) | Returns the element at the specified offset. |
offsetSet() (opens new window) | Sets the element at the specified offset. |
offsetUnset() (opens new window) | Unsets the element at the specified offset. |
onAfterConstruct() (opens new window) | This event is raised after the model instance is created by new operator. |
onAfterValidate() (opens new window) | This event is raised after the validation is performed. |
onBeforeValidate() (opens new window) | This event is raised before the validation is performed. |
onUnsafeAttribute() (opens new window) | This method is invoked when an unsafe attribute is being massively assigned. |
populateModel() | Populates a new model instance with a given set of attributes. |
populateModels() | Mass-populates models based on an array of attribute arrays. |
raiseEvent() (opens new window) | Raises an event. |
rules() | Returns this model's validation rules. |
setAttribute() | Sets an attribute's value. |
setAttributes() | Sets multiple attribute values at once. |
setScenario() (opens new window) | Sets the scenario for the model. |
unsetAttributes() (opens new window) | Sets the attributes to be null. |
validate() | Validates all of the attributes for the current Model. Any attributes that fail validation will additionally get logged to the craft/storage/runtime/logs folder with a level of LogLevel::Warning. |
# Protected Methods
Method | Description |
---|---|
afterConstruct() (opens new window) | This method is invoked after a model instance is created by new operator. |
afterValidate() (opens new window) | This method is invoked after validation ends. |
beforeValidate() (opens new window) | This method is invoked before validation starts. |
defineAttributes() | Defines this model's attributes. |
# defineAttributes()
Defines this model's attributes.
BaseModel::defineAttributes()
View source (opens new window)
Returns
Signature
protected array defineAttributes ( )