Flextype Downloads Documentation

API Reference

Getting Started

Core Concepts

Console

Rest API

Table of contents

Class: \Flextype\Actions

Visibility Function
public __wakeup() : void
Prevent from being unserialized (which would create a second instance of it)
public static getInstance() : mixed
Gets the instance via lazy initialization (created on first usage)
protected __clone() : void
Prevent the instance from being cloned (which would create a second instance of it)
protected __construct() : void
Is not allowed to call from outside to prevent from creating multiple instances, to use the Registry, you have to obtain the instance from Registry::getInstance() instead.

This class extends \Glowy\Arrays\Arrays

This class implements \Traversable, \IteratorAggregate, \Countable, \ArrayAccess

Class: \Flextype\Plugins

Visibility Function
public __call(\string $method, array $parameters) : mixed
Dynamically handle calls to the class.
public static __callStatic(\string $method, array $parameters) : mixed
Dynamically handle calls to the class.
public __construct() : void
Constructor
public static flushMacros() : void
Flush the existing macros.
public getLocales() : array
Get locales
public getPluginsCacheID(array $pluginsList) : mixed
Get plugins Cache ID
public getPluginsDictionary(array $pluginsList, \string $locale) : mixed
Get plugins dictionary
public getPluginsList() : array
Get plugins list
public getValidPluginsDependencies(array $plugins) : mixed
Get valid plugins dependencies
public static hasMacro(\string $name) : bool
Checks if macro is registered.
public static macro(\string $name, object/callable $macro) : void
Register a custom macro.
public static mixin(\object $mixin, \bool $replace=true) : void
Mix another object into the class.
protected init() : void
Init Plugins

Class: \Flextype\Flextype

Visibility Function
public __wakeup() : void
Flextype should not be restorable from strings.
public app() : App Returns Flextype Application.
Get Flextype Application.
public container() : ContainerInterface Returns Flextype Application Container.
Get Flextype Application Container.
public static getInstance(\Psr\Container\ContainerInterface $container=null) : Flextype Returns the current Flextype Instance.
Returns Flextype Instance. Gets the instance via lazy initialization (created on first usage)
public getVersion() : string Returns the current Flextype version.
Get the current Flextype version.
protected __clone() : void
Flextype should not be cloneable.
protected __construct(\Psr\Container\ContainerInterface $container=null) : void
Flextype construct.

Class: \Flextype\I18n

Visibility Function
public static add(array $translates, \string $locale=null) : void
Add translation keys New translation keus for default locale I18n::add(['auth_login' => 'Login', 'auth_password' => 'Password']); New translation keys for en_US locale I18n::add(['auth_login' => 'Login', 'auth_password' => 'Password'], 'en_US');
public static find(\string $translate, array $values=array(), \string $locale=null) : mixed
Returns translation of a string. If no translation exists, the original string will be returned. No parameters are replaced. Get translated string for auth_login for default locale $translated_string = I18n::find('auth_login');

Class: \Flextype\Whoops

Visibility Function
public __construct(array $settings=array()) : void
Instance the whoops guard object
public install() : void
Install the whoops guard object
public setHandlers(array $handlers) : void
Set the custom handlers for whoops
public setRequest(\Psr\Http\Message\ServerRequestInterface $request) : void
Set the server request object

Class: \Flextype\Console\FlextypeConsole

Visibility Function
public run(\Symfony\Component\Console\Input\InputInterface $input=null, \Symfony\Component\Console\Output\OutputInterface $output=null) : void

This class extends \Symfony\Component\Console\Application

This class implements \Symfony\Contracts\Service\ResetInterface

Class: \Flextype\Console\Commands\AboutCommand

Visibility Function
protected configure() : void
protected execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output) : void

This class extends \Symfony\Component\Console\Command\Command

Class: \Flextype\Console\Commands\Cache\CacheClearCommand

Visibility Function
protected configure() : void
protected execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output) : void

This class extends \Symfony\Component\Console\Command\Command

Class: \Flextype\Console\Commands\Cache\CacheClearConfigCommand

Visibility Function
protected configure() : void
protected execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output) : void

This class extends \Symfony\Component\Console\Command\Command

Class: \Flextype\Console\Commands\Cache\CacheSetMultipleCommand

Visibility Function
protected configure() : void
protected execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output) : void

This class extends \Symfony\Component\Console\Command\Command

Class: \Flextype\Console\Commands\Cache\CacheGetMultipleCommand

Visibility Function
protected configure() : void
protected execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output) : void

This class extends \Symfony\Component\Console\Command\Command

Class: \Flextype\Console\Commands\Cache\CacheDeleteMultipleCommand

Visibility Function
protected configure() : void
protected execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output) : void

This class extends \Symfony\Component\Console\Command\Command

Class: \Flextype\Console\Commands\Cache\CacheHasCommand

Visibility Function
protected configure() : void
protected execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output) : void

This class extends \Symfony\Component\Console\Command\Command

Class: \Flextype\Console\Commands\Cache\CacheClearDataCommand

