Yii Framework 1.0

https://www.yiiframework.com/doc/api/1.0
Admin
Yii Framework 1.0 is a high-performance, component-based PHP framework designed for rapidly...
Tokens:400,618
Snippets:5,159
Trust Score:9.9
Update:1 month ago
Show doc for...
Tokens:
Raw
### open method

Source: https://www.yiiframework.com/doc/api/1.0/CHttpSession

Starts the session. If custom storage is enabled, it configures the session save handlers before starting.

```php
public function open()
{
    if($this->getUseCustomStorage())
        @session_set_save_handler(array($this,'openSession'),array($this,'closeSession'),array($this,'readSession'),array($this,'writeSession'),array($this,'destroySession'),array($this,'gcSession'));
    @session_start();
}
```

--------------------------------

### Dependency configuration example

Source: https://www.yiiframework.com/doc/api/1.0/COutputCache

Example of configuring a dependency for the cache using an array specifying the class and SQL query.

```php
array(
    'class'=>'CDbCacheDependency',
    'sql'=>'SELECT MAX(lastModified) FROM Post',
)
```

--------------------------------

### Example commands configuration

Source: https://www.yiiframework.com/doc/api/1.0/CConsoleCommandRunner

Shows how to define the commands property using either a class path alias or an array configuration.

```php
array(
  'email'=>array(
     'class'=>'path.to.Mailer',
     'interval'=>3600,
  ),
  'log'=>'path.to.LoggerCommand',
)
```

--------------------------------

### Define Configuration Data in PHP

Source: https://www.yiiframework.com/doc/api/1.0/CConfiguration

Example of a PHP script returning an array of configuration settings.

```php
<?php
return array
(
    'name'=>'My Application',
    'defaultController'=>'index',
);
?>
```

--------------------------------

### init() method

Source: https://www.yiiframework.com/doc/api/1.0/COutputCache

Initializes the output cache. If content is cached, it replays actions; otherwise, it starts output buffering.

```php
public function init()
{
    if($this->getIsContentCached())
        $this->replayActions();
    else if($this->_cache!==null)
    {
        $this->getController()->getCachingStack()->push($this);
        ob_start();
        ob_implicit_flush(false);
    }
}
```

--------------------------------

### Validation rules configuration examples

Source: https://www.yiiframework.com/doc/api/1.0/CModel

Examples of defining multiple validation rules for different attributes and scenarios.

```php
array(
    array('username', 'required'),
    array('username', 'length', 'min'=>3, 'max'=>12),
    array('password', 'compare', 'compareAttribute'=>'password2', 'on'=>'register'),
    array('password', 'authenticate', 'on'=>'login'),
);
```

--------------------------------

### init() method implementation

Source: https://www.yiiframework.com/doc/api/1.0/CClipWidget

Initializes the widget by starting output buffering and disabling implicit flushing.

```php
public function init()
{
    ob_start();
    ob_implicit_flush(false);
}
```

--------------------------------

### Number formatting pattern examples

Source: https://www.yiiframework.com/doc/api/1.0/CNumberFormatter

Examples showing how specific patterns affect the formatting and rounding of numbers.

```text
Pattern "#,##0.00" will format 12345.678 as "12,345.68".
Pattern "#,#,#0.00" will format 12345.6 as "1,2,3,45.60".
```

--------------------------------

### init()

Source: https://www.yiiframework.com/doc/api/1.0/COutputCache

Initializes the output cache. If content is cached, it replays actions; otherwise, it starts output buffering.

```APIDOC
## void init()

### Description
Marks the start of content to be cached. Content displayed after this method call and before run() will be captured and saved in cache. This method does nothing if valid content is already found in cache.
```

--------------------------------

### getModules() method

Source: https://www.yiiframework.com/doc/api/1.0/CModule

Returns the configuration of currently installed modules.

```php
public function getModules()
{
    return $this->_moduleConfig;
}
```

--------------------------------

### activeDropDownList options example

Source: https://www.yiiframework.com/doc/api/1.0/CHtml

Example of the 'options' array structure for activeDropDownList, where keys are option values and values are extra OPTION tag attributes.

```php
    array(
        'value1'=>array('disabled'=>true, 'label'=>'value 1'),
        'value2'=>array('label'=>'value 2'),
    );
```

--------------------------------

### Example PHP message translation file structure

Source: https://www.yiiframework.com/doc/api/1.0/CPhpMessageSource

This example shows the expected return format for a PHP file containing translated messages, where keys are original messages and values are their translations.

```php
return array(
    'original message 1' => 'translated message 1',
    'original message 2' => 'translated message 2',
);
```

--------------------------------

### init()

Source: https://www.yiiframework.com/doc/api/1.0/CController

Initializes the controller. This method is called by the application before the controller starts to execute.

```APIDOC
## init()

### Description
Initializes the controller. This method is called by the application before the controller starts to execute. You may override this method to perform the needed initialization for the controller.
```

--------------------------------

### CWebUser::init()

Source: https://www.yiiframework.com/doc/api/1.0/CWebUser

Initializes the application component by starting the session, restoring authentication from cookies if enabled, and updating flash variables.

```php
public function init()
{
    parent::init();
    Yii::app()->getSession()->open();
    if($this->getIsGuest() && $this->allowAutoLogin)
        $this->restoreFromCookie();
    $this->updateFlash();
}
```

--------------------------------

### beginTransaction() method

Source: https://www.yiiframework.com/doc/api/1.0/CDbConnection

Starts a database transaction. Throws a CDbException if the connection is inactive.

```php
public function beginTransaction()
{
    if($this->getActive())
    {
        $this->_pdo->beginTransaction();
        return $this->_transaction=new CDbTransaction($this);
    }
    else
        throw new CDbException(Yii::t('yii','CDbConnection is inactive and cannot perform any DB operations.'));
}
```

--------------------------------

### Event Callback Examples

Source: https://www.yiiframework.com/doc/api/1.0/CComponent

Valid formats for PHP callbacks used in event handlers.

```php
'handleOnClick'                   // handleOnClick() is a global function
array($object,'handleOnClick')    // using $object->handleOnClick()
array('Page','handleOnClick')     // using Page::handleOnClick()
```

--------------------------------

### Configure commandMap property

Source: https://www.yiiframework.com/doc/api/1.0/CConsoleApplication

Example configuration for the commandMap property, showing how to map command names to class paths or configuration arrays.

