---
title: "Phalcon Support"
version: "5.17"
---
> Documentation Index
> Fetch the complete documentation index at: https://docs.phalcon.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Phalcon Support
:::info[NOTE]
All classes are prefixed with `Phalcon`
:::
## Support\AbstractLocator
Abstract
Source on GitHub
Abstract base class for service locators.
Provides a unified way to register, validate, and resolve services
from a DI container, with support for both legacy Di and new Container.
@template T of object
- **`Phalcon\Support\AbstractLocator`**
- [`Phalcon\Auth\Access\AccessLocator`](/5.17/api/phalcon_auth/#authaccessaccesslocator)
- [`Phalcon\Auth\Adapter\AdapterLocator`](/5.17/api/phalcon_auth/#authadapteradapterlocator)
- [`Phalcon\Auth\Guard\GuardLocator`](/5.17/api/phalcon_auth/#authguardguardlocator)
__Uses__ `Phalcon\Contracts\Container\Service\Collection` · `Phalcon\Di\DiInterface` · `Throwable`
### Method Summary
### Properties
protected
Collection|DiInterface
$container
protected
array
$services = []
### Methods
Public · 6
__construct()
```php
public function __construct(
mixed $container,
array $services = []
);
```
getAll()
```php
public function getAll(): array;
```
Returns the full registered service map (defaults plus any added via
register()).
getClass()
```php
public function getClass( string $name ): string;
```
Returns the class-string registered under the given name.
has()
```php
public function has( string $name ): bool;
```
Whether a service with the given name is registered.
newInstance()
```php
public function newInstance( string $name ): object;
```
Retrieve a service instance from the container.
On the `DiInterface` path this returns the container's **shared**
instance (`getShared()`) - despite the name, it is not a fresh build.
Locators whose services carry per-activation state should override this
method to resolve a fresh instance; see `Auth\Access\AccessLocator`, which uses
`ContainerResolver::resolveFresh` for exactly that reason.
register()
```php
public function register(
string $name,
string $definition
): static;
```
Register a service or override an existing one.
Protected · 4
getExceptionClass()
```php
abstract protected function getExceptionClass(): string;
```
Get the exception class to throw on errors.
getInterfaceClass()
```php
abstract protected function getInterfaceClass(): string;
```
Get the interface/class that all registered services must implement.
This allows different locators to enforce different contracts.
getService()
```php
protected function getService( string $name ): string;
```
Get the service class name for a given name.
getServices()
```php
abstract protected function getServices(): array;
```
Get the default services for this locator.
## Support\Collection
Class
Source on GitHub
`Phalcon\Support\Collection` is a supercharged object-oriented array. It implements:
- [ArrayAccess](https://www.php.net/manual/en/class.arrayaccess.php)
- [Countable](https://www.php.net/manual/en/class.countable.php)
- [IteratorAggregate](https://www.php.net/manual/en/class.iteratoraggregate.php)
- [JsonSerializable](https://www.php.net/manual/en/class.jsonserializable.php)
It can be used in any part of the application that needs collection of data
Such implementations are for instance accessing globals `$_GET`, `$_POST`
etc.
@property array $data
@property bool $insensitive
@property array $lowerKeys
@property bool $strictNull
@property string|null $type
- **`Phalcon\Support\Collection`** - implements [`Phalcon\Support\Collection\CollectionInterface`](#supportcollectioncollectioninterface), `Countable`, `JsonSerializable`
- [`Phalcon\Config\Config`](/5.17/api/phalcon_config/#configconfig)
- [`Phalcon\Html\Attributes`](/5.17/api/phalcon_html/#htmlattributes)
- [`Phalcon\Session\Bag`](/5.17/api/phalcon_session/#sessionbag)
- [`Phalcon\Support\Collection\ReadOnlyCollection`](#supportcollectionreadonlycollection)
- [`Phalcon\Support\Registry`](#supportregistry)
__Uses__ `ArrayAccess` · `ArrayIterator` · `Countable` · `InvalidArgumentException` · `IteratorAggregate` · `JsonSerializable` · `Phalcon\Support\Collection\CollectionInterface` · `Phalcon\Support\Collection\Exceptions\InvalidValueType` · `Phalcon\Support\Helper\Json\Encode` · `Traversable`
### Method Summary
public
__construct(array $data = [],bool $insensitive = true,bool $strictNull = false,string $type = null)
Collection constructor.
public
mixed
__get( string $element )
Magic getter to get an element from the collection
public
bool
__isset( string $element )
Magic isset to check whether an element exists or not
public
array
__serialize()
Returns the state of the collection for serialization, including
public
void
__set(string $element,mixed $value)
Magic setter to assign values to an element
public
void
__unserialize( array $data )
Restores the collection state. Accepts both the structured format
public
void
__unset( string $element )
Magic unset to remove an element from the collection
public
void
clear()
Clears the internal collection
public
array
column( string $propertyOrMethod )
Returns the values from a single property/method extracted from every
public
int
count()
Count elements of an object
public
static
each( callable $callback )
Invokes the callback for every item in the collection. Returns the
public
static
filter( callable $callback )
Returns a new collection of items for which the callback returns true.
public
mixed
first()
Returns the first value in the collection, or null if empty.
public
mixed
get(string $element,mixed $defaultValue = null,string $cast = null)
Get the element from the collection
public
Traversable
getIterator()
Returns the iterator of the class
public
array
getKeys( bool $insensitive = true )
Returns the keys (insensitive or not) of the collection.
public
string|null
getType()
Returns the configured runtime type guard, or null if none.
public
array
getValues()
Returns the values of the internal array.
public
bool
has( string $element )
Get the element from the collection
public
void
init( array $data = [] )
Initialize internal array
public
bool
isEmpty()
Return if the collection is empty
public
array
jsonSerialize()
Specify data which should be serialized to JSON
public
array
keys( bool $insensitive = true )
Returns the keys (insensitive or not) of the collection.
public
mixed
last()
Returns the last value in the collection, or null if empty.
public
static
map( callable $callback )
Returns a new collection with the callback applied to every value.
public
bool
offsetExists( mixed $element )
Whether a offset exists
public
mixed
offsetGet( mixed $element )
Offset to retrieve
public
void
offsetSet(mixed $element,mixed $value)
Offset to set
public
void
offsetUnset( mixed $element )
Offset to unset
public
mixed
reduce(callable $callback,mixed $initial = null)
Reduces the collection to a single value using the callback. The
public
void
remove( string $element )
Delete the element from the collection
public
void
replace( array $data )
Replaces the collection data with a new array, clearing existing data first
public
string|null
serialize()
BC - delegate to __serialize()
public
void
set(string $element,mixed $value)
Set an element in the collection
public
static
sort(mixed $callback = null,int $order = 4)
Returns a new collection sorted by value. Keys are preserved. When a
public
array
toArray()
Returns the object in an array format
public
string
toJson( int $options = 4194383 )
Returns the object in a JSON format
public
void
unserialize( string $data )
BC - delegate to __unserialize()
public
array
values()
Returns the values of the internal array.
public
static
where(string $propertyOrMethod,mixed $value)
Returns a new collection containing only the items whose
protected
static
cloneEmpty( array $data = [] )
Builds a new collection of the same concrete class, carrying over the
protected
mixed
extractValue(mixed $item,string $propertyOrMethod)
Extracts a single value from an item. For arrays returns the keyed
protected
string
processKey( string $element )
Checks if we need insensitive keys and if so, converts the element to
protected
void
setData(string $element,mixed $value)
Internal method to set data
protected
void
validateType( mixed $value )
Validates the value against the configured $type guard. When $type
### Properties
protected
array
$data = []
protected
bool
$insensitive = true
protected
array
$lowerKeys = []
protected
bool
$strictNull = false
protected
string|null
$type = null
### Methods
Public · 40
__construct()
```php
public function __construct(
array $data = [],
bool $insensitive = true,
bool $strictNull = false,
string $type = null
);
```
Collection constructor.
__get()
```php
public function __get( string $element ): mixed;
```
Magic getter to get an element from the collection
__isset()
```php
public function __isset( string $element ): bool;
```
Magic isset to check whether an element exists or not
__serialize()
```php
public function __serialize(): array;
```
Returns the state of the collection for serialization, including
configuration flags so the round-trip restores full state.
__set()
```php
public function __set(
string $element,
mixed $value
): void;
```
Magic setter to assign values to an element
__unserialize()
```php
public function __unserialize( array $data ): void;
```
Restores the collection state. Accepts both the structured format
emitted by __serialize() and the legacy flat-array format for BC
with previously serialized data.
__unset()
```php
public function __unset( string $element ): void;
```
Magic unset to remove an element from the collection
clear()
```php
public function clear(): void;
```
Clears the internal collection
column()
```php
public function column( string $propertyOrMethod ): array;
```
Returns the values from a single property/method extracted from every
item in the collection, keyed by the original collection key.
count()
```php
public function count(): int;
```
Count elements of an object
each()
```php
public function each( callable $callback ): static;
```
Invokes the callback for every item in the collection. Returns the
collection itself to allow chaining.
filter()
```php
public function filter( callable $callback ): static;
```
Returns a new collection of items for which the callback returns true.
Keys are preserved.
first()
```php
public function first(): mixed;
```
Returns the first value in the collection, or null if empty.
get()
```php
public function get(
string $element,
mixed $defaultValue = null,
string $cast = null
): mixed;
```
Get the element from the collection
getIterator()
```php
public function getIterator(): Traversable;
```
Returns the iterator of the class
getKeys()
```php
public function getKeys( bool $insensitive = true ): array;
```
Returns the keys (insensitive or not) of the collection.
getType()
```php
public function getType(): string|null;
```
Returns the configured runtime type guard, or null if none.
getValues()
```php
public function getValues(): array;
```
Returns the values of the internal array.
has()
```php
public function has( string $element ): bool;
```
Get the element from the collection
init()
```php
public function init( array $data = [] ): void;
```
Initialize internal array
isEmpty()
```php
public function isEmpty(): bool;
```
Return if the collection is empty
jsonSerialize()
```php
public function jsonSerialize(): array;
```
Specify data which should be serialized to JSON
@link https://php.net/manual/en/jsonserializable.jsonserialize.php
keys()
```php
public function keys( bool $insensitive = true ): array;
```
Returns the keys (insensitive or not) of the collection.
last()
```php
public function last(): mixed;
```
Returns the last value in the collection, or null if empty.
map()
```php
public function map( callable $callback ): static;
```
Returns a new collection with the callback applied to every value.
Keys are preserved.
offsetExists()
```php
public function offsetExists( mixed $element ): bool;
```
Whether a offset exists
@link https://php.net/manual/en/arrayaccess.offsetexists.php
offsetGet()
```php
public function offsetGet( mixed $element ): mixed;
```
Offset to retrieve
@link https://php.net/manual/en/arrayaccess.offsetget.php
offsetSet()
```php
public function offsetSet(
mixed $element,
mixed $value
): void;
```
Offset to set
@link https://php.net/manual/en/arrayaccess.offsetset.php
offsetUnset()
```php
public function offsetUnset( mixed $element ): void;
```
Offset to unset
@link https://php.net/manual/en/arrayaccess.offsetunset.php
reduce()
```php
public function reduce(
callable $callback,
mixed $initial = null
): mixed;
```
Reduces the collection to a single value using the callback. The
callback receives `($accumulator, $value, $key)`.
remove()
```php
public function remove( string $element ): void;
```
Delete the element from the collection
replace()
```php
public function replace( array $data ): void;
```
Replaces the collection data with a new array, clearing existing data first
serialize()
```php
public function serialize(): string|null;
```
BC - delegate to __serialize()
set()
```php
public function set(
string $element,
mixed $value
): void;
```
Set an element in the collection
sort()
```php
public function sort(
mixed $callback = null,
int $order = 4
): static;
```
Returns a new collection sorted by value. Keys are preserved. When a
callback is supplied, `uasort` is used. Without a callback, the
comparison direction is controlled by the `$order` argument
(`SORT_ASC` or `SORT_DESC`).
toArray()
```php
public function toArray(): array;
```
Returns the object in an array format
toJson()
```php
public function toJson( int $options = 4194383 ): string;
```
Returns the object in a JSON format
The following options are used if none specified for json_encode
JSON_HEX_TAG, JSON_HEX_APOS, JSON_HEX_AMP, JSON_HEX_QUOT,
JSON_UNESCAPED_SLASHES, JSON_THROW_ON_ERROR
@see https://www.ietf.org/rfc/rfc4627.txt
unserialize()
```php
public function unserialize( string $data ): void;
```
BC - delegate to __unserialize()
values()
```php
public function values(): array;
```
Returns the values of the internal array.
where()
```php
public function where(
string $propertyOrMethod,
mixed $value
): static;
```
Returns a new collection containing only the items whose
`propertyOrMethod` strictly equals `$value`.
Protected · 5
cloneEmpty()
```php
protected function cloneEmpty( array $data = [] ): static;
```
Builds a new collection of the same concrete class, carrying over the
configuration (insensitivity, strict-null, type) of the current one.
```php
protected function extractValue(
mixed $item,
string $propertyOrMethod
): mixed;
```
Extracts a single value from an item. For arrays returns the keyed
entry; for objects, prefers a callable method, then a readable
property. Returns null when nothing matches.
processKey()
```php
protected function processKey( string $element ): string;
```
Checks if we need insensitive keys and if so, converts the element to
lowercase
setData()
```php
protected function setData(
string $element,
mixed $value
): void;
```
Internal method to set data
validateType()
```php
protected function validateType( mixed $value ): void;
```
Validates the value against the configured `$type` guard. When `$type`
is null this is a no-op. Scalar tokens (`int`, `string`, `bool`,
`float`, `array`, `object`) map to their `is_*` checks; anything else
is treated as a class/interface name and tested with `instanceof`.
## Support\Collection\CollectionInterface
Interface
Source on GitHub
Phalcon\Support\Collection\CollectionInterface
- `ArrayAccess`
- [`Phalcon\Contracts\Support\Collection`](/5.17/api/phalcon_contracts/#contractssupportcollection)
- **`Phalcon\Support\Collection\CollectionInterface`**
- [`Phalcon\Config\ConfigInterface`](/5.17/api/phalcon_config/#configconfiginterface)
__Uses__ `Phalcon\Contracts\Support\Collection`
## Support\Collection\Exception
Class
Source on GitHub
Exceptions for the Collection object
- `\Exception`
- [`Phalcon\Support\Exception`](#supportexception)
- **`Phalcon\Support\Collection\Exception`**
- [`Phalcon\Support\Collection\Exceptions\ReadOnlyViolation`](#supportcollectionexceptionsreadonlyviolation)
__Uses__ `Phalcon\Support\Exception`
## Support\Collection\Exceptions\InvalidValueType
Class
Source on GitHub
- `InvalidArgumentException`
- **`Phalcon\Support\Collection\Exceptions\InvalidValueType`**
__Uses__ `InvalidArgumentException`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct(
string $type,
mixed $value
);
```
## Support\Collection\Exceptions\ReadOnlyViolation
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Support\Exception`](#supportexception)
- [`Phalcon\Support\Collection\Exception`](#supportcollectionexception)
- **`Phalcon\Support\Collection\Exceptions\ReadOnlyViolation`**
__Uses__ `Phalcon\Support\Collection\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Support\Collection\ReadOnlyCollection
Class
Source on GitHub
A read only Collection object
- [`Phalcon\Support\Collection`](#supportcollection)
- **`Phalcon\Support\Collection\ReadOnlyCollection`**
__Uses__ `Phalcon\Support\Collection` · `Phalcon\Support\Collection\Exceptions\ReadOnlyViolation`
### Method Summary
### Properties
protected
bool
$constructed = false
### Methods
Public · 7
__construct()
```php
public function __construct(
array $data = [],
bool $insensitive = true,
bool $strictNull = false,
string $type = null
);
```
ReadOnlyCollection constructor.
__unserialize()
```php
public function __unserialize( array $data ): void;
```
Restores the collection state during unserialization.
Temporarily disables the read-only guard so the parent class can restore
the collection state. The guard is re-enabled before the method returns.
clear()
```php
public function clear(): void;
```
init()
```php
public function init( array $data = [] ): void;
```
remove()
```php
public function remove( string $element ): void;
```
Delete the element from the collection
replace()
```php
public function replace( array $data ): void;
```
Replaces the collection data with a new array
set()
```php
public function set(
string $element,
mixed $value
): void;
```
Set an element in the collection
## Support\Debug
Class
Source on GitHub
Listens for uncaught exceptions and renders them. Acts as a thin coordinator
delegating data collection to ReportBuilder and presentation to a Renderer.
- **`Phalcon\Support\Debug`**
__Uses__ `Phalcon\Contracts\Support\Debug\Renderer` · `Phalcon\Support\Debug\Exceptions\RequestHalted` · `Phalcon\Support\Debug\Exceptions\RuntimeWarning` · `Phalcon\Support\Debug\Renderer\HtmlRenderer` · `Phalcon\Support\Debug\ReportBuilder` · `Phalcon\Traits\Support\Helper\Arr\GetTrait` · `ReflectionException` · `Throwable`
### Method Summary
### Properties
protected
array
$blacklist = [...]
protected
array
$data = []
protected
bool
$hideDocumentRoot = false
protected
bool
$isActive = false
protected
Renderer
$renderer
protected
ReportBuilder
$reportBuilder
protected
bool
$showBackTrace = true
protected
bool
$showFileFragment = false
protected
bool
$showFiles = true
protected
string
$uri = "https://assets.phalcon.io/debug/5.0.x/"
### Methods
Public · 20
__construct()
```php
public function __construct();
```
clearVars()
```php
public function clearVars(): static;
```
Clears are variables added previously
debugVar()
```php
public function debugVar( mixed $varz ): static;
```
Adds a variable to the debug output
getCssSources()
```php
public function getCssSources(): string;
```
Returns the CSS sources
getJsSources()
```php
public function getJsSources(): string;
```
Returns the JavaScript sources
getRenderer()
```php
public function getRenderer(): Renderer;
```
Returns the renderer used to produce the output
getVersion()
```php
public function getVersion(): string;
```
Generates a link to the current version documentation
halt()
```php
public function halt(): void;
```
Halts the request showing a backtrace
listen()
```php
public function listen(
bool $exceptions = true,
bool $lowSeverity = false
): static;
```
Listen for uncaught exceptions and non silent notices or warnings
listenExceptions()
```php
public function listenExceptions(): static;
```
Listen for uncaught exceptions
listenLowSeverity()
```php
public function listenLowSeverity(): static;
```
Listen for non silent notices or warnings
onUncaughtException()
```php
public function onUncaughtException( \Throwable $exception ): bool;
```
Handles uncaught exceptions
onUncaughtLowSeverity()
```php
public function onUncaughtLowSeverity(
mixed $severity,
mixed $message,
mixed $file,
mixed $line
): void;
```
Throws an exception when a notice or warning is raised
renderHtml()
```php
public function renderHtml( \Throwable $exception ): string;
```
Render exception to html format.
setBlacklist()
```php
public function setBlacklist( array $blacklist ): static;
```
Sets if files the exception's backtrace must be showed
setRenderer()
```php
public function setRenderer( Renderer $renderer ): static;
```
Sets the renderer used to produce the output
setShowBackTrace()
```php
public function setShowBackTrace( bool $showBackTrace ): static;
```
Sets if files the exception's backtrace must be showed
setShowFileFragment()
```php
public function setShowFileFragment( bool $showFileFragment ): static;
```
Sets if files must be completely opened and showed in the output
or just the fragment related to the exception
setShowFiles()
```php
public function setShowFiles( bool $showFiles ): static;
```
Set if files part of the backtrace must be shown in the output
setUri()
```php
public function setUri( string $uri ): static;
```
Change the base URI for static resources
## Support\Debug\Dump
Class
Source on GitHub
Dumps information about a variable(s)
```php
$foo = 123;
echo (new \Phalcon\Debug\Dump())->variable($foo, "foo");
```
```php
$foo = "string";
$bar = ["key" => "value"];
$baz = new stdClass();
echo (new \Phalcon\Debug\Dump())->variables($foo, $bar, $baz);
```
- **`Phalcon\Support\Debug\Dump`** - implements [`Phalcon\Contracts\Support\Debug\TemplateAware`](/5.17/api/phalcon_contracts/#contractssupportdebugtemplateaware)
__Uses__ `Phalcon\Contracts\Support\Debug\TemplateAware` · `Phalcon\Di\DiInterface` · `Phalcon\Support\Helper\Json\Encode` · `Reflection` · `ReflectionClass` · `ReflectionProperty` · `stdClass`
### Method Summary
### Properties
protected
bool
$detailed = false
protected
array
$methods = []
protected
array
$styles = []
protected
array
$templates = []
Template overrides keyed by name. @todo Move getTemplate()/setTemplate()/templates into a shared trait once Zephir supports traits (mirrors Phalcon\Support\Debug\Traits\TemplateAwareTrait in the PHP source).
### Methods
Public · 11
__construct()
```php
public function __construct(
array $styles = [],
bool $detailed = false
);
```
Phalcon\Debug\Dump constructor
all()
```php
public function all(): string;
```
Alias of variables() method
getDetailed()
```php
public function getDetailed(): bool;
```
getTemplate()
```php
public function getTemplate( string $name ): string;
```
Returns the template for the given name (override if set, default
otherwise).
one()
```php
public function one(
mixed $variable,
string $name = null
): string;
```
Alias of variable() method
setDetailed()
```php
public function setDetailed( bool $flag ): void;
```
setStyles()
```php
public function setStyles( array $styles = [] ): array;
```
Set styles for vars type
setTemplate()
```php
public function setTemplate(
string $name,
string $template
): static;
```
Overrides the template for the given name.
toJson()
```php
public function toJson( mixed $variable ): string;
```
Returns an JSON string of information about a single variable.
```php
$foo = [
"key" => "value",
];
echo (new \Phalcon\Debug\Dump())->toJson($foo);
$foo = new stdClass();
$foo->bar = "buz";
echo (new \Phalcon\Debug\Dump())->toJson($foo);
```
variable()
```php
public function variable(
mixed $variable,
string $name = null
): string;
```
Returns an HTML string of information about a single variable.
```php
echo (new \Phalcon\Debug\Dump())->variable($foo, "foo");
```
variables()
```php
public function variables(): string;
```
Returns an HTML string of debugging information about any number of
variables, each wrapped in a "pre" tag.
```php
$foo = "string";
$bar = ["key" => "value"];
$baz = new stdClass();
echo (new \Phalcon\Debug\Dump())->variables($foo, $bar, $baz);
```
Protected · 3
defaultTemplate()
```php
protected function defaultTemplate( string $name ): string;
```
Returns the embedded default template for the given name.
getStyle()
```php
protected function getStyle( string $type ): string;
```
Get style for type
output()
```php
protected function output(
mixed $variable,
string $name = null,
int $tab = 1
): string;
```
Prepare an HTML string of information about a single variable.
## Support\Debug\Exception
Class
Source on GitHub
Exceptions thrown in Phalcon\Debug will use this class
- `\Exception`
- [`Phalcon\Support\Exception`](#supportexception)
- **`Phalcon\Support\Debug\Exception`**
- [`Phalcon\Support\Debug\Exceptions\RequestHalted`](#supportdebugexceptionsrequesthalted)
__Uses__ `Phalcon\Support\Exception`
## Support\Debug\Exceptions\RequestHalted
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Support\Exception`](#supportexception)
- [`Phalcon\Support\Debug\Exception`](#supportdebugexception)
- **`Phalcon\Support\Debug\Exceptions\RequestHalted`**
__Uses__ `Phalcon\Support\Debug\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Support\Debug\Exceptions\RuntimeWarning
Class
Source on GitHub
- `\ErrorException`
- **`Phalcon\Support\Debug\Exceptions\RuntimeWarning`**
## Support\Debug\Renderer\HtmlRenderer
Class
Source on GitHub
Renders an ExceptionReport as the HTML debug page using embedded, overridable
template strings filled by strtr. All styling and interactivity (theme, tabs,
syntax highlighting, copy/editor links) are provided by the external
debug.css / debug.js assets.
- **`Phalcon\Support\Debug\Renderer\HtmlRenderer`** - implements [`Phalcon\Contracts\Support\Debug\Renderer`](/5.17/api/phalcon_contracts/#contractssupportdebugrenderer)
__Uses__ `Phalcon\Contracts\Support\Debug\Renderer` · `Phalcon\Support\Debug\Report\BacktraceItem` · `Phalcon\Support\Debug\Report\ExceptionReport` · `Phalcon\Support\Version`
### Method Summary
### Properties
protected
array
$templates = []
Template overrides keyed by name. @todo Move getTemplate()/setTemplate()/templates into a shared trait once Zephir supports traits (mirrors Phalcon\Support\Debug\Traits\TemplateAwareTrait in the PHP source).
### Methods
Public · 6
getCssSources()
```php
public function getCssSources( string $uri ): string;
```
getJsSources()
```php
public function getJsSources( string $uri ): string;
```
getTemplate()
```php
public function getTemplate( string $name ): string;
```
Returns the template for the given name (override if set, default
otherwise).
getVersion()
```php
public function getVersion(): string;
```
render()
```php
public function render( ExceptionReport $report ): string;
```
setTemplate()
```php
public function setTemplate(
string $name,
string $template
): static;
```
Overrides the template for the given name.
Protected · 4
defaultTemplate()
```php
protected function defaultTemplate( string $name ): string;
```
Returns the embedded default template for the given name.
escapeString()
```php
protected function escapeString( string $value ): string;
```
Escapes a string with htmlentities
getArrayDump()
```php
protected function getArrayDump(
array $argument,
int $number = 0
): string|null;
```
Produces a recursive representation of an array
getVarDump()
```php
protected function getVarDump( mixed $variable ): string;
```
Produces a string representation of a variable
## Support\Debug\ReportBuilder
Class
Source on GitHub
Collects the runtime data for an exception (backtrace, superglobals, included
files, memory, variables) into an ExceptionReport. Holds no presentation
logic.
- **`Phalcon\Support\Debug\ReportBuilder`**
__Uses__ `Phalcon\Support\Debug\Report\BacktraceItem` · `Phalcon\Support\Debug\Report\ExceptionReport` · `Phalcon\Traits\Php\InfoTrait` · `Phalcon\Traits\Support\Helper\Arr\GetTrait` · `ReflectionClass` · `ReflectionException` · `ReflectionFunction` · `Throwable`
### Method Summary
### Methods
Public · 1
build()
```php
public function build(
\Throwable $exception,
array $blacklist,
bool $showBackTrace,
bool $showFiles,
bool $showFileFragment,
string $uri,
array $data
): ExceptionReport;
```
## Support\Debug\Report\BacktraceItem
Final
Source on GitHub
Represents a single resolved frame of an exception backtrace.
- **`Phalcon\Support\Debug\Report\BacktraceItem`**
### Method Summary
### Properties
protected
array
$args = []
protected
string|null
$classLink = null
protected
string|null
$className = null
protected
string|null
$file = null
protected
array|null
$fragment = null
protected
string|null
$functionLink = null
protected
string
$functionName
protected
bool
$hasArgs = false
protected
int|null
$line = null
protected
string|null
$type = null
### Methods
Public · 11
__construct()
```php
public function __construct(
string $functionName,
mixed $type = null,
mixed $className = null,
mixed $classLink = null,
mixed $functionLink = null,
bool $hasArgs = false,
array $args = [],
mixed $file = null,
mixed $line = null,
mixed $fragment = null
);
```
getArgs()
```php
public function getArgs(): array;
```
getClassLink()
```php
public function getClassLink(): string|null;
```
getClassName()
```php
public function getClassName(): string|null;
```
getFile()
```php
public function getFile(): string|null;
```
getFragment()
```php
public function getFragment(): array|null;
```
getFunctionLink()
```php
public function getFunctionLink(): string|null;
```
getFunctionName()
```php
public function getFunctionName(): string;
```
getLine()
```php
public function getLine(): int|null;
```
getType()
```php
public function getType(): string|null;
```
hasArgs()
```php
public function hasArgs(): bool;
```
## Support\Debug\Report\ExceptionReport
Final
Source on GitHub
Carries all data collected for an exception, ready to be rendered. Holds no
presentation logic.
- **`Phalcon\Support\Debug\Report\ExceptionReport`**
### Method Summary
### Properties
protected
BacktraceItem[]
$backtrace = []
protected
string
$className
protected
string
$file
protected
array
$includedFiles = []
protected
int
$line
protected
int
$memoryUsage = 0
protected
string
$message
protected
int
$peakMemoryUsage = 0
protected
array
$request = []
protected
array
$server = []
protected
bool
$showBackTrace
protected
string
$uri
protected
array
$variables = []
### Methods
Public · 22
__construct()
```php
public function __construct(
string $className,
string $message,
string $file,
int $line,
bool $showBackTrace,
string $uri
);
```
getBacktrace()
```php
public function getBacktrace(): array;
```
getClassName()
```php
public function getClassName(): string;
```
getFile()
```php
public function getFile(): string;
```
getIncludedFiles()
```php
public function getIncludedFiles(): array;
```
getLine()
```php
public function getLine(): int;
```
getMemoryUsage()
```php
public function getMemoryUsage(): int;
```
getMessage()
```php
public function getMessage(): string;
```
getPeakMemoryUsage()
```php
public function getPeakMemoryUsage(): int;
```
getRequest()
```php
public function getRequest(): array;
```
getServer()
```php
public function getServer(): array;
```
getUri()
```php
public function getUri(): string;
```
getVariables()
```php
public function getVariables(): array;
```
hasVariables()
```php
public function hasVariables(): bool;
```
isShowBackTrace()
```php
public function isShowBackTrace(): bool;
```
setBacktrace()
```php
public function setBacktrace( array $backtrace ): static;
```
setIncludedFiles()
```php
public function setIncludedFiles( array $includedFiles ): static;
```
setMemoryUsage()
```php
public function setMemoryUsage( int $memoryUsage ): static;
```
setPeakMemoryUsage()
```php
public function setPeakMemoryUsage( int $peakMemoryUsage ): static;
```
setRequest()
```php
public function setRequest( array $request ): static;
```
setServer()
```php
public function setServer( array $server ): static;
```
setVariables()
```php
public function setVariables( array $variables ): static;
```
## Support\Exception
Class
Source on GitHub
Exceptions thrown in Phalcon\Support will use this class
- `\Exception`
- **`Phalcon\Support\Exception`**
- [`Phalcon\Support\Collection\Exception`](#supportcollectionexception)
- [`Phalcon\Support\Debug\Exception`](#supportdebugexception)
- [`Phalcon\Support\Helper\Exception`](#supporthelperexception)
## Support\HelperFactory
Class
Source on GitHub
ServiceLocator implementation for helpers
@method string basename(string $uri, string $suffix = null)
@method array blacklist(array $collection, array $blackList)
@method string camelize(string $text, string $delimiters = null, bool $lowerFirst = false)
@method array chunk(array $collection, int $size, bool $preserveKeys = false)
@method string concat(string $delimiter, string $first, string $second, string ...$arguments)
@method int countVowels(string $text)
@method string decapitalize(string $text, bool $upperRest = false, string $encoding = 'UTF-8')
@method string decode(string $data, bool $associative = false, int $depth = 512, int $options = 0)
@method string decrement(string $text, string $separator = '_')
@method string dirFromFile(string $file)
@method string dirSeparator(string $directory)
@method string dynamic(string $text, string $leftDel = "\{", string $rightDel = "\}", string $separator = "|")
@method string encode($data, int $options = 0, int $depth = 512)
@method bool endsWith(string $haystack, string $needle, bool $ignoreCase = true)
@method mixed filter(array $collection, callable|null $method)
@method mixed first(array $collection, callable $method = null)
@method string firstBetween(string $text, string $start, string $end)
@method mixed firstKey(array $collection, callable $method = null)
@method string friendly(string $text, string $separator = '-', bool $lowercase = true, $replace = null)
@method array flatten(array $collection, bool $deep = false)
@method mixed get(array $collection, $index, $defaultValue = null, string $cast = null)
@method array group(array $collection, $method)
@method bool has(array $collection, $index)
@method string humanize(string $text)
@method bool includes(string $haystack, string $needle)
@method string increment(string $text, string $separator = '_')
@method string interpolate(string $message, array $context = [], string $leftToken = "%", string $rightToken = "%")
@method bool isAnagram(string $first, string $second)
@method bool isBetween(int $value, int $start, int $end)
@method bool isLower(string $text, string $encoding = 'UTF-8')
@method bool isPalindrome(string $text)
@method bool isUnique(array $collection)
@method bool isUpper(string $text, string $encoding = 'UTF-8')
@method string kebabCase(string $text, string $delimiters = null)
@method mixed last(array $collection, callable $method = null)
@method mixed lastKey(array $collection, callable $method = null)
@method int len(string $text, string $encoding = 'UTF-8')
@method string lower(string $text, string $encoding = 'UTF-8')
@method array order(array $collection, $attribute, string $order = 'asc')
@method string pascalCase(string $text, string $delimiters = null)
@method array pluck(array $collection, string $element)
@method string prefix(string $text, string $prefix)
@method string random(int $type = 0, int $length = 8)
@method string reduceSlashes(string $text)
@method array set(array $collection, $value, $index = null)
@method array sliceLeft(array $collection, int $elements = 1)
@method array sliceRight(array $collection, int $elements = 1)
@method string snakeCase(string $text, string $delimiters = null)
@method array split(array $collection)
@method bool startsWith(string $haystack, string $needle, bool $ignoreCase = true)
@method string suffix($text, string $suffix)
@method object toObject(array $collection)
@method bool validateAll(array $collection, callable $method)
@method bool validateAny(array $collection, callable $method)
@method string ucwords(string $text, string $encoding = 'UTF-8')
@method string uncamelize(string $text, string $delimiters = '_')
@method string underscore(string $text)
@method string upper(string $text, string $encoding = 'UTF-8')
@method array whitelist(array $collection, array $whiteList)
- [`Phalcon\Factory\AbstractConfigFactory`](/5.17/api/phalcon_factory/#factoryabstractconfigfactory)
- [`Phalcon\Factory\AbstractFactory`](/5.17/api/phalcon_factory/#factoryabstractfactory)
- **`Phalcon\Support\HelperFactory`**
__Uses__ `Phalcon\Factory\AbstractFactory`
### Method Summary
### Methods
Public · 3
__call()
```php
public function __call(
string $name,
array $arguments
);
```
__construct()
```php
public function __construct( array $services = [] );
```
FactoryTrait constructor.
newInstance()
```php
public function newInstance( string $name );
```
Protected · 2
getExceptionClass()
```php
protected function getExceptionClass(): string;
```
getServices()
```php
protected function getServices(): array;
```
Returns the available adapters
## Support\Helper\Arr\AbstractArr
Abstract
Source on GitHub
@internal
@todo Remove in v7. Kept only for backwards compatibility; compose
Phalcon\Traits\Support\Helper\Arr\FilterTrait directly instead of extending
this.
- **`Phalcon\Support\Helper\Arr\AbstractArr`**
- [`Phalcon\Support\Helper\Arr\Blacklist`](#supporthelperarrblacklist)
- [`Phalcon\Support\Helper\Arr\Filter`](#supporthelperarrfilter)
- [`Phalcon\Support\Helper\Arr\First`](#supporthelperarrfirst)
- [`Phalcon\Support\Helper\Arr\FirstKey`](#supporthelperarrfirstkey)
- [`Phalcon\Support\Helper\Arr\Last`](#supporthelperarrlast)
- [`Phalcon\Support\Helper\Arr\LastKey`](#supporthelperarrlastkey)
- [`Phalcon\Support\Helper\Arr\ValidateAll`](#supporthelperarrvalidateall)
- [`Phalcon\Support\Helper\Arr\ValidateAny`](#supporthelperarrvalidateany)
- [`Phalcon\Support\Helper\Arr\Whitelist`](#supporthelperarrwhitelist)
__Uses__ `Phalcon\Traits\Support\Helper\Arr\FilterTrait`
## Support\Helper\Arr\Blacklist
Class
Source on GitHub
Black list filter by key: exclude elements of an array
by the keys obtained from the elements of a blacklist
- [`Phalcon\Support\Helper\Arr\AbstractArr`](#supporthelperarrabstractarr)
- **`Phalcon\Support\Helper\Arr\Blacklist`**
### Method Summary
### Methods
Public · 1
__invoke()
```php
public function __invoke(
array $collection,
array $blackList
): array;
```
## Support\Helper\Arr\Chunk
Class
Source on GitHub
Chunks an array into smaller arrays of a specified size.
- **`Phalcon\Support\Helper\Arr\Chunk`**
### Method Summary
### Methods
Public · 1
__invoke()
```php
public function __invoke(
array $collection,
int $size,
bool $preserveKeys = false
): array;
```
## Support\Helper\Arr\Filter
Class
Source on GitHub
Filters a collection using array_filter and using the callable (if defined)
- [`Phalcon\Support\Helper\Arr\AbstractArr`](#supporthelperarrabstractarr)
- **`Phalcon\Support\Helper\Arr\Filter`**
### Method Summary
### Methods
Public · 1
__invoke()
```php
public function __invoke(
array $collection,
mixed $method = null
): mixed;
```
## Support\Helper\Arr\First
Class
Source on GitHub
Returns the first element of the collection. If a callable is passed, the
element returned is the first that validates true
- [`Phalcon\Support\Helper\Arr\AbstractArr`](#supporthelperarrabstractarr)
- **`Phalcon\Support\Helper\Arr\First`**
### Method Summary
### Methods
Public · 1
__invoke()
```php
public function __invoke(
array $collection,
mixed $method = null
): mixed;
```
## Support\Helper\Arr\FirstKey
Class
Source on GitHub
Returns the key of the first element of the collection. If a callable
is passed, the element returned is the first that validates true
- [`Phalcon\Support\Helper\Arr\AbstractArr`](#supporthelperarrabstractarr)
- **`Phalcon\Support\Helper\Arr\FirstKey`**
### Method Summary
### Methods
Public · 1
__invoke()
```php
public function __invoke(
array $collection,
mixed $method = null
): mixed;
```
## Support\Helper\Arr\Flatten
Class
Source on GitHub
Flattens an array up to the one level depth, unless `$deep` is set to
`true`
- **`Phalcon\Support\Helper\Arr\Flatten`**
### Method Summary
### Methods
Public · 1
__invoke()
```php
public function __invoke(
array $collection,
bool $deep = false
): array;
```
## Support\Helper\Arr\Get
Class
Source on GitHub
Gets an array element by key and if it does not exist returns the default.
It also allows for casting the returned value to a specific type using
`settype` internally
- **`Phalcon\Support\Helper\Arr\Get`**
__Uses__ `Phalcon\Traits\Support\Helper\Arr\GetTrait`
### Method Summary
### Methods
Public · 1
__invoke()
```php
public function __invoke(
array $collection,
mixed $index,
mixed $defaultValue = null,
string $cast = null
): mixed;
```
## Support\Helper\Arr\Group
Class
Source on GitHub
Groups the elements of an array based on the passed callable
- **`Phalcon\Support\Helper\Arr\Group`**
__Uses__ `Phalcon\Traits\Php\InfoTrait`
### Method Summary
### Methods
Public · 1
__invoke()
```php
public function __invoke(
array $collection,
mixed $method
): array;
```
## Support\Helper\Arr\Has
Class
Source on GitHub
Checks an array if it has an element with a specific key and returns
`true`/`false` accordingly
- **`Phalcon\Support\Helper\Arr\Has`**
### Method Summary
### Methods
Public · 1
__invoke()
```php
public function __invoke(
array $collection,
mixed $index
): bool;
```
## Support\Helper\Arr\IsUnique
Class
Source on GitHub
Checks a flat list for duplicate values. Returns true if duplicate
values exist and false if values are all unique.
- **`Phalcon\Support\Helper\Arr\IsUnique`**
### Method Summary
### Methods
Public · 1
__invoke()
```php
public function __invoke( array $collection ): bool;
```
## Support\Helper\Arr\Last
Class
Source on GitHub
Returns the last element of the collection. If a callable is passed, the
element returned is the first that validates true
- [`Phalcon\Support\Helper\Arr\AbstractArr`](#supporthelperarrabstractarr)
- **`Phalcon\Support\Helper\Arr\Last`**
### Method Summary
### Methods
Public · 1
__invoke()
```php
public function __invoke(
array $collection,
mixed $method = null
): mixed;
```
## Support\Helper\Arr\LastKey
Class
Source on GitHub
Returns the key of the last element of the collection. If a callable is
passed, the element returned is the first that validates true
- [`Phalcon\Support\Helper\Arr\AbstractArr`](#supporthelperarrabstractarr)
- **`Phalcon\Support\Helper\Arr\LastKey`**
### Method Summary
### Methods
Public · 1
__invoke()
```php
public function __invoke(
array $collection,
mixed $method = null
): mixed;
```
## Support\Helper\Arr\Order
Class
Source on GitHub
Sorts a collection of arrays or objects by an attribute of the object. It
supports ascending/descending sorts but also flags that are identical to
the ones used by `ksort` and `krsort`
- **`Phalcon\Support\Helper\Arr\Order`**
### Method Summary
### Constants
int
ORDER_ASC = 1
int
ORDER_DESC = 2
### Methods
Public · 1
__invoke()
```php
public function __invoke(
array $collection,
mixed $attribute,
int $order = self::ORDER_ASC,
int $flags = 0
): array;
```
## Support\Helper\Arr\Pluck
Class
Source on GitHub
Returns a subset of the collection based on the values of the collection
- **`Phalcon\Support\Helper\Arr\Pluck`**
### Method Summary
### Methods
Public · 1
__invoke()
```php
public function __invoke(
array $collection,
string $element
): array;
```
## Support\Helper\Arr\Set
Class
Source on GitHub
Sets an array element. Using a key is optional
- **`Phalcon\Support\Helper\Arr\Set`**
### Method Summary
### Methods
Public · 1
__invoke()
```php
public function __invoke(
array $collection,
mixed $value,
mixed $index = null
): array;
```
## Support\Helper\Arr\SliceLeft
Class
Source on GitHub
Returns a new array with n elements removed from the left.
- **`Phalcon\Support\Helper\Arr\SliceLeft`**
### Method Summary
### Methods
Public · 1
__invoke()
```php
public function __invoke(
array $collection,
int $elements = 1
): array;
```
## Support\Helper\Arr\SliceRight
Class
Source on GitHub
Returns a new array with n elements removed from the right.
- **`Phalcon\Support\Helper\Arr\SliceRight`**
### Method Summary
### Methods
Public · 1
__invoke()
```php
public function __invoke(
array $collection,
int $elements = 1
): array;
```
## Support\Helper\Arr\Split
Class
Source on GitHub
Returns a new array with keys of the collection as one element and values
as another
- **`Phalcon\Support\Helper\Arr\Split`**
### Method Summary
### Methods
Public · 1
__invoke()
```php
public function __invoke( array $collection ): array;
```
## Support\Helper\Arr\ToObject
Class
Source on GitHub
Returns the passed array as an object.
- **`Phalcon\Support\Helper\Arr\ToObject`**
### Method Summary
### Methods
Public · 1
__invoke()
```php
public function __invoke( array $collection ): object;
```
## Support\Helper\Arr\ValidateAll
Class
Source on GitHub
Returns `true` if the provided function returns `true` for all elements of
the collection, `false` otherwise.
- [`Phalcon\Support\Helper\Arr\AbstractArr`](#supporthelperarrabstractarr)
- **`Phalcon\Support\Helper\Arr\ValidateAll`**
### Method Summary
### Methods
Public · 1
__invoke()
```php
public function __invoke(
array $collection,
mixed $method
): bool;
```
## Support\Helper\Arr\ValidateAny
Class
Source on GitHub
Returns `true` if the provided function returns `true` for at least one
element of the collection, `false` otherwise.
- [`Phalcon\Support\Helper\Arr\AbstractArr`](#supporthelperarrabstractarr)
- **`Phalcon\Support\Helper\Arr\ValidateAny`**
### Method Summary
### Methods
Public · 1
__invoke()
```php
public function __invoke(
array $collection,
mixed $method
): bool;
```
## Support\Helper\Arr\Whitelist
Class
Source on GitHub
White list filter by key: obtain elements of an array filtering by the keys
obtained from the elements of a whitelist
- [`Phalcon\Support\Helper\Arr\AbstractArr`](#supporthelperarrabstractarr)
- **`Phalcon\Support\Helper\Arr\Whitelist`**
### Method Summary
### Methods
Public · 1
__invoke()
```php
public function __invoke(
array $collection,
array $whiteList
): array;
```
## Support\Helper\Exception
Class
Source on GitHub
Exceptions thrown in Phalcon\Support\Helper will use this class
- `\Exception`
- [`Phalcon\Support\Exception`](#supportexception)
- **`Phalcon\Support\Helper\Exception`**
- [`Phalcon\Support\Helper\Str\Exceptions\InsufficientArguments`](#supporthelperstrexceptionsinsufficientarguments)
- [`Phalcon\Support\Helper\Str\Exceptions\InvalidReplaceFormat`](#supporthelperstrexceptionsinvalidreplaceformat)
__Uses__ `Phalcon\Support\Exception`
## Support\Helper\File\Basename
Class
Source on GitHub
Gets the filename from a given path, Same as PHP's `basename()` but has
non-ASCII support. PHP's `basename()` does not properly support streams or
filenames beginning with a non-US-ASCII character.
- **`Phalcon\Support\Helper\File\Basename`**
### Method Summary
### Methods
Public · 1
__invoke()
```php
public function __invoke(
string $uri,
string $suffix = null
): string;
```
@see https://bugs.php.net/bug.php?id=37738
## Support\Helper\Json\Decode
Class
Source on GitHub
Decodes a string using `json_decode` and throws an exception if the
JSON data cannot be decoded
The following options are used if none specified for json_encode
JSON_HEX_TAG, JSON_HEX_APOS, JSON_HEX_AMP, JSON_HEX_QUOT,
JSON_UNESCAPED_SLASHES
If JSON_THROW_ON_ERROR is defined in the options a JsonException will be
thrown in the case of an error. Otherwise, any error will throw
JsonDecodeError
- **`Phalcon\Support\Helper\Json\Decode`**
__Uses__ `Phalcon\Support\Helper\Json\Exceptions\JsonDecodeError` · `Phalcon\Traits\Support\Helper\Json\DecodeTrait`
### Method Summary
### Methods
Public · 1
__invoke()
```php
public function __invoke(
string $data,
bool $associative = false,
int $depth = 512,
int $options = 79
);
```
## Support\Helper\Json\Encode
Class
Source on GitHub
Encodes a string using `json_encode` and throws an exception if the
JSON data cannot be encoded
The following options are used if none specified for json_encode
JSON_HEX_TAG, JSON_HEX_APOS, JSON_HEX_AMP, JSON_HEX_QUOT,
JSON_UNESCAPED_SLASHES
If JSON_THROW_ON_ERROR is defined in the options a JsonException will be
thrown in the case of an error. Otherwise, any error will throw
JsonEncodeError
@see https://www.ietf.org/rfc/rfc4627.txt
- **`Phalcon\Support\Helper\Json\Encode`**
__Uses__ `Phalcon\Support\Helper\Json\Exceptions\JsonEncodeError` · `Phalcon\Traits\Support\Helper\Json\EncodeTrait`
### Method Summary
### Methods
Public · 1
__invoke()
```php
public function __invoke(
mixed $data,
int $options = 79,
int $depth = 512
): string;
```
## Support\Helper\Json\Exceptions\JsonDecodeError
Class
Source on GitHub
- `InvalidArgumentException`
- **`Phalcon\Support\Helper\Json\Exceptions\JsonDecodeError`**
__Uses__ `InvalidArgumentException` · `Throwable`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct(
string $message = "",
int $code = 0,
Throwable $previous = null
);
```
## Support\Helper\Json\Exceptions\JsonEncodeError
Class
Source on GitHub
- `InvalidArgumentException`
- **`Phalcon\Support\Helper\Json\Exceptions\JsonEncodeError`**
__Uses__ `InvalidArgumentException` · `Throwable`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct(
string $message = "",
int $code = 0,
Throwable $previous = null
);
```
## Support\Helper\Number\IsBetween
Class
Source on GitHub
Checks if a number is within a range
- **`Phalcon\Support\Helper\Number\IsBetween`**
### Method Summary
### Methods
Public · 1
__invoke()
```php
public function __invoke(
int $value,
int $start,
int $end
): bool;
```
## Support\Helper\Str\AbstractStr
Abstract
Source on GitHub
Abstract class offering methods to help with the Str namespace.
@internal
@todo Remove in v7. Kept only for backwards compatibility; compose the
individual Phalcon\Traits\Support\Helper\Str\* traits directly instead
of extending this.
- **`Phalcon\Support\Helper\Str\AbstractStr`**
- [`Phalcon\Support\Helper\Str\Concat`](#supporthelperstrconcat)
- [`Phalcon\Support\Helper\Str\Decapitalize`](#supporthelperstrdecapitalize)
- [`Phalcon\Support\Helper\Str\EndsWith`](#supporthelperstrendswith)
- [`Phalcon\Support\Helper\Str\Friendly`](#supporthelperstrfriendly)
- [`Phalcon\Support\Helper\Str\IsLower`](#supporthelperstrislower)
- [`Phalcon\Support\Helper\Str\IsUpper`](#supporthelperstrisupper)
- [`Phalcon\Support\Helper\Str\Lower`](#supporthelperstrlower)
- [`Phalcon\Support\Helper\Str\StartsWith`](#supporthelperstrstartswith)
- [`Phalcon\Support\Helper\Str\Upper`](#supporthelperstrupper)
__Uses__ `Phalcon\Traits\Support\Helper\Str\EndsWithTrait` · `Phalcon\Traits\Support\Helper\Str\InterpolateTrait` · `Phalcon\Traits\Support\Helper\Str\LowerTrait` · `Phalcon\Traits\Support\Helper\Str\StartsWithTrait` · `Phalcon\Traits\Support\Helper\Str\UpperTrait`
## Support\Helper\Str\Camelize
Class
Source on GitHub
Converts strings to upperCamelCase or lowerCamelCase
- **`Phalcon\Support\Helper\Str\Camelize`**
__Uses__ `Phalcon\Traits\Support\Helper\Str\CamelizeTrait`
### Method Summary
### Methods
Public · 1
__invoke()
```php
public function __invoke(
string $text,
string $delimiters = null,
bool $lowerFirst = false
): string;
```
## Support\Helper\Str\Concat
Class
Source on GitHub
Concatenates strings using the separator only once without duplication in
places concatenation
- [`Phalcon\Support\Helper\Str\AbstractStr`](#supporthelperstrabstractstr)
- **`Phalcon\Support\Helper\Str\Concat`**
__Uses__ `Phalcon\Support\Helper\Str\Exceptions\InsufficientArguments`
### Method Summary
### Methods
Public · 1
__invoke()
```php
public function __invoke(
string $delimiter,
string $many
): string;
```
## Support\Helper\Str\CountVowels
Class
Source on GitHub
Returns number of vowels in provided string. Uses a regular expression
to count the number of vowels (A, E, I, O, U) in a string.
- **`Phalcon\Support\Helper\Str\CountVowels`**
### Method Summary
### Methods
Public · 1
__invoke()
```php
public function __invoke( string $text ): int;
```
## Support\Helper\Str\Decapitalize
Class
Source on GitHub
Decapitalizes the first letter of the string and then adds it with rest
of the string. Omit the upperRest parameter to keep the rest of the
string intact, or set it to true to convert to uppercase.
- [`Phalcon\Support\Helper\Str\AbstractStr`](#supporthelperstrabstractstr)
- **`Phalcon\Support\Helper\Str\Decapitalize`**
### Method Summary
### Methods
Public · 1
__invoke()
```php
public function __invoke(
string $text,
bool $upperRest = false,
string $encoding = "UTF-8"
): string;
```
## Support\Helper\Str\Decrement
Class
Source on GitHub
Removes a number from the end of a string or decrements that number if it
is already defined
- **`Phalcon\Support\Helper\Str\Decrement`**
### Method Summary
### Methods
Public · 1
__invoke()
```php
public function __invoke(
string $text,
string $separator = "_"
): string;
```
## Support\Helper\Str\DirFromFile
Class
Source on GitHub
Accepts a file name (without extension) and returns a calculated
directory structure with the filename in the end
- **`Phalcon\Support\Helper\Str\DirFromFile`**
__Uses__ `Phalcon\Traits\Support\Helper\Str\DirFromFileTrait`
### Method Summary
### Methods
Public · 1
__invoke()
```php
public function __invoke( string $file ): string;
```
## Support\Helper\Str\DirSeparator
Class
Source on GitHub
Accepts a directory name and ensures that it ends with
DIRECTORY_SEPARATOR
- **`Phalcon\Support\Helper\Str\DirSeparator`**
__Uses__ `Phalcon\Traits\Support\Helper\Str\DirSeparatorTrait`
### Method Summary
### Methods
Public · 1
__invoke()
```php
public function __invoke( string $directory ): string;
```
## Support\Helper\Str\Dynamic
Class
Source on GitHub
Generates random text in accordance with the template. The template is
defined by the left and right delimiter and it can contain values separated
by the separator
- **`Phalcon\Support\Helper\Str\Dynamic`**
__Uses__ `Phalcon\Support\Helper\Str\Exceptions\SyntaxError`
### Method Summary
### Methods
Public · 1
__invoke()
```php
public function __invoke(
string $text,
string $leftDelimiter = "{",
string $rightDelimiter = "}",
string $separator = "|"
): string;
```
## Support\Helper\Str\EndsWith
Class
Source on GitHub
Check if a string ends with a given string
- [`Phalcon\Support\Helper\Str\AbstractStr`](#supporthelperstrabstractstr)
- **`Phalcon\Support\Helper\Str\EndsWith`**
### Method Summary
### Methods
Public · 1
__invoke()
```php
public function __invoke(
string $haystack,
string $needle,
bool $ignoreCase = true
): bool;
```
## Support\Helper\Str\Exceptions\InsufficientArguments
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Support\Exception`](#supportexception)
- [`Phalcon\Support\Helper\Exception`](#supporthelperexception)
- **`Phalcon\Support\Helper\Str\Exceptions\InsufficientArguments`**
__Uses__ `Phalcon\Support\Helper\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Support\Helper\Str\Exceptions\InvalidReplaceFormat
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Support\Exception`](#supportexception)
- [`Phalcon\Support\Helper\Exception`](#supporthelperexception)
- **`Phalcon\Support\Helper\Str\Exceptions\InvalidReplaceFormat`**
__Uses__ `Phalcon\Support\Helper\Exception`
## Support\Helper\Str\Exceptions\SyntaxError
Class
Source on GitHub
- `RuntimeException`
- **`Phalcon\Support\Helper\Str\Exceptions\SyntaxError`**
__Uses__ `RuntimeException`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct( string $text );
```
## Support\Helper\Str\FirstBetween
Class
Source on GitHub
Returns the first string there is between the strings from the
parameter start and end.
- **`Phalcon\Support\Helper\Str\FirstBetween`**
### Method Summary
### Methods
Public · 1
__invoke()
```php
public function __invoke(
string $text,
string $start,
string $end
): string;
```
## Support\Helper\Str\Friendly
Class
Source on GitHub
Changes a text to a URL friendly one. Replaces commonly known accented
characters with their Latin equivalents. If a `replace` string or array
is passed, it will also be used to replace those characters with a space.
- [`Phalcon\Support\Helper\Str\AbstractStr`](#supporthelperstrabstractstr)
- **`Phalcon\Support\Helper\Str\Friendly`**
__Uses__ `Phalcon\Support\Helper\Str\Exceptions\InvalidReplaceFormat`
### Method Summary
### Methods
Public · 1
__invoke()
```php
public function __invoke(
string $text,
string $separator = "-",
bool $lowercase = true,
mixed $replace = null
): string;
```
## Support\Helper\Str\Humanize
Class
Source on GitHub
Makes an underscored or dashed text human-readable
- **`Phalcon\Support\Helper\Str\Humanize`**
### Method Summary
### Methods
Public · 1
__invoke()
```php
public function __invoke( string $text ): string;
```
## Support\Helper\Str\Includes
Class
Source on GitHub
Determines whether a string includes another string or not.
- **`Phalcon\Support\Helper\Str\Includes`**
### Method Summary
### Methods
Public · 1
__invoke()
```php
public function __invoke(
string $haystack,
string $needle
): bool;
```
## Support\Helper\Str\Increment
Class
Source on GitHub
Adds a number to the end of a string or increments that number if it
is already defined
- **`Phalcon\Support\Helper\Str\Increment`**
### Method Summary
### Methods
Public · 1
__invoke()
```php
public function __invoke(
string $text,
string $separator = "_"
): string;
```
## Support\Helper\Str\Interpolate
Class
Source on GitHub
Interpolates context values into the message placeholders. By default, the
right and left tokens are `%`
@see https://www.php-fig.org/psr/psr-3/ Section 1.2 Message
- **`Phalcon\Support\Helper\Str\Interpolate`**
__Uses__ `Phalcon\Traits\Support\Helper\Str\InterpolateTrait`
### Method Summary
### Methods
Public · 1
__invoke()
```php
public function __invoke(
string $message,
array $context = [],
string $leftToken = "%",
string $rightToken = "%"
): string;
```
## Support\Helper\Str\IsAnagram
Class
Source on GitHub
Compare two strings and returns `true` if both strings are anagram,
`false` otherwise.
- **`Phalcon\Support\Helper\Str\IsAnagram`**
### Method Summary
### Methods
Public · 1
__invoke()
```php
public function __invoke(
string $first,
string $second
): bool;
```
## Support\Helper\Str\IsLower
Class
Source on GitHub
Returns `true` if the given string is in lower case, `false` otherwise.
- [`Phalcon\Support\Helper\Str\AbstractStr`](#supporthelperstrabstractstr)
- **`Phalcon\Support\Helper\Str\IsLower`**
### Method Summary
### Methods
Public · 1
__invoke()
```php
public function __invoke(
string $text,
string $encoding = "UTF-8"
): bool;
```
## Support\Helper\Str\IsPalindrome
Class
Source on GitHub
Returns `true` if the given string is a palindrome, `false` otherwise.
- **`Phalcon\Support\Helper\Str\IsPalindrome`**
### Method Summary
### Methods
Public · 1
__invoke()
```php
public function __invoke( string $text ): bool;
```
## Support\Helper\Str\IsUpper
Class
Source on GitHub
Returns `true` if the given string is in upper case, `false` otherwise.
- [`Phalcon\Support\Helper\Str\AbstractStr`](#supporthelperstrabstractstr)
- **`Phalcon\Support\Helper\Str\IsUpper`**
### Method Summary
### Methods
Public · 1
__invoke()
```php
public function __invoke(
string $text,
string $encoding = "UTF-8"
): bool;
```
## Support\Helper\Str\KebabCase
Class
Source on GitHub
Converts strings to kebab-case style
- [`Phalcon\Support\Helper\Str\PascalCase`](#supporthelperstrpascalcase)
- **`Phalcon\Support\Helper\Str\KebabCase`**
### Method Summary
### Methods
Public · 1
__invoke()
```php
public function __invoke(
string $text,
string $delimiters = null
): string;
```
## Support\Helper\Str\Len
Class
Source on GitHub
Calculates the length of the string using `mb_strlen`
- **`Phalcon\Support\Helper\Str\Len`**
### Method Summary
### Methods
Public · 1
__invoke()
```php
public function __invoke(
string $text,
string $encoding = "UTF-8"
): int;
```
## Support\Helper\Str\Lower
Class
Source on GitHub
Converts a string to lowercase using mbstring
- [`Phalcon\Support\Helper\Str\AbstractStr`](#supporthelperstrabstractstr)
- **`Phalcon\Support\Helper\Str\Lower`**
### Method Summary
### Methods
Public · 1
__invoke()
```php
public function __invoke(
string $text,
string $encoding = "UTF-8"
): string;
```
## Support\Helper\Str\PascalCase
Class
Source on GitHub
Converts strings to PascalCase style
- **`Phalcon\Support\Helper\Str\PascalCase`**
- [`Phalcon\Support\Helper\Str\KebabCase`](#supporthelperstrkebabcase)
- [`Phalcon\Support\Helper\Str\SnakeCase`](#supporthelperstrsnakecase)
### Method Summary
### Methods
Public · 1
__invoke()
```php
public function __invoke(
string $text,
string $delimiters = null
): string;
```
Protected · 1
processArray()
```php
protected function processArray(
string $text,
string $delimiters = null
): array;
```
## Support\Helper\Str\Prefix
Class
Source on GitHub
Prefixes the text with the supplied prefix
- **`Phalcon\Support\Helper\Str\Prefix`**
### Method Summary
### Methods
Public · 1
__invoke()
```php
public function __invoke(
mixed $text,
string $prefix
): string;
```
## Support\Helper\Str\Random
Class
Source on GitHub
Generates a random string based on the given type. Type is one of the
RANDOM_* constants
- **`Phalcon\Support\Helper\Str\Random`**
### Method Summary
### Constants
int
RANDOM_ALNUM = 0
Only alphanumeric characters [a-zA-Z0-9]
int
RANDOM_ALPHA = 1
Only alphabetical characters [azAZ]
int
RANDOM_DISTINCT = 5
Only alphanumeric uppercase characters exclude similar characters [2345679ACDEFHJKLMNPRSTUVWXYZ]
int
RANDOM_HEXDEC = 2
Only hexadecimal characters [0-9a-f]
int
RANDOM_NOZERO = 4
Only numbers without 0 [1-9]
int
RANDOM_NUMERIC = 3
Only numbers [0-9]
### Methods
Public · 1
__invoke()
```php
public function __invoke(
int $type = self::RANDOM_ALNUM,
int $length = 8
): string;
```
## Support\Helper\Str\ReduceSlashes
Class
Source on GitHub
Reduces multiple slashes in a string to single slashes
- **`Phalcon\Support\Helper\Str\ReduceSlashes`**
### Method Summary
### Methods
Public · 1
__invoke()
```php
public function __invoke( string $text ): string;
```
## Support\Helper\Str\SnakeCase
Class
Source on GitHub
Converts strings to snake_case style
- [`Phalcon\Support\Helper\Str\PascalCase`](#supporthelperstrpascalcase)
- **`Phalcon\Support\Helper\Str\SnakeCase`**
### Method Summary
### Methods
Public · 1
__invoke()
```php
public function __invoke(
string $text,
string $delimiters = null
): string;
```
## Support\Helper\Str\StartsWith
Class
Source on GitHub
Check if a string starts with a given string
- [`Phalcon\Support\Helper\Str\AbstractStr`](#supporthelperstrabstractstr)
- **`Phalcon\Support\Helper\Str\StartsWith`**
### Method Summary
### Methods
Public · 1
__invoke()
```php
public function __invoke(
string $haystack,
string $needle,
bool $ignoreCase = true
): bool;
```
## Support\Helper\Str\Suffix
Class
Source on GitHub
Suffixes the text with the supplied suffix
- **`Phalcon\Support\Helper\Str\Suffix`**
### Method Summary
### Methods
Public · 1
__invoke()
```php
public function __invoke(
mixed $text,
string $suffix
): string;
```
## Support\Helper\Str\Ucwords
Class
Source on GitHub
Capitalizes the first letter of each word
- **`Phalcon\Support\Helper\Str\Ucwords`**
### Method Summary
### Methods
Public · 1
__invoke()
```php
public function __invoke(
string $text,
string $encoding = "UTF-8"
): string;
```
## Support\Helper\Str\Uncamelize
Class
Source on GitHub
Converts strings to non camelized style
- **`Phalcon\Support\Helper\Str\Uncamelize`**
__Uses__ `Phalcon\Traits\Support\Helper\Str\UncamelizeTrait`
### Method Summary
### Methods
Public · 1
__invoke()
```php
public function __invoke(
string $text,
string $delimiter = "_"
): string;
```
## Support\Helper\Str\Underscore
Class
Source on GitHub
Makes a text underscored instead of spaced
- **`Phalcon\Support\Helper\Str\Underscore`**
### Method Summary
### Methods
Public · 1
__invoke()
```php
public function __invoke( string $text ): string;
```
## Support\Helper\Str\Upper
Class
Source on GitHub
Converts a string to uppercase using mbstring
- [`Phalcon\Support\Helper\Str\AbstractStr`](#supporthelperstrabstractstr)
- **`Phalcon\Support\Helper\Str\Upper`**
### Method Summary
### Methods
Public · 1
__invoke()
```php
public function __invoke(
string $text,
string $encoding = "UTF-8"
): string;
```
## Support\Registry
Final
Source on GitHub
A registry is a container for storing objects and values in the application
space. By storing the value in a registry, the same object is always
available throughout your application.
```php
$registry = new \Phalcon\Registry();
// Set value
$registry->something = "something";
// or
$registry["something"] = "something";
// Get value
$value = $registry->something;
// or
$value = $registry["something"];
// Check if the key exists
$exists = isset($registry->something);
// or
$exists = isset($registry["something"]);
// Unset
unset($registry->something);
// or
unset($registry["something"]);
```
In addition to ArrayAccess, Phalcon\Registry also implements Countable
(count($registry) will return the number of elements in the registry),
Serializable and Iterator (you can iterate over the registry using a foreach
loop) interfaces. For PHP 5.4 and higher, JsonSerializable interface is
implemented.
Phalcon\Registry is very fast (it is typically faster than any userspace
implementation of the registry); however, this comes at a price:
Phalcon\Registry is a final class and cannot be inherited from.
Though Phalcon\Registry exposes methods like __get(), offsetGet(), count() etc,
it is not recommended to invoke them manually (these methods exist mainly to
match the interfaces the registry implements): $registry->__get("property")
is several times slower than $registry->property.
Internally all the magic methods (and interfaces except JsonSerializable)
are implemented using object handlers or similar techniques: this allows to
bypass relatively slow method calls.
- [`Phalcon\Support\Collection`](#supportcollection)
- **`Phalcon\Support\Registry`**
__Uses__ `Phalcon\Support\Collection` · `Traversable`
### Method Summary
### Methods
Public · 22
__construct()
```php
final public function __construct( array $data = [] );
```
Constructor
__get()
```php
final public function __get( string $element ): mixed;
```
Magic getter to get an element from the collection
__isset()
```php
final public function __isset( string $element ): bool;
```
Magic isset to check whether an element exists or not
__set()
```php
final public function __set(
string $element,
mixed $value
): void;
```
Magic setter to assign values to an element
__unset()
```php
final public function __unset( string $element ): void;
```
Magic unset to remove an element from the collection
clear()
```php
final public function clear(): void;
```
Clears the internal collection
count()
```php
final public function count(): int;
```
Count elements of an object
@link https://php.net/manual/en/countable.count.php
get()
```php
final public function get(
string $element,
mixed $defaultValue = null,
string $cast = null
): mixed;
```
Get the element from the collection
getIterator()
```php
final public function getIterator(): Traversable;
```
Returns the iterator of the class
has()
```php
final public function has( string $element ): bool;
```
Determines whether an element is present in the collection.
init()
```php
final public function init( array $data = [] ): void;
```
Initialize internal array
jsonSerialize()
```php
final public function jsonSerialize(): array;
```
Specify data which should be serialized to JSON
@link https://php.net/manual/en/jsonserializable.jsonserialize.php
offsetExists()
```php
final public function offsetExists( mixed $element ): bool;
```
Whether a offset exists
@link https://php.net/manual/en/arrayaccess.offsetexists.php
offsetGet()
```php
final public function offsetGet( mixed $element ): mixed;
```
Offset to retrieve
@link https://php.net/manual/en/arrayaccess.offsetget.php
offsetSet()
```php
final public function offsetSet(
mixed $element,
mixed $value
): void;
```
Offset to set
@link https://php.net/manual/en/arrayaccess.offsetset.php
offsetUnset()
```php
final public function offsetUnset( mixed $element ): void;
```
Offset to unset
@link https://php.net/manual/en/arrayaccess.offsetunset.php
remove()
```php
final public function remove( string $element ): void;
```
Delete the element from the collection
serialize()
```php
final public function serialize(): string|null;
```
String representation of object
@link https://php.net/manual/en/serializable.serialize.php
set()
```php
final public function set(
string $element,
mixed $value
): void;
```
Set an element in the collection
toArray()
```php
final public function toArray(): array;
```
Returns the object in an array format
toJson()
```php
final public function toJson( int $options = 79 ): string;
```
Returns the object in a JSON format
The default string uses the following options for json_encode
JSON_HEX_TAG, JSON_HEX_APOS, JSON_HEX_AMP, JSON_HEX_QUOT, JSON_UNESCAPED_SLASHES
@see https://www.ietf.org/rfc/rfc4627.txt
unserialize()
```php
final public function unserialize( string $data ): void;
```
Constructs the object
@link https://php.net/manual/en/serializable.unserialize.php
## Support\Settings
Class
Source on GitHub
Phalcon\Support\Settings
Provides a PHP-userland layer for reading and overriding the Phalcon
extension's ini settings (orm.*, db.*, form.*).
get() checks PHP-level overrides first, then falls back to globals_get()
which reads the value configured in php.ini / .htaccess / per-virtualhost.
set() stores the value in the PHP-level overrides array only. It does NOT
call globals_set(), so the change is confined to this static state and never
modifies the underlying C struct. This prevents settings changed by one
project from leaking into another project sharing the same PHP worker process.
NOTE: In non-ZTS (non-thread-safe) PHP builds, globals_get() reads from a
process-level C struct. Because set() does not write to that struct, any
value set via ini_set("phalcon.orm.*", ...) or globals_set() by other code
remains visible through get() as the fallback for keys that have no
PHP-level override. In ZTS builds each thread has its own copy of the struct.
reset() clears only the keys that were previously set via set(), restoring
those keys to their globals_get() fallback values.
- **`Phalcon\Support\Settings`**
### Method Summary
### Properties
protected
array
$overrides
PHP-level overrides. Keys stored here take priority over globals_get().
### Methods
Public · 3
get()
```php
public static function get( string $key ): mixed;
```
Returns the value of a known setting.
Resolution order:
1. PHP-level override (set via Settings::set())
2. globals_get() - the C-level value, honoring php.ini / .htaccess
3. null - for unknown keys
reset()
```php
public static function reset(): void;
```
Clears all PHP-level overrides, restoring get() to return globals_get()
fallback values (as configured in php.ini or .htaccess).
set()
```php
public static function set(
string $key,
mixed $value
): void;
```
Overrides a setting at the PHP level.
Does NOT call globals_set(), so the C-level struct is not modified and
no other project sharing this PHP process is affected.
Unknown keys are silently ignored.
## Support\Version
Class
Source on GitHub
This class allows to get the installed version of the framework
- **`Phalcon\Support\Version`**
### Method Summary
### Constants
int
VERSION_MAJOR = 0
The constant referencing the major version. Returns 0 ``php echo (new Phalcon\Support\Version()) ->getPart(Phalcon\Support\Version::VERSION_MAJOR); ``
int
VERSION_MEDIUM = 1
The constant referencing the major version. Returns 1 ``php echo (new Phalcon\Support\Version()) ->getPart(Phalcon\Support\Version::VERSION_MEDIUM); ``
int
VERSION_MINOR = 2
The constant referencing the major version. Returns 2 ``php echo (new Phalcon\Support\Version()) ->getPart(Phalcon\Support\Version::VERSION_MINOR); ``
int
VERSION_SPECIAL = 3
The constant referencing the major version. Returns 3 ``php echo (new Phalcon\Support\Version()) ->getPart(Phalcon\Support\Version::VERSION_SPECIAL); ``
int
VERSION_SPECIAL_NUMBER = 4
The constant referencing the major version. Returns 4 ``php echo (new Phalcon\Support\Version()) ->getPart(Phalcon\Support\Version::VERSION_SPECIAL_NUMBER); ``
### Methods
Public · 3
get()
```php
public function get(): string;
```
Returns the active version (string)
```php
echo (new Phalcon\Version())->get();
```
getId()
```php
public function getId(): string;
```
Returns the numeric active version
```php
echo (new Phalcon\Version())->getId();
```
getPart()
```php
public function getPart( int $part ): string;
```
Returns a specific part of the version. If the wrong parameter is passed
it will return the full version
```php
echo (new Phalcon\Version())->getPart(Phalcon\Version::VERSION_MAJOR);
```
Protected · 2
getSpecial()
```php
protected final function getSpecial( int $special ): string;
```
Translates a number to a special release.
getVersion()
```php
protected function getVersion(): array;
```
Area where the version number is set. The format is as follows:
ABBCCDE
A - Major version
B - Med version (two digits)
C - Min version (two digits)
D - Special release: 1 = alpha, 2 = beta, 3 = RC, 4 = stable
E - Special release version i.e. RC1, Beta2 etc.
Source: https://docs.phalcon.io/5.17/api/phalcon_support/index.mdx