Visibility Function
protected configure() : void
protected execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output) : void

This class extends \Symfony\Component\Console\Command\Command

Class: \Flextype\Console\Commands\Cache\CacheSetCommand

Visibility Function
protected configure() : void
protected execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output) : void

This class extends \Symfony\Component\Console\Command\Command

Class: \Flextype\Console\Commands\Cache\CacheClearRoutesCommand

Visibility Function
protected configure() : void
protected execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output) : void

This class extends \Symfony\Component\Console\Command\Command

Class: \Flextype\Console\Commands\Cache\CacheDeleteCommand

Visibility Function
protected configure() : void
protected execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output) : void

This class extends \Symfony\Component\Console\Command\Command

Class: \Flextype\Console\Commands\Cache\CacheGetCommand

Visibility Function
protected configure() : void
protected execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output) : void

This class extends \Symfony\Component\Console\Command\Command

Class: \Flextype\Console\Commands\Entries\EntriesMoveCommand

Visibility Function
protected configure() : void
protected execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output) : void

This class extends \Symfony\Component\Console\Command\Command

Class: \Flextype\Console\Commands\Entries\EntriesDeleteCommand

Visibility Function
protected configure() : void
protected execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output) : void

This class extends \Symfony\Component\Console\Command\Command

Class: \Flextype\Console\Commands\Entries\EntriesCreateCommand

Visibility Function
protected configure() : void
protected execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output) : void

This class extends \Symfony\Component\Console\Command\Command

Class: \Flextype\Console\Commands\Entries\EntriesUpdateCommand

Visibility Function
protected configure() : void
protected execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output) : void

This class extends \Symfony\Component\Console\Command\Command

Class: \Flextype\Console\Commands\Entries\EntriesHasCommand

Visibility Function
protected configure() : void
protected execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output) : void

This class extends \Symfony\Component\Console\Command\Command

Class: \Flextype\Console\Commands\Entries\EntriesFetchCommand

Visibility Function
protected configure() : void
protected execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output) : void

This class extends \Symfony\Component\Console\Command\Command

Class: \Flextype\Console\Commands\Entries\EntriesCopyCommand

Visibility Function
protected configure() : void
protected execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output) : void

This class extends \Symfony\Component\Console\Command\Command

Class: \Flextype\Console\Commands\Tokens\TokensFetchCommand

Visibility Function
protected configure() : void
protected execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output) : void

This class extends \Symfony\Component\Console\Command\Command

Class: \Flextype\Console\Commands\Tokens\TokensDeleteCommand

Visibility Function
protected configure() : void
protected execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output) : void

This class extends \Symfony\Component\Console\Command\Command

Class: \Flextype\Console\Commands\Tokens\TokensCreateCommand

Visibility Function
protected configure() : void
protected execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output) : void

This class extends \Symfony\Component\Console\Command\Command

Class: \Flextype\Console\Commands\Tokens\TokensUpdateCommand

Visibility Function
protected configure() : void
protected execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output) : void

This class extends \Symfony\Component\Console\Command\Command

Class: \Flextype\Console\Commands\Tokens\TokensGenerateCommand

Visibility Function
protected configure() : void
protected execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output) : void

This class extends \Symfony\Component\Console\Command\Command

Class: \Flextype\Console\Commands\Tokens\TokensVerifyHashCommand

Visibility Function
protected configure() : void
protected execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output) : void

This class extends \Symfony\Component\Console\Command\Command

Class: \Flextype\Console\Commands\Tokens\TokensHasCommand

Visibility Function
protected configure() : void
protected execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output) : void

This class extends \Symfony\Component\Console\Command\Command

Class: \Flextype\Console\Commands\Tokens\TokensGenerateHashCommand

Visibility Function
protected configure() : void
protected execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output) : void

This class extends \Symfony\Component\Console\Command\Command

Class: \Flextype\Endpoints\Entries

Visibility Function
public copy(\Psr\Http\Message\ServerRequestInterface $request, \Psr\Http\Message\ResponseInterface $response) : ResponseInterface Response.
Copy entry.
public create(\Psr\Http\Message\ServerRequestInterface $request, \Psr\Http\Message\ResponseInterface $response) : ResponseInterface Response.
Create entry.
public delete(\Psr\Http\Message\ServerRequestInterface $request, \Psr\Http\Message\ResponseInterface $response) : ResponseInterface Response.
Delete entry.
public fetch(\Psr\Http\Message\ServerRequestInterface $request, \Psr\Http\Message\ResponseInterface $response) : ResponseInterface Response.
Fetch entry.
public move(\Psr\Http\Message\ServerRequestInterface $request, \Psr\Http\Message\ResponseInterface $response) : ResponseInterface Response.
Move entry.
public update(\Psr\Http\Message\ServerRequestInterface $request, \Psr\Http\Message\ResponseInterface $response) : ResponseInterface Response.
Update entry.

This class extends \Flextype\Endpoints\Api

Class: \Flextype\Endpoints\Tokens