```php
array(
  'email'=>array(
     'class'=>'path.to.Mailer',
     'interval'=>3600,
  ),
  'log'=>'path/to/LoggerCommand.php',
)
```

--------------------------------

### init() Method

Source: https://www.yiiframework.com/doc/api/1.0/CConsoleApplication

Initializes the application, ensuring it is run from the command line and setting up the command runner.

```php
protected function init()
{
    parent::init();
    if(!isset($_SERVER['argv'])) // || strncasecmp(php_sapi_name(),'cli',3))
        die('This script must be run from the command line.');
    $this->_runner=$this->createCommandRunner();
    $this->_runner->commands=$this->commandMap;
    $this->_runner->addCommands($this->getCommandPath());
}
```

--------------------------------

### init() method

Source: https://www.yiiframework.com/doc/api/1.0/CAssetManager

Initializes the application component, setting default base paths and URLs if they are not already configured.

```php
public function init()
{
    parent::init();
    $request=Yii::app()->getRequest();
    if($this->getBasePath()===null)
        $this->setBasePath(dirname($request->getScriptFile()).DIRECTORY_SEPARATOR.self::DEFAULT_BASEPATH);
    if($this->getBaseUrl()===null)
        $this->setBaseUrl($request->getBaseUrl().'/'.self::DEFAULT_BASEPATH);
}
```

--------------------------------

### Fragment Caching Usage Example

Source: https://www.yiiframework.com/doc/api/1.0/CBaseController

A typical pattern for implementing fragment caching using beginCache and endCache.

```php
if($this->beginCache($id))
{
    // ...generate content here
    $this->endCache();
}
```

--------------------------------

### SQL structure for limit and offset

Source: https://www.yiiframework.com/doc/api/1.0/CMssqlCommandBuilder

Example of the SQL structure used for implementing limit and offset in MSSQL.

```sql
SELECT * FROM (  SELECT TOP n * FROM (    SELECT TOP z columns      -- (z=n+skip)    FROM tablename    ORDER BY key ASC  ) AS FOO ORDER BY key DESC -- ('FOO' may be anything) ) AS BAR ORDER BY key ASC    -- ('BAR' may be anything)
```

--------------------------------

### CGoogleApi::init() implementation

Source: https://www.yiiframework.com/doc/api/1.0/CGoogleApi

Renders the jsapi script file. If an API key is provided, it is appended to the bootstrap URL.

```php
 public static function init($apiKey=null)
{
    if($apiKey===null)
        return CHtml::scriptFile(self::BOOTSTRAP_URL);
    else
        return CHtml::scriptFile(self::BOOTSTRAP_URL.'?key='.$apiKey);
} 
```

--------------------------------

### listBox options array example

Source: https://www.yiiframework.com/doc/api/1.0/CHtml

Example of the options array structure for the listBox method, specifying additional attributes for each OPTION tag.

```php
array(
    'value1'=>array('disabled'=>true, 'label'=>'value 1'),
    'value2'=>array('label'=>'value 2'),
);
```

--------------------------------

### getParam() Method

Source: https://www.yiiframework.com/doc/api/1.0/CHttpRequest

Returns the named GET or POST parameter value. GET parameters take precedence over POST parameters if both exist.

```php
public function getParam($name,$defaultValue=null)
{
    return isset($_GET[$name]) ? $_GET[$name] : (isset($_POST[$name]) ? $_POST[$name] : $defaultValue);
}
```

--------------------------------

### init() method

Source: https://www.yiiframework.com/doc/api/1.0/CFileCache

Initializes the application component and ensures the cache directory exists.

```php
public function init()
{
    parent::init();
    if($this->cachePath===null)
        $this->cachePath=Yii::app()->getRuntimePath().DIRECTORY_SEPARATOR.'cache';
    if(!is_dir($this->cachePath))
        mkdir($this->cachePath,0777,true);
}
```

--------------------------------

### CApplication::__construct()

Source: https://www.yiiframework.com/doc/api/1.0/CApplication

Initializes the application instance, sets base paths, and registers core components.

```php
public function __construct($config=null)
{
	Yii::setApplication($this);

	// set basePath at early as possible to avoid trouble
	if(is_string($config))
		$config=require($config);
	if(isset($config['basePath']))
	{
		$this->setBasePath($config['basePath']);
		unset($config['basePath']);
	}
	else
		$this->setBasePath('protected');
	Yii::setPathOfAlias('application',$this->getBasePath());
	Yii::setPathOfAlias('webroot',dirname($_SERVER['SCRIPT_FILENAME']));
	Yii::setPathOfAlias('ext',$this->getBasePath().DIRECTORY_SEPARATOR.'extensions');

	$this->preinit();

	$this->initSystemHandlers();
	$this->registerCoreComponents();

	$this->configure($config);
	$this->attachBehaviors($this->behaviors);
	$this->preloadComponents();

	$this->init();
}
```

--------------------------------

### beginClip() method

Source: https://www.yiiframework.com/doc/api/1.0/CBaseController

Begins recording a clip by initializing a CClipWidget.

```php
public function beginClip($id,$properties=array())
{
    $properties['id']=$id;
    $this->beginWidget('CClipWidget',$properties);
}
```

--------------------------------

### Filter Specification Example

Source: https://www.yiiframework.com/doc/api/1.0/CController

An example of how to define filters in a controller using the filters() method, including method-based and object-based filters with action constraints.

```php
array(
    'accessControl - login',
    'ajaxOnly + search',
    array(
        'COutputCache + list',
        'duration'=>300,
    ),
)
```

--------------------------------

### Mark code block start for profiling with beginProfile()

Source: https://www.yiiframework.com/doc/api/1.0/YiiBase

Logs the start of a profiling block. Must be matched with endProfile() using the same token and properly nested.

```php
public static function beginProfile($token,$category='application')
{
    self::log('begin:'.$token,CLogger::LEVEL_PROFILE,$category);
}
```

```php
Yii::beginProfile('block1');
Yii::beginProfile('block2');
Yii::endProfile('block2');
Yii::endProfile('block1');
```

```php
Yii::beginProfile('block1');
Yii::beginProfile('block2');
Yii::endProfile('block1');
Yii::endProfile('block2');
```

--------------------------------

### init method

Source: https://www.yiiframework.com/doc/api/1.0/CPhpAuthManager

