Class App

app/Network/Http/HttpSocket.php

_checkFatalError()source protected static

_checkFatalError( )

Check if a fatal error happened and trigger the configured handler if configured

_loadClass()source protected static

_loadClass( string $name , string $plugin , string $type , string $originalType , boolean $parent )

Helper function to include classes This is a compatibility wrapper around using App::uses() and automatic class loading

Parameters

string $name

unique name of the file for identifying it inside the application

string $plugin

camel cased plugin name if any

string $type

name of the packed where the class is located

string $originalType

type name as supplied initially by the user

boolean $parent

whether to load the class parent or not

Returns

boolean
true indicating the successful load and existence of the class

_loadFile()source protected static

_loadFile( string $name , string $plugin , array $search , string $file , boolean $return )

Helper function to include single files

Parameters

string $name

unique name of the file for identifying it inside the application

string $plugin

camel cased plugin name if any

array $search

list of paths to search the file into

string $file

filename if known, the $name param will be used otherwise

boolean $return

whether this function should return the contents of the file after being parsed by php or just a success notice

Returns

mixed
if $return contents of the file after php parses it, boolean indicating success otherwise

_loadVendor()source protected static

_loadVendor( string $name , string $plugin , string $file , string $ext )

Helper function to load files from vendors folders

Parameters

string $name

unique name of the file for identifying it inside the application

string $plugin

camel cased plugin name if any

string $file

file name if known

string $ext

file extension if known

Returns

boolean
true if the file was loaded successfully, false otherwise

_map()source protected static

_map( string $file , string $name , string $plugin null )

Maps the $name to the $file.

Parameters

string $file

full path to file

string $name

unique name for this map

string $plugin optional null

camelized if object is from a plugin, the name of the plugin

_mapped()source protected static

_mapped( string $name , string $plugin null )

Returns a file's complete path.

Parameters

string $name

unique name

string $plugin optional null

camelized if object is from a plugin, the name of the plugin

Returns

mixed
file path if found, false otherwise

_packageFormat()source protected static

_packageFormat( )

Sets then returns the templates for each customizable package path

Returns

array
templates for each customizable package path

build()source public static

build( array $paths array() , boolean|string $mode App::PREPEND )

Sets up each package location on the file system. You can configure multiple search paths for each package, those will be used to look for files one folder at a time in the specified order All paths should be terminated with a Directory separator

Usage:

App::build(array('Model' => array('/a/full/path/to/models/'))); will setup a new search path for the Model package

App::build(array('Model' => array('/path/to/models/')), App::RESET); will setup the path as the only valid path for searching models

App::build(array('View/Helper' => array('/path/to/helpers/', '/another/path/'))); will setup multiple search paths for helpers

App::build(array('Service' => array('%s' . 'Service' . DS)), App::REGISTER); will register new package 'Service'

If reset is set to true, all loaded plugins will be forgotten and they will be needed to be loaded again.

Parameters

array $paths optional array()

associative array with package names as keys and a list of directories for new search paths

boolean|string $mode optional App::PREPEND

App::RESET will set paths, App::APPEND with append paths, App::PREPEND will prepend paths (default) App::REGISTER will register new packages and their paths, %s in path will be replaced by APP path

Link

http://book.cakephp.org/2.0/en/core-utility-libraries/app.html#App::build

core()source public static

core( string $type )

Returns the full path to a package inside the CakePHP core

Usage:

App::core('Cache/Engine'); will return the full path to the cache engines package

Parameters

string $type

Package type.

Returns

array
full path to package

Link

http://book.cakephp.org/2.0/en/core-utility-libraries/app.html#App::core

import()source public static

import( string|array $type null , string $name null , boolean|array $parent true , array $search array() , string $file null , boolean $return false )

Finds classes based on $name or specific file(s) to search. Calling App::import() will not construct any classes contained in the files. It will only find and require() the file.

Parameters

string|array $type optional null

The type of Class if passed as a string, or all params can be passed as a single array to $type.

string $name optional null

Name of the Class or a unique name for the file

boolean|array $parent optional true

boolean true if Class Parent should be searched, accepts key => value array('parent' => $parent, 'file' => $file, 'search' => $search, 'ext' => '$ext'); $ext allows setting the extension of the file name based on Inflector::underscore($name) . ".$ext";

array $search optional array()

paths to search for files, array('path 1', 'path 2', 'path 3');

string $file optional null

full name of the file to search for including extension

boolean $return optional false

Return the loaded file, the file must have a return statement in it to work: return $variable;

Returns

boolean
true if Class is already in memory or if file is found and loaded, false if not

Link

http://book.cakephp.org/2.0/en/core-utility-libraries/app.html#including-files-with-app-import

increaseMemoryLimit()source public static

increaseMemoryLimit( string $additionalKb )

Increases the PHP "memory_limit" ini setting by the specified amount in kilobytes

Parameters

string $additionalKb

Number in kilobytes

init()source public static

init( )

Initializes the cache for App, registers a shutdown function.

load()source public static

load( string $className )

Method to handle the automatic class loading. It will look for each class' package defined using App::uses() and with this information it will resolve the package name to a full path to load the class from. File name for each class should follow the class name. For instance, if a class is name MyCustomClass the file name should be MyCustomClass.php

