---
title: "Phalcon Traits"
version: "5.19"
---
> 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 Traits
:::info[NOTE]
All classes are prefixed with `Phalcon`
:::
## Traits\Factory\ConfigTrait
Trait
Source on GitHub
- **`Phalcon\Traits\Factory\ConfigTrait`**
__Uses__ `Phalcon\Config\ConfigInterface`
__Used by__ [`Phalcon\Auth\ManagerFactory`](/5.19/api/phalcon_auth/#authmanagerfactory)
### Method Summary
### Methods
Protected · 2
checkConfig()
```php
protected function checkConfig( mixed $config ): array;
```
checkConfigElement()
```php
protected function checkConfigElement(
array $config,
string $element
): array;
```
Checks if the config has a specific element
## Traits\Factory\FactoryTrait
Trait
Source on GitHub
Methods allowing a mapper based factory to operate. Supports injected
services, getting a service by name (key), initialization and setting of
the exception class (when exceptions are needed to be thrown)
- **`Phalcon\Traits\Factory\FactoryTrait`**
__Uses__ `Exception`
### Method Summary
### Methods
Protected · 5
getCachedInstance()
```php
protected function getCachedInstance(
string $name,
mixed $arguments
): object;
```
Return an object from the instances pool. If it does not exist, create it
getExceptionClass()
```php
abstract protected function getExceptionClass(): string;
```
Returns the exception class for the factory
getService()
```php
protected function getService( string $name ): string;
```
Returns a service based on the name; throws exception if it does not
exist
getServices()
```php
abstract protected function getServices(): array;
```
Returns the services for the factory
init()
```php
protected function init( array $services = [] ): void;
```
Initializes services
## Traits\Php\ApcuTrait
Trait
Source on GitHub
APCu based wrapper methods
- **`Phalcon\Traits\Php\ApcuTrait`**
__Used by__ [`Phalcon\Storage\Adapter\Apcu`](/5.19/api/phalcon_storage/#storageadapterapcu)
### Method Summary
### Methods
Protected · 7
phpApcuDec()
```php
protected static function phpApcuDec(
mixed $key,
int $step = 1
): bool|int;
```
@link https://php.net/manual/en/function.apcu-dec.php
phpApcuDelete()
```php
protected static function phpApcuDelete( mixed $key ): bool|array;
```
@link https://php.net/manual/en/function.apcu-delete.php
phpApcuExists()
```php
protected static function phpApcuExists( mixed $key ): bool|array;
```
@link https://php.net/manual/en/function.apcu-exists.php
phpApcuFetch()
```php
protected static function phpApcuFetch( mixed $key ): mixed;
```
@link https://php.net/manual/en/function.apcu-fetch.php
phpApcuInc()
```php
protected static function phpApcuInc(
mixed $key,
int $step = 1
): bool|int;
```
@link https://php.net/manual/en/function.apcu-inc.php
phpApcuIterator()
```php
protected static function phpApcuIterator( string $pattern ): \APCUIterator|bool;
```
@link https://php.net/manual/en/class.apcuiterator.php
phpApcuStore()
```php
protected static function phpApcuStore(
mixed $key,
mixed $payload,
int $ttl = 0
): bool|array;
```
@link https://php.net/manual/en/function.apcu-store.php
## Traits\Php\Base64Trait
Trait
Source on GitHub
Base64 based wrapper methods
- **`Phalcon\Traits\Php\Base64Trait`**
__Used by__ [`Phalcon\Encryption\Crypt`](/5.19/api/phalcon_encryption/#encryptioncrypt) · [`Phalcon\Encryption\Security\JWT\Builder`](/5.19/api/phalcon_encryption/#encryptionsecurityjwtbuilder) · [`Phalcon\Encryption\Security\JWT\Token\Parser`](/5.19/api/phalcon_encryption/#encryptionsecurityjwttokenparser) · [`Phalcon\Storage\Serializer\Base64`](/5.19/api/phalcon_storage/#storageserializerbase64)
### Method Summary
### Methods
Protected · 4
doDecodeUrl()
```php
protected static function doDecodeUrl( string $input ): string;
```
Decode a Base64 URL string
doEncodeUrl()
```php
protected static function doEncodeUrl( string $input ): string;
```
Encode a string in Base64 URL format
phpBase64Decode()
```php
protected static function phpBase64Decode(
string $input,
bool $strict = false
): string|false;
```
@link https://php.net/manual/en/function.base64-decode.php
phpBase64Encode()
```php
protected static function phpBase64Encode( string $input ): string;
```
@link https://php.net/manual/en/function.base64-encode.php
## Traits\Php\FileTrait
Trait
Source on GitHub
File based wrapper methods
- **`Phalcon\Traits\Php\FileTrait`**
__Used by__ [`Phalcon\Annotations\Adapter\Stream`](/5.19/api/phalcon_annotations/#annotationsadapterstream) · [`Phalcon\Assets\Asset`](/5.19/api/phalcon_assets/#assetsasset) · [`Phalcon\Assets\Collection`](/5.19/api/phalcon_assets/#assetscollection) · [`Phalcon\Assets\Manager`](/5.19/api/phalcon_assets/#assetsmanager) · [`Phalcon\Auth\Adapter\Stream`](/5.19/api/phalcon_auth/#authadapterstream) · [`Phalcon\Cli\Console`](/5.19/api/phalcon_cli/#cliconsole) · [`Phalcon\Config\Adapter\Json`](/5.19/api/phalcon_config/#configadapterjson) · [`Phalcon\Encryption\Security\Uuid\SysNodeProvider`](/5.19/api/phalcon_encryption/#encryptionsecurityuuidsysnodeprovider) · [`Phalcon\Forms\Loader\JsonLoader`](/5.19/api/phalcon_forms/#formsloaderjsonloader) · [`Phalcon\Http\Request`](/5.19/api/phalcon_http/#httprequest) · [`Phalcon\Image\Adapter\Gd`](/5.19/api/phalcon_image/#imageadaptergd) · [`Phalcon\Image\Adapter\Imagick`](/5.19/api/phalcon_image/#imageadapterimagick) · [`Phalcon\Logger\Adapter\Stream`](/5.19/api/phalcon_logger/#loggeradapterstream) · [`Phalcon\Mvc\Application`](/5.19/api/phalcon_mvc/#mvcapplication) · [`Phalcon\Mvc\Model\MetaData\Stream`](/5.19/api/phalcon_mvc/#mvcmodelmetadatastream) · [`Phalcon\Mvc\Router`](/5.19/api/phalcon_mvc/#mvcrouter) · [`Phalcon\Mvc\View`](/5.19/api/phalcon_mvc/#mvcview) · [`Phalcon\Mvc\View\Engine\Volt\Compiler`](/5.19/api/phalcon_mvc/#mvcviewenginevoltcompiler) · [`Phalcon\Mvc\View\Simple`](/5.19/api/phalcon_mvc/#mvcviewsimple) · [`Phalcon\Queue\Adapter\Beanstalk\BeanstalkConnection`](/5.19/api/phalcon_queue/#queueadapterbeanstalkbeanstalkconnection) · [`Phalcon\Queue\Adapter\Stream\StreamContext`](/5.19/api/phalcon_queue/#queueadapterstreamstreamcontext) · [`Phalcon\Session\Adapter\Stream`](/5.19/api/phalcon_session/#sessionadapterstream) · [`Phalcon\Storage\Adapter\Stream`](/5.19/api/phalcon_storage/#storageadapterstream) · [`Phalcon\Translate\Adapter\Csv`](/5.19/api/phalcon_translate/#translateadaptercsv)
### Method Summary
protected
bool
phpFclose( mixed $handle )
Closes an open file pointer
protected
array|false
phpFgetCsv(mixed $stream,int $length = 0,string $separator = ",",mixed $enclosure = null,mixed $escape = null)
Gets line from file pointer and parse for CSV fields
protected
bool
phpFileExists( string $filename )
@link https://php.net/manual/en/function.file-exists.php
protected
false|string
phpFileGetContents(string $filename,bool $useIncludePath = false,mixed $context = null,int $offset = 0,int|null $length = null)
@link https://php.net/manual/en/function.file-get-contents.php
protected
false|int
phpFilePutContents(string $filename,mixed $data,int $flags = 0,mixed $context = null)
@link https://php.net/manual/en/function.file-put-contents.php
protected
mixed
phpFopen(string $filename,string $mode,bool $useIncludePath = false,mixed $context = null)
@link https://php.net/manual/en/function.fopen.php
protected
false|int
phpFwrite(mixed $handle,string $data,int|null $length = null)
Binary-safe file write
protected
bool
phpIsWritable( string $filename )
Tells whether the filename is writable
protected
bool
phpUnlink(string $filename,mixed $context = null)
@link https://php.net/manual/en/function.unlink.php
### Methods
Protected · 9
phpFclose()
```php
protected static function phpFclose( mixed $handle ): bool;
```
Closes an open file pointer
@link https://php.net/manual/en/function.fclose.php
phpFgetCsv()
```php
protected static function phpFgetCsv(
mixed $stream,
int $length = 0,
string $separator = ",",
mixed $enclosure = null,
mixed $escape = null
): array|false;
```
Gets line from file pointer and parse for CSV fields
@link https://php.net/manual/en/function.fgetcsv.php
phpFileExists()
```php
protected static function phpFileExists( string $filename ): bool;
```
@link https://php.net/manual/en/function.file-exists.php
phpFileGetContents()
```php
protected static function phpFileGetContents(
string $filename,
bool $useIncludePath = false,
mixed $context = null,
int $offset = 0,
int|null $length = null
): false|string;
```
@link https://php.net/manual/en/function.file-get-contents.php
phpFilePutContents()
```php
protected static function phpFilePutContents(
string $filename,
mixed $data,
int $flags = 0,
mixed $context = null
): false|int;
```
@link https://php.net/manual/en/function.file-put-contents.php
phpFopen()
```php
protected static function phpFopen(
string $filename,
string $mode,
bool $useIncludePath = false,
mixed $context = null
): mixed;
```
@link https://php.net/manual/en/function.fopen.php
phpFwrite()
```php
protected static function phpFwrite(
mixed $handle,
string $data,
int|null $length = null
): false|int;
```
Binary-safe file write
@link https://php.net/manual/en/function.fwrite.php
phpIsWritable()
```php
protected static function phpIsWritable( string $filename ): bool;
```
Tells whether the filename is writable
@link https://php.net/manual/en/function.is-writable.php
phpUnlink()
```php
protected static function phpUnlink(
string $filename,
mixed $context = null
): bool;
```
@link https://php.net/manual/en/function.unlink.php
## Traits\Php\HashTrait
Trait
Source on GitHub
Hashing method wrappers
- **`Phalcon\Traits\Php\HashTrait`**
__Used by__ [`Phalcon\Assets\Asset`](/5.19/api/phalcon_assets/#assetsasset) · [`Phalcon\Assets\Inline`](/5.19/api/phalcon_assets/#assetsinline) · [`Phalcon\Encryption\Crypt`](/5.19/api/phalcon_encryption/#encryptioncrypt) · [`Phalcon\Encryption\Security`](/5.19/api/phalcon_encryption/#encryptionsecurity) · [`Phalcon\Encryption\Security\JWT\Signer\Hmac`](/5.19/api/phalcon_encryption/#encryptionsecurityjwtsignerhmac)
### Method Summary
### Methods
Protected · 3
phpHash()
```php
protected static function phpHash(
string $algorithm,
string $data,
bool $binary = false
): string;
```
@link https://php.net/manual/en/function.hash.php
phpHashEquals()
```php
protected static function phpHashEquals(
string $knownString,
string $userString
): bool;
```
@link https://php.net/manual/en/function.hash-equals.php
phpHashHmac()
```php
protected static function phpHashHmac(
string $algorithm,
string $data,
string $key,
bool $binary = false
): string;
```
@link https://php.net/manual/en/function.hash-hmac.php
## Traits\Php\HeaderTrait
Trait
Source on GitHub
Header based wrapper methods
- **`Phalcon\Traits\Php\HeaderTrait`**
__Used by__ [`Phalcon\Session\Manager`](/5.19/api/phalcon_session/#sessionmanager)
### Method Summary
### Methods
Protected · 1
```php
protected static function phpHeadersSent(): bool;
```
Checks if or where headers have been sent
@link https://php.net/manual/en/function.headers-sent.php
## Traits\Php\IgbinaryTrait
Trait
Source on GitHub
Igbinary based wrapper methods
- **`Phalcon\Traits\Php\IgbinaryTrait`**
__Used by__ [`Phalcon\Storage\Serializer\Igbinary`](/5.19/api/phalcon_storage/#storageserializerigbinary)
### Method Summary
### Methods
Protected · 2
phpIgbinarySerialize()
```php
protected static function phpIgbinarySerialize( mixed $value ): string|null;
```
@link https://php.net/manual/en/function.igbinary-serialize.php
phpIgbinaryUnserialize()
```php
protected static function phpIgbinaryUnserialize( mixed $value );
```
@link https://php.net/manual/en/function.igbinary-unserialize.php
## Traits\Php\InfoTrait
Trait
Source on GitHub
Information method wrappers
- **`Phalcon\Traits\Php\InfoTrait`**
__Used by__ [`Phalcon\Config\Adapter\Yaml`](/5.19/api/phalcon_config/#configadapteryaml) · [`Phalcon\Encryption\Crypt`](/5.19/api/phalcon_encryption/#encryptioncrypt) · [`Phalcon\Encryption\Security\Uuid\SysNodeProvider`](/5.19/api/phalcon_encryption/#encryptionsecurityuuidsysnodeprovider) · [`Phalcon\Filter\Validation\Validator\Confirmation`](/5.19/api/phalcon_filter/#filtervalidationvalidatorconfirmation) · [`Phalcon\Filter\Validation\Validator\File\MimeType`](/5.19/api/phalcon_filter/#filtervalidationvalidatorfilemimetype) · [`Phalcon\Filter\Validation\Validator\StringLength\Max`](/5.19/api/phalcon_filter/#filtervalidationvalidatorstringlengthmax) · [`Phalcon\Filter\Validation\Validator\StringLength\Min`](/5.19/api/phalcon_filter/#filtervalidationvalidatorstringlengthmin) · [`Phalcon\Forms\Loader\YamlLoader`](/5.19/api/phalcon_forms/#formsloaderyamlloader) · [`Phalcon\Http\Response`](/5.19/api/phalcon_http/#httpresponse) · [`Phalcon\Image\Adapter\Gd`](/5.19/api/phalcon_image/#imageadaptergd) · [`Phalcon\Mvc\View\Engine\Volt`](/5.19/api/phalcon_mvc/#mvcviewenginevolt) · [`Phalcon\Queue\Consumer\Worker`](/5.19/api/phalcon_queue/#queueconsumerworker) · [`Phalcon\Support\Debug\ReportBuilder`](/5.19/api/phalcon_support/#supportdebugreportbuilder) · [`Phalcon\Support\Helper\Arr\Group`](/5.19/api/phalcon_support/#supporthelperarrgroup) · [`Phalcon\Translate\Adapter\Gettext`](/5.19/api/phalcon_translate/#translateadaptergettext)
### Method Summary
### Methods
Protected · 2
phpExtensionLoaded()
```php
protected static function phpExtensionLoaded( string $name ): bool;
```
Find out whether an extension is loaded
@link https://php.net/manual/en/function.extension-loaded.php
phpFunctionExists()
```php
protected static function phpFunctionExists( string $functionName ): bool;
```
Return true if the given function has been defined
@link https://php.net/manual/en/function.function-exists.php
## Traits\Php\IniTrait
Trait
Source on GitHub
- **`Phalcon\Traits\Php\IniTrait`**
__Used by__ [`Phalcon\Config\Adapter\Ini`](/5.19/api/phalcon_config/#configadapterini) · [`Phalcon\Session\Adapter\Stream`](/5.19/api/phalcon_session/#sessionadapterstream)
### Method Summary
### Methods
Protected · 4
phpIniGet()
```php
protected static function phpIniGet(
string $input,
string $defaultValue = ""
): string;
```
Gets the value of a configuration option
@link https://php.net/manual/en/function.ini-get.php
@link https://php.net/manual/en/ini.list.php
phpIniGetBool()
```php
protected static function phpIniGetBool(
string $input,
bool $defaultValue = false
): bool;
```
Query a php.ini value and return it back as boolean
@link https://php.net/manual/en/function.ini-get.php
@link https://php.net/manual/en/ini.list.php
phpIniGetInt()
```php
protected static function phpIniGetInt(
string $input,
int $defaultValue = 0
): int;
```
Query a php.ini value and return it back as integer
@link https://php.net/manual/en/function.ini-get.php
@link https://php.net/manual/en/ini.list.php
phpParseIniFile()
```php
protected static function phpParseIniFile(
string $filename,
bool $processSections = false,
int $scannerMode = 0
): array|false;
```
Parse a configuration file
@link https://php.net/manual/en/function.parse-ini-file.php
## Traits\Php\MbCaseTrait
Trait
Source on GitHub
Multibyte case conversion wrapper method
- **`Phalcon\Traits\Php\MbCaseTrait`**
__Used by__ [`Phalcon\Filter\Sanitize\Lower`](/5.19/api/phalcon_filter/#filtersanitizelower) · [`Phalcon\Filter\Sanitize\Upper`](/5.19/api/phalcon_filter/#filtersanitizeupper) · [`Phalcon\Filter\Sanitize\UpperWords`](/5.19/api/phalcon_filter/#filtersanitizeupperwords)
### Method Summary
### Methods
Protected · 1
phpMbConvertCase()
```php
protected static function phpMbConvertCase(
string $input,
int $mode
): string;
```
Converts the case of a string using `mb_convert_case()`
@link https://php.net/manual/en/function.mb-convert-case.php
## Traits\Php\MsgpackTrait
Trait
Source on GitHub
MessagePack based wrapper methods
- **`Phalcon\Traits\Php\MsgpackTrait`**
__Used by__ [`Phalcon\Storage\Serializer\Msgpack`](/5.19/api/phalcon_storage/#storageserializermsgpack)
### Method Summary
### Methods
Protected · 2
phpMsgpackPack()
```php
protected static function phpMsgpackPack( mixed $value ): string;
```
@link https://php.net/manual/en/function.msgpack-pack.php
phpMsgpackUnpack()
```php
protected static function phpMsgpackUnpack( mixed $value );
```
@link https://php.net/manual/en/function.msgpack-unpack.php
## Traits\Php\OpensslTrait
Trait
Source on GitHub
OpenSSL based wrapper methods
- **`Phalcon\Traits\Php\OpensslTrait`**
__Used by__ [`Phalcon\Encryption\Crypt`](/5.19/api/phalcon_encryption/#encryptioncrypt)
### Method Summary
### Methods
Protected · 2
phpOpensslCipherIvLength()
```php
protected static function phpOpensslCipherIvLength( string $cipher ): int|bool;
```
@link https://php.net/manual/en/function.openssl-cipher-iv-length.php
phpOpensslRandomPseudoBytes()
```php
protected static function phpOpensslRandomPseudoBytes( int $length );
```
@link https://php.net/manual/en/function.openssl-random-pseudo-bytes.php
## Traits\Php\SerializeTrait
Trait
Source on GitHub
PHP serialize/unserialize wrapper methods
- **`Phalcon\Traits\Php\SerializeTrait`**
__Used by__ [`Phalcon\Storage\Serializer\Php`](/5.19/api/phalcon_storage/#storageserializerphp)
### Method Summary
### Methods
Protected · 2
phpSerialize()
```php
protected static function phpSerialize( mixed $value ): string;
```
@link https://php.net/manual/en/function.serialize.php
phpUnserialize()
```php
protected static function phpUnserialize(
string $data,
array $options = []
): mixed;
```
@link https://php.net/manual/en/function.unserialize.php
## Traits\Php\UrlTrait
Trait
Source on GitHub
URL based wrapper methods
- **`Phalcon\Traits\Php\UrlTrait`**
__Used by__ [`Phalcon\Html\Escaper\UrlEscaper`](/5.19/api/phalcon_html/#htmlescaperurlescaper) · [`Phalcon\Http\Response`](/5.19/api/phalcon_http/#httpresponse)
### Method Summary
### Methods
Protected · 3
phpParseUrl()
```php
protected static function phpParseUrl(
string $url,
int $component = -1
);
```
@link https://php.net/manual/en/function.parse-url.php
phpRawUrlDecode()
```php
protected static function phpRawUrlDecode( string $input ): string;
```
@link https://php.net/manual/en/function.rawurldecode.php
phpRawUrlEncode()
```php
protected static function phpRawUrlEncode( string $input ): string;
```
@link https://php.net/manual/en/function.rawurlencode.php
## Traits\Php\YamlTrait
Trait
Source on GitHub
YAML based wrapper methods
- **`Phalcon\Traits\Php\YamlTrait`**
__Used by__ [`Phalcon\Config\Adapter\Yaml`](/5.19/api/phalcon_config/#configadapteryaml)
### Method Summary
### Methods
Protected · 1
phpYamlParseFile()
```php
protected static function phpYamlParseFile(
string $filename,
int $pos = 0,
array $callbacks = []
);
```
Parse a YAML stream from a file
@link https://php.net/manual/en/function.yaml-parse-file.php
## Traits\Support\Helper\Arr\FilterTrait
Trait
Source on GitHub
Filters a collection using array_filter with an optional callable
- **`Phalcon\Traits\Support\Helper\Arr\FilterTrait`**
__Used by__ [`Phalcon\Support\Helper\Arr\AbstractArr`](/5.19/api/phalcon_support/#supporthelperarrabstractarr)
### Method Summary
### Methods
Protected · 1
toFilter()
```php
protected static function toFilter(
array $collection,
mixed $method = null
): array;
```
Helper method to filter the collection
## Traits\Support\Helper\Arr\GetTrait
Trait
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\Traits\Support\Helper\Arr\GetTrait`**
__Used by__ [`Phalcon\ADR\Middleware\CorsMiddleware`](/5.19/api/phalcon_adr/#adrmiddlewarecorsmiddleware) · [`Phalcon\Annotations\AnnotationsFactory`](/5.19/api/phalcon_annotations/#annotationsannotationsfactory) · [`Phalcon\Db\Adapter\PdoFactory`](/5.19/api/phalcon_db/#dbadapterpdofactory) · [`Phalcon\Filter\Validation\Validator\File`](/5.19/api/phalcon_filter/#filtervalidationvalidatorfile) · [`Phalcon\Http\Cookie`](/5.19/api/phalcon_http/#httpcookie) · [`Phalcon\Http\Request\File`](/5.19/api/phalcon_http/#httprequestfile) · [`Phalcon\Image\ImageFactory`](/5.19/api/phalcon_image/#imageimagefactory) · [`Phalcon\Logger\LoggerFactory`](/5.19/api/phalcon_logger/#loggerloggerfactory) · [`Phalcon\Mvc\Model\MetaData`](/5.19/api/phalcon_mvc/#mvcmodelmetadata) · [`Phalcon\Session\Adapter\AbstractAdapter`](/5.19/api/phalcon_session/#sessionadapterabstractadapter) · [`Phalcon\Session\Adapter\Stream`](/5.19/api/phalcon_session/#sessionadapterstream) · [`Phalcon\Session\Manager`](/5.19/api/phalcon_session/#sessionmanager) · [`Phalcon\Storage\Adapter\AbstractAdapter`](/5.19/api/phalcon_storage/#storageadapterabstractadapter) · [`Phalcon\Support\Debug`](/5.19/api/phalcon_support/#supportdebug) · [`Phalcon\Support\Debug\ReportBuilder`](/5.19/api/phalcon_support/#supportdebugreportbuilder) · [`Phalcon\Support\Helper\Arr\Get`](/5.19/api/phalcon_support/#supporthelperarrget)
### Method Summary
### Methods
Protected · 1
getArrVal()
```php
protected static function getArrVal(
array $collection,
mixed $index,
mixed $defaultValue = null,
string|null $cast = null
): mixed;
```
## Traits\Support\Helper\Json\DecodeTrait
Trait
Source on GitHub
Decodes a string using `json_decode`, throwing the native `\JsonException`
on failure. Any framework-flavored exception is added by the `Support`
helper class that wraps this trait.
- **`Phalcon\Traits\Support\Helper\Json\DecodeTrait`**
__Used by__ [`Phalcon\Support\Helper\Json\Decode`](/5.19/api/phalcon_support/#supporthelperjsondecode)
### Method Summary
### Methods
Protected · 1
toDecode()
```php
protected static function toDecode(
string $data,
bool $associative = false,
int $depth = 512,
int $options = 79
);
```
Decodes a string using `json_decode`
## Traits\Support\Helper\Json\EncodeTrait
Trait
Source on GitHub
Encodes data using `json_encode`, throwing the native `\JsonException` on
failure. Any framework-flavored exception is added by the `Support` helper
class that wraps this trait.
- **`Phalcon\Traits\Support\Helper\Json\EncodeTrait`**
__Used by__ [`Phalcon\Logger\Formatter\Json`](/5.19/api/phalcon_logger/#loggerformatterjson) · [`Phalcon\Support\Helper\Json\Encode`](/5.19/api/phalcon_support/#supporthelperjsonencode)
### Method Summary
### Methods
Protected · 1
toEncode()
```php
protected static function toEncode(
mixed $data,
int $options = 79,
int $depth = 512
): string;
```
Encodes data using `json_encode`
## Traits\Support\Helper\Str\CamelizeTrait
Trait
Source on GitHub
Converts strings to upperCamelCase or lowerCamelCase
- **`Phalcon\Traits\Support\Helper\Str\CamelizeTrait`**
__Used by__ [`Phalcon\Support\Helper\Str\Camelize`](/5.19/api/phalcon_support/#supporthelperstrcamelize)
### Method Summary
### Methods
Public · 1
toCamelize()
```php
public static function toCamelize(
string $text,
string $delimiters = "-_",
bool $lowerFirst = false
): string;
```
## Traits\Support\Helper\Str\DirFromFileTrait
Trait
Source on GitHub
Accepts a file name (without extension) and returns a calculated
directory structure with the filename in the end
- **`Phalcon\Traits\Support\Helper\Str\DirFromFileTrait`**
__Used by__ [`Phalcon\Storage\Adapter\Stream`](/5.19/api/phalcon_storage/#storageadapterstream) · [`Phalcon\Support\Helper\Str\DirFromFile`](/5.19/api/phalcon_support/#supporthelperstrdirfromfile)
### Method Summary
### Methods
Protected · 1
toDirFromFile()
```php
protected static function toDirFromFile(
string $file,
bool $filesystemSafe = false
): string;
```
## Traits\Support\Helper\Str\DirSeparatorTrait
Trait
Source on GitHub
Accepts a directory name and ensures that it ends with
DIRECTORY_SEPARATOR
- **`Phalcon\Traits\Support\Helper\Str\DirSeparatorTrait`**
__Used by__ [`Phalcon\Mvc\View`](/5.19/api/phalcon_mvc/#mvcview) · [`Phalcon\Mvc\View\Simple`](/5.19/api/phalcon_mvc/#mvcviewsimple) · [`Phalcon\Session\Adapter\Stream`](/5.19/api/phalcon_session/#sessionadapterstream) · [`Phalcon\Storage\Adapter\Stream`](/5.19/api/phalcon_storage/#storageadapterstream) · [`Phalcon\Support\Helper\Str\DirSeparator`](/5.19/api/phalcon_support/#supporthelperstrdirseparator)
### Method Summary
### Methods
Protected · 1
toDirSeparator()
```php
protected static function toDirSeparator( string $directory ): string;
```
## Traits\Support\Helper\Str\EndsWithTrait
Trait
Source on GitHub
Check if a string ends with a given string
- **`Phalcon\Traits\Support\Helper\Str\EndsWithTrait`**
__Used by__ [`Phalcon\Support\Helper\Str\AbstractStr`](/5.19/api/phalcon_support/#supporthelperstrabstractstr)
### Method Summary
### Methods
Protected · 1
toEndsWith()
```php
protected static function toEndsWith(
string $haystack,
string $needle,
bool $ignoreCase = true
): bool;
```
## Traits\Support\Helper\Str\InterpolateTrait
Trait
Source on GitHub
Interpolates context values into the message placeholders
@see http://www.php-fig.org/psr/psr-3/ Section 1.2 Message
- **`Phalcon\Traits\Support\Helper\Str\InterpolateTrait`**
__Used by__ [`Phalcon\Logger\Formatter\AbstractFormatter`](/5.19/api/phalcon_logger/#loggerformatterabstractformatter) · [`Phalcon\Support\Debug\Dump`](/5.19/api/phalcon_support/#supportdebugdump) · [`Phalcon\Support\Debug\Renderer\HtmlRenderer`](/5.19/api/phalcon_support/#supportdebugrendererhtmlrenderer) · [`Phalcon\Support\Helper\Str\AbstractStr`](/5.19/api/phalcon_support/#supporthelperstrabstractstr) · [`Phalcon\Support\Helper\Str\Interpolate`](/5.19/api/phalcon_support/#supporthelperstrinterpolate) · [`Phalcon\Translate\Interpolator\AssociativeArray`](/5.19/api/phalcon_translate/#translateinterpolatorassociativearray)
### Method Summary
### Methods
Protected · 1
toInterpolate()
```php
protected static function toInterpolate(
string $input,
array $context = [],
string $left = "%",
string $right = "%"
): string;
```
## Traits\Support\Helper\Str\LowerTrait
Trait
Source on GitHub
Lowercases a string using mbstring
- **`Phalcon\Traits\Support\Helper\Str\LowerTrait`**
__Used by__ [`Phalcon\Support\Helper\Str\AbstractStr`](/5.19/api/phalcon_support/#supporthelperstrabstractstr)
### Method Summary
### Methods
Protected · 1
toLower()
```php
protected static function toLower(
string $text,
string $encoding = "UTF-8"
): string;
```
## Traits\Support\Helper\Str\StartsWithTrait
Trait
Source on GitHub
Check if a string starts with a given string
- **`Phalcon\Traits\Support\Helper\Str\StartsWithTrait`**
__Used by__ [`Phalcon\Support\Helper\Str\AbstractStr`](/5.19/api/phalcon_support/#supporthelperstrabstractstr)
### Method Summary
### Methods
Protected · 1
toStartsWith()
```php
protected static function toStartsWith(
string $haystack,
string $needle,
bool $ignoreCase = true
): bool;
```
## Traits\Support\Helper\Str\UncamelizeTrait
Trait
Source on GitHub
Converts strings to non camelized style
- **`Phalcon\Traits\Support\Helper\Str\UncamelizeTrait`**
__Used by__ [`Phalcon\Support\Helper\Str\Uncamelize`](/5.19/api/phalcon_support/#supporthelperstruncamelize)
### Method Summary
### Methods
Protected · 1
toUncamelize()
```php
protected static function toUncamelize(
string $text,
string $delimiter = "_"
): string;
```
## Traits\Support\Helper\Str\UpperTrait
Trait
Source on GitHub
Uppercases a string using mbstring
- **`Phalcon\Traits\Support\Helper\Str\UpperTrait`**
__Used by__ [`Phalcon\Support\Helper\Str\AbstractStr`](/5.19/api/phalcon_support/#supporthelperstrabstractstr)
### Method Summary
### Methods
Protected · 1
toUpper()
```php
protected static function toUpper(
string $text,
string $encoding = "UTF-8"
): string;
```
Source: https://docs.phalcon.io/5.19/api/phalcon_traits/index.mdx