Initializes the component by setting the default auth file path and loading authorization data.

```php
public function init()
{
	parent::init();
	if($this->authFile===null)
		$this->authFile=Yii::getPathOfAlias('application.data.auth').'.php';
	$this->load();
}
```

--------------------------------

### run() method implementation

Source: https://www.yiiframework.com/doc/api/1.0/CHelpCommand

Executes the help command logic, displaying a list of available commands or the help text for a specific command if provided.

```php
 public function run($args)
{
    $runner=$this->getCommandRunner();
    $commands=$runner->commands;
    if(isset($args[0]))
        $name=strtolower($args[0]);
    if(!isset($args[0]) || !isset($commands[$name]))
    {
        if(!empty($commands))
        {
            echo "Yii command runner (based on Yii v".Yii::getVersion().")\n";
            echo "Usage: ".$runner->getScriptName()." <command-name> [parameters...]\n";
            echo "\nThe following commands are available:\n";
            $commandNames=array_keys($commands);
            sort($commandNames);
            echo ' - '.implode("\n - ",$commandNames);
            echo "\n\nTo see individual command help, use the following:\n";
            echo "   ".$runner->getScriptName()." help <command-name>\n";
        }
        else
        {
            echo "No available commands.\n";
            echo "Please define them under the following directory:\n";
            echo "\t".Yii::app()->getCommandPath()."\n";
        }
    }
    else
        echo $runner->createCommand($name)->getHelp();
}
```

--------------------------------

### getIsStarted()

Source: https://www.yiiframework.com/doc/api/1.0/CHttpSession

Checks whether the session has already been started.

```php
public function getIsStarted()
{
    return session_id()!=='';
}
```

--------------------------------

### Get database connection

Source: https://www.yiiframework.com/doc/api/1.0/CDbCommand

Retrieves the CDbConnection instance associated with the command.

```php
public function getConnection()
{
    return $this->_connection;
}
```

--------------------------------

### init()

Source: https://www.yiiframework.com/doc/api/1.0/CXCache

Initializes the application component and verifies that the XCache extension is loaded.

```APIDOC
## public void init()

### Description
Initializes this application component. This method is required by the IApplicationComponent interface. It checks the availability of the XCache extension.

### Returns
- **void**
```

--------------------------------

### get(string $id)

Source: https://www.yiiframework.com/doc/api/1.0/CCache

Retrieves a value from cache with a specified key.

```APIDOC
## get(string $id)

### Description
Retrieves a value from cache with a specified key.

### Parameters
- **$id** (string) - Required - A key identifying the cached value

### Returns
- **mixed** - The cached value, or false if the value is not in the cache or expired.
```

--------------------------------

### init()

Source: https://www.yiiframework.com/doc/api/1.0/CFileLogRoute

Initializes the log route.

```APIDOC
## void init()

### Description
Initializes the route. This method is invoked after the route is created by the route manager.
```

--------------------------------

### getVerifyCode Method

Source: https://www.yiiframework.com/doc/api/1.0/CCaptchaAction

Gets the verification code, optionally regenerating it if specified.

```php
public function getVerifyCode($regenerate=false)
{
    $session=Yii::app()->session;
    $session->open();
    $name=$this->getSessionKey();
    if($session[$name]===null || $regenerate)
    {
        $session[$name]=$this->generateVerifyCode();
        $session[$name.'count']=1;
    }
    return $session[$name];
}
```

--------------------------------

### init()

Source: https://www.yiiframework.com/doc/api/1.0/CDbConnection

Initializes the component.

```APIDOC
## void init()

### Description
Initializes the component. This method is required by IApplicationComponent and is invoked by the application when the CDbConnection is used as an application component.
```

--------------------------------

### init method

Source: https://www.yiiframework.com/doc/api/1.0/CUrlManager

Initializes the application component by processing URL rules.

```php
public function init()
{
    parent::init();
    $this->processRules();
}
```

--------------------------------

### setUrlFormat method

Source: https://www.yiiframework.com/doc/api/1.0/CUrlManager

Sets the URL format, which must be either 'path' or 'get'.

```php
public function setUrlFormat($value)
{
    if($value===self::PATH_FORMAT || $value===self::GET_FORMAT)
        $this->_urlFormat=$value;
    else
        throw new CException(Yii::t('yii','CUrlManager.UrlFormat must be either "path" or "get".'));
}
```

--------------------------------

### init method

Source: https://www.yiiframework.com/doc/api/1.0/CWebApplication

Initializes the application and preloads the 'request' component.

```php
protected function init()
{
    parent::init();
    // preload 'request' so that it has chance to respond to onBeginRequest event.
    $this->getRequest();
}
```

--------------------------------

### CPradoViewRenderer template syntax examples

Source: https://www.yiiframework.com/doc/api/1.0/CPradoViewRenderer

Overview of supported template tags including PHP expressions, component widgets, cache fragments, clips, and comments.

```text
// PHP tags:
<%= expression %>
// <?php echo expression ?>
<% statement %>
// <?php statement ?></li>

// component tags:
<com:WigetClass name1="value1" name2='value2' name3={value3} >
// <?php $this->beginWidget('WigetClass',
// array('name1'=>"value1", 'name2'=>'value2', 'name3'=>value3)); ?>
</com:WigetClass >
// <?php $this->endWidget('WigetClass'); ?>
<com:WigetClass name1="value1" name2='value2' name3={value3} />
// <?php $this->widget('WigetClass',
// array('name1'=>"value1", 'name2'=>'value2', 'name3'=>value3)); ?>

// cache tags:
<cache:fragmentID name1="value1" name2='value2' name3={value3} >
// <?php if($this->beginCache('fragmentID',
// array('name1'=>"value1", 'name2'=>'value2', 'name3'=>value3))): ?>
</cache:fragmentID >
// <?php $this->endCache('fragmentID'); endif; ?>

// clip tags:
<clip:clipID >
// <?php $this->beginClip('clipID'); ?>
</clip:clipID >
// <?php $this->endClip('clipID'); ?>

// comment tags:
<!--- comments --->
// the whole tag will be stripped off
```

--------------------------------

### init method

Source: https://www.yiiframework.com/doc/api/1.0/CDbAuthManager

Initializes the component by establishing the database connection and detecting if SQLite is being used.

