Phalcon support

Support\Collection¶

Source on GitHub

• Namespace

  • Phalcon\Support

• Uses

  • ArrayAccess
  • ArrayIterator
  • Countable
  • InvalidArgumentException
  • IteratorAggregate
  • JsonSerializable
  • Phalcon\Support\Collection\CollectionInterface
  • Serializable
  • Traversable

• Extends

• Implements

  • ArrayAccess
  • CollectionInterface
  • Countable
  • IteratorAggregate
  • JsonSerializable
  • Serializable

Phalcon\Support\Collection is a supercharged object oriented array. It implements: - ArrayAccess - Countable - IteratorAggregate - JsonSerializable - Serializable

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

Properties¶

/**
 * @var array
 */
protected $data;

/**
 * @var bool
 */
protected $insensitive = true;

/**
 * @var array
 */
protected $lowerKeys;

Methods¶

public function __construct( array $data = [], bool $insensitive = bool );

public function __get( string $element ): mixed;

public function __isset( string $element ): bool;

public function __serialize(): array;

public function __set( string $element, mixed $value ): void;

public function __unserialize( array $data ): void;

public function __unset( string $element ): void;

public function clear(): void;

public function count(): int;

public function get( string $element, mixed $defaultValue = null, string $cast = null ): mixed;

public function getIterator(): Traversable;

public function getKeys( bool $insensitive = bool ): array;

public function getValues(): array;

public function has( string $element ): bool;

public function init( array $data = [] ): void;

public function jsonSerialize(): array;

public function offsetExists( mixed $element ): bool;

public function offsetGet( mixed $element ): mixed;

public function offsetSet( mixed $offset, mixed $value ): void;

public function offsetUnset( mixed $element ): void;

public function remove( string $element ): void;

public function serialize(): string | null;

public function set( string $element, mixed $value ): void;

public function toArray(): array;

public function toJson( int $options = int ): string;

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 rfc4627

public function unserialize( string $data ): void;

protected function phpJsonEncode( mixed $value, int $flags = int, int $depth = int );

protected function processKey( string $element ): string;

protected function setData( string $element, mixed $value ): void;

Support\Collection\CollectionInterface ¶

Source on GitHub

• Namespace

  • Phalcon\Support\Collection

• Uses

• Extends

• Implements

Phalcon\Support\Collection\CollectionInterface

Interface for Phalcon\Support\Collection class

Methods¶

public function __get( string $element ): mixed;

public function __isset( string $element ): bool;

public function __set( string $element, mixed $value ): void;

public function __unset( string $element ): void;

public function clear(): void;

public function get( string $element, mixed $defaultValue = null, string $cast = null ): mixed;

public function getKeys( bool $insensitive = bool ): array;

public function getValues(): array;

public function has( string $element ): bool;

public function init( array $data = [] ): void;

public function remove( string $element ): void;

public function set( string $element, mixed $value ): void;

public function toArray(): array;

public function toJson( int $options = int ): string;

Support\Collection\Exception¶

Source on GitHub

• Namespace

  • Phalcon\Support\Collection

• Uses

  • Throwable

• Extends

  \Exception

• Implements

Exceptions for the Collection object

Support\Collection\ReadOnlyCollection¶

Source on GitHub

• Namespace

  • Phalcon\Support\Collection

• Uses

  • Phalcon\Support\Collection

• Extends

  Collection

• Implements

A read only Collection object

Methods¶

public function remove( string $element ): void;

public function set( string $element, mixed $value ): void;

Support\Debug¶

Source on GitHub

• Namespace

  • Phalcon\Support

• Uses

  • ErrorException
  • Phalcon\Support\Debug\Exception
  • ReflectionClass
  • ReflectionException
  • ReflectionFunction
  • Throwable

• Extends

• Implements

Provides debug capabilities to Phalcon applications

Properties¶

/**
 * @var array
 */
protected $blacklist;

/**
 * @var array
 */
protected $data;

/**
 * @var bool
 */
protected $hideDocumentRoot = false;

/**
 * @var bool
 */
protected static $isActive = false;

/**
 * @var bool
 */
protected $showBackTrace = true;

/**
 * @var bool
 */
protected $showFileFragment = false;

/**
 * @var bool
 */
protected $showFiles = true;