Visibility Function
public create(\Psr\Http\Message\ServerRequestInterface $request, \Psr\Http\Message\ResponseInterface $response) : ResponseInterface Response.
Create token entry
public delete(\Psr\Http\Message\ServerRequestInterface $request, \Psr\Http\Message\ResponseInterface $response) : ResponseInterface Response.
Delete token entry.
public fetch(\Psr\Http\Message\ServerRequestInterface $request, \Psr\Http\Message\ResponseInterface $response) : ResponseInterface Response.
Fetch token entry.
public generate(\Psr\Http\Message\ServerRequestInterface $request, \Psr\Http\Message\ResponseInterface $response) : ResponseInterface Response.
Generate token.
public generateHash(\Psr\Http\Message\ServerRequestInterface $request, \Psr\Http\Message\ResponseInterface $response) : ResponseInterface Response.
Generate token hash
public update(\Psr\Http\Message\ServerRequestInterface $request, \Psr\Http\Message\ResponseInterface $response) : ResponseInterface Response.
Update token entry.
public verifyHash(\Psr\Http\Message\ServerRequestInterface $request, \Psr\Http\Message\ResponseInterface $response) : ResponseInterface Response.
Verify token hash

This class extends \Flextype\Endpoints\Api

Class: \Flextype\Endpoints\Cache

Visibility Function
public clear(\Psr\Http\Message\ServerRequestInterface $request, \Psr\Http\Message\ResponseInterface $response) : ResponseInterface Response.
Clear cache.

This class extends \Flextype\Endpoints\Api

Class: \Flextype\Endpoints\Registry

Visibility Function
public get(\Psr\Http\Message\ServerRequestInterface $request, \Psr\Http\Message\ResponseInterface $response) : ResponseInterface Response.
Get registry item.

This class extends \Flextype\Endpoints\Api

Class: \Flextype\Endpoints\Api

Visibility Function
public getApiResponse(mixed $response, array $body=array(), \int $status=200) : ResponseInterface Response.
Get API response.
public getStatusCodeMessage(\int $status) : array Message.
Get Status Code Message.
public validateApiRequest(array $options) : void
Validate Api Request.

Class: \Flextype\Entries\Entries

Visibility Function
public __call(\string $method, array $parameters) : mixed
Dynamically handle calls to the class.
public static __callStatic(\string $method, array $parameters) : mixed
Dynamically handle calls to the class.
public __construct(mixed $options=null, mixed $registry=null) : void
Create a new entries object.
public copy(\string $id, \string $newID) : bool True on success, false on failure.
Copy entry.
public create(\string $id, array $data=array()) : bool True on success, false on failure.
Create entry.
public delete(\string $id) : bool True on success, false on failure.
Delete entry.
public fetch(\string $id, array $options=array()) : mixed Returns mixed results from APIs or default is an instance of The Collection class with founded items.
Fetch.
public static flushMacros() : void
Flush the existing macros.
public getCacheID(\string $id, \string $string='') : string Cache ID.
Get Cache ID for entry.
public getDirectoryLocation(\string $id) : string Entry directory location.
Get entry directory location.
public getFileLocation(\string $id) : string Entry file location.
Get entry file location.
public has(\string $id) : bool True on success, false on failure.
Check whether entry exists.
public static hasMacro(\string $name) : bool
Checks if macro is registered.
public initDirectives(array $directives) : void
Init Directives
public initExpressions(array $expressions) : void
Init Expressions
public initMacros(array $macros) : void
Init Macros
public static macro(\string $name, object/callable $macro) : void
Register a custom macro.
public static mixin(\object $mixin, \bool $replace=true) : void
Mix another object into the class.
public move(\string $id, \string $newID) : bool True on success, false on failure.
Move entry.
public options() : Collection Returns entries options.
Get Entries options.
public registry() : Collection Returns entries registry.
Get Entries Registry.
public setOptions(mixed $options=null) : \Flextype\Entries\self
Set Entries options.
public setRegistry(mixed $registry=null) : \Flextype\Entries\self
Set Entries registry.
public update(\string $id, array $data) : bool True on success, false on failure.
Update entry.

Class: \Flextype\Entries\Expressions\VarExpression

Visibility Function
public getFunctions() : mixed

This class implements \Symfony\Component\ExpressionLanguage\ExpressionFunctionProviderInterface

Class: \Flextype\Entries\Expressions\StringsExpression

Visibility Function
public getFunctions() : mixed

This class implements \Symfony\Component\ExpressionLanguage\ExpressionFunctionProviderInterface

Class: \Flextype\Entries\Expressions\CollectionExpression

Visibility Function
public getFunctions() : mixed

This class implements \Symfony\Component\ExpressionLanguage\ExpressionFunctionProviderInterface

Class: \Flextype\Entries\Expressions\EntriesExpression

Visibility Function
public getFunctions() : mixed

This class implements \Symfony\Component\ExpressionLanguage\ExpressionFunctionProviderInterface

Class: \Flextype\Entries\Expressions\ActionsExpression