```php
public function init()
{
    parent::init();

    $this->getDbConnection()->setActive(true);
    $this->_usingSqlite=!strncmp($this->getDbConnection()->getDriverName(),'sqlite',6);
}
```

--------------------------------

### getBaseUrl() / setBaseUrl(string $value)

Source: https://www.yiiframework.com/doc/api/1.0/CThemeManager

Gets or sets the base URL for all themes.

```APIDOC
## getBaseUrl()

### Description
Returns the base URL for all themes. Defaults to "/WebRoot/themes".

## setBaseUrl(string $value)

### Description
Sets the base URL for all themes.

### Parameters
- **value** (string) - Required - The base URL for themes.
```

--------------------------------

### Configure controllerMap property

Source: https://www.yiiframework.com/doc/api/1.0/CWebApplication

Example configuration for the controllerMap property, mapping controller IDs to their respective class paths and initial property values.

```php
array(
  'post'=>array(
     'class'=>'path.to.PostController',
     'pageTitle'=>'something new',
  ),
  'user'=>'path.to.UserController',,
)
```

--------------------------------

### createWebApplication() method

Source: https://www.yiiframework.com/doc/api/1.0/YiiBase

Creates a Web application instance using the provided configuration.

```php
public static function createWebApplication($config=null)
{
    return self::createApplication('CWebApplication',$config);
}
```

--------------------------------

### getGCProbability()

Source: https://www.yiiframework.com/doc/api/1.0/CHttpSession

Returns the percentage chance that the garbage collection process starts on session initialization.

```php
public function getGCProbability()
{
    return (int)ini_get('session.gc_probability');
}
```

--------------------------------

### safeAttributes return structure

Source: https://www.yiiframework.com/doc/api/1.0/CModel

Example of the array structure returned by safeAttributes for scenario-sensitive models.

```php
array(
   // these attributes can be massively assigned in any scenario
   // that is not explicitly specified below
   'attr1, attr2, ...',

   // these attributes can be massively assigned only in scenario 1
   'scenario1' => 'attr2, attr3, ...',

   // these attributes can be massively assigned only in scenario 2
   'scenario2' => 'attr1, attr3, ...',
);
```

--------------------------------

### preinit() method

Source: https://www.yiiframework.com/doc/api/1.0/CModule

Preinitializes the module. Called at the beginning of the constructor before configuration.

```php
protected function preinit()
{
}
```

--------------------------------

### createConsoleApplication() method

Source: https://www.yiiframework.com/doc/api/1.0/YiiBase

Creates a console application instance using the provided configuration.

```php
public static function createConsoleApplication($config=null)
{
    return self::createApplication('CConsoleApplication',$config);
}
```

--------------------------------

### Querying with named scopes

Source: https://www.yiiframework.com/doc/api/1.0/CActiveRecord

Examples of chaining named scopes to perform database queries.

```php
$posts=Post::model()->published()->findAll();
$posts=Post::model()->published()->recently()->findAll();
$posts=Post::model()->published()->with('comments')->findAll();
```

--------------------------------

### Configure CLogRouter in application configuration

Source: https://www.yiiframework.com/doc/api/1.0/CLogRouter

Example showing how to define the log component and its routes within the application configuration array, including preloading the log component.

```php
array(
    'preload'=>array('log'), // preload log component when app starts
    'components'=>array(
        'log'=>array(
            'class'=>'CLogRouter',
            'routes'=>array(
                array(
                    'class'=>'CFileLogRoute',
                    'levels'=>'trace, info',
                    'categories'=>'system.*',
                ),
                array(
                    'class'=>'CEmailLogRoute',
                    'levels'=>'error, warning',
                    'email'=>'admin@example.com',
                ),
            ),
        ),
    ),
)
```

--------------------------------

### setCurrentPage Method

Source: https://www.yiiframework.com/doc/api/1.0/CPagination

Sets the current page index and updates the global GET parameters.

```php
public function setCurrentPage($value)
{
    $this->_currentPage=$value;
    $_GET[$this->pageVar]=$value+1;
}
```

--------------------------------

### init()

Source: https://www.yiiframework.com/doc/api/1.0/CCache

Initializes the application component by setting the default cache key prefix.

```APIDOC
## init()

### Description
Initializes the application component. This method overrides the parent implementation by setting default cache key prefix.
```

--------------------------------

### CHttpRequest::getRequestType()

Source: https://www.yiiframework.com/doc/api/1.0/CHttpRequest

Returns the request type, such as GET, POST, HEAD, PUT, or DELETE.

```php
public function getRequestType()
{
    return strtoupper(isset($_SERVER['REQUEST_METHOD'])?$_SERVER['REQUEST_METHOD']:'GET');
}
```

--------------------------------

### __construct(mixed $config)

Source: https://www.yiiframework.com/doc/api/1.0/CApplication

Initializes the application instance. The configuration can be a file path or an array, and it is recommended to specify the basePath property.

```APIDOC
## __construct(mixed $config)

### Description
Constructor for the CApplication class. Initializes the application with the provided configuration.

### Parameters
- **$config** (mixed) - Optional - Application configuration. If a string, it is treated as the path of the configuration file; if an array, it is the actual configuration information.
```

--------------------------------

### __construct($provider, $wsdlUrl, $serviceUrl)

Source: https://www.yiiframework.com/doc/api/1.0/CWebService

Initializes a new instance of the CWebService class.

```APIDOC
## __construct

### Description
Constructor for the CWebService class.

### Parameters
- **$provider** (mixed) - The web service provider class name or object.
- **$wsdlUrl** (string) - The URL for WSDL.
- **$serviceUrl** (string) - The URL for the Web service.
```

--------------------------------

### Get SQL text

Source: https://www.yiiframework.com/doc/api/1.0/CDbCommand

Retrieves the SQL statement string currently associated with the command.

```php
public function getText()
{
    return $this->_text;
}
```

--------------------------------

### createWidget()

Source: https://www.yiiframework.com/doc/api/1.0/CBaseController

Creates a widget and initializes it. This method first creates the specified widget instance, configures its properties, and calls CWidget::init.

```APIDOC
## CWidget createWidget(string $className, array $properties=array())

### Description
Creates a widget and initializes it. This method first creates the specified widget instance. It then configures the widget's properties with the given initial values. At the end it calls CWidget::init to initialize the widget.

### Parameters
- **$className** (string) - Required - Class name (can be in path alias format).
- **$properties** (array) - Optional - Initial property values.

### Returns
- **CWidget** - The fully initialized widget instance.
```

