Namespace Global

__() ¶

__(string $singular, array ...$args): string|null

Returns a translated string if one is found; Otherwise, the submitted message.

Parameters

string $singular: Text to translate.
array ...$args: Array with arguments or multiple arguments in function.

Returns

string|null

Links

https://book.cakephp.org/3/en/core-libraries/global-constants-and-functions.html#__

__d() ¶

__d(string $domain, string $msg, array ...$args): string|null

Allows you to override the current domain for a single message lookup.

Parameters

string $domain: Domain.
string $msg: String to translate.
array ...$args: Array with arguments or multiple arguments in function.

Returns

string|null

Links

https://book.cakephp.org/3/en/core-libraries/global-constants-and-functions.html#__d

__dn() ¶

__dn(string $domain, string $singular, string $plural, int $count, array ...$args): string|null

Allows you to override the current domain for a single plural message lookup. Returns correct plural form of message identified by $singular and $plural for count $count from domain $domain.

Parameters

string $domain: Domain.
string $singular: Singular string to translate.
string $plural: Plural.
int $count: Count.
array ...$args: Array with arguments or multiple arguments in function.

Returns

string|null

Links

https://book.cakephp.org/3/en/core-libraries/global-constants-and-functions.html#__dn

__dx() ¶

__dx(string $domain, string $context, string $msg, array ...$args): string|null

Allows you to override the current domain for a single message lookup. The context is a unique identifier for the translations string that makes it unique within the same domain.

Parameters

string $domain: Domain.
string $context: Context of the text.
string $msg: String to translate.
array ...$args: Array with arguments or multiple arguments in function.

Returns

string|null

Links

https://book.cakephp.org/3/en/core-libraries/global-constants-and-functions.html#__dx

__dxn() ¶

__dxn(string $domain, string $context, string $singular, string $plural, int $count, array ...$args): string|null

Returns correct plural form of message identified by $singular and $plural for count $count. Allows you to override the current domain for a single message lookup. The context is a unique identifier for the translations string that makes it unique within the same domain.

Parameters

string $domain: Domain.
string $context: Context of the text.
string $singular: Singular text to translate.
string $plural: Plural text.
int $count: Count.
array ...$args: Array with arguments or multiple arguments in function.

Returns

string|null

Links

https://book.cakephp.org/3/en/core-libraries/global-constants-and-functions.html#__dxn

__n() ¶

__n(string $singular, string $plural, int $count, array ...$args): string|null

Returns correct plural form of message identified by $singular and $plural for count $count. Some languages have more than one form for plural messages dependent on the count.

Parameters

string $singular: Singular text to translate.
string $plural: Plural text.
int $count: Count.
array ...$args: Array with arguments or multiple arguments in function.

Returns

string|null

Links

https://book.cakephp.org/3/en/core-libraries/global-constants-and-functions.html#__n

__x() ¶

__x(string $context, string $singular, array ...$args): string|null

Returns a translated string if one is found; Otherwise, the submitted message. The context is a unique identifier for the translations string that makes it unique within the same domain.

Parameters

string $context: Context of the text.
string $singular: Text to translate.
array ...$args: Array with arguments or multiple arguments in function.

Returns

string|null

Links

https://book.cakephp.org/3/en/core-libraries/global-constants-and-functions.html#__x

__xn() ¶

__xn(string $context, string $singular, string $plural, int $count, array ...$args): string|null

Returns correct plural form of message identified by $singular and $plural for count $count. Some languages have more than one form for plural messages dependent on the count. The context is a unique identifier for the translations string that makes it unique within the same domain.

Parameters

string $context: Context of the text.
string $singular: Singular text to translate.
string $plural: Plural text.
int $count: Count.
array ...$args: Array with arguments or multiple arguments in function.

Returns

string|null

Links

https://book.cakephp.org/3/en/core-libraries/global-constants-and-functions.html#__xn

breakpoint() ¶

breakpoint(): string

Command to return the eval-able code to startup PsySH in interactive debugger Works the same way as eval(\Psy\sh()); psy/psysh must be loaded in your project

Returns

string

Links

http://psysh.org/ ``` eval(breakpoint()); ```

collection() ¶

collection(Traversable|array $items): Cake\Collection\Collection

Returns a new Cake\Collection\Collection object wrapping the passed argument.

Parameters

Traversable|array $items: The items from which the collection will be built.

Returns

Cake\Collection\Collection

dd() ¶

