Class Docs

This is the model class for table "x2_docs".

CComponent

Extended by

CModel implements IteratorAggregate, ArrayAccess

Extended by

CActiveRecord

Extended by

X2ActiveRecord

Extended by

X2Model

Extended by

Docs

Package: application\modules\docs\models
Located at x2engine/protected/modules/docs/models/Docs.php

Methods summary
`public static Docs`	# `model( string $className = __CLASS__ )` Returns the static model of the specified AR class. Returns the static model of the specified AR class. Parameters `$className` `string` $className active record class name. Returns `Docs` the static model class Overrides `X2Model::model()`
`public string`	# `tableName( )` Returns `string` the associated database table name Overrides `CActiveRecord::tableName()`
`public array`	# `behaviors( )` Returns a list of behaviors that this model should behave as. Returns a list of behaviors that this model should behave as. Returns `array` the behavior configurations (behavior name=>behavior configuration) Overrides `X2Model::behaviors()`
`public array`	# `relations( )` Returns `array` relational rules. Overrides `X2Model::relations()`
`public array`	# `rules( )` Generates validation rules for custom fields Generates validation rules for custom fields Returns `array` validation rules for model attributes. Overrides `X2Model::rules()`
`public`	# `menuCheck( mixed $attr, mixed $params = array() )`
`public`	# `parseType( )`
`public CActiveDataProvider`	# `search( mixed $pageSize = null )` Retrieves a list of models based on the current search/filter conditions. Retrieves a list of models based on the current search/filter conditions. Returns `CActiveDataProvider` the data provider that can return the models based on the search/filter conditions.
`public static string`	# `replaceVariables( type $str, X2Model $model, array $vars = array(), boolean $encode = false, mixed $renderFlag = true )` Replace tokens with model attribute values. Replace tokens with model attribute values. Parameters `$str` `type` $str Input text `$model` `X2Model` $model Model to use for replacement `$vars` `array` $vars List of extra variables to replace `$encode` `boolean` $encode Encode replacement values if true; use renderAttribute otherwise. `$renderFlag` Returns `string`
`public static type`	# `getEmailTemplates( type $type = 'email', string $associationType = '' )` Returns a list of email available email templates. Returns a list of email available email templates. Email and quote are the only two types of supported templates; no design has yet been done to completely generalize templating to accomodate generic models. Part of the challenge will lie in how, for multiple associated contacts (i.e. an account) any reference to a contact is ambiguous unless it is distinguished (i.e. primary contact, secondary contact, etc.) Current solution to this problem: Templates only contain insertable attributes for one type Parameters `$type` `type` $type `$associationType` `string` associationType Type associated with template (used for attribute replacement). If the empty string is passed, templates of all association types will be retrieved. Returns `type`
`public static`	# `getEmailTemplates2( )`
`public static array`	# `modelsWhichSupportEmailTemplates( )` Returns `array` names of models which support email templates

Methods inherited from X2Model
__construct(), afterCreate(), afterDelete(), afterFind(), afterSave(), afterUpdate(), attributeChanged(), attributeLabels(), beforeSave(), checkThrowAttrError(), compareAssignment(), compareAttribute(), compareAttributes(), compareBoolean(), compareDropdown(), duplicateFields(), findAll(), findByAttributes(), findByEmail(), findByNameId(), findByPkInArray(), getAllRecordNames(), getAssignmentOptions(), getAssociationModel(), getAssociationType(), getAssociationTypeOptions(), getAttribute(), getAttributeLabel(), getAttributeLabels(), getDefaultAssignment(), getDefaultFormLayout(), getDisplayName(), getEditableAttributeNames(), getEditableFieldNames(), getField(), getFieldComparisonOptions(), getFieldPermissions(), getFields(), getFieldsForDropdown(), getInsertableAttributeTokens(), getIsExemptFromFieldLevelPermissions(), getLinkedAttribute(), getLinkedModel(), getLinkedModelMock(), getModelLink(), getModelLinkMock(), getModelName(), getModelNames(), getModelOfTypeWithId(), getModelOfTypeWithName(), getModelTitle(), getModelTypes(), getModelTypesWhichSupportRelationships(), getModelTypesWhichSupportWorkflow(), getModelsFromNames(), getModuleModel(), getModuleModelName(), getModuleModelNames(), getModuleModelsByName(), getModuleName(), getModules(), getMyModelName(), getOldAttributes(), getPhoneNumber(), getReadableAttributeNames(), getRecordName(), getSort(), getStaticLinkedModels(), getSummaryFields(), getTableNames(), getTranslatedModelTitles(), getVisibleAttributes(), hide(), insert(), isModuleModelName(), massUpdateNameId(), model2(), modelRules(), onAfterCreate(), onAfterInsert(), onAfterUpdate(), query(), queryFields(), renderErroneousField(), renderInput(), renderLinkedAttribute(), renderMergeInput(), renderModelAutocomplete(), renderModelInput(), resetFieldsPropertyCache(), runWithoutBehavior(), save(), searchBase(), setX2Fields(), translatedAttributeLabel(), unshiftOperator(), updateNameId(), updateNameIdRefs(), updateTimerTotals()

Methods inherited from X2ActiveRecord
`getAllErrorMessages(), getBehaviorRules(), getFormatter(), getInputRenderer(), getName(), renderAttribute(), setFormatter(), setInputRenderer()`

Methods inherited from CActiveRecord
__call(), __get(), __isset(), __set(), __sleep(), __unset(), addRelatedRecord(), afterFindInternal(), applyScopes(), attributeNames(), beforeCount(), beforeDelete(), beforeFind(), beforeFindInternal(), cache(), count(), countByAttributes(), countBySql(), defaultScope(), delete(), deleteAll(), deleteAllByAttributes(), deleteByPk(), equals(), exists(), find(), findAllByAttributes(), findAllByPk(), findAllBySql(), findByPk(), findBySql(), getActiveFinder(), getActiveRelation(), getAttributes(), getCommandBuilder(), getDbConnection(), getDbCriteria(), getIsNewRecord(), getMetaData(), getOldPrimaryKey(), getPrimaryKey(), getRelated(), getTableAlias(), getTableSchema(), hasAttribute(), hasRelated(), init(), instantiate(), offsetExists(), onAfterDelete(), onAfterFind(), onAfterSave(), onBeforeCount(), onBeforeDelete(), onBeforeFind(), onBeforeSave(), populateRecord(), populateRecords(), primaryKey(), refresh(), refreshMetaData(), resetScope(), 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()`

Constants inherited from CActiveRecord
`BELONGS_TO, HAS_MANY, HAS_ONE, MANY_MANY, STAT`

Properties summary
`public true`	`$supportsWorkflow`	`false`	# if this model can have workflows associated with it, false otherwise if this model can have workflows associated with it, false otherwise

Properties inherited from X2Model
`$_editableFieldNames, $_fieldPermissions, $_fields, $_linkedModels, $_nameIdRefs, $_oldAttributes, $_runAfterCreate, $associationModels, $autoPopulateFields, $dbPersistentGridSettings, $disablePersistentGridSettings, $fieldFormatterClass, $modelNameToModuleName, $subScenario, $supportsFieldLevelPermissions, $translatedModelTitles, $uid`

Properties inherited from X2ActiveRecord
`$fieldInputRendererClass`

Properties inherited from CActiveRecord
`$db`

Magic properties inherited from X2Model
`$fieldPermissions, $isExemptFromFieldLevelPermissions, $myModelName, $readableAttributeNames, $relatedX2Models`

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`