--------------------------------

### Overriding beforeControllerAction

Source: https://www.yiiframework.com/doc/api/1.0/CWebModule

Example of how to override the beforeControllerAction method to include custom logic before executing the action.

```php
if(parent::beforeControllerAction($controller,$action))
{
    // your code
    return true;
}
else
    return false;
```

--------------------------------

### init() method

Source: https://www.yiiframework.com/doc/api/1.0/CDbConnection

Initializes the component. If overridden, the parent implementation must be called.

```php
public function init()
{
    parent::init();
    if($this->autoConnect)
        $this->setActive(true);
}
```

--------------------------------

### CJavaScript::encode() usage example

Source: https://www.yiiframework.com/doc/api/1.0/CJavaScript

Demonstrates how to encode a PHP array into a JavaScript object representation.

```php
$options=array('key1'=>true,'key2'=>123,'key3'=>'value');
echo CJavaScript::encode($options);
// The following javascript code would be generated:
// {'key1':true,'key2':123,'key3':'value'}
```

--------------------------------

### createApplication() method

Source: https://www.yiiframework.com/doc/api/1.0/YiiBase

Creates an application instance of the specified class using the provided configuration.

```php
public static function createApplication($class,$config=null)
{
    return new $class($config);
}
```

--------------------------------

### beginContent() method

Source: https://www.yiiframework.com/doc/api/1.0/CBaseController

Begins the rendering of content that is to be decorated by the specified view.

```php
public function beginContent($view=null,$data=array())
{
    $this->beginWidget('CContentDecorator',array('view'=>$view, 'data'=>$data));
}
```

--------------------------------

### Defining named scopes

Source: https://www.yiiframework.com/doc/api/1.0/CActiveRecord

Example of overriding the scopes method to define named query criteria.

```php
return array(
    'published'=>array(
          'condition'=>'status=1',
    ),
    'recently'=>array(
          'order'=>'createTime DESC',
          'limit'=>5,
    ),
);
```

--------------------------------

### Extracting criteria properties

Source: https://www.yiiframework.com/doc/api/1.0/CDbCriteria

Example showing how to iterate over criteria properties and store them in a result array.

```php
$result[$name]=$this->$name;  
    return $result;  
}
```

--------------------------------

### init method

Source: https://www.yiiframework.com/doc/api/1.0/CAutoComplete

Initializes the widget, registers client scripts, and renders the autocomplete input field.

```php
 public function init()
{
    list($name,$id)=$this->resolveNameID();
    if(!isset($this->htmlOptions['id']))
        $this->htmlOptions['id']=$id;
    if(!isset($this->htmlOptions['name']))
        $this->htmlOptions['name']=$name;

    $this->registerClientScript();

    if($this->hasModel())
    {
        $field=$this->textArea ? 'activeTextArea' : 'activeTextField';
        echo CHtml::$field($this->model,$this->attribute,$this->htmlOptions);
    }
    else
    {
        $field=$this->textArea ? 'textArea' : 'textField';
        echo CHtml::$field($name,$this->value,$this->htmlOptions);
    }
}
```

--------------------------------

### CWebService::getOptions()

Source: https://www.yiiframework.com/doc/api/1.0/CWebService

Returns the configuration options for creating a SoapServer instance.

```php
protected function getOptions()
{
    $options=array();
    if($this->soapVersion==='1.1')
        $options['soap_version']=SOAP_1_1;
    else if($this->soapVersion==='1.2')
        $options['soap_version']=SOAP_1_2;
    if($this->actor!==null)
        $options['actor']=$this->actor;
    $options['encoding']=$this->encoding;
    foreach($this->classMap as $type=>$className)
    {
        $className=Yii::import($className,true);
        if(is_int($type))
            $type=$className;
        $options['classmap'][$type]=$className;
    }
    return $options;
}
```

--------------------------------

### setUrlFormat(string $value)

Source: https://www.yiiframework.com/doc/api/1.0/CUrlManager

Sets the URL format for the application, which must be either 'path' or 'get'.

```APIDOC
## void setUrlFormat(string $value)

### Description
Configures the URL format used by the manager.

### Parameters
- **$value** (string) - Required - The URL format, must be either 'path' or 'get'.
```

--------------------------------

### getBasePath() / setBasePath(string $value)

Source: https://www.yiiframework.com/doc/api/1.0/CThemeManager

Gets or sets the base directory path where themes are stored.

```APIDOC
## getBasePath()

### Description
Returns the base path for all themes. Defaults to "WebRootPath/themes".

## setBasePath(string $value)

### Description
Sets the base path for all themes.

### Parameters
- **value** (string) - Required - The directory path for themes.
```

--------------------------------

### CXCache::init() implementation

Source: https://www.yiiframework.com/doc/api/1.0/CXCache

Initializes the component and verifies that the XCache extension is loaded.

```php
 public function init()
{
    parent::init();
    if(!function_exists('xcache_isset'))
        throw new CException(Yii::t('yii','CXCache requires PHP XCache extension to be loaded.'));
}
```

--------------------------------

### getQuery()

Source: https://www.yiiframework.com/doc/api/1.0/CHttpRequest

Retrieves a named GET parameter value, with an optional default value if the parameter does not exist.

```APIDOC
## getQuery(string $name, mixed $defaultValue)

### Description
Returns the named GET parameter value. If the GET parameter does not exist, the second parameter to this method will be returned.

### Parameters
- **$name** (string) - Required - The GET parameter name.
- **$defaultValue** (mixed) - Optional - The default parameter value if the GET parameter does not exist.

### Returns
- **mixed** - The GET parameter value.
```

--------------------------------

### run method

Source: https://www.yiiframework.com/doc/api/1.0/CCaptcha

Executes the widget by rendering the image and registering the required client scripts.

```php
public function run()
{
    $this->renderImage();
    $this->registerClientScript();
}
```

--------------------------------

### init() method

Source: https://www.yiiframework.com/doc/api/1.0/CModule

Initializes the module. Called at the end of the constructor after configuration and component registration.

```php
protected function init()
{
}
```

--------------------------------

### getParam(string $name, mixed $defaultValue)

Source: https://www.yiiframework.com/doc/api/1.0/CHttpRequest

Returns the named GET or POST parameter value.