Parameters

string $className

the name of the class to load

Returns

boolean

location()source public static

location( string $className )

Returns the package name where a class was defined to be located at

Parameters

string $className

name of the class to obtain the package name from

Returns

string|null
Package name, or null if not declared

Link

http://book.cakephp.org/2.0/en/core-utility-libraries/app.html#App::location

objects()source public static

objects( string $type , string|array $path null , boolean $cache true )

Returns an array of objects of the given type.

Example usage:

App::objects('plugin'); returns array('DebugKit', 'Blog', 'User');

App::objects('Controller'); returns array('PagesController', 'BlogController');

You can also search only within a plugin's objects by using the plugin dot syntax.

App::objects('MyPlugin.Model'); returns array('MyPluginPost', 'MyPluginComment');

When scanning directories, files and directories beginning with . will be excluded as these are commonly used by version control systems.

Parameters

string $type

Type of object, i.e. 'Model', 'Controller', 'View/Helper', 'file', 'class' or 'plugin'

string|array $path optional null

Optional Scan only the path given. If null, paths for the chosen type will be used.

boolean $cache optional true

Set to false to rescan objects of the chosen type. Defaults to true.

Returns

mixed
Either false on incorrect / miss. Or an array of found objects.

Link

http://book.cakephp.org/2.0/en/core-utility-libraries/app.html#App::objects

path()source public static

path( string $type , string $plugin null )

Used to read information stored path

Usage:

App::path('Model'); will return all paths for models

App::path('Model/Datasource', 'MyPlugin'); will return the path for datasources under the 'MyPlugin' plugin

Parameters

string $type

type of path

string $plugin optional null

name of plugin

Returns

array

Link

http://book.cakephp.org/2.0/en/core-utility-libraries/app.html#App::path

paths()source public static

paths( )

Get all the currently loaded paths from App. Useful for inspecting or storing all paths App knows about. For a paths to a specific package use App::path()

Returns

array
An array of packages and their associated paths.

Link

http://book.cakephp.org/2.0/en/core-utility-libraries/app.html#App::paths

pluginPath()source public static

pluginPath( string $plugin )

Gets the path that a plugin is on. Searches through the defined plugin paths.

Usage:

App::pluginPath('MyPlugin'); will return the full path to 'MyPlugin' plugin'

Deprecated

3.0.0 Use CakePlugin::path() instead.

Parameters

string $plugin

CamelCased/lower_cased plugin name to find the path of.

Returns

string
full path to the plugin.

Link

http://book.cakephp.org/2.0/en/core-utility-libraries/app.html#App::pluginPath

shutdown()source public static

shutdown( )

Object destructor.

Writes cache file if changes have been made to the $_map. Also, check if a fatal error happened and call the handler.

themePath()source public static

themePath( string $theme )

Finds the path that a theme is on. Searches through the defined theme paths.

Usage:

App::themePath('MyTheme'); will return the full path to the 'MyTheme' theme

Parameters

string $theme

theme name to find the path of.

Returns

string
full path to the theme.

Link

http://book.cakephp.org/2.0/en/core-utility-libraries/app.html#App::themePath

uses()source public static

uses( string $className , string $location )

Declares a package for a class. This package location will be used by the automatic class loader if the class is tried to be used

Usage:

App::uses('MyCustomController', 'Controller'); will setup the class to be found under Controller package

App::uses('MyHelper', 'MyPlugin.View/Helper'); will setup the helper class to be found in plugin's helper package

Parameters

string $className

the name of the class to configure package for

string $location

the package name

Link

http://book.cakephp.org/2.0/en/core-utility-libraries/app.html#App::uses

false

array()

array()

false

array()

array()

array()

false

array(
    'models' => 'Model',
    'behaviors' => 'Model/Behavior',
    'datasources' => 'Model/Datasource',
    'controllers' => 'Controller',
    'components' => 'Controller/Component',
    'views' => 'View',
    'helpers' => 'View/Helper',
    'shells' => 'Console/Command',
    'libs' => 'Lib',
    'vendors' => 'Vendor',
    'plugins' => 'Plugin',
    'locales' => 'Locale'
)

false

array()

array(
    'class' => array('extends' => null, 'core' => true),
    'file' => array('extends' => null, 'core' => true),
    'model' => array('extends' => 'AppModel', 'core' => false),
    'behavior' => array('suffix' => 'Behavior', 'extends' => 'Model/ModelBehavior', 'core' => true),
    'controller' => array('suffix' => 'Controller', 'extends' => 'AppController', 'core' => true),
    'component' => array('suffix' => 'Component', 'extends' => null, 'core' => true),
    'lib' => array('extends' => null, 'core' => true),
    'view' => array('suffix' => 'View', 'extends' => null, 'core' => true),
    'helper' => array('suffix' => 'Helper', 'extends' => 'AppHelper', 'core' => true),
    'vendor' => array('extends' => null, 'core' => true),
    'shell' => array('suffix' => 'Shell', 'extends' => 'AppShell', 'core' => true),
    'plugin' => array('extends' => null, 'core' => true)
)