/**
 * @var string
    */
protected $uri = https://assets.phalcon.io/debug/5.0.x/;

/**
 * @var Version
 */
private $version;

Methods¶

public function __construct();

public function clearVars(): Debug;

public function debugVar( mixed $varz ): Debug;

public function getCssSources(): string;

public function getJsSources(): string;

public function getVersion(): string;

public function halt(): void;

@throws Exception

public function listen( bool $exceptions = bool, bool $lowSeverity = bool ): Debug;

public function listenExceptions(): Debug;

public function listenLowSeverity(): Debug;

public function onUncaughtException( \Throwable $exception ): bool;

public function onUncaughtLowSeverity( mixed $severity, mixed $message, mixed $file, mixed $line, mixed $context ): void;

public function renderHtml( \Throwable $exception ): string;

public function setBlacklist( array $blacklist ): Debug;

public function setShowBackTrace( bool $showBackTrace ): Debug;

public function setShowFileFragment( bool $showFileFragment ): Debug;

public function setShowFiles( bool $showFiles ): Debug;

public function setUri( string $uri ): Debug;

protected function escapeString( string $value ): string;

protected function getArrayDump( array $argument, mixed $n = int ): string | null;

protected function getVarDump( mixed $variable ): string;

final protected function showTraceItem( int $n, array $trace ): string;

Support\Debug\Dump¶

Source on GitHub

• Namespace

  • Phalcon\Support\Debug

• Uses

  • Phalcon\Di\Di
  • Phalcon\Support\Helper\Json\Encode
  • Reflection
  • ReflectionClass
  • ReflectionProperty
  • stdClass

• Extends

• Implements

Dumps information about a variable(s)

$foo = 123;

echo (new \Phalcon\Debug\Dump())->variable($foo, "foo");

$foo = "string";
$bar = ["key" => "value"];
$baz = new stdClass();

echo (new \Phalcon\Debug\Dump())->variables($foo, $bar, $baz);

Properties¶

/**
 * @var bool
 */
protected $detailed = false;

/**
 * @var array
 */
protected $methods;

/**
 * @var array
 */
protected $styles;

/**
 * @var Encode
 */
private $encode;

Methods¶

public function __construct( array $styles = [], bool $detailed = bool );

public function all(): string;

public function getDetailed(): bool;

public function one( mixed $variable, string $name = null ): string;

public function setDetailed( bool $detailed ): void;

public function setStyles( array $styles = [] ): array;

public function toJson( mixed $variable ): string;

$foo = [
    "key" => "value",
];

echo (new \Phalcon\Debug\Dump())->toJson($foo);

$foo = new stdClass();
$foo->bar = "buz";

echo (new \Phalcon\Debug\Dump())->toJson($foo);

public function variable( mixed $variable, string $name = null ): string;

echo (new \Phalcon\Debug\Dump())->variable($foo, "foo");

public function variables(): string;

$foo = "string";
$bar = ["key" => "value"];
$baz = new stdClass();

echo (new \Phalcon\Debug\Dump())->variables($foo, $bar, $baz);

protected function getStyle( string $type ): string;

protected function output( mixed $variable, string $name = null, int $tab = int ): string;

Support\Debug\Exception¶

Source on GitHub

• Namespace

  • Phalcon\Support\Debug

• Uses

• Extends

  \Exception

• Implements

Exceptions thrown in Phalcon\Debug will use this class

Support\Exception¶

Source on GitHub

• Namespace

  • Phalcon\Support

• Uses

• Extends

  \Exception

• Implements

Phalcon\Support\Exception

Support\Helper\Arr\AbstractArr ¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Arr

• Uses

• Extends

• Implements

Abstract class offering methods to help with the Arr namespace. This can be moved to a trait once Zephir supports it.

@todo move to trait when there is support for it

Methods¶

protected function toFilter( array $collection, mixed $method = null ): array;

Support\Helper\Arr\Blacklist¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Arr

• Uses

• Extends

  AbstractArr

• Implements

Black list filter by key: exclude elements of an array by the keys obtained from the elements of a blacklist

Methods¶

public function __invoke( array $collection, array $blackList ): array;

Support\Helper\Arr\Chunk¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Arr

• Uses

• Extends

• Implements

Chunks an array into smaller arrays of a specified size.

