My FIU Curriculum Class Reference. Yii Framework

# CurrCourse

Package | application
Inheritance | class CurrCourse » CActiveRecord » CModel » CComponent
Implements | IteratorAggregate, Traversable, ArrayAccess
Source Code |

This is the model class for table "curr_course".
The followings are the available columns in table 'curr_course':

## Public Properties

Hide inherited properties

Property | Type | Description | Defined By
--- | --- | --- | ---
attributes | array | Returns all column attribute values. | CActiveRecord
commandBuilder | CDbCommandBuilder | Returns the command builder used by this AR. | CActiveRecord
db | CDbConnection | the default database connection for all active record classes. | CActiveRecord
dbConnection | CDbConnection | Returns the database connection used by active record. | CActiveRecord
dbCriteria | CDbCriteria | Returns the query criteria associated with this model. | CActiveRecord
errors | array | Returns the errors for all attribute or a single attribute. | CModel
isNewRecord | boolean | Returns if the current record is new. | CActiveRecord
iterator | CMapIterator | Returns an iterator for traversing the attributes in the model. | CModel
metaData | CActiveRecordMetaData | Returns the meta-data for this AR | CActiveRecord
oldPrimaryKey | mixed | Returns the old primary key value. | CActiveRecord
primaryKey | mixed | Returns the primary key value. | CActiveRecord
safeAttributeNames | array | Returns the attribute names that are safe to be massively assigned. | CModel
scenario | string | Returns the scenario that this model is used in. | CModel
tableAlias | string | Returns the table alias to be used by the find methods. | CActiveRecord
tableSchema | CDbTableSchema | Returns the metadata of the table that this AR belongs to | CActiveRecord
validatorList | CList | Returns all the validators declared in the model. | CModel
validators | array | Returns the validators applicable to the current scenario. | CModel

## Public Methods

Hide inherited methods