dd(mixed $var, bool|null $showHtml = null): void

Prints out debug information about given variable and dies.

Only runs if debug mode is enabled. It will otherwise just continue code execution and ignore this function.

Parameters

mixed $var: Variable to show debug information for.
bool|null $showHtml optional: If set to true, the method prints the debug data in a browser-friendly way.

Returns

void

Links

https://book.cakephp.org/3/en/development/debugging.html#basic-debugging

debug() ¶

debug(mixed $var, bool|null $showHtml = null, bool $showFrom = true): mixed

Prints out debug information about given variable and returns the variable that was passed.

Only runs if debug mode is enabled.

Parameters

mixed $var: Variable to show debug information for.
bool|null $showHtml optional: If set to true, the method prints the debug data in a browser-friendly way.
bool $showFrom optional: If set to true, the method prints from where the function was called.

Returns

mixed

Links

https://book.cakephp.org/3/en/development/debugging.html#basic-debugging

https://book.cakephp.org/3/en/core-libraries/global-constants-and-functions.html#debug

deprecationWarning() ¶

deprecationWarning(string $message, int $stackFrame = 1): void

Helper 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

void

env() ¶

env(string $key, string|bool|null $default = null): string|bool|null

Gets 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|null

Links

https://book.cakephp.org/3/en/core-libraries/global-constants-and-functions.html#env

getTypeName() ¶

getTypeName(mixed $var): string

Returns the objects class or var type of it's not an object

Parameters

mixed $var: Variable to check

Returns

string

h() ¶

h(mixed $text, bool $double = true, string|null $charset = null): mixed

Convenience 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 __toString method. 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

mixed

Links

https://book.cakephp.org/3/en/core-libraries/global-constants-and-functions.html#h

loadPHPUnitAliases() ¶

loadPHPUnitAliases(): void

Loads PHPUnit aliases

This is an internal function used for backwards compatibility during fixture related tests.

Returns

void

namespaceSplit() ¶

namespaceSplit(string $class): array

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

pj() ¶

pj(mixed $var): mixed

json 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

 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
          
            mixed

                      
        
        
                  See Also
          
                          pr()
                      
        
                  Links
          
                          https://book.cakephp.org/3/en/core-libraries/global-constants-and-functions.html#pj

pluginSplit() ¶

pluginSplit(string $name, bool $dotAppend = false, string|null $plugin = null): array

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

Links

https://book.cakephp.org/3/en/core-libraries/global-constants-and-functions.html#pluginSplit

pr() ¶

pr(mixed $var): mixed

print_r() convenience function.

In terminals this will act similar to using print_r() directly, when not run on cli print_r() will also wrap

 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
          
            mixed

                      
        
        
                  See Also
          
                          debug()
                      
        
                  Links
          
                          https://book.cakephp.org/3/en/core-libraries/global-constants-and-functions.html#pr

stackTrace() ¶

stackTrace(array $options = []): void

Outputs a stack trace based on the supplied options.

Options

depth - The number of stack frames to return. Defaults to 999
args - Should arguments for functions be shown? If true, the arguments for each method call will be displayed.
start - The stack frame to start generating a trace from. Defaults to 1

Parameters

array $options optional: Format for outputting stack trace

Returns

void

triggerWarning() ¶

triggerWarning(string $message): void

Triggers an E_USER_WARNING.

Parameters

string $message: The warning message.

Returns

void

Namespaces

Function Detail

__() ¶

Parameters

Returns

Links

__d() ¶

Parameters

Returns

Links

__dn() ¶

Parameters

Returns

Links

__dx() ¶

Parameters

Returns

Links

__dxn() ¶

Parameters

Returns

Links

__n() ¶

Parameters

Returns

Links

__x() ¶

Parameters

Returns

Links

__xn() ¶

Parameters

Returns

Links

breakpoint() ¶

Returns

Links

collection() ¶

Parameters

Returns

dd() ¶

Parameters

Returns

Links

debug() ¶

Parameters

Returns

Links

deprecationWarning() ¶

Parameters

Returns

env() ¶

Parameters

Returns

Links

getTypeName() ¶

Parameters

Returns

h() ¶

Parameters

Returns

Links

loadPHPUnitAliases() ¶

Returns

namespaceSplit() ¶

Parameters

Returns

pj() ¶

Parameters

Returns

See Also

Links

pluginSplit() ¶

Parameters

Returns

Links

pr() ¶

Parameters

Returns