PHP Class Prado\PradoBase

PradoBase implements a few fundamental static methods. To use the static methods, Use Prado as the class name rather than PradoBase. PradoBase is meant to serve as the base class of Prado. The latter might be rewritten for customization.
Since: 3.0
Author: Qiang Xue ([email protected])
Show file Open project: pradosoft/prado

Public Properties

Property Type Description
$classMap list of namespaces currently in use

Protected Properties

Property Type Description
$classExists list of class exists checks

Public Methods

Method Description
autoload ( $className ) Class autoload loader.
createComponent ( $requestedType ) : TComponent Creates a component with the specified type.
exceptionHandler ( $exception ) Default exception handler.
fatalError ( $msg ) Fatal error handler.
getApplication ( ) : TApplication
getFrameworkPath ( ) : string
getLogger ( ) : TLogger
getPathOfAlias ( $alias ) : string
getPathOfNamespace ( $namespace, $ext = '' ) : string Translates a namespace into a file path.
getPreferredLanguage ( ) : string Returns the most preferred language by the client user.
getUserLanguages ( ) : array Returns a list of user preferred languages.
getVersion ( ) : string
init ( )
initAutoloader ( ) Loads the static classmap and registers the autoload function.
initErrorHandlers ( ) Initializes error handlers.
localize ( $text, $parameters = [], $catalogue = null, $charset = null ) : string Localize a text to the locale/culture specified in the globalization handler.
log ( $msg, $level = TLogger::INFO, $category = 'Uncategorized', $ctl = null ) Logs a message.
phpErrorHandler ( $errno, $errstr, $errfile, $errline ) PHP error handler.
phpFatalErrorHandler ( ) PHP shutdown function used to catch fatal errors.
poweredByPrado ( $logoType ) : string
setApplication ( $application ) Stores the application instance in the class static member.
setPathOfAlias ( $alias, $path )
trace ( $msg, $category = 'Uncategorized', $ctl = null ) Writes a log message.
using ( $namespace, $checkClassExistence = true ) Uses a namespace.
varDump ( $var, $depth = 10, $highlight = false ) : string Converts a variable into a string representation.

Protected Methods

Method Description
getPathAliases ( )
prado3NamespaceToPhpNamespace ( $type ) : string Convert old Prado namespaces to PHP namespaces

Method Details

autoload() public static method

This method is provided to be invoked within an __autoload() magic method.
public static autoload ( $className )

createComponent() public static method

A component type can be either the component class name or a namespace referring to the path of the component class file. For example, 'TButton', '\Prado\Web\UI\WebControls\TButton' are both valid component type. This method can also pass parameters to component constructors. All parameters passed to this method except the first one (the component type) will be supplied as component constructor parameters.
public static createComponent ( $requestedType ) : TComponent
return TComponent component instance of the specified type

exceptionHandler() public static method

This method should be registered as default exception handler using {@link set_exception_handler}. The method tries to use the errorhandler module of the Prado application to handle the exception. If the application or the module does not exist, it simply echoes the exception.
public static exceptionHandler ( $exception )

fatalError() public static method

This method displays an error message together with the current call stack. The application will exit after calling this method.
public static fatalError ( $msg )

getApplication() public static method

public static getApplication ( ) : TApplication
return TApplication the application singleton, null if the singleton has not be created yet.

getFrameworkPath() public static method

public static getFrameworkPath ( ) : string
return string the path of the framework

getLogger() public static method

public static getLogger ( ) : TLogger
return Prado\Util\TLogger message logger

getPathAliases() protected static method

protected static getPathAliases ( )

getPathOfAlias() public static method

public static getPathOfAlias ( $alias ) : string
return string the path corresponding to the alias, null if alias not defined.

getPathOfNamespace() public static method

The first segment of the namespace is considered as a path alias which is replaced with the actual path. The rest segments are subdirectory names appended to the aliased path. If the namespace ends with an asterisk '*', it represents a directory; Otherwise it represents a file whose extension name is specified by the second parameter (defaults to empty). Note, this method does not ensure the existence of the resulting file path.
public static getPathOfNamespace ( $namespace, $ext = '' ) : string
return string file path corresponding to the namespace, null if namespace is invalid

getPreferredLanguage() public static method

Returns the most preferred language by the client user.
public static getPreferredLanguage ( ) : string
return string the most preferred language by the client user, defaults to English.

getUserLanguages() public static method

The languages are returned as an array. Each array element represents a single language preference. The languages are ordered according to user preferences. The first language is the most preferred.
public static getUserLanguages ( ) : array
return array list of user preferred languages.

getVersion() public static method

public static getVersion ( ) : string
return string the version of Prado framework

init() public static method

public static init ( )

initAutoloader() public static method

Loads the static classmap and registers the autoload function.
public static initAutoloader ( )

initErrorHandlers() public static method

This method set error and exception handlers to be functions defined in this class.
public static initErrorHandlers ( )

localize() public static method

Localize a text to the locale/culture specified in the globalization handler.
See also: TTranslate::formatter()
See also: TTranslate::init()
public static localize ( $text, $parameters = [], $catalogue = null, $charset = null ) : string
return string localized text.

log() public static method

Messages logged by this method may be retrieved via {@link TLogger::getLogs} and may be recorded in different media, such as file, email, database, using {@link TLogRouter}.
public static log ( $msg, $level = TLogger::INFO, $category = 'Uncategorized', $ctl = null )

phpErrorHandler() public static method

This method should be registered as PHP error handler using {@link set_error_handler}. The method throws an exception that contains the error information.
public static phpErrorHandler ( $errno, $errstr, $errfile, $errline )

phpFatalErrorHandler() public static method

This method should be registered as PHP error handler using {@link register_shutdown_function}. The method throws an exception that contains the error information.
public static phpFatalErrorHandler ( )

poweredByPrado() public static method

public static poweredByPrado ( $logoType ) : string
return string a string that can be displayed on your Web page showing powered-by-PRADO information

prado3NamespaceToPhpNamespace() protected static method

Convert old Prado namespaces to PHP namespaces
protected static prado3NamespaceToPhpNamespace ( $type ) : string
return string Equivalent class name in PHP namespace format

setApplication() public static method

This method helps implement a singleton pattern for TApplication. Repeated invocation of this method or the application constructor will cause the throw of an exception. This method should only be used by framework developers.
public static setApplication ( $application )

setPathOfAlias() public static method

public static setPathOfAlias ( $alias, $path )

trace() public static method

This method wraps {@link log()} by checking the application mode. When the application is in Debug mode, debug backtrace information is appended to the message and the message is logged at DEBUG level. When the application is in Performance mode, this method does nothing. Otherwise, the message is logged at INFO level.
public static trace ( $msg, $category = 'Uncategorized', $ctl = null )

using() public static method

A namespace ending with an asterisk '*' refers to a directory, otherwise it represents a PHP file. If the namespace corresponds to a directory, the directory will be appended to the include path. If the namespace corresponds to a file, it will be included (include_once).
public static using ( $namespace, $checkClassExistence = true )

varDump() public static method

This method achieves the similar functionality as var_dump and print_r but is more robust when handling complex objects such as PRADO controls.
public static varDump ( $var, $depth = 10, $highlight = false ) : string
return string the string representation of the variable

Property Details

$classExists protected static property

list of class exists checks
protected static $classExists

$classMap public static property

list of namespaces currently in use
public static $classMap