Visibility Function
public getFunctions() : mixed

This class implements \Symfony\Component\ExpressionLanguage\ExpressionFunctionProviderInterface

Class: \Flextype\Entries\Expressions\FilesystemExpression

Visibility Function
public getFunctions() : mixed

This class implements \Symfony\Component\ExpressionLanguage\ExpressionFunctionProviderInterface

Class: \Flextype\Entries\Expressions\SlugifyExpression

Visibility Function
public getFunctions() : mixed

This class implements \Symfony\Component\ExpressionLanguage\ExpressionFunctionProviderInterface

Class: \Flextype\Entries\Expressions\I18nExpression

Visibility Function
public getFunctions() : mixed

This class implements \Symfony\Component\ExpressionLanguage\ExpressionFunctionProviderInterface

Class: \Flextype\Entries\Expressions\ConstExpression

Visibility Function
public getFunctions() : mixed

This class implements \Symfony\Component\ExpressionLanguage\ExpressionFunctionProviderInterface

Class: \Flextype\Entries\Expressions\FieldExpression

Visibility Function
public getFunctions() : mixed

This class implements \Symfony\Component\ExpressionLanguage\ExpressionFunctionProviderInterface

Class: \Flextype\Entries\Expressions\UrlExpression

Visibility Function
public getFunctions() : mixed

This class implements \Symfony\Component\ExpressionLanguage\ExpressionFunctionProviderInterface

Class: \Flextype\Entries\Expressions\SerializersExpression

Visibility Function
public getFunctions() : mixed

This class implements \Symfony\Component\ExpressionLanguage\ExpressionFunctionProviderInterface

Class: \Flextype\Entries\Expressions\CsrfExpression

Visibility Function
public getFunctions() : mixed

This class implements \Symfony\Component\ExpressionLanguage\ExpressionFunctionProviderInterface

Class: \Flextype\Entries\Expressions\ParsersExpression

Visibility Function
public getFunctions() : mixed

This class implements \Symfony\Component\ExpressionLanguage\ExpressionFunctionProviderInterface

Class: \Flextype\Entries\Expressions\RegistryExpression

Visibility Function
public getFunctions() : mixed

This class implements \Symfony\Component\ExpressionLanguage\ExpressionFunctionProviderInterface

Class: \Flextype\Middlewares\CsrfMiddleware

Visibility Function
public __invoke(\Psr\Http\Message\ServerRequestInterface $request, \Psr\Http\Server\RequestHandlerInterface $handler) : void
Invoke

Class: \Flextype\Middlewares\WhoopsMiddleware

Visibility Function
public __construct(array $settings=array(), array $handlers=array()) : void
Instance the whoops middleware object
public process(\Psr\Http\Message\ServerRequestInterface $request, \Psr\Http\Server\RequestHandlerInterface $handler) : void
Handle the requests

This class implements \Psr\Http\Server\MiddlewareInterface

Class: \Flextype\Parsers\Shortcodes

Visibility Function
public __wakeup() : void
Shortcode should not be restorable from strings.
public addEventHandler(\string $name, \callable $handler) : void
Add event handler.
public addHandler(\string $name, \callable $handler) : void
Add shortcode handler.
public facade() : void
Shortcode facade.
public getCacheID(\string $input, \string $string='') : string Cache ID.
Get Cache ID for shortcode.
public static getInstance() : mixed
Gets the instance via lazy initialization (created on first usage).
public initShortcodes(array $shortcodes) : void
Init Shortcodes
public parse(\string $input) : void
Parse and processes text to replaces shortcodes.
public parseText(\string $input) : void
Parses text into shortcodes.
protected __clone() : void
Shortcode should not be cloneable.
protected __construct() : void
Shortcode construct.

Class: \Flextype\Parsers\Markdown

Visibility Function
public __wakeup() : void
Markdown should not be restorable from strings.
public converter() : void
Markdown Converter
public environment() : void
Markdown Environment
public getCacheID(\string $input, \string $string='') : string Cache ID.
Get Cache ID for markdown.
public static getInstance() : mixed
Gets the instance via lazy initialization (created on first usage).
public parse(\string $input) : mixed The MARKDOWN converted to a PHP value
Takes a MARKDOWN encoded string and converts it into a PHP variable.
protected __clone() : void
Markdown should not be cloneable.
protected __construct() : void
Markdown construct

Class: \Flextype\Parsers\Textile

Visibility Function
public __wakeup() : void
Textile should not be restorable from strings.
public environment() : void
Textile Environment
public getCacheID(\string $input, \string $string='') : string Cache ID.
Get Cache ID for textile.
public static getInstance() : mixed
Gets the instance via lazy initialization (created on first usage).
public parse(\string $input) : mixed The TEXTILE converted to a PHP value
Takes a TEXTILE encoded string and converts it into a PHP variable.
protected __clone() : void
Textile should not be cloneable.
protected __construct() : void
Textile construct

Class: \Flextype\Parsers\Parsers

