Class \Prado\Prado

Prado class.

Prado implements a few fundamental static methods.

To use the static methods, Use Prado as the class name rather than Prado. Prado is meant to serve as the base class of Prado. The latter might be rewritten for customization.

Class hierarchy

\Prado\Prado

Author: Qiang Xue <qiang.xue@gmail.com>
Since: 3.0

Methods summary
`public static`	`alert(string $msg[, string\|null $category = null ][, null\|TControl\|string $ctl = null ]) : void` Writes an alert log message.
`public static`	`autoload(string $className) : void` Class autoload loader. This method is provided to be registered within an spl_autoload_register() method.
`public static`	`callingObject() : object\|null` This method return the object that is calling your method.
`public static`	`createComponent(T> $requestedType, array<string\|int, mixed> ...$params) : T` Creates a component with the specified type. 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`	`debug(string $msg[, string\|null $category = null ][, null\|TControl\|string $ctl = null ]) : void` Writes a debug log message.
`public static`	`error(string $msg[, string\|null $category = null ][, null\|TControl\|string $ctl = null ]) : void` Writes an error log message.
`public static`	`exceptionHandler(Throwable $exception) : void` Default exception handler. This method should be registered as default exception handler using 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`	`fatal(string $msg[, string\|null $category = null ][, null\|TControl\|string $ctl = null ]) : void` Writes a fatal log message.
`public static`	`fatalError(string $msg) : void` Fatal error handler. This method displays an error message together with the current call stack. The application will exit after calling this method.
`public static`	`getApplication() : null\|TApplication`
`public static`	`getDefaultDirPermissions() : int`
`public static`	`getDefaultFilePermissions() : int`
`public deprecated static`	`getDefaultPermissions() : int`
`public static`	`getFrameworkPath() : string`
`public static`	`getLogger() : TLogger`
`public static`	`getPathOfAlias(string $alias) : null\|string`
`public static`	`getPathOfNamespace(string $namespace[, string $ext = '' ]) : null\|string` Translates a namespace into a file path. 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`	`getPreferredLanguage() : string` Returns the most preferred language by the client user.
`public static`	`getUserLanguages() : array<string\|int, string>` Returns a list of user preferred languages. 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`	`getVersion() : string`
`public static`	`info(string $msg[, string\|null $category = null ][, null\|TControl\|string $ctl = null ]) : void` Writes an info log message.
`public static`	`init() : void` Initializes the Prado static class
`public static`	`initAutoloader() : void` Loads the static classmap and registers the autoload function.
`public static`	`initErrorHandlers() : void` Initializes error handlers. This method set error and exception handlers to be functions defined in this class.
`public static`	`isCallingSelf() : bool` This checks if object calling your object method is the same object. In effect, this signifies if self, parents, and children have visibility to "protected" properties, methods, and constants.
`public static`	`isCallingSelfClass() : bool` This checks if object calling your object method is the same object and same class. In effect, this allows only the self to have visibility to "private" properties, methods, and constants.
`public static`	`localize(string $text[, array<string, string> $parameters = [] ][, string $catalogue = null ][, string $charset = null ]) : string` Localize a text to the locale/culture specified in the globalization handler.
`public static`	`log(string $msg[, int $level = TLogger::INFO ][, string $category = 'Uncategorized' ][, null\|TControl\|string $ctl = null ]) : float\|null` Logs a message. Messages logged by this method may be retrieved via TLogger::getLogs and may be recorded in different media, such as file, email, database, using TLogRouter.
`public static`	`method_visible(object\|string $object_or_class, string $method) : bool` This conforms PHP's Magic Methods to PHP's Visibility standards for public, protected, and private properties, methods, and constants. This method checks if the object calling your method can access your object's property, method, or constant based upon the defined visibility. External objects can only access public properties, methods, and constants. When calling the self, private properties, methods, and constants are allowed to be accessed by the same class.
`public static`	`notice(string $msg[, string\|null $category = null ][, null\|TControl\|string $ctl = null ]) : void` Writes a notice log message.
`public static`	`phpErrorHandler(int $errno, string $errstr, string $errfile, int $errline) : bool` PHP error handler. This method should be registered as PHP error handler using set_error_handler. The method throws an exception that contains the error information.
`public static`	`phpFatalErrorHandler() : void` PHP shutdown function used to catch fatal errors. This method should be registered as PHP error handler using register_shutdown_function. The method throws an exception that contains the error information.
`public static`	`poweredByPrado([int $logoType = 0 ]) : string`
`public static`	`profileBegin(string $token[, string\|null $category = null ][, null\|TControl\|string $ctl = null ]) : void` Writes a profile begin message.
`public static`	`profileEnd(string $token[, string\|null $category = null ][, null\|TControl\|string $ctl = null ]) : float\|null` Writes a profile end message.
`public static`	`setApplication(TApplication $application) : void` Stores the application instance in the class static member. 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`	`setPathOfAlias(string $alias, string $path) : void`
`public static`	`trace(string $msg[, string\|null $category = null ][, null\|TControl\|string $ctl = null ]) : void` Writes a log message. This method wraps 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`	`using(string $namespace) : void` Uses a namespace. 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`	`varDump(mixed $var[, int $depth = 10 ][, bool $highlight = false ]) : string` Converts a variable into a string representation. 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`	`warning(string $msg[, string\|null $category = null ][, null\|TControl\|string $ctl = null ]) : void` Writes a warning log message.
`protected static`	`getPathAliases() : array<string, string>`
`protected static`	`prado3NamespaceToPhpNamespace(string $type) : string` Convert old Prado namespaces to PHP namespaces

Inherited methods

Constants summary
`public mixed`	`CLASS_FILE_EXT` File extension for Prado class files.	`'.php'`

Classes

Interfaces

Traits

Search results

Class \Prado\Prado

Class hierarchy