YiiBase

Package	system
Inheritance	class YiiBase
Subclasses	Yii
Since	1.0
Source Code	framework/YiiBase.php

Property Details

filters for autoloading mechanism. It should be callable. For callable function autoloader pass className. If filter function returns true Yii autoloader will be skipped.

class map used by the Yii autoloading mechanism. The array keys are the class names and the array values are the corresponding class file paths.

whether to rely on PHP include path to autoload class files. Defaults to true. You may set this to be false if your hosting environment doesn't allow changing the PHP include path, or if you want to append additional autoloaders to the default Yii autoloader.

Method Details

public static CApplication app()
{return}	CApplication	the application singleton, null if the singleton has not been created yet.

Returns the application singleton or null if the singleton has not been created yet.

public static boolean autoload(string $className, bool $classMapOnly=false)
$className	string	class name
$classMapOnly	bool	whether to load classes via classmap only
{return}	boolean	whether the class has been loaded successfully

Class autoload loader. This method is provided to be invoked within an __autoload() magic method.

public static void beginProfile(string $token, string $category='application')
$token	string	token for the code block
$category	string	the category of this log message

Marks the beginning of a code block for profiling. This has to be matched with a call to endProfile() with the same token. The begin- and end- calls must also be properly nested, e.g.,

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

The following sequence is not valid:

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

public static mixed createApplication(string $class, mixed $config=NULL)
$class	string	the application class name
$config	mixed	application configuration. This parameter will be passed as the parameter to the constructor of the application class.
{return}	mixed	the application instance

Creates an application of the specified class.

public static mixed createComponent(mixed $config)
$config	mixed	the configuration. It can be either a string or an array.
{return}	mixed	the created object

Creates an object and initializes it based on the given configuration.

The specified configuration can be either a string or an array. If the former, the string is treated as the object type which can be either the class name or class path alias. If the latter, the 'class' element is treated as the object type, and the rest of the name-value pairs in the array are used to initialize the corresponding object properties.

Any additional parameters passed to this method will be passed to the constructor of the object being created.

public static CConsoleApplication createConsoleApplication(mixed $config=NULL)
$config	mixed	application configuration. If a string, it is treated as the path of the file that contains the configuration; If an array, it is the actual configuration information. Please make sure you specify the basePath property in the configuration, which should point to the directory containing all application logic, template and data. If not, the directory will be defaulted to 'protected'.
{return}	CConsoleApplication

Creates a console application instance.

public static CWebApplication createWebApplication(mixed $config=NULL)
$config	mixed	application configuration. If a string, it is treated as the path of the file that contains the configuration; If an array, it is the actual configuration information. Please make sure you specify the basePath property in the configuration, which should point to the directory containing all application logic, template and data. If not, the directory will be defaulted to 'protected'.
{return}	CWebApplication

Creates a Web application instance.

public static void endProfile(string $token, string $category='application')
$token	string	token for the code block
$category	string	the category of this log message

Marks the end of a code block for profiling. This has to be matched with a previous call to beginProfile() with the same token.

public static string getFrameworkPath()
{return}	string	the path of the framework

public static CLogger getLogger()
{return}	CLogger	message logger

public static mixed getPathOfAlias(string $alias)
$alias	string	alias (e.g. system.web.CController)
{return}	mixed	file path corresponding to the alias, false if the alias is invalid.

Translates an alias into a file path. Note, this method does not ensure the existence of the resulting file path. It only checks if the root alias is valid or not.

public static string getVersion()
{return}	string	the version of Yii framework

public static string import(string $alias, boolean $forceInclude=false)
$alias	string	path alias to be imported
$forceInclude	boolean	whether to include the class file immediately. If false, the class file will be included only when the class is being used. This parameter is used only when the path alias refers to a class.
{return}	string	the class name or the directory that this alias refers to

Imports a class or a directory.

Importing a class is like including the corresponding class file. The main difference is that importing a class is much lighter because it only includes the class file when the class is referenced the first time.

