Namespace Core
Namespaces
Function Detail
deprecationWarning() ¶
deprecationWarning(string $version, string $message, int $stackFrame = 1): voidHelper method for outputting deprecation warnings
Parameters
-
string$version The version that added this deprecation warning.
-
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|float|int|bool|null $default = null): string|float|int|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|float|int|bool|null$default optional Specify a default value in case the environment variable is not defined.
Returns
string|float|int|bool|nullEnvironment variable setting.
Links
h() ¶
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
mixedWrapped text.
Links
namespaceSplit() ¶
namespaceSplit(string $class): array{0: string, 1: 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{0: string, 1: string}Array with 2 indexes. 0 => namespace, 1 => classname.
pathCombine() ¶
pathCombine(array<string> $parts, bool|null $trailing = null): stringCombines parts with a forward-slash /.
Skips adding a forward-slash if either / or \ already exists.
Parameters
-
array<string>$parts -
bool|null$trailing optional Determines how trailing slashes are handled
- If true, ensures a trailing forward-slash is added if one doesn't exist
- If false, ensures any trailing slash is removed
- if null, ignores trailing slashes
Returns
stringpj() ¶
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
mixedthe same $var that was passed to this function
See Also
Links
pluginSplit() ¶
pluginSplit(string $name, bool $dotAppend = false, string|null $plugin = null): array{0: (string|null, 1: string}Splits 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
array{0: (string|null, 1: string}Array with 2 indexes. 0 => plugin name, 1 => class name.
Links
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
mixedthe same $var that was passed to this function
See Also
Links
toBool() ¶
toBool(mixed $value): bool|nullConverts a value to boolean.
1 | '1' | 1.0 | true - values returns as true 0 | '0' | 0.0 | false - values returns as false Other values returns as null.
Parameters
-
mixed$value The value to convert to boolean.
Returns
bool|nullReturns true if the value is truthy, false if it's falsy, or NULL otherwise.
toFloat() ¶
toFloat(mixed $value): float|nullConverts a value to a float.
This method attempts to convert the given value to a float. If the conversion is successful, it returns the value as an float. If the conversion fails, it returns NULL.
String values are trimmed using trim().
Parameters
-
mixed$value The value to be converted to a float.
Returns
float|nullReturns the converted float value or null if the conversion fails.
toInt() ¶
toInt(mixed $value): int|nullConverts a value to an integer.
This method attempts to convert the given value to an integer. If the conversion is successful, it returns the value as an integer. If the conversion fails, it returns NULL.
String values are trimmed using trim().
Parameters
-
mixed$value The value to be converted to an integer.
Returns
int|nullReturns the converted integer value or null if the conversion fails.
toString() ¶
toString(mixed $value): ?stringConverts the given value to a string.
This method attempts to convert the given value to a string.
If the value is already a string, it returns the value as it is.
null is returned if the conversion is not possible.
Parameters
-
mixed$value The value to be converted.
Returns
?stringReturns the string representation of the value, or null if the value is not a string.
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
-
EventAwareApplicationInterface
-
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
-
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
-
PluginConfig
PluginConfig contains all available plugins and their config if/how they should be loaded
-
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.