```APIDOC
## getParam(string $name, mixed $defaultValue)

### Description
Returns the named GET or POST parameter value. If the parameter does not exist, the default value is returned. GET parameters take precedence over POST parameters.

### Parameters
- **$name** (string) - Required - The parameter name.
- **$defaultValue** (mixed) - Optional - The default value if the parameter does not exist.

### Returns
- (mixed) - The parameter value.
```

--------------------------------

### run method

Source: https://www.yiiframework.com/doc/api/1.0/CFlexWidget

Renders the Flex widget after validating the name and baseUrl properties and registering required client scripts.

```php
 public function run()
{
    if(empty($this->name))
        throw new CException(Yii::t('yii','CFlexWidget.name cannot be empty.'));
    if(empty($this->baseUrl))
        throw new CException(Yii::t('yii','CFlexWidget.baseUrl cannot be empty.'));
    if($this->altHtmlContent===null)
        $this->altHtmlContent=Yii::t('yii','This content requires the <a href="https://www.adobe.com/go/getflash/">Adobe Flash Player</a>.');

    $this->registerClientScript();

    $this->render('flexWidget');
}
```

--------------------------------

### checkAccess(string $itemName, array $params)

Source: https://www.yiiframework.com/doc/api/1.0/CAuthItem

Checks if the specified item is within the hierarchy starting from this item.

```APIDOC
## checkAccess(string $itemName, array $params)

### Description
Checks to see if the specified item is within the hierarchy starting from this item.

### Parameters
- **itemName** (string) - Required - The name of the item to be checked.
- **params** (array) - Optional - The parameters to be passed to business rule evaluation.

### Returns
- **boolean** - Whether the specified item is within the hierarchy.
```

--------------------------------

### init() method

Source: https://www.yiiframework.com/doc/api/1.0/CApcCache

Initializes the application component and checks for the availability of the APC extension.

```php
public function init()
{
    parent::init();
    if(!extension_loaded('apc'))
        throw new CException(Yii::t('yii','CApcCache requires PHP apc extension to be loaded.'));
}
```

--------------------------------

### beginWidget() method

Source: https://www.yiiframework.com/doc/api/1.0/CBaseController

Creates a widget and executes it, expecting a corresponding endWidget() call.

```php
public function beginWidget($className,$properties=array())
{
    $widget=$this->createWidget($className,$properties);
    $this->_widgetStack[]=$widget;
    return $widget;
}
```

--------------------------------

### init() method

Source: https://www.yiiframework.com/doc/api/1.0/CDbColumnSchema

Initializes the column with its database type and default value, setting up internal properties like PHP type, size, and scale.

```php
 public function init($dbType, $defaultValue)
{
    $this->dbType=$dbType;
    $this->extractType($dbType);
    $this->extractLimit($dbType);
    if($defaultValue!==null)
        $this->extractDefault($defaultValue);
}
```

--------------------------------

### Customizing eager loading options

Source: https://www.yiiframework.com/doc/api/1.0/CActiveRecord

Example of passing an array to with() to customize query options for relations on the fly.

```php
Post::model()->with(array(
    'author'=>array('select'=>'id, name'),
    'comments'=>array('condition'=>'approved=1', 'order'=>'createTime'),
))->findAll();
```

--------------------------------

### Eager loading relations with with()

Source: https://www.yiiframework.com/doc/api/1.0/CActiveRecord

Examples of using with() to eagerly load related objects like authors and comments.

```php
// find all posts together with their author and comments
Post::model()->with('author','comments')->findAll();
// find all posts together with their author and the author's profile
Post::model()->with('author','author.profile')->findAll();
```

--------------------------------

### init method

Source: https://www.yiiframework.com/doc/api/1.0/CMemCache

Initializes the application component by creating the memcache instance and adding configured servers. This method is required by the IApplicationComponent interface.

```php
public function init()
{
    parent::init();
    $servers=$this->getServers();
    $cache=$this->getMemCache();
    if(count($servers))
    {
        foreach($servers as $server)
        {
            if($this->useMemcached)
                $cache->addServer($server->host,$server->port,$server->weight);
            else
                $cache->addServer($server->host,$server->port,$server->persistent,$server->weight,$server->timeout,$server->status);
        }
    }
    else
        $cache->addServer('localhost',11211);
}
```

--------------------------------

### init()

Source: https://www.yiiframework.com/doc/api/1.0/CHttpSession

Initializes the session component and opens the session if autoStart is enabled.

```php
public function init()
{
    parent::init();
    if($this->autoStart)
        $this->open();
```

--------------------------------

### Get PDO statement

Source: https://www.yiiframework.com/doc/api/1.0/CDbCommand

Retrieves the underlying PDOStatement object. It may return null if the statement has not been prepared.

```php
public function getPdoStatement()
{
    return $this->_statement;
}
```

--------------------------------

### createConsoleApplication

Source: https://www.yiiframework.com/doc/api/1.0/YiiBase

Creates a console application instance.

```APIDOC
## createConsoleApplication(mixed $config=NULL)

### Description
Creates a console application instance using CConsoleApplication.

### Parameters
- **$config** (mixed) - Optional - Application configuration path or array.
```

--------------------------------

### getHelp() method implementation

Source: https://www.yiiframework.com/doc/api/1.0/CHelpCommand

Returns the command description with an optional command-name parameter appended.

```php
 public function getHelp()
{
    return parent::getHelp().' [command-name]';
}
```

--------------------------------

### Declare a remote invokable method

Source: https://www.yiiframework.com/doc/api/1.0/CWsdlGenerator

Example of a public method with a doc comment block containing the @soap tag.

```php
/ **
  * A foo method.
  * @param string name of something
  * @param string value of something
  * @return string[] some array
  * @soap
  * /
public function foo($name,$value) {...}
```

--------------------------------

### run method

Source: https://www.yiiframework.com/doc/api/1.0/CConsoleCommandRunner

Executes the requested command.

```php
 public function run($args)
{
    $this->_scriptName=$args[0];
    array_shift($args);
    if(isset($args[0]))
    {
        $name=$args[0];
        array_shift($args);
    }
    else
        $name='help';

    if(($command=$this->createCommand($name))===null)
        $command=$this->createCommand('help');
    $command->run($args);
}
```

--------------------------------

### Configure CMemCache in application components

Source: https://www.yiiframework.com/doc/api/1.0/CMemCache