Visibility Function
public __call(\string $method, array $parameters) : mixed
Dynamically handle calls to the class.
public static __callStatic(\string $method, array $parameters) : mixed
Dynamically handle calls to the class.
public static flushMacros() : void
Flush the existing macros.
public static hasMacro(\string $name) : bool
Checks if macro is registered.
public static macro(\string $name, object/callable $macro) : void
Register a custom macro.
public markdown() : void
Create a Markdown instance.
public static mixin(\object $mixin, \bool $replace=true) : void
Mix another object into the class.
public shortcodes() : void
Create a Shortcodes instance.
public textile() : void
Create a Textile instance.

Class: \Flextype\Serializers\Frontmatter

Visibility Function
public decode(\string $input) : mixed The FRONTMATTER converted to a PHP value.
Takes a FRONTMATTER encoded string and converts it into a PHP variable.
public encode(\mixed $input) : string A FRONTMATTER string representing the original PHP value.
Returns the FRONTMATTER representation of a value.
public getCacheID(\string $input, \string $string='') : string Cache ID.
Get Cache ID for frontmatter.

Class: \Flextype\Serializers\Json

Visibility Function
public decode(\string $input) : mixed The JSON converted to a PHP value
Takes a JSON encoded string and converts it into a PHP variable.
public encode(\mixed $input) : mixed A JSON string representing the original PHP value
Returns the JSON representation of a value
public getCacheID(\string $input, \string $string='') : string Cache ID.
Get Cache ID for JSON.

Class: \Flextype\Serializers\Serializers

Visibility Function
public __call(\string $method, array $parameters) : mixed
Dynamically handle calls to the class.
public static __callStatic(\string $method, array $parameters) : mixed
Dynamically handle calls to the class.
public static flushMacros() : void
Flush the existing macros.
public frontmatter() : void
Create a Frontmatter instance.
public static hasMacro(\string $name) : bool
Checks if macro is registered.
public json() : void
Create a Json instance.
public json5() : void
Create a Json instance.
public static macro(\string $name, object/callable $macro) : void
Register a custom macro.
public static mixin(\object $mixin, \bool $replace=true) : void
Mix another object into the class.
public neon() : void
Create a Neon instance.
public phparray() : void
Create a PhpArray instance.
public yaml() : void
Create a Yaml instance.

Class: \Flextype\Serializers\PhpArray

Visibility Function
public decode(\string $input) : mixed The PhpArray converted to a PHP value.
Takes a PhpArray encoded string and converts it into a PHP variable.
public encode(\mixed $input) : string A PhpArray string representing the original PHP value.
Returns the PhpArray representation of a value.
public getCacheID(\string $input, \string $string='') : string Cache ID.
Get Cache ID for phparray.

Class: \Flextype\Serializers\Json5

Visibility Function
public decode(\string $input) : mixed The JSON5 converted to a PHP value.
Takes a JSON5 encoded string and converts it into a PHP variable.
public encode(\mixed $input) : mixed A JSON5 string representing the original PHP value.
Returns the JSON5 representation of a value.
public getCacheID(\string $input, \string $string='') : string Cache ID.
Get Cache ID for JSON5.

Class: \Flextype\Serializers\Yaml

Visibility Function
public decode(\string $input) : mixed The YAML converted to a PHP value.
Parses YAML into a PHP value.
public encode(\mixed $input) : string A YAML string representing the original PHP value.
Dumps a PHP value to a YAML string. The dump method, when supplied with an array, will do its best to convert the array into friendly YAML.
public getCacheID(\string $input, \string $string='') : string Cache ID.
Get Cache ID for YAML.

Class: \Flextype\Serializers\Neon

Visibility Function
public decode(\string $input) : mixed The NEON converted to a PHP value.
Takes a NEON encoded string and converts it into a PHP variable.
public encode(\mixed $input) : string A NEON string representing the original PHP value.
Returns the NEON representation of a value.
public getCacheID(\string $input, \string $string='') : string Cache ID.
Get Cache ID for neon.

Class: \Phpfastcache\Drivers\Phparray\Config

Visibility Function
public __construct(array $parameters=array()) : void
ConfigurationOptionInterface constructor.

This class extends \Phpfastcache\Config\IOConfigurationOption

This class implements \Phpfastcache\Config\ConfigurationOptionInterface, \Phpfastcache\Config\LockableConfigurationInterface, \Phpfastcache\Config\IOConfigurationOptionInterface

Class: \Phpfastcache\Drivers\Phparray\Driver