Method | Description | Defined By
--- | --- | ---
__call() | Calls the named method which is not a class method. | CActiveRecord
__construct() | Constructor. | CActiveRecord
__get() | PHP getter magic method. | CActiveRecord
__isset() | Checks if a property value is null. | CActiveRecord
__set() | PHP setter magic method. | CActiveRecord
__sleep() | PHP sleep magic method. | CActiveRecord
__unset() | Sets a component property to be null. | CActiveRecord
addError() | Adds a new error to the specified attribute. | CModel
addErrors() | Adds a list of errors. | CModel
addRelatedRecord() | Do not call this method. This method is used internally by CActiveFinder to populate | CActiveRecord
afterFindInternal() | Calls afterFind. | CActiveRecord
applyScopes() | Applies the query scopes to the given criteria. | CActiveRecord
asa() | Returns the named behavior object. | CComponent
attachBehavior() | Attaches a behavior to this component. | CComponent
attachBehaviors() | Attaches a list of behaviors to the component. | CComponent
attachEventHandler() | Attaches an event handler to an event. | CComponent
attributeLabels() |  | CurrCourse
attributeNames() | Returns the list of all attribute names of the model. | CActiveRecord
beforeFindInternal() | Calls beforeFind. | CActiveRecord
behaviors() | Returns a list of behaviors that this model should behave as. | CModel
cache() | Sets the parameters about query caching. | CActiveRecord
canGetProperty() | Determines whether a property can be read. | CComponent
canSetProperty() | Determines whether a property can be set. | CComponent
clearErrors() | Removes errors for all attributes or a single attribute. | CModel
count() | Finds the number of rows satisfying the specified query condition. | CActiveRecord
countByAttributes() | Finds the number of rows that have the specified attribute values. | CActiveRecord
countBySql() | Finds the number of rows using the given SQL statement. | CActiveRecord
createValidators() | Creates validator objects based on the specification in rules. | CModel
defaultScope() | Returns the default named scope that should be implicitly applied to all queries for this model. | CActiveRecord
delete() | Deletes the row corresponding to this active record. | CActiveRecord
deleteAll() | Deletes rows with the specified condition. | CActiveRecord
deleteAllByAttributes() | Deletes rows which match the specified attribute values. | CActiveRecord
deleteByPk() | Deletes rows with the specified primary key. | CActiveRecord
detachBehavior() | Detaches a behavior from the component. | CComponent
detachBehaviors() | Detaches all behaviors from the component. | CComponent
detachEventHandler() | Detaches an existing event handler. | CComponent
disableBehavior() | Disables an attached behavior. | CComponent
disableBehaviors() | Disables all behaviors attached to this component. | CComponent
enableBehavior() | Enables an attached behavior. | CComponent
enableBehaviors() | Enables all behaviors attached to this component. | CComponent
equals() | Compares current active record with another one. | CActiveRecord
evaluateExpression() | Evaluates a PHP expression or callback under the context of this component. | CComponent
exists() | Checks whether there is row satisfying the specified condition. | CActiveRecord
find() | Finds a single active record with the specified condition. | CActiveRecord
findAll() | Finds all active records satisfying the specified condition. | CActiveRecord
findAllByAttributes() | Finds all active records that have the specified attribute values. | CActiveRecord
findAllByPk() | Finds all active records with the specified primary keys. | CActiveRecord
findAllBySql() | Finds all active records using the specified SQL statement. | CActiveRecord
findByAttributes() | Finds a single active record that has the specified attribute values. | CActiveRecord
findByPk() | Finds a single active record with the specified primary key. | CActiveRecord
findBySql() | Finds a single active record with the specified SQL statement. | CActiveRecord
generateAttributeLabel() | Generates a user friendly attribute label. | CModel
getActiveRelation() | Returns the named relation declared for this AR class. | CActiveRecord
getAttribute() | Returns the named attribute value. | CActiveRecord
getAttributeLabel() | Returns the text label for the specified attribute. | CActiveRecord
getAttributes() | Returns all column attribute values. | CActiveRecord
getCommandBuilder() | Returns the command builder used by this AR. | CActiveRecord
getDbConnection() | Returns the database connection used by active record. | CActiveRecord
getDbCriteria() | Returns the query criteria associated with this model. | CActiveRecord
getError() | Returns the first error of the specified attribute. | CModel
getErrors() | Returns the errors for all attribute or a single attribute. | CModel
getEventHandlers() | Returns the list of attached event handlers for an event. | CComponent
getIsNewRecord() | Returns if the current record is new. | CActiveRecord
getIterator() | Returns an iterator for traversing the attributes in the model. | CModel
getMetaData() | Returns the meta-data for this AR | CActiveRecord
getOldPrimaryKey() | Returns the old primary key value. | CActiveRecord
getPrimaryKey() | Returns the primary key value. | CActiveRecord
getRelated() | Returns the related record(s). | CActiveRecord
getSafeAttributeNames() | Returns the attribute names that are safe to be massively assigned. | CModel
getScenario() | Returns the scenario that this model is used in. | CModel
getTableAlias() | Returns the table alias to be used by the find methods. | CActiveRecord
getTableSchema() | Returns the metadata of the table that this AR belongs to | CActiveRecord
getValidatorList() | Returns all the validators declared in the model. | CModel
getValidators() | Returns the validators applicable to the current scenario. | CModel
hasAttribute() | Checks whether this AR has the named attribute | CActiveRecord
hasErrors() | Returns a value indicating whether there is any validation error. | CModel
hasEvent() | Determines whether an event is defined. | CComponent
hasEventHandler() | Checks whether the named event has attached handlers. | CComponent
hasProperty() | Determines whether a property is defined. | CComponent
hasRelated() | Returns a value indicating whether the named related object(s) has been loaded. | CActiveRecord
init() | Initializes this model. | CActiveRecord
insert() | Inserts a row into the table based on this active record attributes. | CActiveRecord
isAttributeRequired() | Returns a value indicating whether the attribute is required. | CModel
isAttributeSafe() | Returns a value indicating whether the attribute is safe for massive assignments. | CModel
model() | Returns the static model of the specified AR class. | CurrCourse
offsetExists() | Returns whether there is an element at the specified offset. | CActiveRecord
offsetGet() | Returns the element at the specified offset. | CModel
offsetSet() | Sets the element at the specified offset. | CModel
offsetUnset() | Unsets the element at the specified offset. | CModel
onAfterConstruct() | This event is raised after the model instance is created by new operator. | CModel
onAfterDelete() | This event is raised after the record is deleted. | CActiveRecord
onAfterFind() | This event is raised after the record is instantiated by a find method. | CActiveRecord
onAfterSave() | This event is raised after the record is saved. | CActiveRecord
onAfterValidate() | This event is raised after the validation is performed. | CModel
onBeforeDelete() | This event is raised before the record is deleted. | CActiveRecord
onBeforeFind() | This event is raised before an AR finder performs a find call. | CActiveRecord
onBeforeSave() | This event is raised before the record is saved. | CActiveRecord
onBeforeValidate() | This event is raised before the validation is performed. | CModel
onUnsafeAttribute() | This method is invoked when an unsafe attribute is being massively assigned. | CModel
populateRecord() | Creates an active record with the given attributes. | CActiveRecord
populateRecords() | Creates a list of active records based on the input data. | CActiveRecord
primaryKey() | Returns the primary key of the associated database table. | CActiveRecord
raiseEvent() | Raises an event. | CComponent
refresh() | Repopulates this active record with the latest data. | CActiveRecord
refreshMetaData() | Refreshes the meta data for this AR class. | CActiveRecord
relations() |  | CurrCourse
resetScope() | Resets all scopes and criterias applied. | CActiveRecord
rules() |  | CurrCourse
save() | Saves the current record. | CActiveRecord
saveAttributes() | Saves a selected list of attributes. | CActiveRecord
saveCounters() | Saves one or several counter columns for the current AR object. | CActiveRecord
scopes() | Returns the declaration of named scopes. | CActiveRecord
search() | Retrieves a list of models based on the current search/filter conditions. | CurrCourse
setAttribute() | Sets the named attribute value. | CActiveRecord
setAttributes() | Sets the attribute values in a massive way. | CModel
setDbCriteria() | Sets the query criteria for the current model. | CActiveRecord
setIsNewRecord() | Sets if the record is new. | CActiveRecord
setOldPrimaryKey() | Sets the old primary key value. | CActiveRecord
setPrimaryKey() | Sets the primary key value. | CActiveRecord
setScenario() | Sets the scenario for the model. | CModel
setTableAlias() | Sets the table alias to be used in queries. | CActiveRecord
tableName() |  | CurrCourse
together() | Sets CDbCriteria::together property to be true. | CActiveRecord
unsetAttributes() | Sets the attributes to be null. | CModel
update() | Updates the row represented by this active record. | CActiveRecord
updateAll() | Updates records with the specified condition. | CActiveRecord
updateByPk() | Updates records with the specified primary key(s). | CActiveRecord
updateCounters() | Updates one or several counter columns. | CActiveRecord
validate() | Performs the validation. | CModel
with() | Specifies which related objects should be eagerly loaded. | CActiveRecord

