Class P3Media
-
CComponent
-
CModel
implements
IteratorAggregate,
ArrayAccess
-
CActiveRecord
-
BaseP3Media
-
P3Media
Methods summary
public static
CActiveRecord
|
#
model( string $className = __CLASS__ )
Returns the static model of the specified AR class. The model returned is a
static instance of the AR class. It is provided for invoking class-level methods
(something similar to static class methods.)
Returns the static model of the specified AR class. The model returned is a
static instance of the AR class. It is provided for invoking class-level methods
(something similar to static class methods.)
EVERY derived AR class must override this method as follows,
public static function model($className=__CLASS__)
{
return parent::model($className);
}
Parameters
- $className
string $className active record class name.
Returns
CActiveRecord active record model instance.
Overrides
|
public
|
#
init( )
Initializes this model. This method is invoked when an AR instance is newly
created and has its scenario set. You may override this method to
provide code that is needed to initialize the model (e.g. setting initial
property values.)
Initializes this model. This method is invoked when an AR instance is newly
created and has its scenario set. You may override this method to
provide code that is needed to initialize the model (e.g. setting initial
property values.)
Overrides
CActiveRecord::init
|
public
|
|
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
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
See
scenario
Overrides
|
public
array
|
#
relations( )
This method should be overridden to declare related objects.
This method should be overridden to declare related objects.
There are four types of relations that may exist between two active record
objects:
- BELONGS_TO: e.g. a member belongs to a team;
- HAS_ONE: e.g. a member has at most one profile;
- HAS_MANY: e.g. a team has many members;
- MANY_MANY: e.g. a member has many skills and a skill belongs to a
member.
Besides the above relation types, a special relation called STAT is also
supported that can be used to perform statistical query (or aggregational
query). It retrieves the aggregational information about the related objects,
such as the number of comments for each post, the average rating for each
product, etc.
Each kind of related objects is defined in this method as an array with the
following elements:
'varName'=>array('relationType', 'className', 'foreignKey', ...additional options)
where 'varName' refers to the name of the variable/property that the related
object(s) can be accessed through; 'relationType' refers to the type of the
relation, which can be one of the following four constants: self::BELONGS_TO,
self::HAS_ONE, self::HAS_MANY and self::MANY_MANY; 'className' refers to the
name of the active record class that the related object(s) is of; and
'foreignKey' states the foreign key that relates the two kinds of active record.
Note, for composite foreign keys, they can be either listed together, separated
by commas or specified as an array in format of array('key1','key2'). In case
you need to specify custom PK->FK association you can define it as
array('fk'=>'pk'). For composite keys it will be
array('fk_c1'=>'pk_с1','fk_c2'=>'pk_c2'). For foreign keys used in
MANY_MANY relation, the joining table must be declared as well (e.g.
'join_table(fk1, fk2)').
Additional options may be specified as name-value pairs in the rest array
elements:
- 'select': string|array, a list of columns to be selected. Defaults to '*',
meaning all columns. Column names should be disambiguated if they appear in an
expression (e.g. COUNT(relationName.name) AS name_count).
- 'condition': string, the WHERE clause. Defaults to empty. Note, column
references need to be disambiguated with prefix 'relationName.' (e.g.
relationName.age>20)
- 'order': string, the ORDER BY clause. Defaults to empty. Note, column
references need to be disambiguated with prefix 'relationName.' (e.g.
relationName.age DESC)
- 'with': string|array, a list of child related objects that should be loaded
together with this object. Note, this is only honored by lazy loading, not eager
loading.
- 'joinType': type of join. Defaults to 'LEFT OUTER JOIN'.
- 'alias': the alias for the table associated with this relationship. It
defaults to null, meaning the table alias is the same as the relation name.
- 'params': the parameters to be bound to the generated SQL statement. This
should be given as an array of name-value pairs.
- 'on': the ON clause. The condition specified here will be appended to the
joining condition using the AND operator.
- 'index': the name of the column whose values should be used as keys of the
array that stores related objects. This option is only available to HAS_MANY and
MANY_MANY relations.
- 'scopes': scopes to apply. In case of a single scope can be used like
'scopes'=>'scopeName', in case of multiple scopes can be used like
'scopes'=>array('scopeName1','scopeName2'). This option has been available
since version 1.1.9.
The following options are available for certain relations when lazy loading:
- 'group': string, the GROUP BY clause. Defaults to empty. Note, column
references need to be disambiguated with prefix 'relationName.' (e.g.
relationName.age). This option only applies to HAS_MANY and MANY_MANY
relations.
- 'having': string, the HAVING clause. Defaults to empty. Note, column
references need to be disambiguated with prefix 'relationName.' (e.g.
relationName.age). This option only applies to HAS_MANY and MANY_MANY
relations.
- 'limit': limit of the rows to be selected. This option does not apply to
BELONGS_TO relation.
- 'offset': offset of the rows to be selected. This option does not apply to
BELONGS_TO relation.
- 'through': name of the model's relation that will be used as a bridge when
getting related data. Can be set only for HAS_ONE and HAS_MANY. This option has
been available since version 1.1.7.
Below is an example declaring related objects for 'Post' active record
class:
return array(
'author'=>array(self::BELONGS_TO, 'User', 'author_id'),
'comments'=>array(self::HAS_MANY, 'Comment', 'post_id', 'with'=>'author', 'order'=>'create_time DESC'),
'tags'=>array(self::MANY_MANY, 'Tag', 'post_tag(post_id, tag_id)', 'order'=>'name'),
);
Returns
array list of related object declarations. Defaults to empty array.
Overrides
|
public
|
|
public
|
|
public
array
|
#
behaviors( )
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:
'behaviorName'=>array(
'class'=>'path.to.BehaviorClass',
'property1'=>'value1',
'property2'=>'value2',
)
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:
'behaviorName'=>array(
'class'=>'path.to.BehaviorClass',
'property1'=>'value1',
'property2'=>'value2',
)
Note, the behavior classes must implement IBehavior or extend from
CBehavior. Behaviors declared in this method will be attached to the
model when it is instantiated.
For more details about behaviors, see CComponent.
Returns
array the behavior configurations (behavior name=>behavior configuration)
Overrides
CModel::behaviors
|
public
|
|
public
|
#
image( mixed $preset = null )
|
public
|
|
public
|
|
Methods inherited from BaseP3Media
attributeLabels()
,
tableName()
Methods inherited from CActiveRecord
__call()
,
__construct()
,
__get()
,
__isset()
,
__set()
,
__sleep()
,
__unset()
,
addRelatedRecord()
,
afterDelete()
,
afterFind()
,
afterFindInternal()
,
afterSave()
,
applyScopes()
,
attributeNames()
,
beforeDelete()
,
beforeFind()
,
beforeFindInternal()
,
beforeSave()
,
cache()
,
count()
,
countByAttributes()
,
countBySql()
,
defaultScope()
,
delete()
,
deleteAll()
,
deleteAllByAttributes()
,
deleteByPk()
,
equals()
,
exists()
,
find()
,
findAll()
,
findAllByAttributes()
,
findAllByPk()
,
findAllBySql()
,
findByAttributes()
,
findByPk()
,
findBySql()
,
getActiveRelation()
,
getAttribute()
,
getAttributeLabel()
,
getAttributes()
,
getCommandBuilder()
,
getDbConnection()
,
getDbCriteria()
,
getIsNewRecord()
,
getMetaData()
,
getOldPrimaryKey()
,
getPrimaryKey()
,
getRelated()
,
getTableAlias()
,
getTableSchema()
,
hasAttribute()
,
hasRelated()
,
insert()
,
instantiate()
,
offsetExists()
,
onAfterDelete()
,
onAfterFind()
,
onAfterSave()
,
onBeforeDelete()
,
onBeforeFind()
,
onBeforeSave()
,
populateRecord()
,
populateRecords()
,
primaryKey()
,
query()
,
refresh()
,
refreshMetaData()
,
resetScope()
,
save()
,
saveAttributes()
,
saveCounters()
,
scopes()
,
setAttribute()
,
setDbCriteria()
,
setIsNewRecord()
,
setOldPrimaryKey()
,
setPrimaryKey()
,
setTableAlias()
,
together()
,
update()
,
updateAll()
,
updateByPk()
,
updateCounters()
,
with()
Methods inherited from CModel
addError()
,
addErrors()
,
afterConstruct()
,
afterValidate()
,
beforeValidate()
,
clearErrors()
,
createValidators()
,
generateAttributeLabel()
,
getError()
,
getErrors()
,
getIterator()
,
getSafeAttributeNames()
,
getScenario()
,
getValidatorList()
,
getValidators()
,
hasErrors()
,
isAttributeRequired()
,
isAttributeSafe()
,
offsetGet()
,
offsetSet()
,
offsetUnset()
,
onAfterConstruct()
,
onAfterValidate()
,
onBeforeValidate()
,
onUnsafeAttribute()
,
setAttributes()
,
setScenario()
,
unsetAttributes()
,
validate()
Methods inherited from CComponent
asa()
,
attachBehavior()
,
attachBehaviors()
,
attachEventHandler()
,
canGetProperty()
,
canSetProperty()
,
detachBehavior()
,
detachBehaviors()
,
detachEventHandler()
,
disableBehavior()
,
disableBehaviors()
,
enableBehavior()
,
enableBehaviors()
,
evaluateExpression()
,
getEventHandlers()
,
hasEvent()
,
hasEventHandler()
,
hasProperty()
,
raiseEvent()
Magic methods summary
Constants summary
Constants inherited from CActiveRecord
BELONGS_TO
,
HAS_MANY
,
HAS_ONE
,
MANY_MANY
,
STAT
Properties summary
Properties inherited from BaseP3Media
$type
Properties inherited from CActiveRecord
$db
Magic properties inherited from BaseP3Media
$description
,
$id
,
$info
,
$md5
,
$mimeType
,
$originalName
,
$p3MediaMeta
,
$path
,
$size
,
$title
,
$type
Magic properties inherited from CActiveRecord
$attributes
,
$commandBuilder
,
$dbConnection
,
$dbCriteria
,
$isNewRecord
,
$metaData
,
$oldPrimaryKey
,
$primaryKey
,
$tableAlias
,
$tableSchema
Magic properties inherited from CModel
$errors
,
$iterator
,
$safeAttributeNames
,
$scenario
,
$validatorList
,
$validators