Methods¶

public function __invoke( array $collection, int $size, bool $preserveKeys = bool ): array;

Support\Helper\Arr\Filter¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Arr

• Uses

• Extends

  AbstractArr

• Implements

Filters a collection using array_filter and using the callable (if defined)

Methods¶

public function __invoke( array $collection, mixed $method = null ): mixed;

Support\Helper\Arr\First¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Arr

• Uses

• Extends

  AbstractArr

• Implements

Returns the first element of the collection. If a callable is passed, the element returned is the first that validates true

Methods¶

public function __invoke( array $collection, mixed $method = null ): mixed;

Support\Helper\Arr\FirstKey¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Arr

• Uses

• Extends

  AbstractArr

• Implements

Returns the key of the first element of the collection. If a callable is passed, the element returned is the first that validates true

Methods¶

public function __invoke( array $collection, mixed $method = null ): mixed;

Support\Helper\Arr\Flatten¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Arr

• Uses

• Extends

• Implements

Flattens an array up to the one level depth, unless $deep is set to true

Methods¶

public function __invoke( array $collection, bool $deep = bool ): array;

Support\Helper\Arr\Get¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Arr

• Uses

• Extends

• Implements

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

Methods¶

public function __invoke( array $collection, mixed $index, mixed $defaultValue = null, string $cast = null ): mixed;

Support\Helper\Arr\Group¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Arr

• Uses

• Extends

• Implements

Groups the elements of an array based on the passed callable

Methods¶

public function __invoke( array $collection, mixed $method ): array;

Support\Helper\Arr\Has¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Arr

• Uses

• Extends

• Implements

Checks an array if it has an element with a specific key and returns true/false accordingly

Methods¶

public function __invoke( array $collection, mixed $index ): bool;

Support\Helper\Arr\IsUnique¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Arr

• Uses

• Extends

• Implements

Checks a flat list for duplicate values. Returns true if duplicate values exist and false if values are all unique.

Methods¶

public function __invoke( array $collection ): bool;

Support\Helper\Arr\Last¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Arr

• Uses

• Extends

  AbstractArr

• Implements

Returns the last element of the collection. If a callable is passed, the element returned is the first that validates true

Methods¶

public function __invoke( array $collection, mixed $method = null ): mixed;

Support\Helper\Arr\LastKey¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Arr

• Uses

• Extends

  AbstractArr

• Implements

Returns the key of the last element of the collection. If a callable is passed, the element returned is the first that validates true

Methods¶

public function __invoke( array $collection, mixed $method = null ): mixed;

Support\Helper\Arr\Order¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Arr

• Uses

• Extends

• Implements

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

Constants¶

const ORDER_ASC = 1;
const ORDER_DESC = 2;

Methods¶

public function __invoke( array $collection, mixed $attribute, int $order = static-constant-access, int $flags = int ): array;

Support\Helper\Arr\Pluck¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Arr

• Uses

• Extends

• Implements

Returns a subset of the collection based on the values of the collection

Methods¶

public function __invoke( array $collection, string $element ): array;

Support\Helper\Arr\Set¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Arr

• Uses

• Extends

• Implements

Sets an array element. Using a key is optional

Methods¶

public function __invoke( array $collection, mixed $value, mixed $index = null ): array;

Support\Helper\Arr\SliceLeft¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Arr

• Uses

• Extends

• Implements

Returns a new array with n elements removed from the left.

Methods¶

public function __invoke( array $collection, int $elements = int ): array;

Support\Helper\Arr\SliceRight¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Arr

• Uses

• Extends

• Implements

Returns a new array with n elements removed from the right.

Methods¶

public function __invoke( array $collection, int $elements = int ): array;

Support\Helper\Arr\Split¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Arr

• Uses

• Extends

• Implements

Returns a new array with keys of the collection as one element and values as another

Methods¶

public function __invoke( array $collection ): array;

Support\Helper\Arr\ToObject¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Arr

• Uses

• Extends

• Implements

Returns the passed array as an object.

Methods¶

public function __invoke( array $collection ): object;

Support\Helper\Arr\ValidateAll¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Arr

• Uses

• Extends

  AbstractArr

• Implements

Returns true if the provided function returns true for all elements of the collection, false otherwise.

Methods¶

