Class ActionFormModel

Form model for publisher action form. Simplifies publisher form submission since it allows all types to be treated the same. Also allows for additional validation rules not applied to main action form.

CComponent

CModel implements IteratorAggregate, ArrayAccess

CFormModel

X2FormModel

ActionFormModelBase

ActionFormModel

Located at x2engine/protected/modules/actions/models/ActionFormModel.php

Methods summary
`public array`	# `rules( )` Returns the validation rules for attributes. Returns the validation rules for attributes. This method should be overridden to declare validation rules. Each rule is an array with the following structure: array('attribute list', 'validator name', 'on'=>'scenario name', ...validation parameters...) where attribute list: specifies the attributes (separated by commas) to be validated; validator name: specifies the validator to be used. It can be the name of a model class method, the name of a built-in validator, or a validator class (or its path alias). A validation method must have the following signature: // $params refers to validation parameters given in the rule function validatorName($attribute,$params) A built-in validator refers to one of the validators declared in CValidator::builtInValidators. And a validator class is a class extending CValidator. on: this specifies the scenarios when the validation rule should be performed. Separate different scenarios with commas. If this option is not set, the rule will be applied in any scenario that is not listed in "except". Please see scenario for more details about this option. except: this specifies the scenarios when the validation rule should not be performed. Separate different scenarios with commas. Please see scenario for more details about this option. additional parameters are used to initialize the corresponding validator properties. Please refer to individual validator class API for possible properties. The following are some examples: array( array('username', 'required'), array('username', 'length', 'min'=>3, 'max'=>12), array('password', 'compare', 'compareAttribute'=>'password2', 'on'=>'register'), array('password', 'authenticate', 'on'=>'login'), ); Note, in order to inherit rules defined in the parent class, a child class needs to merge the parent rules with child rules using functions like array_merge(). Returns `array` validation rules to be applied when `ActionFormModelBase::validate()` is called. See scenario Overrides `ActionFormModelBase::rules()`
`public array`	# `attributeNames( )` Returns the list of attribute names. By default, this method returns all public properties of the class. You may override this method to change the default. Returns the list of attribute names. By default, this method returns all public properties of the class. You may override this method to change the default. Returns `array` list of attribute names. Defaults to all public properties of the class. Overrides `CFormModel::attributeNames()`
`public mixed`	# `__get( string $name )` Returns a property value, an event handler list or a behavior based on its name. Do not call this method. This is a PHP magic method that we override to allow using the following syntax to read a property or obtain event handlers: $value=$component->propertyName; $handlers=$component->eventName; Returns a property value, an event handler list or a behavior based on its name. Do not call this method. This is a PHP magic method that we override to allow using the following syntax to read a property or obtain event handlers: $value=$component->propertyName; $handlers=$component->eventName; Parameters `$name` `string` $name the property name or event name Returns `mixed` the property value, event handlers attached to the event, or the named behavior Throws `CException` if the property or event is not defined See `ActionFormModel::__set()` Overrides `CComponent::__get()`
`public mixed`	# `__set( string $name, mixed $value )` Sets value of a component property. Do not call this method. This is a PHP magic method that we override to allow using the following syntax to set a property or attach an event handler $this->propertyName=$value; $this->eventName=$callback; Sets value of a component property. Do not call this method. This is a PHP magic method that we override to allow using the following syntax to set a property or attach an event handler $this->propertyName=$value; $this->eventName=$callback; Parameters `$name` `string` $name the property name or the event name `$value` `mixed` $value the property value or callback Returns `mixed` Throws `CException` if the property/event is not defined or the property is read only. See `ActionFormModel::__get()` Overrides `CComponent::__set()`

Methods inherited from ActionFormModelBase
`attributeLabels(), getAction(), mergeErrors(), validate(), validateAssignedTo(), validateAssociationId(), validateAssociationName(), validateCompleteDate(), validateDate()`

Methods inherited from X2FormModel
`getAllErrorMessages()`

Methods inherited from CFormModel
`__construct(), init()`

Methods inherited from CModel
addError(), addErrors(), afterConstruct(), afterValidate(), beforeValidate(), behaviors(), clearErrors(), createValidators(), generateAttributeLabel(), getAttributeLabel(), getAttributes(), getError(), getErrors(), getIterator(), getSafeAttributeNames(), getScenario(), getValidatorList(), getValidators(), hasErrors(), isAttributeRequired(), isAttributeSafe(), offsetExists(), offsetGet(), offsetSet(), offsetUnset(), onAfterConstruct(), onAfterValidate(), onBeforeValidate(), onUnsafeAttribute(), setAttributes(), setScenario(), unsetAttributes()

Methods inherited from CComponent
`__call(), __isset(), __unset(), asa(), attachBehavior(), attachBehaviors(), attachEventHandler(), canGetProperty(), canSetProperty(), detachBehavior(), detachBehaviors(), detachEventHandler(), disableBehavior(), disableBehaviors(), enableBehavior(), enableBehaviors(), evaluateExpression(), getEventHandlers(), hasEvent(), hasEventHandler(), hasProperty(), raiseEvent()`

Properties summary
`public mixed`	`$type`	`null`	#

Properties inherited from ActionFormModelBase
`$assignedTo, $associationId, $associationName, $associationType, $completeDate, $dueDate, $skipActionTimers, $timerIds`

Properties inherited from X2FormModel
`$exceptionClass, $throwExceptions`

Magic properties inherited from CModel
`$attributes, $errors, $iterator, $safeAttributeNames, $scenario, $validatorList, $validators`

Packages

Classes

Interfaces

Exceptions

Functions

Class ActionFormModel

Returns

See

Overrides

Returns

Overrides

Parameters

Returns

Throws

See

Overrides

Parameters

Returns

Throws

See

Overrides