Visibility Function
public __construct(\Phpfastcache\Config\ConfigurationOptionInterface $config, \string $instanceId, \Phpfastcache\Event\EventManagerInterface $em) : void
public __driverBaseConstruct(\Phpfastcache\Config\ConfigurationOptionInterface $config, \string $instanceId, \Phpfastcache\Event\EventManagerInterface $em) : void
Driver constructor.
public appendItemsByTag(\string $tagName, \Phpfastcache\Core\Pool\array/string/\string $data, \int $strategy=1) : bool True if the item was successfully appended. False if there was an error.
Decrement the items from the pool by tag. The tag for which to append
public appendItemsByTags(string[] $tagNames, \Phpfastcache\Core\Pool\array/string/\string $data, \int $strategy=1) : bool True if the items were successfully appended. False if there was an error.
Append the items from the pool by one of multiple tag names. The tag for which to append
public attachItem(\Psr\Cache\CacheItemInterface $item) : void
public clear() : bool
public commit() : bool
public decrementItemsByTag(\string $tagName, \int $step=1, \int $strategy=1) : bool True if the item was successfully decremented. False if there was an error.
Decrement the items from the pool by tag. The tag for which to decrement
public decrementItemsByTags(string[] $tagNames, \int $step=1, \int $strategy=1) : bool True if the item was successfully decremented. False if there was an error.
Decrement the items from the pool by one of multiple tag names. The tag for which to decrement
public deleteItem(\string $key) : bool
public deleteItems(string[] $keys) : bool True if the items were successfully removed. False if there was an error.
Removes multiple items from the pool. An array of keys that should be removed from the pool.
public deleteItemsByTag(\string $tagName, \int $strategy=1) : bool True if the item was successfully removed. False if there was an error.
Removes the item from the pool by tag. The tag for which to delete
public deleteItemsByTags(string[] $tagNames, \int $strategy=1) : bool True if the items were successfully removed. False if there was an error.
Removes the item from the pool by one of multiple tag names. The tag for which to delete
public detachAllItems() : void
public detachItem(\Psr\Cache\CacheItemInterface $item) : void
public driverCheck() : void
public driverPreWrap(\Phpfastcache\Core\Item\ExtendedCacheItemInterface $item, \bool $stringifyDate=false) : array<string, mixed>
public driverUnwrapCdate(array $wrapper) : \Phpfastcache\Drivers\Phparray\DateTimeInterface/null
public driverUnwrapData(array $wrapper) : mixed
public driverUnwrapEdate(array $wrapper) : \Phpfastcache\Drivers\Phparray\DateTimeInterface
public driverUnwrapMdate(array $wrapper) : \Phpfastcache\Drivers\Phparray\DateTimeInterface/null
public getClassName() : string
public static getClassNamespace() : string
public getConfig() : \Phpfastcache\Drivers\Phparray\ConfigurationOptionInterface
public static getConfigClass() : string
public getDefaultConfig() : \Phpfastcache\Drivers\Phparray\ConfigurationOptionInterface
public getDriverName() : string
public getEventManager() : \Phpfastcache\Drivers\Phparray\EventManagerInterface
public getHelp() : string
public getIO() : \Phpfastcache\Drivers\Phparray\DriverIO
public getInstanceId() : string
public getItem(\string $key) : \Phpfastcache\Core\Item\ExtendedCacheItemInterface
public static getItemClass() : mixed
public getItems(array/string[] $keys=array()) : iterable An iterable collection of Cache Items keyed by the cache keys of each item. A Cache item will be returned for each key, even if that key is not found. However, if no keys are specified then an empty traversable MUST be returned instead.
Returns a traversable set of cache items. An indexed array of keys of items to retrieve.
public getItemsAsJsonString(array/\Phpfastcache\Core\Pool\array/array $keys=array(), \int $options=4194304, \int $depth=512) : string
Returns A json string that represents an array of items.
public getItemsByTag(\string $tagName, \int $strategy=1) : ExtendedCacheItemInterface[] A traversable collection of Cache Items keyed by the cache keys of each item. A Cache item will be returned for each key, even if that key is not found. However, if no keys are specified then an empty traversable MUST be returned instead.
Returns a traversable set of cache items by a tag name. An indexed array of keys of items to retrieve.
public getItemsByTags(string[] $tagNames, \int $strategy=1) : ExtendedCacheItemInterface[] A traversable collection of Cache Items keyed by the cache keys of each item. A Cache item will be returned for each key, even if that key is not found. However, if no keys are specified then an empty traversable MUST be returned instead.
Returns a traversable set of cache items by one of multiple tag names. An indexed array of keys of items to retrieve.
public getItemsByTagsAsJsonString(string[] $tagNames, \int $option=4194304, \int $depth=512, \int $strategy=1) : string
Returns A json string that represents an array of items by tags-based. An indexed array of keys of items to retrieve.
public getPath(\bool $readonly=false) : string
public getStats() : \Phpfastcache\Drivers\Phparray\DriverStatistic
Provide a generic getStats() method for files-based drivers
public hasEventManager() : bool
public hasItem(\string $key) : bool
public incrementItemsByTag(\string $tagName, \int $step=1, \int $strategy=1) : bool True if the item was successfully incremented. False if there was an error.
Increment the items from the pool by tag. The tag for which to increment
public incrementItemsByTags(string[] $tagNames, \int $step=1, \int $strategy=1) : bool True if the items were successfully incremented. False if there was an error.
Increment the items from the pool by one of multiple tag names. The tag for which to increment
public isAggregatedBy() : bool
public isAttached(\Psr\Cache\CacheItemInterface $item) : bool
public prependItemsByTag(\string $tagName, \Phpfastcache\Core\Pool\array/string/\string $data, \int $strategy=1) : bool True if the item was successfully prepended. False if there was an error.
Prepend the items from the pool by tag. The tag for which to prepend
public prependItemsByTags(string[] $tagNames, \Phpfastcache\Core\Pool\array/string/\string $data, \int $strategy=1) : bool True if the item was successfully prepended. False if there was an error.
Prepend the items from the pool by one of multiple tag names. The tag for which to prepend
public save(\Psr\Cache\CacheItemInterface $item) : bool
public saveDeferred(\Psr\Cache\CacheItemInterface $item) : bool
public saveMultiple(mixed $items) : bool
public setAggregatedBy(\Phpfastcache\Cluster\ClusterPoolInterface $clusterPool) : void
public setConfig(\Phpfastcache\Config\ConfigurationOptionInterface $config) : \Phpfastcache\Drivers\Phparray\static
public setEventManager(\Phpfastcache\Event\EventManagerInterface $em) : \Phpfastcache\Drivers\Phparray\static
public setItem(\Psr\Cache\CacheItemInterface $item) : void
protected assertCacheItemType(\Phpfastcache\Core\Item\ExtendedCacheItemInterface $item, \string $expectedClassType) : void
protected buildSecurityKey(\string $httpHost) : void
protected static buildTokenClasses(\string $namespace, \string $class, string[] $classes, \int $index, \Phpfastcache\Drivers\Phparray\array<array/\Phpfastcache\Drivers\Phparray\string>/array $tokens) : string[]
protected static buildTokenNamespace(\int $index, \Phpfastcache\Drivers\Phparray\array<array/\Phpfastcache\Drivers\Phparray\string>/array $tokens) : string
protected static cleanFileName(\string $filename) : string
protected cleanItemTags(\Phpfastcache\Core\Item\ExtendedCacheItemInterface $item) : void
protected static createClassMap(\string $dir) : array<string, string> A class map array
Iterate over all files in the given directory searching for classes. NOTICE: This method has been borrowed from Symfony ClassLoader 3.4 since they deprecated the whole component as of SF4. Our thanks to them.
protected decode(string/null/\string $value) : mixed
Decode data types such as object/array for driver that does not support non-scalar value
protected deregisterItem(\string $item) : void
protected driverClear() : void
protected driverConnect() : void
protected driverDelete(\Phpfastcache\Core\Item\ExtendedCacheItemInterface $item) : void
protected driverRead(\Phpfastcache\Core\Item\ExtendedCacheItemInterface $item) : ?array<string, mixed>
protected driverUnwrapTags(\Phpfastcache\Drivers\Phparray\array/array $wrapper) : string[]
protected driverWrite(\Phpfastcache\Core\Item\ExtendedCacheItemInterface $item) : void
protected driverWriteTags(\Phpfastcache\Core\Item\ExtendedCacheItemInterface $item) : bool
protected encode(\mixed $data) : string
Encode data types such as object/array for driver that does not support non-scalar value
protected encodeFilename(\string $keyword) : string
protected fetchItemsByTagFromBackend(\string $tagName) : \Phpfastcache\Core\Item\ExtendedCacheItemInterface[]
protected static findClasses(\string $path) : string[] The found classes
Extract the classes in the given file. NOTICE: This method has been borrowed from Symfony ClassLoader 3.4 since they deprecated the whole component as of SF4. Our thanks to them.
protected getDefaultChmod() : int
protected getFilePath(string/bool/\bool $keyword, \bool $skip=false) : string
protected getTagKey(\string $key) : string
protected getTagKeys(\Phpfastcache\Drivers\Phparray\array/array $keys) : \Phpfastcache\Drivers\Phparray\array
protected handleExpiredCacheItem(\Phpfastcache\Core\Item\ExtendedCacheItemInterface $item) : void
protected mkdir(\string $fullPath, \string $fullPathTmp) : void
protected readFile(\string $file) : string
protected validateCacheKey(\string $key) : void
protected writeFile(\string $file, \string $data, \bool $secureFileManipulation=false) : bool