Example configuration for CMemCache using two memcache servers with specific weights.

```php
array(
    'components'=>array(
        'cache'=>array(
            'class'=>'CMemCache',
            'servers'=>array(
                array(
                    'host'=>'server1',
                    'port'=>11211,
                    'weight'=>60,
                ),
                array(
                    'host'=>'server2',
                    'port'=>11211,
                    'weight'=>40,
                ),
            ),
        ),
    ),
)
```

--------------------------------

### Usage of save() with user input

Source: https://www.yiiframework.com/doc/api/1.0/CActiveRecord

Example of using save() with user-provided data, which includes validation and attribute filtering.

```php
$postRecord=Post::model()->findByPk($postID);
$postRecord->attributes=$_POST['post'];
$postRecord->save();
```

--------------------------------

### Initialize Route init

Source: https://www.yiiframework.com/doc/api/1.0/CDbLogRoute

Initializes the route, activates the database connection, and optionally creates the log table if it does not exist.

```php
public function init()
{
    parent::init();

    $db=$this->getDbConnection();
    $db->setActive(true);

    if($this->autoCreateLogTable)
    {
        $sql="DELETE FROM {$this->logTableName} WHERE 0=1";
        try
        {
            $db->createCommand($sql)->execute();
        }
        catch(Exception $e)
        {
            $this->createLogTable($db,$this->logTableName);
        }
    }
}
```

--------------------------------

### parseActionParams method

Source: https://www.yiiframework.com/doc/api/1.0/CWebApplication

Parses a path info string into an action ID and GET variables. Available since v1.0.3.

```php
protected function parseActionParams($pathInfo)
{
    if(($pos=strpos($pathInfo,'/'))!==false)
    {
        CUrlManager::parsePathInfo((string)substr($pathInfo,$pos+1));
        $actionID=substr($pathInfo,0,$pos);
        return $this->getUrlManager()->caseSensitive ? $actionID : strtolower($actionID);
    }
    else
        return $pathInfo;
}
```

--------------------------------

### beginClip()

Source: https://www.yiiframework.com/doc/api/1.0/CBaseController

Begins recording a clip. This method is a shortcut to beginning CClipWidget.

```APIDOC
## void beginClip(string $id, array $properties=array())

### Description
Begins recording a clip. This method is a shortcut to beginning CClipWidget.

### Parameters
- **$id** (string) - Required - The clip ID.
- **$properties** (array) - Optional - Initial property values for CClipWidget.
```

--------------------------------

### CHttpRequest::getQuery()

Source: https://www.yiiframework.com/doc/api/1.0/CHttpRequest

Returns the named GET parameter value. If the parameter does not exist, the provided default value is returned.

```php
public function getQuery($name,$defaultValue=null)
{
    return isset($_GET[$name]) ? $_GET[$name] : $defaultValue;
}
```

--------------------------------

### init()

Source: https://www.yiiframework.com/doc/api/1.0/CEAcceleratorCache

Initializes the application component and verifies that the eAccelerator extension is available.

```APIDOC
## public void init()

### Description
Initializes this application component. This method is required by the IApplicationComponent interface. It checks the availability of eAccelerator.
```

--------------------------------

### CStatePersister::init() implementation

Source: https://www.yiiframework.com/doc/api/1.0/CStatePersister

Initializes the component and validates that the state file directory is writable.

```php
public function init()
{
    parent::init();
    if($this->stateFile===null)
        $this->stateFile=Yii::app()->getRuntimePath().DIRECTORY_SEPARATOR.'state.bin';
    $dir=dirname($this->stateFile);
    if(!is_dir($dir) || !is_writable($dir))
        throw new CException(Yii::t('yii','Unable to create application state file "{file}". Make sure the directory containing the file exists and is writable by the Web server process.',
            array('{file}'=>$this->stateFile)));
}
```

--------------------------------

### init()

Source: https://www.yiiframework.com/doc/api/1.0/CZendDataCache

Initializes the application component and verifies that the Zend Data Cache extension is loaded.

```APIDOC
## public void init()

### Description
Initializes this application component. This method is required by the IApplicationComponent interface. It checks the availability of Zend Data Cache.
```

--------------------------------

### Configure catchAllRequest property

Source: https://www.yiiframework.com/doc/api/1.0/CWebApplication

Example configuration for the catchAllRequest property, used to redirect all requests to a specific controller during maintenance mode.

```php
array(
    'offline/notice',
    'param1'=>'value1',
    'param2'=>'value2',
)
```

--------------------------------

### init() method implementation

Source: https://www.yiiframework.com/doc/api/1.0/CEAcceleratorCache

Initializes this application component and checks the availability of the eAccelerator extension.

```php
 public function init()
{
    parent::init();
    if(!function_exists('eaccelerator_get'))
        throw new CException(Yii::t('yii','CEAcceleratorCache requires PHP eAccelerator extension to be loaded, enabled or compiled with the "--with-eaccelerator-shared-memory" option.'));
}
```

--------------------------------

### Declare a class with remote accessible properties

Source: https://www.yiiframework.com/doc/api/1.0/CWsdlGenerator

Example of a class where public properties are marked with the @soap tag for WSDL generation.

```php
class Foo {
    / **
      * @var string name of foo
      * @soap
      * /
    public $name;
    / **
      * @var Member[] members of foo
      * @soap
      * /
    public $members;
}
```

--------------------------------

### Define URL rules

Source: https://www.yiiframework.com/doc/api/1.0/CUrlManager

Example of specifying URL rules using the rules property as an array of pattern to route mappings.

```php
array(
    'articles'=>'article/list',
    'article/<id:\d+>/*'=>'article/read',
)
```

--------------------------------

### CWebService::__construct()

Source: https://www.yiiframework.com/doc/api/1.0/CWebService

Initializes the CWebService instance with the provider, WSDL URL, and service URL.

```php
public function __construct($provider,$wsdlUrl,$serviceUrl)
{
    $this->provider=$provider;
    $this->wsdlUrl=$wsdlUrl;
    $this->serviceUrl=$serviceUrl;
}
```

--------------------------------

### Load Configuration Data

Source: https://www.yiiframework.com/doc/api/1.0/CConfiguration

Instantiate CConfiguration by passing the path to the configuration file.

```php
$config=new CConfiguration('path/to/config.php');
```

--------------------------------

### Configure CTabView tabs property

