summaryrefslogtreecommitdiff
path: root/framework
diff options
context:
space:
mode:
authorrojaro <>2009-07-13 14:12:10 +0000
committerrojaro <>2009-07-13 14:12:10 +0000
commit2ecfe49532dbfc53d75a32e68df643b7af13dc1f (patch)
tree6d0a0ca67e1e0cdd1c2ff9403bfb760abb87d61c /framework
parent78af2b4630ccde4b03659a259f739f83ae0de9ec (diff)
- Models, Behaviors ...
Diffstat (limited to 'framework')
-rw-r--r--framework/Base/TBehavior.php120
-rw-r--r--framework/Base/TEvent.php36
-rw-r--r--framework/Base/TModel.php567
-rw-r--r--framework/Base/TModelBehavior.php57
-rw-r--r--framework/Base/TModelEvent.php30
-rw-r--r--framework/TComponent.php134
-rw-r--r--framework/Web/UI/TTemplateManager.php2
7 files changed, 944 insertions, 2 deletions
diff --git a/framework/Base/TBehavior.php b/framework/Base/TBehavior.php
new file mode 100644
index 00000000..b2833140
--- /dev/null
+++ b/framework/Base/TBehavior.php
@@ -0,0 +1,120 @@
+<?php
+/**
+ * CBehavior class file.
+ *
+ * @author Qiang Xue <qiang.xue@gmail.com>
+ * @link http://www.yiiframework.com/
+ * @copyright Copyright &copy; 2008-2009 Yii Software LLC
+ * @license http://www.yiiframework.com/license/
+ */
+
+/**
+ * CBehavior is a convenient base class for behavior classes.
+ * @author Qiang Xue <qiang.xue@gmail.com>
+ * @version $Id: CBehavior.php 564 2009-01-21 22:07:10Z qiang.xue $
+ * @package system.base
+ * @since 1.0.2
+ */
+class TBehavior extends TComponent implements IBehavior
+{
+ private $_enabled;
+ private $_owner;
+
+ /**
+ * Declares events and the corresponding event handler methods.
+ * The events are defined by the {@link owner} component, while the handler
+ * methods by the behavior class. The handlers will be attached to the corresponding
+ * events when the behavior is attached to the {@link owner} component; and they
+ * will be detached from the events when the behavior is detached from the component.
+ * @return array events (array keys) and the corresponding event handler methods (array values).
+ */
+ public function events()
+ {
+ return array();
+ }
+
+ /**
+ * Attaches the behavior object to the component.
+ * The default implementation will set the {@link owner} property
+ * and attach event handlers as declared in {@link events}.
+ * Make sure you call the parent implementation if you override this method.
+ * @param CComponent the component that this behavior is to be attached to.
+ */
+ public function attach($owner)
+ {
+ $this->_owner=$owner;
+ foreach($this->events() as $event=>$handler)
+ $owner->attachEventHandler($event,array($this,$handler));
+ }
+
+ /**
+ * Detaches the behavior object from the component.
+ * The default implementation will unset the {@link owner} property
+ * and detach event handlers declared in {@link events}.
+ * Make sure you call the parent implementation if you override this method.
+ * @param CComponent the component that this behavior is to be detached from.
+ */
+ public function detach($owner)
+ {
+ foreach($this->events() as $event=>$handler)
+ $owner->detachEventHandler($event,array($this,$handler));
+ $this->_owner=null;
+ }
+
+ /**
+ * @return CComponent the owner component that this behavior is attached to.
+ */
+ public function getOwner()
+ {
+ return $this->_owner;
+ }
+
+ /**
+ * @return boolean whether this behavior is enabled
+ */
+ public function getEnabled()
+ {
+ return $this->_enabled;
+ }
+
+ /**
+ * @param boolean whether this behavior is enabled
+ */
+ public function setEnabled($value)
+ {
+ $this->_enabled=$value;
+ }
+}
+
+/**
+ * IBehavior interfaces is implemented by all behavior classes.
+ *
+ * A behavior is a way to enhance a component with additional methods that
+ * are defined in the behavior class and not available in the component class.
+ *
+ * @author Qiang Xue <qiang.xue@gmail.com>
+ * @version $Id: interfaces.php 956 2009-04-21 15:16:03Z qiang.xue@gmail.com $
+ * @package system.base
+ * @since 1.0.2
+ */
+interface IBehavior
+{
+ /**
+ * Attaches the behavior object to the component.
+ * @param CComponent the component that this behavior is to be attached to.
+ */
+ public function attach($component);
+ /**
+ * Detaches the behavior object from the component.
+ * @param CComponent the component that this behavior is to be detached from.
+ */
+ public function detach($component);
+ /**
+ * @return boolean whether this behavior is enabled
+ */
+ public function getEnabled();
+ /**
+ * @param boolean whether this behavior is enabled
+ */
+ public function setEnabled($value);
+} \ No newline at end of file
diff --git a/framework/Base/TEvent.php b/framework/Base/TEvent.php
new file mode 100644
index 00000000..0f64e89d
--- /dev/null
+++ b/framework/Base/TEvent.php
@@ -0,0 +1,36 @@
+<?php
+/**
+ * CEvent is the base class for all event classes.
+ *
+ * It encapsulates the parameters associated with an event.
+ * The {@link sender} property describes who raises the event.
+ * And the {@link handled} property indicates if the event is handled.
+ * If an event handler sets {@link handled} to true, those handlers
+ * that are not invoked yet will not be invoked anymore.
+ *
+ * @author Qiang Xue <qiang.xue@gmail.com>
+ * @version $Id: CComponent.php 978 2009-05-06 03:36:09Z qiang.xue $
+ * @package system.base
+ * @since 1.0
+ */
+class TEvent extends TComponent
+{
+ /**
+ * @var object the sender of this event
+ */
+ public $sender;
+ /**
+ * @var boolean whether the event is handled. Defaults to false.
+ * When a handler sets this true, the rest uninvoked handlers will not be invoked anymore.
+ */
+ public $handled=false;
+
+ /**
+ * Constructor.
+ * @param mixed sender of the event
+ */
+ public function __construct($sender=null)
+ {
+ $this->sender=$sender;
+ }
+} \ No newline at end of file
diff --git a/framework/Base/TModel.php b/framework/Base/TModel.php
new file mode 100644
index 00000000..492bcbd9
--- /dev/null
+++ b/framework/Base/TModel.php
@@ -0,0 +1,567 @@
+<?php
+/**
+ * CModel class file.
+ *
+ * @author Qiang Xue <qiang.xue@gmail.com>
+ * @link http://www.yiiframework.com/
+ * @copyright Copyright &copy; 2008-2009 Yii Software LLC
+ * @license http://www.yiiframework.com/license/
+ */
+
+Prado::using('System.Base.TModelEvent');
+
+/**
+ * CModel is the base class providing the common features needed by data model objects.
+ *
+ * CModel defines the basic framework for data models that need to be validated.
+ *
+ * @author Qiang Xue <qiang.xue@gmail.com>
+ * @version $Id: CModel.php 1093 2009-06-05 13:09:17Z qiang.xue $
+ * @package system.base
+ * @since 1.0
+ */
+abstract class TModel extends TComponent implements IteratorAggregate, ArrayAccess
+{
+ private $_errors=array(); // attribute name => array of errors
+ private $_validators; // validators
+ private $_scenario=''; // scenario
+
+ /**
+ * THE FOLLOWING METHOD IS NEEDED BECAUSE OF COMPATIBILITY REASONS WITH PRADO
+ * raiseEvent adapter method for TComponent
+ * Was necessary because CActiveRecord doesnt use the third parameter
+ * @param string EventName
+ * @param TEvent Event
+ */
+ public function raiseEvent($name, $event)
+ {
+ parent::raiseEvent($name, $event, new TEventParameter());
+ }
+
+ /**
+ * Returns the list of attribute names of the model.
+ * @return array list of attribute names.
+ * @since 1.0.1
+ */
+ abstract public function attributeNames();
+
+ /**
+ * Returns the validation rules for attributes.
+ *
+ * This method should be overridden to declare validation rules.
+ * Each rule is an array with the following structure:
+ * <pre>
+ * array('attribute list', 'validator name', 'on'=>'scenario name', ...validation parameters...)
+ * </pre>
+ * where
+ * <ul>
+ * <li>attribute list: specifies the attributes (separated by commas) to be validated;</li>
+ * <li>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:
+ * <pre>
+ * // $params refers to validation parameters given in the rule
+ * function validatorName($attribute,$params)
+ * </pre>
+ * A built-in validator refers to one of the validators declared in {@link CValidator::builtInValidators}.
+ * And a validator class is a class extending {@link CValidator}.</li>
+ * <li>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. Please see {@link scenario} for more details about this option.</li>
+ * <li>additional parameters are used to initialize the corresponding validator properties.
+ * Please refer to individal validator class API for possible properties.</li>
+ * </ul>
+ *
+ * The following are some examples:
+ * <pre>
+ * array(
+ * array('username', 'required'),
+ * array('username', 'length', 'min'=>3, 'max'=>12),
+ * array('password', 'compare', 'compareAttribute'=>'password2', 'on'=>'register'),
+ * array('password', 'authenticate', 'on'=>'login'),
+ * );
+ * </pre>
+ *
+ * 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().
+ *
+ * @return array validation rules to be applied when {@link validate()} is called.
+ * @see scenario
+ */
+ public function rules()
+ {
+ return array();
+ }
+
+ /**
+ * Returns a list of behaviors that this model should behave as.
+ * The return value should be an array of behavior configurations indexed by
+ * behavior names. Each behavior configuration can be either a string specifying
+ * the behavior class or an array of the following structure:
+ * <pre>
+ * 'behaviorName'=>array(
+ * 'class'=>'path.to.BehaviorClass',
+ * 'property1'=>'value1',
+ * 'property2'=>'value2',
+ * )
+ * </pre>
+ *
+ * Note, the behavior classes must implement {@link IBehavior} or extend from
+ * {@link CBehavior}. Behaviors declared in this method will be attached
+ * to the model when it is instantiated.
+ *
+ * For more details about behaviors, see {@link CComponent}.
+ * @return array the behavior configurations (behavior name=>behavior configuration)
+ * @since 1.0.2
+ */
+ public function behaviors()
+ {
+ return array();
+ }
+
+ /**
+ * Returns the attribute labels.
+ * Attribute labels are mainly used in error messages of validation.
+ * By default an attribute label is generated using {@link generateAttributeLabel}.
+ * This method allows you to explicitly specify attribute labels.
+ *
+ * Note, in order to inherit labels defined in the parent class, a child class needs to
+ * merge the parent labels with child labels using functions like array_merge().
+ *
+ * @return array attribute labels (name=>label)
+ * @see generateAttributeLabel
+ */
+ public function attributeLabels()
+ {
+ return array();
+ }
+
+ /**
+ * Performs the validation.
+ *
+ * This method executes the validation rules as declared in {@link rules}.
+ * Only the rules applicable to the current {@link scenario} will be executed.
+ * A rule is considered applicable to a scenario if its 'on' option is not set
+ * or contains the scenario.
+ *
+ * Errors found during the validation can be retrieved via {@link getErrors}.
+ *
+ * @param array list of attributes that should be validated. Defaults to null,
+ * meaning any attribute listed in the applicable validation rules should be
+ * validated. If this parameter is given as a list of attributes, only
+ * the listed attributes will be validated.
+ * @return boolean whether the validation is successful without any error.
+ * @see beforeValidate
+ * @see afterValidate
+ */
+ public function validate($attributes=null)
+ {
+ $this->clearErrors();
+ if($this->beforeValidate())
+ {
+ foreach($this->getValidators() as $validator)
+ $validator->validate($this,$attributes);
+ $this->afterValidate();
+ return !$this->hasErrors();
+ }
+ else
+ return false;
+ }
+
+ /**
+ * This method is invoked before validation starts.
+ * The default implementation calls {@link onBeforeValidate} to raise an event.
+ * You may override this method to do preliminary checks before validation.
+ * Make sure the parent implementation is invoked so that the event can be raised.
+ * @return boolean whether validation should be executed. Defaults to true.
+ */
+ protected function beforeValidate()
+ {
+ $event=new TModelEvent($this);
+ $this->onBeforeValidate($event);
+ return $event->isValid;
+ }
+
+ /**
+ * This method is invoked after validation ends.
+ * The default implementation calls {@link onAfterValidate} to raise an event.
+ * You may override this method to do postprocessing after validation.
+ * Make sure the parent implementation is invoked so that the event can be raised.
+ */
+ protected function afterValidate()
+ {
+ $this->onAfterValidate(new TEvent($this));
+ }
+
+ /**
+ * This event is raised before the validation is performed.
+ * @param CModelEvent the event parameter
+ * @since 1.0.2
+ */
+ public function onBeforeValidate($event)
+ {
+ $this->raiseEvent('onBeforeValidate',$event);
+ }
+
+ /**
+ * This event is raised after the validation is performed.
+ * @param CEvent the event parameter
+ * @since 1.0.2
+ */
+ public function onAfterValidate($event)
+ {
+ $this->raiseEvent('onAfterValidate',$event);
+ }
+
+ /**
+ * Returns the validators applicable to the current {@link scenario}.
+ * @param string the name of the attribute whose validators should be returned.
+ * If this is null, the validators for ALL attributes in the model will be returned.
+ * @return array the validators applicable to the current {@link scenario}.
+ * @since 1.0.1
+ *
+ * @TODO Port validators from Yii to Prado? Not used in ActiveRecords -> ignoring this for now...
+ *
+ */
+ public function getValidators($attribute=null)
+ {
+ /*if($this->_validators===null)
+ $this->_validators=$this->createValidators();
+
+ $validators=array();
+ $scenario=$this->getScenario();
+ foreach($this->_validators as $validator)
+ {
+ if($validator->applyTo($scenario))
+ {
+ if($attribute===null || in_array($attribute,$validator->attributes,true))
+ $validators[]=$validator;
+ }
+ }
+ return $validators;*/
+ return array();
+ }
+
+ /**
+ * Creates validator objects based on the specification in {@link rules}.
+ * This method is mainly used internally.
+ * @return array validators built based on {@link rules()}.
+ *
+ * @TODO Port validators from Yii to Prado? Not used in ActiveRecords -> ignoring this for now...
+ *
+ */
+ public function createValidators()
+ {
+ /*$validators=array();
+ foreach($this->rules() as $rule)
+ {
+ if(isset($rule[0],$rule[1])) // attributes, validator name
+ $validators[]=CValidator::createValidator($rule[1],$this,$rule[0],array_slice($rule,2));
+ else
+ throw new CException(Yii::t('yii','{class} has an invalid validation rule. The rule must specify attributes to be validated and the validator name.',
+ array('{class}'=>get_class($this))));
+ }
+ return $validators;*/
+ return array();
+ }
+
+ /**
+ * Returns a value indicating whether the attribute is required.
+ * This is determined by checking if the attribute is associated with a
+ * {@link CRequiredValidator} validation rule in the current {@link scenario}.
+ * @param string attribute name
+ * @return boolean whether the attribute is required
+ * @since 1.0.2
+ *
+ * @TODO Port validators from Yii to Prado? Not used in ActiveRecords -> ignoring this for now...
+ *
+ */
+ public function isAttributeRequired($attribute)
+ {
+ /*
+ foreach($this->getValidators($attribute) as $validator)
+ {
+ if($validator instanceof CRequiredValidator)
+ return true;
+ }
+ return false;
+ */
+ return true;
+ }
+
+ /**
+ * Returns the text label for the specified attribute.
+ * @param string the attribute name
+ * @return string the attribute label
+ * @see generateAttributeLabel
+ * @see attributeLabels
+ */
+ public function getAttributeLabel($attribute)
+ {
+ $labels=$this->attributeLabels();
+ if(isset($labels[$attribute]))
+ return $labels[$attribute];
+ else
+ return $this->generateAttributeLabel($attribute);
+ }
+
+ /**
+ * Returns a value indicating whether there is any validation error.
+ * @param string attribute name. Use null to check all attributes.
+ * @return boolean whether there is any error.
+ */
+ public function hasErrors($attribute=null)
+ {
+ if($attribute===null)
+ return $this->_errors!==array();
+ else
+ return isset($this->_errors[$attribute]);
+ }
+
+ /**
+ * Returns the errors for all attribute or a single attribute.
+ * @param string attribute name. Use null to retrieve errors for all attributes.
+ * @return array errors for all attributes or the specified attribute. Empty array is returned if no error.
+ */
+ public function getErrors($attribute=null)
+ {
+ if($attribute===null)
+ return $this->_errors;
+ else
+ return isset($this->_errors[$attribute]) ? $this->_errors[$attribute] : array();
+ }
+
+ /**
+ * Returns the first error of the specified attribute.
+ * @param string attribute name.
+ * @return string the error message. Null is returned if no error.
+ * @since 1.0.2
+ */
+ public function getError($attribute)
+ {
+ return isset($this->_errors[$attribute]) ? reset($this->_errors[$attribute]) : null;
+ }
+
+ /**
+ * Adds a new error to the specified attribute.
+ * @param string attribute name
+ * @param string new error message
+ */
+ public function addError($attribute,$error)
+ {
+ $this->_errors[$attribute][]=$error;
+ }
+
+ /**
+ * Adds a list of errors.
+ * @param array a list of errors. The array keys must be attribute names.
+ * The array values should be error messages. If an attribute has multiple errors,
+ * these errors must be given in terms of an array.
+ * You may use the result of {@link getErrors} as the value for this parameter.
+ * @since 1.0.5
+ */
+ public function addErrors($errors)
+ {
+ foreach($errors as $attribute=>$error)
+ {
+ if(is_array($error))
+ {
+ foreach($error as $e)
+ $this->_errors[$attribute][]=$e;
+ }
+ else
+ $this->_errors[$attribute][]=$error;
+ }
+ }
+
+ /**
+ * Removes errors for all attributes or a single attribute.
+ * @param string attribute name. Use null to remove errors for all attribute.
+ */
+ public function clearErrors($attribute=null)
+ {
+ if($attribute===null)
+ $this->_errors=array();
+ else
+ unset($this->_errors[$attribute]);
+ }
+
+ /**
+ * Generates a user friendly attribute label.
+ * This is done by replacing underscores or dashes with blanks and
+ * changing the first letter of each word to upper case.
+ * For example, 'department_name' or 'DepartmentName' becomes 'Department Name'.
+ * @param string the column name
+ * @return string the attribute label
+ */
+ public function generateAttributeLabel($name)
+ {
+ return ucwords(trim(strtolower(str_replace(array('-','_'),' ',preg_replace('/(?<![A-Z])[A-Z]/', ' \0', $name)))));
+ }
+
+ /**
+ * Returns all attribute values.
+ * @param array list of attributes whose value needs to be returned.
+ * Defaults to null, meaning all attributes as listed in {@link attributeNames} will be returned.
+ * If it is an array, only the attributes in the array will be returned.
+ * @return array attribute values (name=>value).
+ */
+ public function getAttributes($names=null)
+ {
+ $values=array();
+ foreach($this->attributeNames() as $name)
+ $values[$name]=$this->$name;
+
+ if(is_array($names))
+ {
+ $values2=array();
+ foreach($names as $name)
+ $values2[$name]=isset($values[$name]) ? $values[$name] : null;
+ return $values2;
+ }
+ else
+ return $values;
+ }
+
+ /**
+ * Sets the attribute values in a massive way.
+ * @param array attribute values (name=>value) to be set.
+ * @param boolean whether the assignments should only be done to the safe attributes.
+ * A safe attribute is one that is associated with a validation rule in the current {@link scenario}.
+ * @see getSafeAttributeNames
+ * @see attributeNames
+ */
+ public function setAttributes($values,$safeOnly=true)
+ {
+ if(!is_array($values))
+ return;
+ $attributes=array_flip($safeOnly ? $this->getSafeAttributeNames() : $this->attributeNames());
+ foreach($values as $name=>$value)
+ {
+ if(isset($attributes[$name]))
+ $this->$name=$value;
+ }
+ }
+
+ /**
+ * Returns the scenario that this model is used in.
+ *
+ * Scenario affects how validation is performed and which attributes can
+ * be massively assigned.
+ *
+ * A validation rule will be performed when calling {@link validate()}
+ * if its 'on' option is not set or contains the current scenario value.
+ *
+ * And an attribute can be massively assigned if it is associated with
+ * a validation rule for the current scenario. Note that an exception is
+ * the {@link CUnsafeValidator unsafe} validator which marks the associated
+ * attributes as unsafe and not allowed to be massively assigned.
+ *
+ * @return string the scenario that this model is in.
+ * @since 1.0.4
+ */
+ public function getScenario()
+ {
+ return $this->_scenario;
+ }
+
+ /**
+ * @param string the scenario that this model is in.
+ * @see getScenario
+ * @since 1.0.4
+ */
+ public function setScenario($value)
+ {
+ $this->_scenario=$value;
+ }
+
+ /**
+ * Returns the attribute names that are safe to be massively assigned.
+ * A safe attribute is one that is associated with a validation rule in the current {@link scenario}.
+ * @return array safe attribute names
+ * @since 1.0.2
+ *
+ * @TODO Port validators from Yii to Prado? Not used in ActiveRecords -> ignoring this for now...
+ *
+ */
+ public function getSafeAttributeNames()
+ {
+ $attributes=array();
+ $unsafe=array();
+ foreach($this->getValidators() as $validator)
+ {
+# if($validator instanceof CUnsafeValidator)
+# {
+# foreach($validator->attributes as $name)
+# $unsafe[]=$name;
+# }
+# else
+# {
+ foreach($validator->attributes as $name)
+ $attributes[$name]=true;
+# }
+ }
+
+# foreach($unsafe as $name)
+# unset($attributes[$name]);
+ return array_keys($attributes);
+ }
+
+ /**
+ * Returns an iterator for traversing the attributes in the model.
+ * This method is required by the interface IteratorAggregate.
+ * @return CMapIterator an iterator for traversing the items in the list.
+ */
+ public function getIterator()
+ {
+ $attributes=$this->getAttributes();
+ return new TMapIterator($attributes);
+ }
+
+ /**
+ * Returns whether there is an element at the specified offset.
+ * This method is required by the interface ArrayAccess.
+ * @param mixed the offset to check on
+ * @return boolean
+ * @since 1.0.2
+ */
+ public function offsetExists($offset)
+ {
+ return property_exists($this,$offset);
+ }
+
+ /**
+ * Returns the element at the specified offset.
+ * This method is required by the interface ArrayAccess.
+ * @param integer the offset to retrieve element.
+ * @return mixed the element at the offset, null if no element is found at the offset
+ * @since 1.0.2
+ */
+ public function offsetGet($offset)
+ {
+ return $this->$offset;
+ }
+
+ /**
+ * Sets the element at the specified offset.
+ * This method is required by the interface ArrayAccess.
+ * @param integer the offset to set element
+ * @param mixed the element value
+ * @since 1.0.2
+ */
+ public function offsetSet($offset,$item)
+ {
+ $this->$offset=$item;
+ }
+
+ /**
+ * Unsets the element at the specified offset.
+ * This method is required by the interface ArrayAccess.
+ * @param mixed the offset to unset element
+ * @since 1.0.2
+ */
+ public function offsetUnset($offset)
+ {
+ unset($this->$offset);
+ }
+}
diff --git a/framework/Base/TModelBehavior.php b/framework/Base/TModelBehavior.php
new file mode 100644
index 00000000..a5182e8f
--- /dev/null
+++ b/framework/Base/TModelBehavior.php
@@ -0,0 +1,57 @@
+<?php
+/**
+ * CModelBehavior class file.
+ *
+ * @author Qiang Xue <qiang.xue@gmail.com>
+ * @link http://www.yiiframework.com/
+ * @copyright Copyright &copy; 2008-2009 Yii Software LLC
+ * @license http://www.yiiframework.com/license/
+ */
+
+/**
+ * CModelBehavior is a base class for behaviors that are attached to a model component.
+ * The model should extend from {@link CModel} or its child classes.
+ * @author Qiang Xue <qiang.xue@gmail.com>
+ * @version $Id: CModelBehavior.php 1082 2009-06-01 12:03:00Z qiang.xue $
+ * @package system.base
+ * @since 1.0.2
+ */
+
+Prado::using('System.Base.TBehavior');
+
+class TModelBehavior extends TBehavior
+{
+ /**
+ * Declares events and the corresponding event handler methods.
+ * The default implementation returns 'onBeforeValidate' and 'onAfterValidate' events and handlers.
+ * If you override this method, make sure you merge the parent result to the return value.
+ * @return array events (array keys) and the corresponding event handler methods (array values).
+ * @see CBehavior::events
+ */
+ public function events()
+ {
+ return array(
+ 'onBeforeValidate'=>'beforeValidate',
+ 'onAfterValidate'=>'afterValidate',
+ );
+ }
+
+ /**
+ * Responds to {@link CModel::onBeforeValidate} event.
+ * Overrides this method if you want to handle the corresponding event of the {@link owner}.
+ * You may set {@link CModelEvent::isValid} to be false if you want to stop the current validation process.
+ * @param CModelEvent event parameter
+ */
+ public function beforeValidate($event)
+ {
+ }
+
+ /**
+ * Responds to {@link CModel::onAfterValidate} event.
+ * Overrides this method if you want to handle the corresponding event of the {@link owner}.
+ * @param CEvent event parameter
+ */
+ public function afterValidate($event)
+ {
+ }
+}
diff --git a/framework/Base/TModelEvent.php b/framework/Base/TModelEvent.php
new file mode 100644
index 00000000..1bf42a2b
--- /dev/null
+++ b/framework/Base/TModelEvent.php
@@ -0,0 +1,30 @@
+<?php
+/**
+ * CModelEvent class file.
+ *
+ * @author Qiang Xue <qiang.xue@gmail.com>
+ * @link http://www.yiiframework.com/
+ * @copyright Copyright &copy; 2008-2009 Yii Software LLC
+ * @license http://www.yiiframework.com/license/
+ */
+
+Prado::using('System.Base.TEvent');
+
+/**
+ * CModelEvent class.
+ *
+ * CModelEvent represents the event parameters needed by events raised by a model.
+ *
+ * @author Qiang Xue <qiang.xue@gmail.com>
+ * @version $Id: CModelEvent.php 1093 2009-06-05 13:09:17Z qiang.xue $
+ * @package system.base
+ * @since 1.0
+ */
+class TModelEvent extends TEvent
+{
+ /**
+ * @var boolean whether the model is valid. Defaults to true.
+ * If this is set false, {@link CModel::validate()} will return false and quit the current validation process.
+ */
+ public $isValid=true;
+}
diff --git a/framework/TComponent.php b/framework/TComponent.php
index f9c36cc8..2fc0ebff 100644
--- a/framework/TComponent.php
+++ b/framework/TComponent.php
@@ -79,6 +79,11 @@ class TComponent
private $_e=array();
/**
+ * @var array models (ported from Yii)
+ */
+ private $_m=array();
+
+ /**
* Returns a property value or an event handler list by property or event 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:
@@ -351,6 +356,7 @@ class TComponent
$method=substr($handler,$pos+1);
if(method_exists($object,$method))
$object->$method($sender,$param);
+
else
throw new TInvalidDataValueException('component_eventhandler_invalid',get_class($this),$name,$handler);
}
@@ -451,6 +457,133 @@ class TComponent
public function addParsedObject($object)
{
}
+
+ /**
+ * Returns the named behavior object.
+ * The name 'asa' stands for 'as a'.
+ * @param string the behavior name
+ * @return IBehavior the behavior object, or null if the behavior does not exist
+ */
+ public function asa($behavior)
+ {
+ return isset($this->_m[$behavior]) ? $this->_m[$behavior] : null;
+ }
+
+ /**
+ * Attaches a list of behaviors to the component.
+ * Each behavior is indexed by its name and should be an instance of
+ * {@link IBehavior}, a string specifying the behavior class, or an
+ * array of the following structure:
+ * <pre>
+ * array(
+ * 'class'=>'path.to.BehaviorClass',
+ * 'property1'=>'value1',
+ * 'property2'=>'value2',
+ * )
+ * </pre>
+ * @param array list of behaviors to be attached to the component
+ */
+ public function attachBehaviors($behaviors)
+ {
+ foreach($behaviors as $name=>$behavior)
+ $this->attachBehavior($name,$behavior);
+ }
+
+ /**
+ * Detaches all behaviors from the component.
+ */
+ public function detachBehaviors()
+ {
+ if($this->_m!==null)
+ {
+ foreach($this->_m as $name=>$behavior)
+ $this->detachBehavior($name);
+ $this->_m=null;
+ }
+ }
+
+ /**
+ * Attaches a behavior to this component.
+ * This method will create the behavior object based on the given
+ * configuration. After that, the behavior object will be initialized
+ * by calling its {@link IBehavior::attach} method.
+ * @param string the behavior's name. It should uniquely identify this behavior.
+ * @param mixed the behavior configuration. This is passed as the first
+ * parameter to {@link YiiBase::createComponent} to create the behavior object.
+ * @return IBehavior the behavior object
+ */
+ public function attachBehavior($name,$behavior)
+ {
+ if(!($behavior instanceof IBehavior))
+ $behavior=Yii::createComponent($behavior);
+ $behavior->setEnabled(true);
+ $behavior->attach($this);
+ return $this->_m[$name]=$behavior;
+ }
+
+ /**
+ * Detaches a behavior from the component.
+ * The behavior's {@link IBehavior::detach} method will be invoked.
+ * @param string the behavior's name. It uniquely identifies the behavior.
+ * @return IBehavior the detached behavior. Null if the behavior does not exist.
+ */
+ public function detachBehavior($name)
+ {
+ if(isset($this->_m[$name]))
+ {
+ $this->_m[$name]->detach($this);
+ $behavior=$this->_m[$name];
+ unset($this->_m[$name]);
+ return $behavior;
+ }
+ }
+
+ /**
+ * Enables all behaviors attached to this component.
+ */
+ public function enableBehaviors()
+ {
+ if($this->_m!==null)
+ {
+ foreach($this->_m as $behavior)
+ $behavior->setEnabled(true);
+ }
+ }
+
+ /**
+ * Disables all behaviors attached to this component.
+ */
+ public function disableBehaviors()
+ {
+ if($this->_m!==null)
+ {
+ foreach($this->_m as $behavior)
+ $behavior->setEnabled(false);
+ }
+ }
+
+ /**
+ * Enables an attached behavior.
+ * A behavior is only effective when it is enabled.
+ * A behavior is enabled when first attached.
+ * @param string the behavior's name. It uniquely identifies the behavior.
+ */
+ public function enableBehavior($name)
+ {
+ if(isset($this->_m[$name]))
+ $this->_m[$name]->setEnabled(true);
+ }
+
+ /**
+ * Disables an attached behavior.
+ * A behavior is only effective when it is enabled.
+ * @param string the behavior's name. It uniquely identifies the behavior.
+ */
+ public function disableBehavior($name)
+ {
+ if(isset($this->_m[$name]))
+ $this->_m[$name]->setEnabled(false);
+ }
}
/**
@@ -838,4 +971,3 @@ class TComponentReflection extends TComponent
return $this->_methods;
}
}
-
diff --git a/framework/Web/UI/TTemplateManager.php b/framework/Web/UI/TTemplateManager.php
index 6d44d7d7..01694300 100644
--- a/framework/Web/UI/TTemplateManager.php
+++ b/framework/Web/UI/TTemplateManager.php
@@ -149,7 +149,7 @@ class TTemplateManager extends TModule
* <prop:MainProperty SubProperty1="Value1" SubProperty2="Value2" .../>
* - directive: directive specifies the property values for the template owner.
* It is in the format of <%@ property name-value pairs %>;
- * - expressions: They are in the formate of <%= PHP expression %> and <%% PHP statements %>
+ * - expressions: They are in the format of <%= PHP expression %> and <%% PHP statements %>
* - comments: There are two kinds of comments, regular HTML comments and special template comments.
* The former is in the format of <!-- comments -->, which will be treated as text strings.
* The latter is in the format of <!-- comments --!>, which will be stripped out.