Namespace Core
Function Detail
deprecationWarning() ¶
deprecationWarning(string $message, int $stackFrame = 1): voidHelper method for outputting deprecation warnings
Parameters
-
string$message The message to output as a deprecation warning.
-
int$stackFrame optional The stack frame to include in the error. Defaults to 1 as that should point to application/plugin code.
Returns
voidenv() ¶
env(string $key, string|bool|null $default = null): string|bool|nullGets an environment variable from available sources, and provides emulation for unsupported or inconsistent environment variables (i.e. DOCUMENT_ROOT on IIS, or SCRIPT_NAME in CGI mode). Also exposes some additional custom environment information.
Parameters
-
string$key Environment variable name.
-
string|bool|null$default optional Specify a default value in case the environment variable is not defined.
Returns
string|bool|nullLinks
getTypeName() ¶
getTypeName(mixed $var): stringReturns the objects class or var type of it's not an object
Parameters
-
mixed$var Variable to check
Returns
stringh() ¶
h(mixed $text, bool $double = true, string|null $charset = null): mixedConvenience method for htmlspecialchars.
Parameters
-
mixed$text Text to wrap through htmlspecialchars. Also works with arrays, and objects. Arrays will be mapped and have all their elements escaped. Objects will be string cast if they implement a
__toStringmethod. Otherwise, the class name will be used. Other scalar types will be returned unchanged.-
bool$double optional Encode existing html entities.
-
string|null$charset optional Character set to use when escaping. Defaults to config value in
mb_internal_encoding()or 'UTF-8'.
Returns
mixedLinks
namespaceSplit() ¶
namespaceSplit(string $class): array<string>Split the namespace from the classname.
Commonly used like list($namespace, $className) = namespaceSplit($class);.
Parameters
-
string$class The full class name, ie
Cake\Core\App.
Returns
array<string>pj() ¶
pj(mixed $var): mixedJSON pretty print convenience function.
In terminals this will act similar to using json_encode() with JSON_PRETTY_PRINT directly, when not run on CLI
will also wrap <pre> tags around the output of given variable. Similar to pr().
This function returns the same variable that was passed.
Parameters
-
mixed$var Variable to print out.
Returns
mixedSee Also
Links
pluginSplit() ¶
pluginSplit(string $name, bool $dotAppend = false, string|null $plugin = null): arraySplits a dot syntax plugin name into its plugin and class name. If $name does not have a dot, then index 0 will be null.
Commonly used like
list($plugin, $name) = pluginSplit($name);Parameters
-
string$name The name you want to plugin split.
-
bool$dotAppend optional Set to true if you want the plugin to have a '.' appended to it.
-
string|null$plugin optional Optional default plugin to use if no plugin is found. Defaults to null.
Returns
arrayLinks
pr() ¶
pr(mixed $var): mixedprint_r() convenience function.
In terminals this will act similar to using print_r() directly, when not run on CLI
print_r() will also wrap <pre> tags around the output of given variable. Similar to debug().
This function returns the same variable that was passed.
Parameters
-
mixed$var Variable to print out.
Returns
mixedSee Also
Links
triggerWarning() ¶
triggerWarning(string $message): voidTriggers an E_USER_WARNING.
Parameters
-
string$message The warning message.
Returns
voidInterfaces
-
ConsoleApplicationInterface
An interface defining the methods that the console runner depend on.
-
ContainerApplicationInterface
Interface for applications that configure and use a dependency injection container.
-
ContainerInterface
Interface for the Dependency Injection Container in CakePHP applications
-
HttpApplicationInterface
An interface defining the methods that the http server depend on.
-
PluginApplicationInterface
Interface for Applications that leverage plugins & events.
-
PluginInterface
Plugin Interface
Classes
-
App
App is responsible for resource location, and path management.
-
BasePlugin
Base Plugin Class
-
ClassLoader
ClassLoader
-
Configure
Configuration class. Used for managing runtime configuration information.
-
Container
Dependency Injection container
-
ObjectRegistry
Acts as a registry/factory for objects.
-
Plugin
Plugin is used to load and locate plugins.
-
PluginCollection
Plugin Collection
-
ServiceConfig
Read-only wrapper for configuration data
-
ServiceProvider
Container ServiceProvider
Traits
-
ConventionsTrait
Provides methods that allow other classes access to conventions based inflections.
-
InstanceConfigTrait
A trait for reading and writing instance config
-
StaticConfigTrait
A trait that provides a set of static methods to manage configuration for classes that provide an adapter facade or need to have sets of configuration data registered and manipulated.