Better PHP Documentation
opinionated
Open main menu
Get Started
Documentation
Community
Training
Better PHP Documentation
Close menu
Get Started
Documentation
Community
Training
Log in
Change language:
English
German
Spanish
French
Italian
Japanese
Brazilian Portuguese
Russian
Turkish
Ukrainian
Chinese (Simplified)
Other
Yet Another Framework
Introduction
Installing/Configuring
Installation
Runtime Configuration
Predefined Constants
Examples
Application Configuration
Yaf_Application
β The Yaf_Application class
Yaf_Application::app
β Retrieve an Application instance
Yaf_Application::bootstrap
β Call bootstrap
Yaf_Application::clearLastError
β Clear the last error info
Yaf_Application::__construct
β Yaf_Application constructor
Yaf_Application::__destruct
β The __destruct purpose
Yaf_Application::environ
β Retrive environ
Yaf_Application::execute
β Execute a callback
Yaf_Application::getAppDirectory
β Get the application directory
Yaf_Application::getConfig
β Retrive the config instance
Yaf_Application::getDispatcher
β Get Yaf_Dispatcher instance
Yaf_Application::getLastErrorMsg
β Get message of the last occurred error
Yaf_Application::getLastErrorNo
β Get code of last occurred error
Yaf_Application::getModules
β Get defined module names
Yaf_Application::run
β Start Yaf_Application
Yaf_Application::setAppDirectory
β Change the application directory
Yaf_Bootstrap_Abstract
β The Yaf_Bootstrap_Abstract class
Yaf_Dispatcher
β The Yaf_Dispatcher class
Yaf_Dispatcher::autoRender
β Switch on/off autorendering
Yaf_Dispatcher::catchException
β Switch on/off exception catching
Yaf_Dispatcher::__construct
β Yaf_Dispatcher constructor
Yaf_Dispatcher::disableView
β Disable view rendering
Yaf_Dispatcher::dispatch
β Dispatch a request
Yaf_Dispatcher::enableView
β Enable view rendering
Yaf_Dispatcher::flushInstantly
β Switch on/off the instant flushing
Yaf_Dispatcher::getApplication
β Retrieve the application
Yaf_Dispatcher::getDefaultAction
β Retrive the default action name
Yaf_Dispatcher::getDefaultController
β Retrive the default controller name
Yaf_Dispatcher::getDefaultModule
β Retrive the default module name
Yaf_Dispatcher::getInstance
β Retrive the dispatcher instance
Yaf_Dispatcher::getRequest
β Retrive the request instance
Yaf_Dispatcher::getRouter
β Retrive router instance
Yaf_Dispatcher::initView
β Initialize view and return it
Yaf_Dispatcher::registerPlugin
β Register a plugin
Yaf_Dispatcher::returnResponse
β The returnResponse purpose
Yaf_Dispatcher::setDefaultAction
β Change default action name
Yaf_Dispatcher::setDefaultController
β Change default controller name
Yaf_Dispatcher::setDefaultModule
β Change default module name
Yaf_Dispatcher::setErrorHandler
β Set error handler
Yaf_Dispatcher::setRequest
β The setRequest purpose
Yaf_Dispatcher::setView
β Set a custom view engine
Yaf_Dispatcher::throwException
β Switch on/off exception throwing
Yaf_Config_Abstract
β The Yaf_Config_Abstract class
Yaf_Config_Abstract::get
β Getter
Yaf_Config_Abstract::readonly
β Find a config whether readonly
Yaf_Config_Abstract::set
β Setter
Yaf_Config_Abstract::toArray
β Cast to array
Yaf_Config_Ini
β The Yaf_Config_Ini class
Yaf_Config_Ini::__construct
β Yaf_Config_Ini constructor
Yaf_Config_Ini::count
β Count all elements in Yaf_Config.ini
Yaf_Config_Ini::current
β Retrieve the current value
Yaf_Config_Ini::__get
β Retrieve a element
Yaf_Config_Ini::__isset
β Determine if a key is exists
Yaf_Config_Ini::key
β Fetch current element's key
Yaf_Config_Ini::next
β Advance the internal pointer
Yaf_Config_Ini::offsetExists
β The offsetExists purpose
Yaf_Config_Ini::offsetGet
β The offsetGet purpose
Yaf_Config_Ini::offsetSet
β The offsetSet purpose
Yaf_Config_Ini::offsetUnset
β The offsetUnset purpose
Yaf_Config_Ini::readonly
β The readonly purpose
Yaf_Config_Ini::rewind
β The rewind purpose
Yaf_Config_Ini::__set
β The __set purpose
Yaf_Config_Ini::toArray
β Return config as a PHP array
Yaf_Config_Ini::valid
β The valid purpose
Yaf_Config_Simple
β The Yaf_Config_Simple class
Yaf_Config_Simple::__construct
β The __construct purpose
Yaf_Config_Simple::count
β The count purpose
Yaf_Config_Simple::current
β The current purpose
Yaf_Config_Simple::__get
β The __get purpose
Yaf_Config_Simple::__isset
β The __isset purpose
Yaf_Config_Simple::key
β The key purpose
Yaf_Config_Simple::next
β The next purpose
Yaf_Config_Simple::offsetExists
β The offsetExists purpose
Yaf_Config_Simple::offsetGet
β The offsetGet purpose
Yaf_Config_Simple::offsetSet
β The offsetSet purpose
Yaf_Config_Simple::offsetUnset
β The offsetUnset purpose
Yaf_Config_Simple::readonly
β The readonly purpose
Yaf_Config_Simple::rewind
β The rewind purpose
Yaf_Config_Simple::__set
β The __set purpose
Yaf_Config_Simple::toArray
β Returns a PHP array
Yaf_Config_Simple::valid
β The valid purpose
Yaf_Controller_Abstract
β The Yaf_Controller_Abstract class
Yaf_Controller_Abstract::__construct
β Yaf_Controller_Abstract constructor
Yaf_Controller_Abstract::display
β The display purpose
Yaf_Controller_Abstract::forward
β Forward to another action
Yaf_Controller_Abstract::getInvokeArg
β The getInvokeArg purpose
Yaf_Controller_Abstract::getInvokeArgs
β The getInvokeArgs purpose
Yaf_Controller_Abstract::getModuleName
β Get module name
Yaf_Controller_Abstract::getName
β Get self name
Yaf_Controller_Abstract::getRequest
β Retrieve current request object
Yaf_Controller_Abstract::getResponse
β Retrieve current response object
Yaf_Controller_Abstract::getView
β Retrieve the view engine
Yaf_Controller_Abstract::getViewpath
β The getViewpath purpose
Yaf_Controller_Abstract::init
β Controller initializer
Yaf_Controller_Abstract::initView
β The initView purpose
Yaf_Controller_Abstract::redirect
β Redirect to a URL
Yaf_Controller_Abstract::render
β Render view template
Yaf_Controller_Abstract::setViewpath
β The setViewpath purpose
Yaf_Action_Abstract
β The Yaf_Action_Abstract class
Yaf_Action_Abstract::execute
β Action entry point
Yaf_Action_Abstract::getController
β Retrieve controller object
Yaf_Action_Abstract::getControllerName
β Get controller name
Yaf_View_Interface
β The Yaf_View_Interface class
Yaf_View_Interface::assign
β Assign value to View engine
Yaf_View_Interface::display
β Render and output a template
Yaf_View_Interface::getScriptPath
β The getScriptPath purpose
Yaf_View_Interface::render
β Render a template
Yaf_View_Interface::setScriptPath
β The setScriptPath purpose
Yaf_View_Simple
β The Yaf_View_Simple class
Yaf_View_Simple::assign
β Assign values
Yaf_View_Simple::assignRef
β The assignRef purpose
Yaf_View_Simple::clear
β Clear Assigned values
Yaf_View_Simple::__construct
β Constructor of Yaf_View_Simple
Yaf_View_Simple::display
β Render and display
Yaf_View_Simple::eval
β Render template
Yaf_View_Simple::__get
β Retrieve assigned variable
Yaf_View_Simple::getScriptPath
β Get templates directory
Yaf_View_Simple::__isset
β The __isset purpose
Yaf_View_Simple::render
β Render template
Yaf_View_Simple::__set
β Set value to engine
Yaf_View_Simple::setScriptPath
β Set tempaltes directory
Yaf_Loader
β The Yaf_Loader class
Yaf_Loader::autoload
β The autoload purpose
Yaf_Loader::clearLocalNamespace
β The clearLocalNamespace purpose
Yaf_Loader::__construct
β The __construct purpose
Yaf_Loader::getInstance
β The getInstance purpose
Yaf_Loader::getLibraryPath
β Get the library path
Yaf_Loader::getLocalNamespace
β The getLocalNamespace purpose
Yaf_Loader::getNamespacePath
β Retieve path of a registered namespace
Yaf_Loader::getLocalNamespace
β Retrive all register namespaces info
Yaf_Loader::import
β The import purpose
Yaf_Loader::isLocalName
β The isLocalName purpose
Yaf_Loader::registerLocalNamespace
β Register local class prefix
Yaf_Loader::registerNamespace
β Register namespace with searching path
Yaf_Loader::setLibraryPath
β Change the library path
Yaf_Plugin_Abstract
β The Yaf_Plugin_Abstract class
Yaf_Plugin_Abstract::dispatchLoopShutdown
β The dispatchLoopShutdown purpose
Yaf_Plugin_Abstract::dispatchLoopStartup
β Hook before dispatch loop
Yaf_Plugin_Abstract::postDispatch
β The postDispatch purpose
Yaf_Plugin_Abstract::preDispatch
β The preDispatch purpose
Yaf_Plugin_Abstract::preResponse
β The preResponse purpose
Yaf_Plugin_Abstract::routerShutdown
β The routerShutdown purpose
Yaf_Plugin_Abstract::routerStartup
β RouterStartup hook
Yaf_Registry
β The Yaf_Registry class
Yaf_Registry::__construct
β Yaf_Registry implements singleton
Yaf_Registry::del
β Remove an item from registry
Yaf_Registry::get
β Retrieve an item from registry
Yaf_Registry::has
β Check whether an item exists
Yaf_Registry::set
β Add an item into registry
Yaf_Request_Abstract
β The Yaf_Request_Abstract class
Yaf_Request_Abstract::clearParams
β Remove all params
Yaf_Request_Abstract::getActionName
β The getActionName purpose
Yaf_Request_Abstract::getBaseUri
β The getBaseUri purpose
Yaf_Request_Abstract::getControllerName
β The getControllerName purpose
Yaf_Request_Abstract::getEnv
β Retrieve ENV varialbe
Yaf_Request_Abstract::getException
β The getException purpose
Yaf_Request_Abstract::getLanguage
β Retrieve client's preferred language
Yaf_Request_Abstract::getMethod
β Retrieve the request method
Yaf_Request_Abstract::getModuleName
β The getModuleName purpose
Yaf_Request_Abstract::getParam
β Retrieve calling parameter
Yaf_Request_Abstract::getParams
β Retrieve all calling parameters
Yaf_Request_Abstract::getRequestUri
β The getRequestUri purpose
Yaf_Request_Abstract::getServer
β Retrieve SERVER variable
Yaf_Request_Abstract::isCli
β Determine if request is CLI request
Yaf_Request_Abstract::isDispatched
β Determin if the request is dispatched
Yaf_Request_Abstract::isGet
β Determine if request is GET request
Yaf_Request_Abstract::isHead
β Determine if request is HEAD request
Yaf_Request_Abstract::isOptions
β Determine if request is OPTIONS request
Yaf_Request_Abstract::isPost
β Determine if request is POST request
Yaf_Request_Abstract::isPut
β Determine if request is PUT request
Yaf_Request_Abstract::isRouted
β Determin if request has been routed
Yaf_Request_Abstract::isXmlHttpRequest
β Determine if request is AJAX request
Yaf_Request_Abstract::setActionName
β Set action name
Yaf_Request_Abstract::setBaseUri
β Set base URI
Yaf_Request_Abstract::setControllerName
β Set controller name
Yaf_Request_Abstract::setDispatched
β The setDispatched purpose
Yaf_Request_Abstract::setModuleName
β Set module name
Yaf_Request_Abstract::setParam
β Set a calling parameter to a request
Yaf_Request_Abstract::setRequestUri
β The setRequestUri purpose
Yaf_Request_Abstract::setRouted
β The setRouted purpose
Yaf_Request_Http
β The Yaf_Request_Http class
Yaf_Request_Http::__construct
β Constructor of Yaf_Request_Http
Yaf_Request_Http::get
β Retrieve variable from client
Yaf_Request_Http::getCookie
β Retrieve Cookie variable
Yaf_Request_Http::getFiles
β The getFiles purpose
Yaf_Request_Http::getPost
β Retrieve POST variable
Yaf_Request_Http::getQuery
β Fetch a query parameter
Yaf_Request_Http::getRaw
β Retrieve Raw request body
Yaf_Request_Http::getRequest
β The getRequest purpose
Yaf_Request_Http::isXmlHttpRequest
β Determin if request is Ajax Request
Yaf_Request_Simple
β The Yaf_Request_Simple class
Yaf_Request_Simple::__construct
β Constructor of Yaf_Request_Simple
Yaf_Request_Simple::get
β The get purpose
Yaf_Request_Simple::getCookie
β The getCookie purpose
Yaf_Request_Simple::getFiles
β The getFiles purpose
Yaf_Request_Simple::getPost
β The getPost purpose
Yaf_Request_Simple::getQuery
β The getQuery purpose
Yaf_Request_Simple::getRequest
β The getRequest purpose
Yaf_Request_Simple::isXmlHttpRequest
β Determin if request is AJAX request
Yaf_Response_Abstract
β The Yaf_Response_Abstract class
Yaf_Response_Abstract::appendBody
β Append to response body
Yaf_Response_Abstract::clearBody
β Discard all exists response body
Yaf_Response_Abstract::clearHeaders
β Discard all set headers
Yaf_Response_Abstract::__construct
β The __construct purpose
Yaf_Response_Abstract::__destruct
β The __destruct purpose
Yaf_Response_Abstract::getBody
β Retrieve a exists content
Yaf_Response_Abstract::getHeader
β The getHeader purpose
Yaf_Response_Abstract::prependBody
β The prependBody purpose
Yaf_Response_Abstract::response
β Send response
Yaf_Response_Abstract::setAllHeaders
β The setAllHeaders purpose
Yaf_Response_Abstract::setBody
β Set content to response
Yaf_Response_Abstract::setHeader
β Set reponse header
Yaf_Response_Abstract::setRedirect
β The setRedirect purpose
Yaf_Response_Abstract::__toString
β Retrieve all bodys as string
Yaf_Route_Interface
β The Yaf_Route_Interface class
Yaf_Route_Interface::assemble
β Assemble a request
Yaf_Route_Interface::route
β Route a request
Yaf_Route_Map
β The Yaf_Route_Map class
Yaf_Route_Map::assemble
β Assemble a url
Yaf_Route_Map::__construct
β The __construct purpose
Yaf_Route_Map::route
β The route purpose
Yaf_Route_Regex
β The Yaf_Route_Regex class
Yaf_Route_Regex::assemble
β Assemble a url
Yaf_Route_Regex::__construct
β Yaf_Route_Regex constructor
Yaf_Route_Regex::route
β The route purpose
Yaf_Route_Rewrite
β The Yaf_Route_Rewrite class
Yaf_Route_Rewrite::assemble
β Assemble a url
Yaf_Route_Rewrite::__construct
β Yaf_Route_Rewrite constructor
Yaf_Route_Rewrite::route
β The route purpose
Yaf_Router
β The Yaf_Router class
Yaf_Router::addConfig
β Add config-defined routes into Router
Yaf_Router::addRoute
β Add new Route into Router
Yaf_Router::__construct
β Yaf_Router constructor
Yaf_Router::getCurrentRoute
β Get the effective route name
Yaf_Router::getRoute
β Retrieve a route by name
Yaf_Router::getRoutes
β Retrieve registered routes
Yaf_Router::route
β The route purpose
Yaf_Route_Simple
β The Yaf_Route_Simple class
Yaf_Route_Simple::assemble
β Assemble a url
Yaf_Route_Simple::__construct
β Yaf_Route_Simple constructor
Yaf_Route_Simple::route
β Route a request
Yaf_Route_Static
β The Yaf_Route_Static class
Yaf_Route_Static::assemble
β Assemble a url
Yaf_Route_Static::match
β The match purpose
Yaf_Route_Static::route
β Route a request
Yaf_Route_Supervar
β The Yaf_Route_Supervar class
Yaf_Route_Supervar::assemble
β Assemble a url
Yaf_Route_Supervar::__construct
β The __construct purpose
Yaf_Route_Supervar::route
β The route purpose
Yaf_Session
β The Yaf_Session class
Yaf_Session::__construct
β Constructor of Yaf_Session
Yaf_Session::count
β The count purpose
Yaf_Session::current
β The current purpose
Yaf_Session::del
β The del purpose
Yaf_Session::__get
β The __get purpose
Yaf_Session::getInstance
β The getInstance purpose
Yaf_Session::has
β The has purpose
Yaf_Session::__isset
β The __isset purpose
Yaf_Session::key
β The key purpose
Yaf_Session::next
β The next purpose
Yaf_Session::offsetExists
β The offsetExists purpose
Yaf_Session::offsetGet
β The offsetGet purpose
Yaf_Session::offsetSet
β The offsetSet purpose
Yaf_Session::offsetUnset
β The offsetUnset purpose
Yaf_Session::rewind
β The rewind purpose
Yaf_Session::__set
β The __set purpose
Yaf_Session::start
β The start purpose
Yaf_Session::__unset
β The __unset purpose
Yaf_Session::valid
β The valid purpose
Yaf_Exception
β The Yaf_Exception class
Yaf_Exception::__construct
β The __construct purpose
Yaf_Exception::getPrevious
β The getPrevious purpose
Yaf_Exception_TypeError
β The Yaf_Exception_TypeError class
Yaf_Exception_StartupError
β The Yaf_Exception_StartupError class
Yaf_Exception_DispatchFailed
β The Yaf_Exception_DispatchFailed class
Yaf_Exception_RouterFailed
β The Yaf_Exception_RouterFailed class
Yaf_Exception_LoadFailed
β The Yaf_Exception_LoadFailed class
Yaf_Exception_LoadFailed_Module
β The Yaf_Exception_LoadFailed_Module class
Yaf_Exception_LoadFailed_Controller
β The Yaf_Exception_LoadFailed_Controller class
Yaf_Exception_LoadFailed_Action
β The Yaf_Exception_LoadFailed_Action class
Yaf_Exception_LoadFailed_View
β The Yaf_Exception_LoadFailed_View class
Found A Problem?
Learn How To Improve This Page
β’
Submit a Pull Request
β’
Report a Bug
οΌ
add a note
User Contributed Notes
There are no user contributed notes for this page.
0
pcntl_sigtimedwait
Waits for signals, with a timeout
0
similar_text
Calculate the similarity between two strings
0
boolval
Get the boolean value of a variable
0
curl_multi_close
Close a set of cURL handles
0
imap_body
Read the message body
0
mb_strpos
Find position of first occurrence of string in a string
0
pg_send_prepare
Sends a request to create a prepared statement with the given parameters, without waiting for completion
0
swoole_native_socket_bind
0
Arr::prependKeysWith
0
zend_version
Gets the version of the current Zend engine
^