This class implements \Phpfastcache\Cluster\AggregatablePoolInterface, \Psr\Cache\CacheItemPoolInterface, \Phpfastcache\Event\EventManagerDispatcherInterface, \Phpfastcache\Util\ClassNamespaceResolverInterface, \Phpfastcache\Core\Pool\TaggableCacheItemPoolInterface, \Phpfastcache\Core\Pool\ExtendedCacheItemPoolInterface

Class: \Phpfastcache\Drivers\Phparray\Item

Visibility Function
public __construct(\Phpfastcache\Core\Pool\ExtendedCacheItemPoolInterface $driver, \string $key, \Phpfastcache\Event\EventManagerInterface $em) : void
Item constructor.
public addTag(\string $tagName) : \Phpfastcache\Core\Item\ExtendedCacheItemInterface
public addTags(string[] $tagNames) : \Phpfastcache\Core\Item\ExtendedCacheItemInterface
public append(\string $data) : void
public cloneInto(\Phpfastcache\Core\Item\ExtendedCacheItemInterface $itemTarget, \Phpfastcache\Core\Pool\ExtendedCacheItemPoolInterface $itemPoolTarget=null) : void
public decrement(\int $step=1) : void
public doesItemBelongToThatDriverBackend(\Phpfastcache\Core\Pool\ExtendedCacheItemPoolInterface $driverPool) : void
public expiresAfter(\null $time) : \Phpfastcache\Drivers\Phparray$this
public expiresAt(\DateTimeInterface $expiration) : void
public get() : mixed
public getClassName() : string
public static getClassNamespace() : string
public getCreationDate() : \DateTimeInterface
public getDataAsJsonString(\int $options=4194304, \int $depth=512) : string
Return the data as a well-formatted string. Any scalar value will be casted to an array
public getEncodedKey() : string The encoded key string for this cache item.
Returns the encoded key for the current cache item. Is a MD5 (default),SHA1,SHA256 hash if "defaultKeyHashFunction" config option is configured Else return the plain cache item key "defaultKeyHashFunction" config option is emptied
public getEventManager() : \Phpfastcache\Drivers\Phparray\EventManagerInterface
public getExpirationDate() : \DateTimeInterface
public getKey() : mixed
public getLength() : int
Return the data length: Either the string length if it's a string (binary mode) # or the number of element (count) if it's an array # or the number returned by count() if it's an object implementing \Countable interface # -1 for anything else
public getModificationDate() : \DateTimeInterface
public getRawValue() : mixed
Returns the raw value, regardless of hit status. This method can be called if the cache item is NOT YET persisted, and you need to access to its set value. Although not part of the CacheItemInterface, this method is used by the pool for extracting information for saving.
public getRemovedTags() : string[]
public getTags() : string[]
public getTagsAsString(\string $separator=', ') : string
public getTtl() : mixed
public hasEventManager() : bool
public hasTag(\string $tagName) : bool
public hasTags(string[] $tagNames, \int $strategy=1) : bool
public increment(\int $step=1) : void
public isEmpty() : bool
public isExpired() : bool
public isHit() : bool
public isNull() : bool
public jsonSerialize() : void
public prepend(\string $data) : void
public removeTag(\string $tagName) : \Phpfastcache\Core\Item\ExtendedCacheItemInterface
public removeTags(string[] $tagNames) : \Phpfastcache\Core\Item\ExtendedCacheItemInterface
public set(\mixed $value) : void
public setCreationDate(mixed/\DateTimeInterface $date) : \Phpfastcache\Core\Item\ExtendedCacheItemInterface
public setDriver(\Phpfastcache\Core\Pool\ExtendedCacheItemPoolInterface $driver) : \Phpfastcache\Core\Item\ExtendedCacheItemInterface
public setEventManager(\Phpfastcache\Event\EventManagerInterface $em) : \Phpfastcache\Drivers\Phparray\static
public setExpirationDate(\DateTimeInterface $expiration) : ExtendedCacheItemInterface The called object.
Alias of expireAt() with forced $expiration param The point in time after which the item MUST be considered expired. If null is passed explicitly, a default value MAY be used. If none is set, the value should be stored permanently or for as long as the implementation allows.
public setHit(\bool $isHit) : \Phpfastcache\Core\Item\ExtendedCacheItemInterface
public setModificationDate(mixed/\DateTimeInterface $date) : \Phpfastcache\Core\Item\ExtendedCacheItemInterface
public setTags(string[] $tags) : \Phpfastcache\Core\Item\ExtendedCacheItemInterface
protected static buildTokenClasses(\string $namespace, \string $class, string[] $classes, \int $index, \Phpfastcache\Drivers\Phparray\array<array/\Phpfastcache\Drivers\Phparray\string>/array $tokens) : string[]
protected static buildTokenNamespace(\int $index, \Phpfastcache\Drivers\Phparray\array<array/\Phpfastcache\Drivers\Phparray\string>/array $tokens) : string
protected static createClassMap(\string $dir) : array<string, string> A class map array
Iterate over all files in the given directory searching for classes. NOTICE: This method has been borrowed from Symfony ClassLoader 3.4 since they deprecated the whole component as of SF4. Our thanks to them.
protected demutateDatetime(\DateTimeInterface $dateTime) : void
protected static findClasses(\string $path) : string[] The found classes
Extract the classes in the given file. NOTICE: This method has been borrowed from Symfony ClassLoader 3.4 since they deprecated the whole component as of SF4. Our thanks to them.
protected getDriverClass() : mixed

This class implements \Phpfastcache\Core\Item\ExtendedCacheItemInterface, \Phpfastcache\Core\Item\TaggableCacheItemInterface, \JsonSerializable, \Phpfastcache\Util\ClassNamespaceResolverInterface, \Phpfastcache\Event\EventManagerDispatcherInterface, \Psr\Cache\CacheItemInterface

Edit this page