public function __invoke( array $collection, mixed $method ): bool;

Support\Helper\Arr\ValidateAny¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Arr

• Uses

• Extends

  AbstractArr

• Implements

Returns true if the provided function returns true for at least one element of the collection, false otherwise.

Methods¶

public function __invoke( array $collection, mixed $method ): bool;

Support\Helper\Arr\Whitelist¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Arr

• Uses

• Extends

  AbstractArr

• Implements

White list filter by key: obtain elements of an array filtering by the keys obtained from the elements of a whitelist

Methods¶

public function __invoke( array $collection, array $whiteList ): array;

Support\Helper\Exception¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper

• Uses

• Extends

  \Exception

• Implements

• Phalcon\Support\Exception */

Support\Helper\File\Basename¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\File

• Uses

• Extends

• Implements

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.

Methods¶

public function __invoke( string $uri, string $suffix = null ): string;

Support\Helper\Json\Decode¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Json

• Uses

  • InvalidArgumentException

• Extends

• Implements

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 InvalidArgumentException

Methods¶

public function __invoke( string $data, bool $associative = bool, int $depth = int, int $options = int );

Support\Helper\Json\Encode¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Json

• Uses

  • InvalidArgumentException

• Extends

• Implements

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 InvalidArgumentException

@see https://www.ietf.org/rfc/rfc4627.txt

Methods¶

public function __invoke( mixed $data, int $options = int, int $depth = int ): string;

Support\Helper\Number\IsBetween¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Number

• Uses

• Extends

• Implements

Checks if a number is within a range

Methods¶

public function __invoke( int $value, int $start, int $end ): bool;

Support\Helper\Str\AbstractStr ¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Str

• Uses

• Extends

• Implements

Abstract class offering methods to help with the Str namespace. This can be moved to a trait once Zephir supports it.

@todo move to trait when there is support for it

Methods¶

protected function toEndsWith( string $haystack, string $needle, bool $ignoreCase = bool ): bool;

protected function toInterpolate( string $input, array $context = [], string $left = string, string $right = string ): string;

@see https://www.php-fig.org/psr/psr-3/ Section 1.2 Message

protected function toLower( string $text, string $encoding = string ): string;

protected function toStartsWith( string $haystack, string $needle, bool $ignoreCase = bool ): bool;

protected function toUpper( string $text, string $encoding = string ): string;

Support\Helper\Str\Camelize¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Str

• Uses

• Extends

  PascalCase

• Implements

Converts strings to upperCamelCase or lowerCamelCase

Methods¶

public function __invoke( string $text, string $delimiters = null, bool $lowerFirst = bool ): string;

Support\Helper\Str\Concat¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Str

• Uses

  • Phalcon\Support\Helper\Exception

• Extends

  AbstractStr

• Implements

Concatenates strings using the separator only once without duplication in places concatenation

Methods¶

public function __invoke(): string;

Support\Helper\Str\CountVowels¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Str

• Uses

• Extends

• Implements

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.

Methods¶

public function __invoke( string $text ): int;

Support\Helper\Str\Decapitalize¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Str

• Uses

• Extends

  AbstractStr

• Implements

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.

Methods¶

public function __invoke( string $text, bool $upperRest = bool, string $encoding = string ): string;

Support\Helper\Str\Decrement¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Str

• Uses

• Extends

• Implements

Removes a number from the end of a string or decrements that number if it is already defined

Methods¶

public function __invoke( string $text, string $separator = string ): string;

Support\Helper\Str\DirFromFile¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Str

• Uses

• Extends

• Implements

Accepts a file name (without extension) and returns a calculated directory structure with the filename in the end

Methods¶

public function __invoke( string $file ): string;

Support\Helper\Str\DirSeparator¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Str

• Uses

• Extends

• Implements

Accepts a directory name and ensures that it ends with DIRECTORY_SEPARATOR

Methods¶

public function __invoke( string $directory ): string;

Support\Helper\Str\Dynamic¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Str

• Uses

  • RuntimeException

• Extends

• Implements

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

Methods¶

public function __invoke( string $text, string $leftDelimiter = string, string $rightDelimiter = string, string $separator = string ): string;

Support\Helper\Str\EndsWith¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Str

• Uses

• Extends

  AbstractStr

• Implements

Check if a string ends with a given string

Methods¶

public function __invoke( string $haystack, string $needle, bool $ignoreCase = bool ): bool;

Support\Helper\Str\FirstBetween¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Str

• Uses

• Extends

• Implements

Returns the first string there is between the strings from the parameter start and end.

Methods¶

public function __invoke( string $text, string $start, string $end ): string;

Support\Helper\Str\Friendly¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Str

• Uses

  • Phalcon\Support\Helper\Exception

• Extends

  AbstractStr

• Implements

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.

Methods¶

public function __invoke( string $text, string $separator = string, bool $lowercase = bool, mixed $replace = null ): string;

Support\Helper\Str\Humanize¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Str

• Uses

• Extends

• Implements

Makes an underscored or dashed text human-readable

Methods¶

public function __invoke( string $text ): string;

Support\Helper\Str\Includes¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Str

• Uses

• Extends

• Implements

Determines whether a string includes another string or not.

Methods¶

public function __invoke( string $haystack, string $needle ): bool;

Support\Helper\Str\Increment¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Str

• Uses

• Extends

• Implements

Adds a number to the end of a string or increments that number if it is already defined

Methods¶

public function __invoke( string $text, string $separator = string ): string;

Support\Helper\Str\Interpolate¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Str

• Uses

• Extends

• Implements

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

Methods¶

public function __invoke( string $message, array $context = [], string $leftToken = string, string $rightToken = string ): string;

Support\Helper\Str\IsAnagram¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Str

• Uses

• Extends

• Implements

Compare two strings and returns true if both strings are anagram, false otherwise.

Methods¶

public function __invoke( string $first, string $second ): bool;

Support\Helper\Str\IsLower¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Str

• Uses

• Extends

  AbstractStr

• Implements

Returns true if the given string is in lower case, false otherwise.

Methods¶

public function __invoke( string $text, string $encoding = string ): bool;

Support\Helper\Str\IsPalindrome¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Str

• Uses

• Extends

• Implements

Returns true if the given string is a palindrome, false otherwise.

Methods¶

public function __invoke( string $text ): bool;

Support\Helper\Str\IsUpper¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Str

• Uses

• Extends

  AbstractStr

• Implements

Returns true if the given string is in upper case, false otherwise.

Methods¶

public function __invoke( string $text, string $encoding = string ): bool;

Support\Helper\Str\KebabCase¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Str

• Uses

• Extends

  PascalCase

• Implements

Converts strings to kebab-case style

Methods¶

public function __invoke( string $text, string $delimiters = null ): string;

Support\Helper\Str\Len¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Str

• Uses

• Extends

• Implements

Calculates the length of the string using mb_strlen

Methods¶

public function __invoke( string $text, string $encoding = string ): int;

Support\Helper\Str\Lower¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Str

• Uses

• Extends

  AbstractStr

• Implements

Converts a string to lowercase using mbstring

Methods¶

public function __invoke( string $text, string $encoding = string ): string;

Support\Helper\Str\PascalCase¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Str

• Uses

• Extends

• Implements

Converts strings to PascalCase style

Methods¶

public function __invoke( string $text, string $delimiters = null ): string;

protected function processArray( string $text, string $delimiters = null ): array;

Support\Helper\Str\Prefix¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Str

• Uses

• Extends

• Implements

Prefixes the text with the supplied prefix

Methods¶

public function __invoke( mixed $text, string $prefix ): string;

Support\Helper\Str\Random¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Str

• Uses

• Extends

• Implements

Generates a random string based on the given type. Type is one of the RANDOM_* constants

Constants¶

const RANDOM_ALNUM = 0;
const RANDOM_ALPHA = 1;
const RANDOM_DISTINCT = 5;
const RANDOM_HEXDEC = 2;
const RANDOM_NOZERO = 4;
const RANDOM_NUMERIC = 3;

Methods¶

public function __invoke( int $type = static-constant-access, int $length = int ): string;

Support\Helper\Str\ReduceSlashes¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Str

• Uses

• Extends

• Implements

Reduces multiple slashes in a string to single slashes

Methods¶

public function __invoke( string $text ): string;

Support\Helper\Str\SnakeCase¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Str

• Uses

• Extends

  PascalCase

• Implements

Converts strings to snake_case style

Methods¶

public function __invoke( string $text, string $delimiters = null ): string;

Support\Helper\Str\StartsWith¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Str

• Uses

• Extends

  AbstractStr

• Implements

Check if a string starts with a given string

Methods¶

public function __invoke( string $haystack, string $needle, bool $ignoreCase = bool ): bool;

Support\Helper\Str\Suffix¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Str

• Uses

• Extends

• Implements

Suffixes the text with the supplied suffix

Methods¶

public function __invoke( mixed $text, string $suffix ): string;

Support\Helper\Str\Ucwords¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Str

• Uses

• Extends

• Implements

Capitalizes the first letter of each word

Methods¶

public function __invoke( string $text, string $encoding = string ): string;

Support\Helper\Str\Uncamelize¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Str

• Uses

• Extends

• Implements

Converts strings to non camelized style

Methods¶

public function __invoke( string $text, string $delimiter = string ): string;

Support\Helper\Str\Underscore¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Str

• Uses

• Extends

• Implements

Makes a text underscored instead of spaced

Methods¶

public function __invoke( string $text ): string;

Support\Helper\Str\Upper¶

Source on GitHub

• Namespace

  • Phalcon\Support\Helper\Str

• Uses

• Extends

  AbstractStr

• Implements

Converts a string to uppercase using mbstring

Methods¶

public function __invoke( string $text, string $encoding = string ): string;

Support\HelperFactory¶

Source on GitHub

• Namespace

  • Phalcon\Support

• Uses

  • Phalcon\Factory\AbstractFactory

• Extends

  AbstractFactory

• Implements

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 $leftDelimiter = "{", string $rightDelimiter = "}", 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($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)

Methods¶

public function __call( string $name, array $arguments );

public function __construct( array $services = [] );

public function newInstance( string $name );

protected function getExceptionClass(): string;

protected function getServices(): array;

Support\Registry ¶

Source on GitHub

• Namespace

  • Phalcon\Support

• Uses

  • Phalcon\Support\Collection
  • Traversable

• Extends

  Collection

• Implements

Phalcon\Registry

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.

$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.

Methods¶

final public function __construct( array $data = [] );

final public function __get( string $element ): mixed;

final public function __isset( string $element ): bool;

final public function __set( string $element, mixed $value ): void;

final public function __unset( string $element ): void;

final public function clear(): void;

final public function count(): int;

@link https://php.net/manual/en/countable.count.php

final public function get( string $element, mixed $defaultValue = null, string $cast = null ): mixed;

final public function getIterator(): Traversable;

final public function has( string $element ): bool;

final public function init( array $data = [] ): void;

final public function jsonSerialize(): array;

@link https://php.net/manual/en/jsonserializable.jsonserialize.php

final public function offsetExists( mixed $element ): bool;

@link https://php.net/manual/en/arrayaccess.offsetexists.php

final public function offsetGet( mixed $element ): mixed;

@link https://php.net/manual/en/arrayaccess.offsetget.php

final public function offsetSet( mixed $offset, mixed $value ): void;

@link https://php.net/manual/en/arrayaccess.offsetset.php

final public function offsetUnset( mixed $element ): void;

@link https://php.net/manual/en/arrayaccess.offsetunset.php

final public function remove( string $element ): void;

final public function serialize(): string | null;

@link https://php.net/manual/en/serializable.serialize.php

final public function set( string $element, mixed $value ): void;

final public function toArray(): array;

final public function toJson( int $options = int ): string;

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

final public function unserialize( string $data ): void;

@link https://php.net/manual/en/serializable.unserialize.php

Support\Version¶

Source on GitHub

• Namespace

  • Phalcon\Support

• Uses

• Extends

• Implements

This class allows to get the installed version of the framework

Constants¶

const VERSION_MAJOR = 0;
const VERSION_MEDIUM = 1;
const VERSION_MINOR = 2;
const VERSION_SPECIAL = 3;
const VERSION_SPECIAL_NUMBER = 4;

Methods¶

public function get(): string;

echo (new Phalcon\Version())->get();

public function getId(): string;

echo (new Phalcon\Version())->getId();

public function getPart( int $part ): string;

echo (new Phalcon\Version())->getPart(Phalcon\Version::VERSION_MAJOR);

protected function getVersion(): array;

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.