## Protected Methods

Hide inherited methods

Method | Description | Defined By
--- | --- | ---
afterConstruct() | This method is invoked after a model instance is created by new operator. | CModel
afterDelete() | This method is invoked after deleting a record. | CActiveRecord
afterFind() | This method is invoked after each record is instantiated by a find method. | CActiveRecord
afterSave() | This method is invoked after saving a record successfully. | CActiveRecord
afterValidate() | This method is invoked after validation ends. | CModel
beforeDelete() | This method is invoked before deleting a record. | CActiveRecord
beforeFind() | This method is invoked before an AR finder executes a find call. | CActiveRecord
beforeSave() | This method is invoked before saving a record (after validation, if any). | CActiveRecord
beforeValidate() | This method is invoked before validation starts. | CModel
instantiate() | Creates an active record instance. | CActiveRecord
query() | Performs the actual DB query and populates the AR objects with the query result. | CActiveRecord

## Events

Hide inherited events

Event | Description | Defined By
--- | --- | ---
onBeforeSave | This event is raised before the record is saved. | CActiveRecord
onAfterSave | This event is raised after the record is saved. | CActiveRecord
onBeforeDelete | This event is raised before the record is deleted. | CActiveRecord
onAfterDelete | This event is raised after the record is deleted. | CActiveRecord
onBeforeFind | This event is raised before an AR finder performs a find call. | CActiveRecord
onAfterFind | This event is raised after the record is instantiated by a find method. | CActiveRecord
onAfterConstruct | This event is raised after the model instance is created by new operator. | CModel
onBeforeValidate | This event is raised before the validation is performed. | CModel
onAfterValidate | This event is raised after the validation is performed. | CModel
onUnsafeAttribute | This method is invoked when an unsafe attribute is being massively assigned. | CModel

