Class Tours

Model to provide one-time tips to help user learn a feature.

CComponent

CModel implements IteratorAggregate, ArrayAccess

CActiveRecord

Tours

Package: application\models
Author: Alex Rowe <alex@x2engine>
Located at x2engine/protected/models/Tours.php

Methods summary
`public string`	# `tableName( )` Returns `string` the associated database table name Overrides `CActiveRecord::tableName()`
`public static static`	# `model( string $className = 'Tours' )` 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 `static` active record model instance. Overrides `CActiveRecord::model()`
`public static string`	# `tip( string $params = array(), array $return = false )` Main API to create a tip. Main API to create a tip. EXAMPLES: 1.This will display as a flash-style tip with the specified text Tours::tip (array( 'content' => "<h1>Welcome to the profile page</h1>" )); 2. This example will create a Q-tip dialog, and highlight the element '#create-new-user-button'. Tours::tip ( array( 'content' => 'The button here will create a new user", 'target' => '#create-new-user-button' )); Parameters `$params` `string` $content HTML, text, or partial alias OR array of tips `$return` `array` $params Config array (Described below) Returns `string` HTML for a tip
`public static string`	# `tips( array $tips = array(), boolean $return = false )` renders an array of tips renders an array of tips Parameters `$tips` `array` $tips array of tip arrays. @see self::tip `$return` `boolean` $return Wether or not to return html Returns `string` empty if return = false
`public static string`	# `loadTips( string $partial = null, boolean $return = false )` Renders a file specifically to view tips. It is a simple rener partial call and the partial should echo out the tips Renders a file specifically to view tips. It is a simple rener partial call and the partial should echo out the tips Parameters `$partial` `string` $partial Partial name (in components/tours) `$return` `boolean` $return wether to return or echo the contents Returns `string` contents if return is true
`public static mixed`	# `getTip( string $key )` Checks if a tip has been seen returns false if it has been seen Checks if a tip has been seen returns false if it has been seen Parameters `$key` `string` $key Key to find a tip for Returns `mixed` Returns false if the tip has been seen, and returns the tip object if it has not been seen yet.

Methods inherited from CActiveRecord
__call(), __construct(), __get(), __isset(), __set(), __sleep(), __unset(), addRelatedRecord(), afterDelete(), afterFind(), afterFindInternal(), afterSave(), applyScopes(), attributeNames(), beforeCount(), beforeDelete(), beforeFind(), beforeFindInternal(), beforeSave(), cache(), count(), countByAttributes(), countBySql(), defaultScope(), delete(), deleteAll(), deleteAllByAttributes(), deleteByPk(), equals(), exists(), find(), findAll(), findAllByAttributes(), findAllByPk(), findAllBySql(), findByAttributes(), findByPk(), findBySql(), getActiveFinder(), getActiveRelation(), getAttribute(), getAttributeLabel(), getAttributes(), getCommandBuilder(), getDbConnection(), getDbCriteria(), getIsNewRecord(), getMetaData(), getOldPrimaryKey(), getPrimaryKey(), getRelated(), getTableAlias(), getTableSchema(), hasAttribute(), hasRelated(), init(), insert(), instantiate(), offsetExists(), onAfterDelete(), onAfterFind(), onAfterSave(), onBeforeCount(), onBeforeDelete(), onBeforeFind(), onBeforeSave(), populateRecord(), populateRecords(), primaryKey(), query(), refresh(), refreshMetaData(), relations(), 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(), attributeLabels(), beforeValidate(), behaviors(), clearErrors(), createValidators(), generateAttributeLabel(), getError(), getErrors(), getIterator(), getSafeAttributeNames(), getScenario(), getValidatorList(), getValidators(), hasErrors(), isAttributeRequired(), isAttributeSafe(), offsetGet(), offsetSet(), offsetUnset(), onAfterConstruct(), onAfterValidate(), onBeforeValidate(), onUnsafeAttribute(), rules(), 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 inherited from CActiveRecord
`$db`

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`

Packages

Classes

Class Tours

Returns

Overrides

Parameters

Returns

Overrides

EXAMPLES:

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns