CakePHP
  • Documentation
    • Book
    • API
    • Videos
    • Reporting Security Issues
    • Privacy Policy
    • Logos & Trademarks
  • Business Solutions
  • Swag
  • Road Trip
  • Team
  • Community
    • Community
    • Get Involved
    • Issues (Github)
    • Bakery
    • Featured Resources
    • Training
    • Meetups
    • My CakePHP
    • CakeFest
    • Newsletter
    • Linkedin
    • YouTube
    • Facebook
    • Twitter
    • Mastodon
    • Help & Support
    • Forum
    • Stack Overflow
    • IRC
    • Slack
    • Paid Support
CakePHP

C CakePHP 5.1 Chiffon API

  • Project:
    • CakePHP
      • CakePHP
      • Chronos
      • Elastic Search
      • Queue
  • Version:
    • 5.1
      • 5.1
      • 5.0
      • 4.5
      • 4.4
      • 4.3
      • 4.2
      • 4.1
      • 4.0
      • 3.10
      • 3.9
      • 3.8
      • 3.7
      • 3.6
      • 3.5
      • 3.4
      • 3.3
      • 3.2
      • 3.1
      • 3.0
      • 2.10
      • 2.9
      • 2.8
      • 2.7
      • 2.6
      • 2.5
      • 2.4
      • 2.3
      • 2.2
      • 2.1
      • 2.0
      • 1.3
      • 1.2

Namespaces

  • Global
  • Cake
    • Cache
    • Collection
    • Command
    • Console
    • Controller
    • Core
    • Database
    • Datasource
    • Error
    • Event
    • Form
    • Http
    • I18n
    • Log
    • Mailer
    • Network
    • ORM
    • Routing
    • TestSuite
    • Utility
    • Validation
    • View

Namespace Global

Function Detail

__() ¶ 

__(string $singular, mixed ...$args): string

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

Parameters
string $singular

Text to translate.

mixed ...$args

Array with arguments or multiple arguments in function.

Returns
string
Links
https://book.cakephp.org/5/en/core-libraries/global-constants-and-functions.html#__

__d() ¶ 

__d(string $domain, string $msg, mixed ...$args): string

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

Parameters
string $domain

Domain.

string $msg

String to translate.

mixed ...$args

Array with arguments or multiple arguments in function.

Returns
string
Links
https://book.cakephp.org/5/en/core-libraries/global-constants-and-functions.html#__d

__dn() ¶ 

__dn(string $domain, string $singular, string $plural, int $count, mixed ...$args): string

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.

mixed ...$args

Array with arguments or multiple arguments in function.

Returns
string
Links
https://book.cakephp.org/5/en/core-libraries/global-constants-and-functions.html#__dn

__dx() ¶ 

__dx(string $domain, string $context, string $msg, mixed ...$args): string

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.

mixed ...$args

Array with arguments or multiple arguments in function.

Returns
string
Links
https://book.cakephp.org/5/en/core-libraries/global-constants-and-functions.html#__dx

__dxn() ¶ 

__dxn(string $domain, string $context, string $singular, string $plural, int $count, mixed ...$args): string

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.

mixed ...$args

Array with arguments or multiple arguments in function.

Returns
string
Links
https://book.cakephp.org/5/en/core-libraries/global-constants-and-functions.html#__dxn

__n() ¶ 

__n(string $singular, string $plural, int $count, mixed ...$args): string

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.

mixed ...$args

Array with arguments or multiple arguments in function.

Returns
string
Links
https://book.cakephp.org/5/en/core-libraries/global-constants-and-functions.html#__n

__x() ¶ 

__x(string $context, string $singular, mixed ...$args): string

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.

mixed ...$args

Array with arguments or multiple arguments in function.

Returns
string
Links
https://book.cakephp.org/5/en/core-libraries/global-constants-and-functions.html#__x

__xn() ¶ 

__xn(string $context, string $singular, string $plural, int $count, mixed ...$args): string

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.

mixed ...$args

Array with arguments or multiple arguments in function.

Returns
string
Links
https://book.cakephp.org/5/en/core-libraries/global-constants-and-functions.html#__xn

breakpoint() ¶ 

breakpoint(): string|null

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

eval(breakpoint());
Returns
string|null
Links
https://psysh.org/

collection() ¶ 

collection(iterable $items): Cake\Collection\Collection

Returns a new {@link \Cake\Collection\Collection} object wrapping the passed argument.

Parameters
iterable $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/5/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/5/en/development/debugging.html#basic-debugging

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

deprecationWarning() ¶ 

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

Helper 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
void

env() ¶ 

env(string $key, string|bool|null $default = null): string|float|int|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|float|int|bool|null
Links
https://book.cakephp.org/5/en/core-libraries/global-constants-and-functions.html#env

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/5/en/core-libraries/global-constants-and-functions.html#h

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}

pathCombine() ¶ 

pathCombine(list<string> $parts, bool|null $trailing = null): string

Combines parts with a forward-slash /.

Skips adding a forward-slash if either / or \ already exists.

Parameters
list<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
string

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 <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
mixed
See Also
pr()
Links
https://book.cakephp.org/5/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/5/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 <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
mixed
See Also
debug()
Links
https://book.cakephp.org/5/en/core-libraries/global-constants-and-functions.html#pr

stackTrace() ¶ 

stackTrace(array<string, mixed> $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<string, mixed> $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

url() ¶ 

url(Psr\Http\Message\UriInterface|array|string|null $url = null, bool $full = false): string

Convenience wrapper for Router::url().

Parameters
Psr\Http\Message\UriInterface|array|string|null $url optional

An array specifying any of the following: 'controller', 'action', 'plugin' additionally, you can provide routed elements or query string parameters. If string it can be name any valid url string or it can be an UriInterface instance.

bool $full optional

If true, the full base URL will be prepended to the result. Default is false.

Returns
string
Throws
Cake\Core\Exception\CakeException
When the route name is not found
See Also
\Cake\Routing\Router::url()

urlArray() ¶ 

urlArray(string $path, array $params = []): array

Returns an array URL from a route path string.

Parameters
string $path

Route path.

array $params optional

An array specifying any additional parameters. Can be also any special parameters supported by Router::url().

Returns
array
See Also
\Cake\Routing\Router::pathUrl()
OpenHub
Pingping
Linode
  • Business Solutions
  • Showcase
  • Documentation
  • Book
  • API
  • Videos
  • Reporting Security Issues
  • Privacy Policy
  • Logos & Trademarks
  • Community
  • Get Involved
  • Issues (Github)
  • Bakery
  • Featured Resources
  • Training
  • Meetups
  • My CakePHP
  • CakeFest
  • Newsletter
  • Linkedin
  • YouTube
  • Facebook
  • Twitter
  • Mastodon
  • Help & Support
  • Forum
  • Stack Overflow
  • IRC
  • Slack
  • Paid Support

Generated using CakePHP API Docs