Class App
App is responsible for resource location, and path management.
Adding paths
Additional paths for Templates and Plugins are configured with Configure now. See config/app.php for an
example. The App.paths.plugins and App.paths.templates variables are used to configure paths for plugins
and templates respectively. All class based resources should be mapped using your application's autoloader.
Inspecting loaded paths
You can inspect the currently loaded paths using App::classPath('Controller') for example to see loaded
controller paths.
It is also possible to inspect paths for plugin classes, for instance, to get
the path to a plugin's helpers you would call App::classPath('View/Helper', 'MyPlugin')
Locating plugins
Plugins can be located with App as well. Using Plugin::path('DebugKit') for example, will give you the full path to the DebugKit plugin.
Method Summary
-
_classExistsInBase() protected static
_classExistsInBase
-
className() public static
Return the class name namespaced. This method checks if the class is defined on the application/plugin, otherwise try to load from the CakePHP core
-
classPath() public static
Gets the path to a class type in the application or a plugin.
-
core() public static
Returns the full path to a package inside the CakePHP core
-
path() public static
Used to read information of stored path.
-
shortName() public static
Returns the plugin split name of a class
Method Detail
_classExistsInBase() ¶ protected static
_classExistsInBase(string $name, string $namespace): bool_classExistsInBase
Test isolation wrapper
Parameters
-
string$name Class name.
-
string$namespace Namespace.
Returns
boolclassName() ¶ public static
className(string $class, string $type = '', string $suffix = ''): class-string|nullReturn the class name namespaced. This method checks if the class is defined on the application/plugin, otherwise try to load from the CakePHP core
Parameters
-
string$class Class name
-
string$type optional Type of class
-
string$suffix optional Class name suffix
Returns
class-string|nullclassPath() ¶ public static
classPath(string $type, string|null $plugin = null): list<string>Gets the path to a class type in the application or a plugin.
Example:
App::classPath('Model/Table');Will return the path for tables - e.g. src/Model/Table/.
App::classPath('Model/Table', 'My/Plugin');Will return the plugin based path for those.
Parameters
-
string$type Package type.
-
string|null$plugin optional Plugin name.
Returns
list<string>core() ¶ public static
core(string $type): list<string>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
list<string>path() ¶ public static
path(string $type, string|null $plugin = null): array<int|string, string>Used to read information of stored path.
When called without the $plugin argument it will return the value of App.paths.$type config.
Default types:
- plugins
- templates
- locales
Example:
App::path('plugins');Will return the value of App.paths.plugins config.
For plugins it can be used to get paths for types templates or locales.
Parameters
-
string$type Type of path
-
string|null$plugin optional Plugin name
Returns
array<int|string, string>Links
shortName() ¶ public static
shortName(string $class, string $type, string $suffix = ''): stringReturns the plugin split name of a class
Examples:
App::shortName(
'SomeVendor\SomePlugin\Controller\Component\TestComponent',
'Controller/Component',
'Component'
)Returns: SomeVendor/SomePlugin.Test
App::shortName(
'SomeVendor\SomePlugin\Controller\Component\Subfolder\TestComponent',
'Controller/Component',
'Component'
)Returns: SomeVendor/SomePlugin.Subfolder/Test
App::shortName(
'Cake\Controller\Component\FlashComponent',
'Controller/Component',
'Component'
)Returns: Flash
Parameters
-
string$class Class name
-
string$type Type of class
-
string$suffix optional Class name suffix
Returns
string