Importing a directory is equivalent to adding a directory into the PHP include path. If multiple directories are imported, the directories imported later will take precedence in class file searching (i.e., they are added to the front of the PHP include path).

Path aliases are used to import a class or directory. For example,

• application.components.GoogleMap: import the GoogleMap class.
• application.components.*: import the components directory.

The same path alias can be imported multiple times, but only the first time is effective. Importing a directory does not import any of its subdirectories.

Starting from version 1.1.5, this method can also be used to import a class in namespace format (available for PHP 5.3 or above only). It is similar to importing a class in path alias format, except that the dot separator is replaced by the backslash separator. For example, importing application\components\GoogleMap is similar to importing application.components.GoogleMap. The difference is that the former class is using qualified name, while the latter unqualified.

Note, importing a class in namespace format requires that the namespace corresponds to a valid path alias once backslash characters are replaced with dot characters. For example, the namespace application\components must correspond to a valid path alias application.components.

public static void log(string $msg, string $level='info', string $category='application')
$msg	string	message to be logged
$level	string	level of the message (e.g. 'trace', 'warning', 'error'). It is case-insensitive.
$category	string	category of the message (e.g. 'system.web'). It is case-insensitive.

Logs a message. Messages logged by this method may be retrieved via CLogger::getLogs and may be recorded in different media, such as file, email, database, using CLogRouter.

public static string powered()
{return}	string	a string that can be displayed on your Web page showing Powered-by-Yii information

Returns a string that can be displayed on your Web page showing Powered-by-Yii information

public static void registerAutoloader(callback $callback, boolean $append=false)
$callback	callback	a valid PHP callback (function name or array($className,$methodName)).
$append	boolean	whether to append the new autoloader after the default Yii autoloader. Be careful using this option as it will disable autoloading via include path when set to true. After this the Yii autoloader can not rely on loading classes via simple include anymore and you have to import all classes explicitly.

Registers a new class autoloader. The new autoloader will be placed before autoload and after any other existing autoloaders.

public static void setApplication(CApplication $app)
$app	CApplication	the application instance. If this is null, the existing application singleton will be removed.

Stores the application instance in the class static member. This method helps implement a singleton pattern for CApplication. Repeated invocation of this method or the CApplication constructor will cause the throw of an exception. To retrieve the application instance, use app().

public static void setLogger(CLogger $logger)
$logger	CLogger	the logger object.

Sets the logger object.

public static void setPathOfAlias(string $alias, string $path)
$alias	string	alias to the path
$path	string	the path corresponding to the alias. If this is null, the corresponding path alias will be removed.

Create a path alias. Note, this method neither checks the existence of the path nor normalizes the path.

public static string t(string $category, string $message, array $params=array ( ), string $source=NULL, string $language=NULL)
$category	string	message category. Please use only word letters. Note, category 'yii' is reserved for Yii framework core code use. See CPhpMessageSource for more interpretation about message category.
$message	string	the original message
$params	array	parameters to be applied to the message using strtr. The first parameter can be a number without key. And in this case, the method will call CChoiceFormat::format to choose an appropriate message translation. Starting from version 1.1.6 you can pass parameter for CChoiceFormat::format or plural forms format without wrapping it with array. This parameter is then available as {n} in the message translation string.
$source	string	which message source application component to use. Defaults to null, meaning using 'coreMessages' for messages belonging to the 'yii' category and using 'messages' for the rest messages.
$language	string	the target language. If null (default), the application language will be used.
{return}	string	the translated message

Translates a message to the specified language. This method supports choice format (see CChoiceFormat), i.e., the message returned will be chosen from a few candidates according to the given number value. This feature is mainly used to solve plural format issue in case a message has different plural forms in some languages.

public static void trace(string $msg, string $category='application')
$msg	string	message to be logged
$category	string	category of the message

Writes a trace message. This method will only log a message when the application is in debug mode.