## Method Details

attributeLabels() method

public array attributeLabels()
{return} | array | customized attribute labels (name=>label)

Source Code: (show)
`public function attributeLabels()
{
return array(
'id' => 'ID',
'name' => 'Course Name',
'catalog_id' => 'Catalog',
);
}`

model() method

public static CurrCourse model(string $className='CurrCourse')
$className | string | active record class name.
{return} | CurrCourse | the static model class

Source Code: (show)
`public static function model($className=__CLASS__)
{
return parent::model($className);
}`

Returns the static model of the specified AR class.

relations() method

public array relations()
{return} | array | relational rules.

Source Code: (show)
`public function relations()
{
// NOTE: you may need to adjust the relation name and the related
// class name for the relations automatically generated below.
return array(
'catalog' => array(self::BELONGS_TO, 'Catalog', 'catalog_id'),
'currCourseDepartments' => array(self::HAS_MANY, 'CurrCourseDepartment', 'course_id'),
'currRequisites' => array(self::HAS_MANY, 'CurrRequisite', 'course_id'),
'currSetCourses' => array(self::HAS_MANY, 'CurrSetCourse', 'course_id'),
'hisCourses' => array(self::HAS_MANY, 'HisCourse', 'identifier_id'),
);
}`

rules() method

public array rules()
{return} | array | validation rules for model attributes.

Source Code: (show)
`public function rules()
{
// NOTE: you should only define rules for those attributes that
// will receive user inputs.
return array(
array('name, catalog_id', 'required'),
array('catalog_id', 'numerical', 'integerOnly'=>true),
array('name', 'length', 'max'=>255),
// The following rule is used by search().
// Please remove those attributes that should not be searched.
array('id, name, catalog_id', 'safe', 'on'=>'search'),
);
}`

search() method

public CActiveDataProvider search()
{return} | CActiveDataProvider | the data provider that can return the models based on the search/filter conditions.

Source Code: (show)
`public function search()
{
// Warning: Please modify the following code to remove attributes that
// should not be searched.
$criteria=new CDbCriteria;
$criteria->compare('id',$this->id);
$criteria->compare('name',$this->name,true);
$criteria->compare('catalog_id',$this->catalog_id);
return new CActiveDataProvider($this, array(
'criteria'=>$criteria,
));
}`

Retrieves a list of models based on the current search/filter conditions.

tableName() method

public string tableName()
{return} | string | the associated database table name

Source Code: (show)
`public function tableName()
{
return 'curr_course';
}`

Copyright © 2008-2011 by Yii Software LLC
All Rights Reserved.