Source: https://www.yiiframework.com/doc/api/1.0/CTabView

Example configuration for the tabs property, showing how to define tabs with views or external URLs.

```php
array(
    'tab1'=>array(
          'title'=>'tab 1 title',
          'view'=>'view1',
    ),
    'tab2'=>array(
          'title'=>'tab 2 title',
          'url'=>'https://www.yiiframework.com/',
    ),
)
```

--------------------------------

### init() method

Source: https://www.yiiframework.com/doc/api/1.0/CCacheHttpSession

Initializes the application component. This method overrides the parent implementation by checking if cache is available.

```php
public function init()
{
    $this->_cache=Yii::app()->getComponent($this->cacheID);
    if(!($this->_cache instanceof ICache))
        throw new CException(Yii::t('yii','CCacheHttpSession.cacheID is invalid. Please make sure "{id}" refers to a valid cache application component.',
            array('{id}'=>$this->cacheID)));
    parent::init();
}
```

--------------------------------

### normalizeUrl() method

Source: https://www.yiiframework.com/doc/api/1.0/CHtml

Normalizes an input parameter into a valid URL. If an array is provided, it is treated as a controller route and GET parameters.

```php
public static function normalizeUrl($url)
{
    if(is_array($url))
    {
        if(isset($url[0]))
        {
            if(($c=Yii::app()->getController())!==null)
                $url=$c->createUrl($url[0],array_splice($url,1));
            else
                $url=Yii::app()->createUrl($url[0],array_splice($url,1));
        }
        else
            $url='';
    }
    return $url==='' ? Yii::app()->getRequest()->getUrl() : $url;
}
```

--------------------------------

### CCache::init() method

Source: https://www.yiiframework.com/doc/api/1.0/CCache

Initializes the application component by setting the default cache key prefix.

```php
public function init()
{
    parent::init();
    if($this->keyPrefix===null)
        $this->keyPrefix=Yii::app()->getId();
}
```

--------------------------------

### beforeValidate() method

Source: https://www.yiiframework.com/doc/api/1.0/CModel

Invoked before validation starts. Override this to perform preliminary checks, ensuring the parent implementation is called to raise the event.

```php
protected function beforeValidate($scenario)
{
    $event=new CModelEvent($this);
    $this->onBeforeValidate($event);
    return $event->isValid;
}
```

--------------------------------

### Specify language for syntax highlighting

Source: https://www.yiiframework.com/doc/api/1.0/CMarkdownParser

Use the [language] syntax at the start of a code block to enable syntax highlighting for supported languages.

```markdown
[language]
```

--------------------------------

### getHelp method

Source: https://www.yiiframework.com/doc/api/1.0/CConsoleCommand

Provides the command description. This method may be overridden to return the actual command description.

```php
public function getHelp()
{
	return 'Usage: '.$this->getCommandRunner()->getScriptName().' '.$this->getName();
}
```

--------------------------------

### init()

Source: https://www.yiiframework.com/doc/api/1.0/CTreeView

Initializes the widget. This method registers all necessary client scripts and renders the initial tree view content.

```APIDOC
## public void init()

### Description
Initializes the widget. This method registers all needed client scripts and renders the tree view content.
```

--------------------------------

### setCookieParams() method

Source: https://www.yiiframework.com/doc/api/1.0/CHttpSession

Sets the session cookie parameters. This method must be called before the session starts and its effect lasts only for the duration of the script.

```php
public function setCookieParams($value)
{
    $data=session_get_cookie_params();
    extract($data);
    extract($value);
    if(isset($httponly))
        session_set_cookie_params($lifetime,$path,$domain,$secure,$httponly);
    else
        session_set_cookie_params($lifetime,$path,$domain,$secure);
}
```

--------------------------------

### CAuthItem::checkAccess Method

Source: https://www.yiiframework.com/doc/api/1.0/CAuthItem

Checks if the specified item exists within the hierarchy starting from this item, evaluating business rules as needed.

```php
public function checkAccess($itemName,$params=array())
{
    Yii::trace('Checking permission "'.$this->_name.'"','system.web.auth.CAuthItem');
    if($this->_auth->executeBizRule($this->_bizRule,$params,$this->_data))
    {
        if($this->_name==$itemName)
            return true;
        foreach($this->_auth->getItemChildren($this->_name) as $item)
        {
            if($item->checkAccess($itemName,$params))
                return true;
        }
    }
    return false;
}
```

--------------------------------

### init()

Source: https://www.yiiframework.com/doc/api/1.0/CAutoComplete

Initializes the widget. This method registers all needed client scripts and renders the autocomplete input.

```APIDOC
## init()

### Description
Initializes the widget. This method registers all needed client scripts and renders the autocomplete input.

### Signature
`public void init()`
```

--------------------------------

### Using CPropertyValue in a setter method

Source: https://www.yiiframework.com/doc/api/1.0/CPropertyValue

Example of using CPropertyValue::ensureBoolean to enforce a boolean type within a component setter method.

```php
public function setPropertyName($value)
{
    $value=CPropertyValue::ensureBoolean($value);
    // $value is now of boolean type
}
```

--------------------------------

### init(string $apiKey)

Source: https://www.yiiframework.com/doc/api/1.0/CGoogleApi

Renders the script tag required to load the Google jsapi.

```APIDOC
## static string init(string $apiKey=NULL)

### Description
Renders the jsapi script file. This method should be called to include the base Google API script.

### Parameters
- **$apiKey** (string) - Optional - The API key. Null if you do not have a key.

### Returns
- **string** - The script tag that loads Google jsapi.
```

--------------------------------

### Define Class-based Filter Configuration

Source: https://www.yiiframework.com/doc/api/1.0/CController

Example structure for defining a class-based filter in CController, where name-value pairs initialize filter properties.

```php
array(
    'FilterClass[ +|- Action1, Action2, ...]',
    'name1'=>'value1',
    'name2'=>'value2',
    ...
)
```

--------------------------------

### init() method implementation

Source: https://www.yiiframework.com/doc/api/1.0/CZendDataCache

Initializes the application component and checks for the availability of the Zend Data Cache extension.

```php
 public function init()
{
    parent::init();
    if(!function_exists('zend_shm_cache_store'))
        throw new CException(Yii::t('yii','CZendDataCache requires PHP Zend Data Cache extension to be loaded.'));
} 
```
Tokens:
Raw