diff --git a/docs/api/phalcon_acl.md b/docs/api/phalcon_acl.md index 6dabb19c3..ded847583 100644 --- a/docs/api/phalcon_acl.md +++ b/docs/api/phalcon_acl.md @@ -7,24 +7,29 @@ hide: All classes are prefixed with `Phalcon` -## Acl\Adapter\AbstractAdapter + + +## Acl\Adapter\AbstractAdapter ![Abstract](assets/images/abstract-green.png) + +[Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Acl/Adapter/AbstractAdapter.zep) + - __Namespace__ - `Phalcon\Acl\Adapter` - __Uses__ - - - `Phalcon\Acl\Enum` + + - `Phalcon\Acl\Enum` - `Phalcon\Events\AbstractEventsAware` - `Phalcon\Events\EventsAwareInterface` - __Extends__ - + `AbstractEventsAware` - __Implements__ - + - `AdapterInterface` - `EventsAwareInterface` @@ -106,24 +111,25 @@ Sets the default access level (Phalcon\Acl\Enum::ALLOW or Phalcon\Acl\Enum::DENY -## Acl\Adapter\AdapterInterface +## Acl\Adapter\AdapterInterface ![Abstract](assets/images/interface-blue.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Acl/Adapter/AdapterInterface.zep) + - __Namespace__ - `Phalcon\Acl\Adapter` - __Uses__ - + - `Phalcon\Acl\ComponentInterface` - `Phalcon\Acl\RoleInterface` - __Extends__ - + - __Implements__ - + Interface for Phalcon\Acl adapters @@ -262,33 +268,35 @@ accessKey -## Acl\Adapter\Memory + +## Acl\Adapter\Memory [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Acl/Adapter/Memory.zep) + - __Namespace__ - `Phalcon\Acl\Adapter` - __Uses__ - + - `Phalcon\Acl\Component` - `Phalcon\Acl\ComponentAwareInterface` - `Phalcon\Acl\ComponentInterface` - `Phalcon\Acl\Enum` - `Phalcon\Acl\Exception` - `Phalcon\Acl\Role` - - `Phalcon\Acl\RoleInterface` - `Phalcon\Acl\RoleAwareInterface` + - `Phalcon\Acl\RoleInterface` - `ReflectionClass` - `ReflectionFunction` - __Extends__ - + `AbstractAdapter` - __Implements__ - + Manages ACL lists in memory @@ -353,7 +361,7 @@ foreach ($privateComponents as $component => $actions) { ``` -## Properties +### Properties ```php /** * Access @@ -434,7 +442,7 @@ protected roleInherits; ``` -## Methods +### Methods ```php public function __construct(); @@ -638,17 +646,29 @@ accessKey -

Class Phalcon\Acl\Component

+## Acl\Component [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Acl/Component.zep) -| Namespace | Phalcon\Acl | -| Implements | ComponentInterface | + +- __Namespace__ + + - `Phalcon\Acl` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + + - `ComponentInterface` This class defines component entity and its description -## Properties +### Properties ```php /** * Component description @@ -666,7 +686,7 @@ private name; ``` -## Methods +### Methods ```php public function __construct( string $name, string $description = null ); @@ -694,16 +714,28 @@ public function getName(): string; -

Interface Phalcon\Acl\ComponentAwareInterface

+## Acl\ComponentAwareInterface ![Abstract](assets/images/interface-blue.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Acl/ComponentAwareInterface.zep) -| Namespace | Phalcon\Acl | + +- __Namespace__ + + - `Phalcon\Acl` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Interface for classes which could be used in allow method as RESOURCE -## Methods +### Methods ```php public function getComponentName(): string; @@ -713,16 +745,28 @@ Returns component name -

Interface Phalcon\Acl\ComponentInterface

+## Acl\ComponentInterface ![Abstract](assets/images/interface-blue.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Acl/ComponentInterface.zep) -| Namespace | Phalcon\Acl | + +- __Namespace__ + + - `Phalcon\Acl` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Interface for Phalcon\Acl\Component -## Methods +### Methods ```php public function __toString(): string; @@ -744,44 +788,80 @@ Returns the component name -

Class Phalcon\Acl\Enum

+## Acl\Enum [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Acl/Enum.zep) -| Namespace | Phalcon\Acl | + +- __Namespace__ + + - `Phalcon\Acl` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Constants for Phalcon\Acl\Adapter adapters -## Constants +### Constants ```php const ALLOW = 1; const DENY = 0; ``` -

Class Phalcon\Acl\Exception

+## Acl\Exception [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Acl/Exception.zep) -| Namespace | Phalcon\Acl | -| Extends | \Exception | + +- __Namespace__ + + - `Phalcon\Acl` + +- __Uses__ + + +- __Extends__ + + `\Exception` + +- __Implements__ + Class for exceptions thrown by Phalcon\Acl -

Class Phalcon\Acl\Role

+## Acl\Role [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Acl/Role.zep) -| Namespace | Phalcon\Acl | -| Implements | RoleInterface | + +- __Namespace__ + + - `Phalcon\Acl` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + + - `RoleInterface` This class defines role entity and its description -## Properties +### Properties ```php /** * Role description @@ -799,7 +879,7 @@ private name; ``` -## Methods +### Methods ```php public function __construct( string $name, string $description = null ); @@ -827,16 +907,28 @@ public function getName(): string; -

Interface Phalcon\Acl\RoleAwareInterface

+## Acl\RoleAwareInterface ![Abstract](assets/images/interface-blue.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Acl/RoleAwareInterface.zep) -| Namespace | Phalcon\Acl | + +- __Namespace__ + + - `Phalcon\Acl` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Interface for classes which could be used in allow method as ROLE -## Methods +### Methods ```php public function getRoleName(): string; @@ -846,16 +938,28 @@ Returns role name -

Interface Phalcon\Acl\RoleInterface

+## Acl\RoleInterface ![Abstract](assets/images/interface-blue.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Acl/RoleInterface.zep) -| Namespace | Phalcon\Acl | + +- __Namespace__ + + - `Phalcon\Acl` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Interface for Phalcon\Acl\Role -## Methods +### Methods ```php public function __toString(): string; diff --git a/docs/api/phalcon_annotations.md b/docs/api/phalcon_annotations.md index cb2d943df..387a4e6d2 100644 --- a/docs/api/phalcon_annotations.md +++ b/docs/api/phalcon_annotations.md @@ -1,29 +1,42 @@ +--- +hide: + - navigation +--- -* [Phalcon\Annotations\Adapter\AbstractAdapter](#annotations-adapter-abstractadapter) -* [Phalcon\Annotations\Adapter\AdapterInterface](#annotations-adapter-adapterinterface) -* [Phalcon\Annotations\Adapter\Apcu](#annotations-adapter-apcu) -* [Phalcon\Annotations\Adapter\Memory](#annotations-adapter-memory) -* [Phalcon\Annotations\Adapter\Stream](#annotations-adapter-stream) -* [Phalcon\Annotations\Annotation](#annotations-annotation) -* [Phalcon\Annotations\AnnotationsFactory](#annotations-annotationsfactory) -* [Phalcon\Annotations\Collection](#annotations-collection) -* [Phalcon\Annotations\Exception](#annotations-exception) -* [Phalcon\Annotations\Reader](#annotations-reader) -* [Phalcon\Annotations\ReaderInterface](#annotations-readerinterface) -* [Phalcon\Annotations\Reflection](#annotations-reflection) - -

Abstract Class Phalcon\Annotations\Adapter\AbstractAdapter

+!!! info "NOTE" + + All classes are prefixed with `Phalcon` + + + +## Annotations\Adapter\AbstractAdapter ![Abstract](assets/images/abstract-green.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Annotations/Adapter/AbstractAdapter.zep) -| Namespace | Phalcon\Annotations\Adapter | -| Uses | Phalcon\Annotations\Reader, Phalcon\Annotations\Exception, Phalcon\Annotations\Collection, Phalcon\Annotations\Reflection, Phalcon\Annotations\ReaderInterface | -| Implements | AdapterInterface | + +- __Namespace__ + + - `Phalcon\Annotations\Adapter` + +- __Uses__ + + - `Phalcon\Annotations\Collection` + - `Phalcon\Annotations\Exception` + - `Phalcon\Annotations\Reader` + - `Phalcon\Annotations\ReaderInterface` + - `Phalcon\Annotations\Reflection` + +- __Extends__ + + +- __Implements__ + + - `AdapterInterface` This is the base class for Phalcon\Annotations adapters -## Properties +### Properties ```php /** * @var array @@ -37,7 +50,7 @@ protected reader; ``` -## Methods +### Methods ```php public function get( mixed $className ): Reflection; @@ -95,17 +108,31 @@ Sets the annotations parser -

Interface Phalcon\Annotations\Adapter\AdapterInterface

+## Annotations\Adapter\AdapterInterface ![Abstract](assets/images/interface-blue.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Annotations/Adapter/AdapterInterface.zep) -| Namespace | Phalcon\Annotations\Adapter | -| Uses | Phalcon\Annotations\Reflection, Phalcon\Annotations\Collection, Phalcon\Annotations\ReaderInterface | + +- __Namespace__ + + - `Phalcon\Annotations\Adapter` + +- __Uses__ + + - `Phalcon\Annotations\Collection` + - `Phalcon\Annotations\ReaderInterface` + - `Phalcon\Annotations\Reflection` + +- __Extends__ + + +- __Implements__ + This interface must be implemented by adapters in Phalcon\Annotations -## Methods +### Methods ```php public function get( string $className ): Reflection; @@ -163,13 +190,25 @@ Sets the annotations parser -

Class Phalcon\Annotations\Adapter\Apcu

+## Annotations\Adapter\Apcu [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Annotations/Adapter/Apcu.zep) -| Namespace | Phalcon\Annotations\Adapter | -| Uses | Phalcon\Annotations\Reflection | -| Extends | AbstractAdapter | + +- __Namespace__ + + - `Phalcon\Annotations\Adapter` + +- __Uses__ + + - `Phalcon\Annotations\Reflection` + +- __Extends__ + + `AbstractAdapter` + +- __Implements__ + Stores the parsed annotations in APCu. This adapter is suitable for production @@ -180,7 +219,7 @@ $annotations = new Apcu(); ``` -## Properties +### Properties ```php /** * @var string @@ -194,7 +233,7 @@ protected ttl = 172800; ``` -## Methods +### Methods ```php public function __construct( array $options = [] ); @@ -216,19 +255,31 @@ Writes parsed annotations to APCu -

Class Phalcon\Annotations\Adapter\Memory

+## Annotations\Adapter\Memory [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Annotations/Adapter/Memory.zep) -| Namespace | Phalcon\Annotations\Adapter | -| Uses | Phalcon\Annotations\Reflection | -| Extends | AbstractAdapter | + +- __Namespace__ + + - `Phalcon\Annotations\Adapter` + +- __Uses__ + + - `Phalcon\Annotations\Reflection` + +- __Extends__ + + `AbstractAdapter` + +- __Implements__ + Stores the parsed annotations in memory. This adapter is the suitable development/testing -## Properties +### Properties ```php /** * @var mixed @@ -237,7 +288,7 @@ protected data; ``` -## Methods +### Methods ```php public function read( string $key ): Reflection | bool; @@ -253,13 +304,27 @@ Writes parsed annotations to memory -

Class Phalcon\Annotations\Adapter\Stream

+## Annotations\Adapter\Stream [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Annotations/Adapter/Stream.zep) -| Namespace | Phalcon\Annotations\Adapter | -| Uses | Phalcon\Annotations\Reflection, Phalcon\Annotations\Exception, RuntimeException | -| Extends | AbstractAdapter | + +- __Namespace__ + + - `Phalcon\Annotations\Adapter` + +- __Uses__ + + - `Phalcon\Annotations\Exception` + - `Phalcon\Annotations\Reflection` + - `RuntimeException` + +- __Extends__ + + `AbstractAdapter` + +- __Implements__ + Stores the parsed annotations in files. This adapter is suitable for production @@ -274,7 +339,7 @@ $annotations = new Stream( ``` -## Properties +### Properties ```php /** * @var string @@ -283,7 +348,7 @@ protected annotationsDir = ./; ``` -## Methods +### Methods ```php public function __construct( array $options = [] ); @@ -305,16 +370,28 @@ Writes parsed annotations to files -

Class Phalcon\Annotations\Annotation

+## Annotations\Annotation [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Annotations/Annotation.zep) -| Namespace | Phalcon\Annotations | + +- __Namespace__ + + - `Phalcon\Annotations` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Represents a single annotation in an annotations collection -## Properties +### Properties ```php /** * Annotation Arguments @@ -339,7 +416,7 @@ protected name; ``` -## Methods +### Methods ```php public function __construct( array $reflectionData ); @@ -403,18 +480,32 @@ Returns the number of arguments that the annotation has -

Class Phalcon\Annotations\AnnotationsFactory

+## Annotations\AnnotationsFactory [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Annotations/AnnotationsFactory.zep) -| Namespace | Phalcon\Annotations | -| Uses | Phalcon\Annotations\Adapter\AdapterInterface, Phalcon\Factory\AbstractFactory, Phalcon\Support\Helper\Arr\Get | -| Extends | AbstractFactory | + +- __Namespace__ + + - `Phalcon\Annotations` + +- __Uses__ + + - `Phalcon\Annotations\Adapter\AdapterInterface` + - `Phalcon\Factory\AbstractFactory` + - `Phalcon\Support\Helper\Arr\Get` + +- __Extends__ + + `AbstractFactory` + +- __Implements__ + Factory to create annotations components -## Methods +### Methods ```php public function __construct( array $services = [] ); @@ -448,13 +539,27 @@ Returns the available adapters -

Class Phalcon\Annotations\Collection

+## Annotations\Collection [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Annotations/Collection.zep) -| Namespace | Phalcon\Annotations | -| Uses | Countable, Iterator | -| Implements | Iterator, Countable | + +- __Namespace__ + + - `Phalcon\Annotations` + +- __Uses__ + + - `Countable` + - `Iterator` + +- __Extends__ + + +- __Implements__ + + - `Countable` + - `Iterator` Represents a collection of annotations. This class allows to traverse a group of annotations easily @@ -473,7 +578,7 @@ $annotation = $classAnnotations->get("Cacheable"); ``` -## Properties +### Properties ```php /** * @var array @@ -487,7 +592,7 @@ protected position = 0; ``` -## Methods +### Methods ```php public function __construct( array $reflectionData = [] ); @@ -557,29 +662,53 @@ Check if the current annotation in the iterator is valid -

Class Phalcon\Annotations\Exception

+## Annotations\Exception [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Annotations/Exception.zep) -| Namespace | Phalcon\Annotations | -| Extends | \Exception | + +- __Namespace__ + + - `Phalcon\Annotations` + +- __Uses__ + + +- __Extends__ + + `\Exception` + +- __Implements__ + Class for exceptions thrown by Phalcon\Annotations -

Class Phalcon\Annotations\Reader

+## Annotations\Reader [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Annotations/Reader.zep) -| Namespace | Phalcon\Annotations | -| Uses | ReflectionClass | -| Implements | ReaderInterface | + +- __Namespace__ + + - `Phalcon\Annotations` + +- __Uses__ + + - `ReflectionClass` + +- __Extends__ + + +- __Implements__ + + - `ReaderInterface` Parses docblocks returning an array with the found annotations -## Methods +### Methods ```php public function parse( string $className ): array; @@ -595,16 +724,28 @@ Parses a raw doc block returning the annotations found -

Interface Phalcon\Annotations\ReaderInterface

+## Annotations\ReaderInterface ![Abstract](assets/images/interface-blue.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Annotations/ReaderInterface.zep) -| Namespace | Phalcon\Annotations | + +- __Namespace__ + + - `Phalcon\Annotations` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Parses docblocks returning an array with the found annotations -## Methods +### Methods ```php public function parse( string $className ): array; @@ -620,11 +761,23 @@ Parses a raw docblock returning the annotations found -

Class Phalcon\Annotations\Reflection

+## Annotations\Reflection [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Annotations/Reflection.zep) -| Namespace | Phalcon\Annotations | + +- __Namespace__ + + - `Phalcon\Annotations` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Allows to manipulate the annotations reflection in an OO manner @@ -644,7 +797,7 @@ $classAnnotations = $reflection->getClassAnnotations(); ``` -## Properties +### Properties ```php /** * @var Collection|null @@ -673,7 +826,7 @@ protected reflectionData; ``` -## Methods +### Methods ```php public function __construct( array $reflectionData = [] ); diff --git a/docs/api/phalcon_application.md b/docs/api/phalcon_application.md index a2c556e41..685b9a51a 100644 --- a/docs/api/phalcon_application.md +++ b/docs/api/phalcon_application.md @@ -1,20 +1,42 @@ +--- +hide: + - navigation +--- -* [Phalcon\Application\AbstractApplication](#application-abstractapplication) -* [Phalcon\Application\Exception](#application-exception) +!!! info "NOTE" -

Abstract Class Phalcon\Application\AbstractApplication

+ All classes are prefixed with `Phalcon` + + + +## Application\AbstractApplication ![Abstract](assets/images/abstract-green.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Application/AbstractApplication.zep) -| Namespace | Phalcon\Application | -| Uses | Phalcon\Di\DiInterface, Phalcon\Di\Injectable, Phalcon\Events\EventsAwareInterface, Phalcon\Events\ManagerInterface | -| Extends | Injectable | -| Implements | EventsAwareInterface | + +- __Namespace__ + + - `Phalcon\Application` + +- __Uses__ + + - `Phalcon\Di\DiInterface` + - `Phalcon\Di\Injectable` + - `Phalcon\Events\EventsAwareInterface` + - `Phalcon\Events\ManagerInterface` + +- __Extends__ + + `Injectable` + +- __Implements__ + + - `EventsAwareInterface` Base class for Phalcon\Cli\Console and Phalcon\Mvc\Application. -## Properties +### Properties ```php /** * @var DiInterface|null @@ -24,7 +46,7 @@ protected container; /** * @var string */ -protected defaultModule = ""; +protected defaultModule = ; /** * @var ManagerInterface|null @@ -38,7 +60,7 @@ protected modules; ``` -## Methods +### Methods ```php public function __construct( DiInterface $container = null ); @@ -105,11 +127,23 @@ Sets the events manager -

Class Phalcon\Application\Exception

+## Application\Exception [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Application/Exception.zep) -| Namespace | Phalcon\Application | -| Extends | \Exception | + +- __Namespace__ + + - `Phalcon\Application` + +- __Uses__ + + +- __Extends__ + + `\Exception` + +- __Implements__ + Exceptions thrown in Phalcon\Application class will use this class diff --git a/docs/api/phalcon_assets.md b/docs/api/phalcon_assets.md index 10528b06f..6ff0ed55a 100644 --- a/docs/api/phalcon_assets.md +++ b/docs/api/phalcon_assets.md @@ -1,25 +1,32 @@ +--- +hide: + - navigation +--- -* [Phalcon\Assets\Asset](#assets-asset) -* [Phalcon\Assets\Asset\Css](#assets-asset-css) -* [Phalcon\Assets\Asset\Js](#assets-asset-js) -* [Phalcon\Assets\AssetInterface](#assets-assetinterface) -* [Phalcon\Assets\Collection](#assets-collection) -* [Phalcon\Assets\Exception](#assets-exception) -* [Phalcon\Assets\FilterInterface](#assets-filterinterface) -* [Phalcon\Assets\Filters\CssMin](#assets-filters-cssmin) -* [Phalcon\Assets\Filters\JsMin](#assets-filters-jsmin) -* [Phalcon\Assets\Filters\None](#assets-filters-none) -* [Phalcon\Assets\Inline](#assets-inline) -* [Phalcon\Assets\Inline\Css](#assets-inline-css) -* [Phalcon\Assets\Inline\Js](#assets-inline-js) -* [Phalcon\Assets\Manager](#assets-manager) - -

Class Phalcon\Assets\Asset

+!!! info "NOTE" + + All classes are prefixed with `Phalcon` + + + +## Assets\Asset [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Assets/Asset.zep) -| Namespace | Phalcon\Assets | -| Implements | AssetInterface | + +- __Namespace__ + + - `Phalcon\Assets` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + + - `AssetInterface` Represents an asset @@ -28,7 +35,7 @@ $asset = new \Phalcon\Assets\Asset("js", "js/jquery.js"); ``` -## Properties +### Properties ```php /** * @var array @@ -84,7 +91,7 @@ protected version; ``` -## Methods +### Methods ```php public function __construct( string $type, string $path, bool $isLocal = bool, bool $filter = bool, array $attributes = [], string $version = null, bool $isAutoVersion = bool ); @@ -257,18 +264,30 @@ protected function phpFileGetContents( string $filename ); -

Class Phalcon\Assets\Asset\Css

+## Assets\Asset\Css [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Assets/Asset/Css.zep) -| Namespace | Phalcon\Assets\Asset | -| Uses | Phalcon\Assets\Asset | -| Extends | AssetBase | + +- __Namespace__ + + - `Phalcon\Assets\Asset` + +- __Uses__ + + - `Phalcon\Assets\Asset` + +- __Extends__ + + `AssetBase` + +- __Implements__ + Represents CSS assets -## Methods +### Methods ```php public function __construct( string $path, bool $local = bool, bool $filter = bool, array $attributes = [], string $version = null, bool $autoVersion = bool ); @@ -278,18 +297,30 @@ Phalcon\Assets\Asset\Css constructor -

Class Phalcon\Assets\Asset\Js

+## Assets\Asset\Js [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Assets/Asset/Js.zep) -| Namespace | Phalcon\Assets\Asset | -| Uses | Phalcon\Assets\Asset | -| Extends | AssetBase | + +- __Namespace__ + + - `Phalcon\Assets\Asset` + +- __Uses__ + + - `Phalcon\Assets\Asset` + +- __Extends__ + + `AssetBase` + +- __Implements__ + Represents JavaScript assets -## Methods +### Methods ```php public function __construct( string $path, bool $local = bool, bool $filter = bool, array $attributes = [], string $version = null, bool $autoVersion = bool ); @@ -299,16 +330,28 @@ Phalcon\Assets\Asset\Js constructor -

Interface Phalcon\Assets\AssetInterface

+## Assets\AssetInterface ![Abstract](assets/images/interface-blue.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Assets/AssetInterface.zep) -| Namespace | Phalcon\Assets | + +- __Namespace__ + + - `Phalcon\Assets` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Interface for custom Phalcon\Assets resources -## Methods +### Methods ```php public function getAssetKey(): string; @@ -354,18 +397,33 @@ Sets the asset's type. -

Class Phalcon\Assets\Collection

+## Assets\Collection [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Assets/Collection.zep) -| Namespace | Phalcon\Assets | -| Uses | ArrayIterator, Countable, IteratorAggregate | -| Implements | Countable, IteratorAggregate | + +- __Namespace__ + + - `Phalcon\Assets` + +- __Uses__ + + - `ArrayIterator` + - `Countable` + - `IteratorAggregate` + +- __Extends__ + + +- __Implements__ + + - `Countable` + - `IteratorAggregate` Collection of asset objects -## Properties +### Properties ```php /** * @var array @@ -436,7 +494,7 @@ protected version = ; ``` -## Methods +### Methods ```php public function add( AssetInterface $asset ): Collection; @@ -672,27 +730,51 @@ Adds an asset or inline-code to the collection -

Class Phalcon\Assets\Exception

+## Assets\Exception [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Assets/Exception.zep) -| Namespace | Phalcon\Assets | -| Extends | \Exception | + +- __Namespace__ + + - `Phalcon\Assets` + +- __Uses__ + + +- __Extends__ + + `\Exception` + +- __Implements__ + Exceptions thrown in Phalcon\Assets will use this class -

Interface Phalcon\Assets\FilterInterface

+## Assets\FilterInterface ![Abstract](assets/images/interface-blue.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Assets/FilterInterface.zep) -| Namespace | Phalcon\Assets | + +- __Namespace__ + + - `Phalcon\Assets` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Interface for custom Phalcon\Assets filters -## Methods +### Methods ```php public function filter( string $content ): string; @@ -702,71 +784,105 @@ Filters the content returning a string with the filtered content -

Class Phalcon\Assets\Filters\Cssmin

+## Assets\Filters\Cssmin [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Assets/Filters/CssMin.zep) -| Namespace | Phalcon\Assets\Filters | -| Uses | Phalcon\Assets\FilterInterface | -| Implements | FilterInterface | + +- __Namespace__ + + - `Phalcon\Assets\Filters` + +- __Uses__ + + - `Phalcon\Assets\FilterInterface` + +- __Extends__ + + +- __Implements__ + + - `FilterInterface` Minify the CSS - removes comments removes newlines and line feeds keeping removes last semicolon from last property -## Methods +### Methods ```php public function filter( string $content ): string; ``` Filters the content using CSSMIN -!!! info "NOTE" - - This functionality is not currently available +> NOTE: This functionality is not currently available +{: .alert .alert-info } -

Class Phalcon\Assets\Filters\Jsmin

+## Assets\Filters\Jsmin [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Assets/Filters/JsMin.zep) -| Namespace | Phalcon\Assets\Filters | -| Uses | Phalcon\Assets\FilterInterface | -| Implements | FilterInterface | + +- __Namespace__ + + - `Phalcon\Assets\Filters` + +- __Uses__ + + - `Phalcon\Assets\FilterInterface` + +- __Extends__ + + +- __Implements__ + + - `FilterInterface` Deletes the characters which are insignificant to JavaScript. Comments will be removed. Tabs will be replaced with spaces. Carriage returns will be replaced with linefeeds. Most spaces and linefeeds will be removed. -## Methods +### Methods ```php public function filter( string $content ): string; ``` Filters the content using JSMIN -!!! info "NOTE" +> NOTE: This functionality is not currently available +{: .alert .alert-info } - This functionality is not currently available - -

Class Phalcon\Assets\Filters\None

+## Assets\Filters\None [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Assets/Filters/None.zep) -| Namespace | Phalcon\Assets\Filters | -| Uses | Phalcon\Assets\FilterInterface | -| Implements | FilterInterface | + +- __Namespace__ + + - `Phalcon\Assets\Filters` + +- __Uses__ + + - `Phalcon\Assets\FilterInterface` + +- __Extends__ + + +- __Implements__ + + - `FilterInterface` Returns the content without make any modification to the original source -## Methods +### Methods ```php public function filter( string $content ): string; @@ -776,12 +892,24 @@ Returns the content as is -

Class Phalcon\Assets\Inline

+## Assets\Inline [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Assets/Inline.zep) -| Namespace | Phalcon\Assets | -| Implements | AssetInterface | + +- __Namespace__ + + - `Phalcon\Assets` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + + - `AssetInterface` Represents an inline asset @@ -790,7 +918,7 @@ $inline = new \Phalcon\Assets\Inline("js", "alert('hello world');"); ``` -## Properties +### Properties ```php /** * @var array @@ -814,7 +942,7 @@ protected type; ``` -## Methods +### Methods ```php public function __construct( string $type, string $content, bool $filter = bool, array $attributes = [] ); @@ -872,18 +1000,30 @@ Sets the inline's type -

Class Phalcon\Assets\Inline\Css

+## Assets\Inline\Css [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Assets/Inline/Css.zep) -| Namespace | Phalcon\Assets\Inline | -| Uses | Phalcon\Assets\Inline | -| Extends | InlineBase | + +- __Namespace__ + + - `Phalcon\Assets\Inline` + +- __Uses__ + + - `Phalcon\Assets\Inline` + +- __Extends__ + + `InlineBase` + +- __Implements__ + Represents an inlined CSS -## Methods +### Methods ```php public function __construct( string $content, bool $filter = bool, array $attributes = [] ); @@ -893,18 +1033,30 @@ Phalcon\Assets\Inline\Css constructor -

Class Phalcon\Assets\Inline\Js

+## Assets\Inline\Js [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Assets/Inline/Js.zep) -| Namespace | Phalcon\Assets\Inline | -| Uses | Phalcon\Assets\Inline | -| Extends | InlineBase | + +- __Namespace__ + + - `Phalcon\Assets\Inline` + +- __Uses__ + + - `Phalcon\Assets\Inline` + +- __Extends__ + + `InlineBase` + +- __Implements__ + Represents an inline JavaScript -## Methods +### Methods ```php public function __construct( string $content, bool $filter = bool, array $attributes = [] ); @@ -914,18 +1066,38 @@ Phalcon\Assets\Inline\Js constructor -

Class Phalcon\Assets\Manager

+## Assets\Manager [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Assets/Manager.zep) -| Namespace | Phalcon\Assets | -| Uses | Phalcon\Assets\Asset\Css, Phalcon\Assets\Asset\Js, Phalcon\Assets\Inline\Css, Phalcon\Assets\Inline\Js, Phalcon\Di\AbstractInjectionAware, Phalcon\Html\Helper\Element, Phalcon\Html\Helper\Link, Phalcon\Html\Helper\Script, Phalcon\Html\TagFactory | -| Extends | AbstractInjectionAware | + +- __Namespace__ + + - `Phalcon\Assets` + +- __Uses__ + + - `Phalcon\Assets\Asset\Css` + - `Phalcon\Assets\Asset\Js` + - `Phalcon\Assets\Inline\Css` + - `Phalcon\Assets\Inline\Js` + - `Phalcon\Di\AbstractInjectionAware` + - `Phalcon\Html\Helper\Element` + - `Phalcon\Html\Helper\Link` + - `Phalcon\Html\Helper\Script` + - `Phalcon\Html\TagFactory` + +- __Extends__ + + `AbstractInjectionAware` + +- __Implements__ + Manages collections of CSS/JavaScript assets -## Properties +### Properties ```php /** * @var array @@ -949,7 +1121,7 @@ protected tagFactory; ``` -## Methods +### Methods ```php public function __construct( TagFactory $tagFactory, array $options = [] ); diff --git a/docs/api/phalcon_autoload.md b/docs/api/phalcon_autoload.md index 81d905466..af16ed576 100644 --- a/docs/api/phalcon_autoload.md +++ b/docs/api/phalcon_autoload.md @@ -1,32 +1,63 @@ +--- +hide: + - navigation +--- -* [Phalcon\Autoload\Exception](#autoload-exception) -* [Phalcon\Autoload\Loader](#autoload-loader) +!!! info "NOTE" -

Class Phalcon\Autoload\Exception

+ All classes are prefixed with `Phalcon` + + + +## Autoload\Exception [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Autoload/Exception.zep) -| Namespace | Phalcon\Autoload | -| Extends | \Exception | + +- __Namespace__ + + - `Phalcon\Autoload` + +- __Uses__ + + +- __Extends__ + + `\Exception` + +- __Implements__ + Exceptions thrown in Phalcon\Autoload will use this class -

Class Phalcon\Autoload\Loader

+## Autoload\Loader [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Autoload/Loader.zep) -| Namespace | Phalcon\Autoload | -| Uses | Phalcon\Events\AbstractEventsAware | -| Extends | AbstractEventsAware | + +- __Namespace__ + + - `Phalcon\Autoload` + +- __Uses__ + + - `Phalcon\Events\AbstractEventsAware` + +- __Extends__ + + `AbstractEventsAware` + +- __Implements__ + The Phalcon Autoloader provides an easy way to automatically load classes (namespaced or not) as well as files. It also features extension loading, allowing the user to autoload files with different extensions than .php. -## Properties +### Properties ```php /** * @var string|null @@ -85,7 +116,7 @@ protected namespaces; ``` -## Methods +### Methods ```php public function __construct( bool $isDebug = bool ); diff --git a/docs/api/phalcon_cache.md b/docs/api/phalcon_cache.md index 6e7799dab..91cf14734 100644 --- a/docs/api/phalcon_cache.md +++ b/docs/api/phalcon_cache.md @@ -1,31 +1,41 @@ +--- +hide: + - navigation +--- -* [Phalcon\Cache\AbstractCache](#cache-abstractcache) -* [Phalcon\Cache\Adapter\AdapterInterface](#cache-adapter-adapterinterface) -* [Phalcon\Cache\Adapter\Apcu](#cache-adapter-apcu) -* [Phalcon\Cache\Adapter\Libmemcached](#cache-adapter-libmemcached) -* [Phalcon\Cache\Adapter\Memory](#cache-adapter-memory) -* [Phalcon\Cache\Adapter\Redis](#cache-adapter-redis) -* [Phalcon\Cache\Adapter\Stream](#cache-adapter-stream) -* [Phalcon\Cache\Adapter\Weak](#cache-adapter-weak) -* [Phalcon\Cache\AdapterFactory](#cache-adapterfactory) -* [Phalcon\Cache\Cache](#cache-cache) -* [Phalcon\Cache\CacheFactory](#cache-cachefactory) -* [Phalcon\Cache\CacheInterface](#cache-cacheinterface) -* [Phalcon\Cache\Exception\Exception](#cache-exception-exception) -* [Phalcon\Cache\Exception\InvalidArgumentException](#cache-exception-invalidargumentexception) - -

Abstract Class Phalcon\Cache\AbstractCache

+!!! info "NOTE" + + All classes are prefixed with `Phalcon` + + + +## Cache\AbstractCache ![Abstract](assets/images/abstract-green.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Cache/AbstractCache.zep) -| Namespace | Phalcon\Cache | -| Uses | DateInterval, Phalcon\Cache\Adapter\AdapterInterface, Phalcon\Cache\Exception\InvalidArgumentException, Traversable | -| Implements | CacheInterface | + +- __Namespace__ + + - `Phalcon\Cache` + +- __Uses__ + + - `DateInterval` + - `Phalcon\Cache\Adapter\AdapterInterface` + - `Phalcon\Cache\Exception\InvalidArgumentException` + - `Traversable` + +- __Extends__ + + +- __Implements__ + + - `CacheInterface` This component offers caching capabilities for your application. -## Properties +### Properties ```php /** * The adapter @@ -36,7 +46,7 @@ protected adapter; ``` -## Methods +### Methods ```php public function __construct( AdapterInterface $adapter ); @@ -119,108 +129,213 @@ Returns the exception class that will be used for exceptions thrown -

Interface Phalcon\Cache\Adapter\AdapterInterface

+## Cache\Adapter\AdapterInterface ![Abstract](assets/images/interface-blue.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Cache/Adapter/AdapterInterface.zep) -| Namespace | Phalcon\Cache\Adapter | -| Uses | Phalcon\Storage\Adapter\AdapterInterface | -| Extends | StorageAdapterInterface | + +- __Namespace__ + + - `Phalcon\Cache\Adapter` + +- __Uses__ + + - `Phalcon\Storage\Adapter\AdapterInterface` + +- __Extends__ + + `StorageAdapterInterface` + +- __Implements__ + Interface for Phalcon\Cache adapters -

Class Phalcon\Cache\Adapter\Apcu

+## Cache\Adapter\Apcu [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Cache/Adapter/Apcu.zep) -| Namespace | Phalcon\Cache\Adapter | -| Uses | Phalcon\Cache\Adapter\AdapterInterface, Phalcon\Storage\Adapter\Apcu | -| Extends | StorageApcu | -| Implements | CacheAdapterInterface | + +- __Namespace__ + + - `Phalcon\Cache\Adapter` + +- __Uses__ + + - `Phalcon\Cache\Adapter\AdapterInterface` + - `Phalcon\Storage\Adapter\Apcu` + +- __Extends__ + + `StorageApcu` + +- __Implements__ + + - `CacheAdapterInterface` Apcu adapter -

Class Phalcon\Cache\Adapter\Libmemcached

+## Cache\Adapter\Libmemcached [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Cache/Adapter/Libmemcached.zep) -| Namespace | Phalcon\Cache\Adapter | -| Uses | Phalcon\Cache\Adapter\AdapterInterface, Phalcon\Storage\Adapter\Libmemcached | -| Extends | StorageLibmemcached | -| Implements | CacheAdapterInterface | + +- __Namespace__ + + - `Phalcon\Cache\Adapter` + +- __Uses__ + + - `Phalcon\Cache\Adapter\AdapterInterface` + - `Phalcon\Storage\Adapter\Libmemcached` + +- __Extends__ + + `StorageLibmemcached` + +- __Implements__ + + - `CacheAdapterInterface` Libmemcached adapter -

Class Phalcon\Cache\Adapter\Memory

+## Cache\Adapter\Memory [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Cache/Adapter/Memory.zep) -| Namespace | Phalcon\Cache\Adapter | -| Uses | Phalcon\Cache\Adapter\AdapterInterface, Phalcon\Storage\Adapter\Memory | -| Extends | StorageMemory | -| Implements | CacheAdapterInterface | + +- __Namespace__ + + - `Phalcon\Cache\Adapter` + +- __Uses__ + + - `Phalcon\Cache\Adapter\AdapterInterface` + - `Phalcon\Storage\Adapter\Memory` + +- __Extends__ + + `StorageMemory` + +- __Implements__ + + - `CacheAdapterInterface` Memory adapter -

Class Phalcon\Cache\Adapter\Redis

+## Cache\Adapter\Redis [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Cache/Adapter/Redis.zep) -| Namespace | Phalcon\Cache\Adapter | -| Uses | Phalcon\Cache\Adapter\AdapterInterface, Phalcon\Storage\Adapter\Redis | -| Extends | StorageRedis | -| Implements | CacheAdapterInterface | + +- __Namespace__ + + - `Phalcon\Cache\Adapter` + +- __Uses__ + + - `Phalcon\Cache\Adapter\AdapterInterface` + - `Phalcon\Storage\Adapter\Redis` + +- __Extends__ + + `StorageRedis` + +- __Implements__ + + - `CacheAdapterInterface` Redis adapter -

Class Phalcon\Cache\Adapter\Stream

+## Cache\Adapter\Stream [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Cache/Adapter/Stream.zep) -| Namespace | Phalcon\Cache\Adapter | -| Uses | Phalcon\Cache\Adapter\AdapterInterface, Phalcon\Storage\Adapter\Stream | -| Extends | StorageStream | -| Implements | CacheAdapterInterface | + +- __Namespace__ + + - `Phalcon\Cache\Adapter` + +- __Uses__ + + - `Phalcon\Cache\Adapter\AdapterInterface` + - `Phalcon\Storage\Adapter\Stream` + +- __Extends__ + + `StorageStream` + +- __Implements__ + + - `CacheAdapterInterface` Stream adapter -

Class Phalcon\Cache\Adapter\Weak

+## Cache\Adapter\Weak [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Cache/Adapter/Weak.zep) -| Namespace | Phalcon\Cache\Adapter | -| Uses | Phalcon\Cache\Adapter\AdapterInterface, Phalcon\Storage\Adapter\Weak | -| Extends | StorageWeak | -| Implements | CacheAdapterInterface | + +- __Namespace__ + + - `Phalcon\Cache\Adapter` + +- __Uses__ + + - `Phalcon\Cache\Adapter\AdapterInterface` + - `Phalcon\Storage\Adapter\Weak` + +- __Extends__ + + `StorageWeak` + +- __Implements__ + + - `CacheAdapterInterface` * WeakCache implementation based on WeakReference */ -

Class Phalcon\Cache\AdapterFactory

+## Cache\AdapterFactory [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Cache/AdapterFactory.zep) -| Namespace | Phalcon\Cache | -| Uses | Phalcon\Cache\Adapter\AdapterInterface, Phalcon\Cache\Exception\Exception, Phalcon\Factory\AbstractFactory, Phalcon\Storage\SerializerFactory | -| Extends | AbstractFactory | + +- __Namespace__ + + - `Phalcon\Cache` + +- __Uses__ + + - `Phalcon\Cache\Adapter\AdapterInterface` + - `Phalcon\Cache\Exception\Exception` + - `Phalcon\Factory\AbstractFactory` + - `Phalcon\Storage\SerializerFactory` + +- __Extends__ + + `AbstractFactory` + +- __Implements__ + Factory to create Cache adapters -## Properties +### Properties ```php /** * @var SerializerFactory @@ -229,7 +344,7 @@ private serializerFactory; ``` -## Methods +### Methods ```php public function __construct( SerializerFactory $factory, array $services = [] ); @@ -257,18 +372,32 @@ Returns the available adapters -

Class Phalcon\Cache\Cache

+## Cache\Cache [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Cache/Cache.zep) -| Namespace | Phalcon\Cache | -| Uses | DateInterval, Phalcon\Cache\Adapter\AdapterInterface, Phalcon\Cache\Exception\InvalidArgumentException | -| Extends | AbstractCache | + +- __Namespace__ + + - `Phalcon\Cache` + +- __Uses__ + + - `DateInterval` + - `Phalcon\Cache\Adapter\AdapterInterface` + - `Phalcon\Cache\Exception\InvalidArgumentException` + +- __Extends__ + + `AbstractCache` + +- __Implements__ + This component offers caching capabilities for your application. -## Methods +### Methods ```php public function clear(): bool; @@ -327,18 +456,34 @@ Returns the exception class that will be used for exceptions thrown -

Class Phalcon\Cache\CacheFactory

+## Cache\CacheFactory [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Cache/CacheFactory.zep) -| Namespace | Phalcon\Cache | -| Uses | Phalcon\Cache\Adapter\AdapterInterface, Phalcon\Cache\Cache, Phalcon\Cache\Exception\Exception, Phalcon\Config\ConfigInterface, Phalcon\Factory\AbstractConfigFactory | -| Extends | AbstractConfigFactory | + +- __Namespace__ + + - `Phalcon\Cache` + +- __Uses__ + + - `Phalcon\Cache\Adapter\AdapterInterface` + - `Phalcon\Cache\Cache` + - `Phalcon\Cache\Exception\Exception` + - `Phalcon\Config\ConfigInterface` + - `Phalcon\Factory\AbstractConfigFactory` + +- __Extends__ + + `AbstractConfigFactory` + +- __Implements__ + Creates a new Cache class -## Properties +### Properties ```php /** * @var AdapterFactory @@ -347,7 +492,7 @@ protected adapterFactory; ``` -## Methods +### Methods ```php public function __construct( AdapterFactory $factory ); @@ -375,17 +520,30 @@ protected function getExceptionClass(): string; -

Interface Phalcon\Cache\CacheInterface

+## Cache\CacheInterface ![Abstract](assets/images/interface-blue.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Cache/CacheInterface.zep) -| Namespace | Phalcon\Cache | -| Uses | DateInterval, Phalcon\Cache\Exception\InvalidArgumentException | + +- __Namespace__ + + - `Phalcon\Cache` + +- __Uses__ + + - `DateInterval` + - `Phalcon\Cache\Exception\InvalidArgumentException` + +- __Extends__ + + +- __Implements__ + Interface for Phalcon\Cache\Cache -## Methods +### Methods ```php public function clear(): bool; @@ -438,22 +596,46 @@ Persists a set of key => value pairs in the cache, with an optional TTL. -

Class Phalcon\Cache\Exception\Exception

+## Cache\Exception\Exception [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Cache/Exception/Exception.zep) -| Namespace | Phalcon\Cache\Exception | -| Extends | \Exception | + +- __Namespace__ + + - `Phalcon\Cache\Exception` + +- __Uses__ + + +- __Extends__ + + `\Exception` + +- __Implements__ + Exceptions thrown in Phalcon\Cache will use this class -

Class Phalcon\Cache\Exception\InvalidArgumentException

+## Cache\Exception\InvalidArgumentException [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Cache/Exception/InvalidArgumentException.zep) -| Namespace | Phalcon\Cache\Exception | -| Extends | \Exception | + +- __Namespace__ + + - `Phalcon\Cache\Exception` + +- __Uses__ + + +- __Extends__ + + `\Exception` + +- __Implements__ + Exceptions thrown in Phalcon\Cache will use this class diff --git a/docs/api/phalcon_cli.md b/docs/api/phalcon_cli.md index 828c0059d..23c39c7db 100644 --- a/docs/api/phalcon_cli.md +++ b/docs/api/phalcon_cli.md @@ -1,29 +1,42 @@ +--- +hide: + - navigation +--- -* [Phalcon\Cli\Console](#cli-console) -* [Phalcon\Cli\Console\Exception](#cli-console-exception) -* [Phalcon\Cli\Dispatcher](#cli-dispatcher) -* [Phalcon\Cli\Dispatcher\Exception](#cli-dispatcher-exception) -* [Phalcon\Cli\DispatcherInterface](#cli-dispatcherinterface) -* [Phalcon\Cli\Router](#cli-router) -* [Phalcon\Cli\Router\Exception](#cli-router-exception) -* [Phalcon\Cli\Router\Route](#cli-router-route) -* [Phalcon\Cli\Router\RouteInterface](#cli-router-routeinterface) -* [Phalcon\Cli\RouterInterface](#cli-routerinterface) -* [Phalcon\Cli\Task](#cli-task) -* [Phalcon\Cli\TaskInterface](#cli-taskinterface) - -

Class Phalcon\Cli\Console

+!!! info "NOTE" + + All classes are prefixed with `Phalcon` + + + +## Cli\Console [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Cli/Console.zep) -| Namespace | Phalcon\Cli | -| Uses | Phalcon\Application\AbstractApplication, Phalcon\Cli\Router\Route, Phalcon\Cli\Console\Exception, Phalcon\Di\DiInterface, Phalcon\Events\ManagerInterface | -| Extends | AbstractApplication | + +- __Namespace__ + + - `Phalcon\Cli` + +- __Uses__ + + - `Phalcon\Application\AbstractApplication` + - `Phalcon\Cli\Console\Exception` + - `Phalcon\Cli\Router\Route` + - `Phalcon\Di\DiInterface` + - `Phalcon\Events\ManagerInterface` + +- __Extends__ + + `AbstractApplication` + +- __Implements__ + This component allows to create CLI applications using Phalcon -## Properties +### Properties ```php /** * @var array @@ -37,7 +50,7 @@ protected options; ``` -## Methods +### Methods ```php public function handle( array $arguments = null ); @@ -53,25 +66,52 @@ Set an specific argument -

Class Phalcon\Cli\Console\Exception

+## Cli\Console\Exception [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Cli/Console/Exception.zep) -| Namespace | Phalcon\Cli\Console | -| Extends | \Phalcon\Application\Exception | + +- __Namespace__ + + - `Phalcon\Cli\Console` + +- __Uses__ + + +- __Extends__ + + `\Phalcon\Application\Exception` + +- __Implements__ + Exceptions thrown in Phalcon\Cli\Console will use this class -

Class Phalcon\Cli\Dispatcher

+## Cli\Dispatcher [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Cli/Dispatcher.zep) -| Namespace | Phalcon\Cli | -| Uses | Phalcon\Cli\Dispatcher\Exception, Phalcon\Dispatcher\AbstractDispatcher, Phalcon\Events\ManagerInterface, Phalcon\Filter\FilterInterface | -| Extends | CliDispatcher | -| Implements | DispatcherInterface | + +- __Namespace__ + + - `Phalcon\Cli` + +- __Uses__ + + - `Phalcon\Cli\Dispatcher\Exception` + - `Phalcon\Dispatcher\AbstractDispatcher` + - `Phalcon\Events\ManagerInterface` + - `Phalcon\Filter\FilterInterface` + +- __Extends__ + + `CliDispatcher` + +- __Implements__ + + - `DispatcherInterface` Dispatching is the process of taking the command-line arguments, extracting the module name, task name, action name, and optional parameters contained in @@ -95,7 +135,7 @@ $handle = $dispatcher->dispatch(); ``` -## Properties +### Properties ```php // protected defaultHandler = main; @@ -117,7 +157,7 @@ protected options; ``` -## Methods +### Methods ```php public function callActionMethod( mixed $handler, string $actionMethod, array $params = [] ): mixed; @@ -205,29 +245,53 @@ Throws an internal exception -

Class Phalcon\Cli\Dispatcher\Exception

+## Cli\Dispatcher\Exception [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Cli/Dispatcher/Exception.zep) -| Namespace | Phalcon\Cli\Dispatcher | -| Extends | \Phalcon\Dispatcher\Exception | + +- __Namespace__ + + - `Phalcon\Cli\Dispatcher` + +- __Uses__ + + +- __Extends__ + + `\Phalcon\Dispatcher\Exception` + +- __Implements__ + Exceptions thrown in Phalcon\Cli\Dispatcher will use this class -

Interface Phalcon\Cli\DispatcherInterface

+## Cli\DispatcherInterface ![Abstract](assets/images/interface-blue.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Cli/DispatcherInterface.zep) -| Namespace | Phalcon\Cli | -| Uses | Phalcon\Dispatcher\DispatcherInterface | -| Extends | DispatcherInterfaceBase | + +- __Namespace__ + + - `Phalcon\Cli` + +- __Uses__ + + - `Phalcon\Dispatcher\DispatcherInterface` + +- __Extends__ + + `DispatcherInterfaceBase` + +- __Implements__ + Interface for Phalcon\Cli\Dispatcher -## Methods +### Methods ```php public function getActiveTask(): TaskInterface; @@ -285,13 +349,29 @@ Sets the default task suffix -

Class Phalcon\Cli\Router

+## Cli\Router [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Cli/Router.zep) -| Namespace | Phalcon\Cli | -| Uses | Phalcon\Di\DiInterface, Phalcon\Di\AbstractInjectionAware, Phalcon\Cli\Router\Route, Phalcon\Cli\Router\Exception, Phalcon\Cli\Router\RouteInterface | -| Extends | AbstractInjectionAware | + +- __Namespace__ + + - `Phalcon\Cli` + +- __Uses__ + + - `Phalcon\Cli\Router\Exception` + - `Phalcon\Cli\Router\Route` + - `Phalcon\Cli\Router\RouteInterface` + - `Phalcon\Di\AbstractInjectionAware` + - `Phalcon\Di\DiInterface` + +- __Extends__ + + `AbstractInjectionAware` + +- __Implements__ + Phalcon\Cli\Router is the standard framework router. Routing is the process of taking a command-line arguments and decomposing it into parameters to @@ -313,22 +393,22 @@ echo $router->getTaskName(); ``` -## Properties +### Properties ```php /** - * @var string|null + * @var string */ -protected action; +protected action = ; /** - * @var string|null + * @var string */ -protected defaultAction; +protected defaultAction = ; /** * @var string */ -protected defaultModule = ""; +protected defaultModule = ; /** * @var array @@ -336,9 +416,9 @@ protected defaultModule = ""; protected defaultParams; /** - * @var string|null + * @var string */ -protected defaultTask; +protected defaultTask = ; /** * @var RouteInterface|null @@ -353,7 +433,7 @@ protected matches; /** * @var string */ -protected module = ""; +protected module = ; /** * @var array @@ -366,9 +446,9 @@ protected params; protected routes; /** - * @var string|null + * @var string */ -protected task; +protected task = ; /** * @var bool @@ -377,7 +457,7 @@ protected wasMatched = false; ``` -## Methods +### Methods ```php public function __construct( bool $defaultRoutes = bool ); @@ -506,33 +586,57 @@ Checks if the router matches any of the defined routes -

Class Phalcon\Cli\Router\Exception

+## Cli\Router\Exception [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Cli/Router/Exception.zep) -| Namespace | Phalcon\Cli\Router | -| Extends | \Exception | + +- __Namespace__ + + - `Phalcon\Cli\Router` + +- __Uses__ + + +- __Extends__ + + `\Exception` + +- __Implements__ + Exceptions thrown in Phalcon\Cli\Router will use this class -

Class Phalcon\Cli\Router\Route

+## Cli\Router\Route [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Cli/Router/Route.zep) -| Namespace | Phalcon\Cli\Router | -| Implements | RouteInterface | + +- __Namespace__ + + - `Phalcon\Cli\Router` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + + - `RouteInterface` This class represents every route added to the router -## Constants +### Constants ```php const DEFAULT_DELIMITER = ; ``` -## Properties +### Properties ```php /** * @var mixed|null @@ -540,9 +644,9 @@ const DEFAULT_DELIMITER = ; protected beforeMatch; /** - * @var string|null + * @var string */ -protected compiledPattern; +protected compiledPattern = ; /** * @var array @@ -560,9 +664,9 @@ protected delimiter; protected static delimiterPath; /** - * @var string|null + * @var string */ -protected description; +protected description = ; /** * @var string @@ -572,7 +676,7 @@ protected routeId; /** * @var string */ -protected name; +protected name = ; /** * @var array @@ -582,16 +686,16 @@ protected paths; /** * @var string */ -protected pattern; +protected pattern = ; /** - * @var int|string + * @var int */ protected static uniqueId = 0; ``` -## Methods +### Methods ```php public function __construct( string $pattern, mixed $paths = null ); @@ -728,16 +832,28 @@ $router->add( -

Interface Phalcon\Cli\Router\RouteInterface

+## Cli\Router\RouteInterface ![Abstract](assets/images/interface-blue.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Cli/Router/RouteInterface.zep) -| Namespace | Phalcon\Cli\Router | + +- __Namespace__ + + - `Phalcon\Cli\Router` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Interface for Phalcon\Cli\Router\Route -## Methods +### Methods ```php public function compilePattern( string $pattern ): string; @@ -826,17 +942,29 @@ Sets the route's name -

Interface Phalcon\Cli\RouterInterface

+## Cli\RouterInterface ![Abstract](assets/images/interface-blue.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Cli/RouterInterface.zep) -| Namespace | Phalcon\Cli | -| Uses | Phalcon\Cli\Router\RouteInterface | + +- __Namespace__ + + - `Phalcon\Cli` + +- __Uses__ + + - `Phalcon\Cli\Router\RouteInterface` + +- __Extends__ + + +- __Implements__ + Interface for Phalcon\Cli\Router -## Methods +### Methods ```php public function add( string $pattern, mixed $paths = null ): RouteInterface; @@ -943,14 +1071,29 @@ Check if the router matches any of the defined routes -

Class Phalcon\Cli\Task

+## Cli\Task [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Cli/Task.zep) -| Namespace | Phalcon\Cli | -| Uses | Phalcon\Di\Injectable, Phalcon\Events\EventsAwareInterface, Phalcon\Events\ManagerInterface | -| Extends | Injectable | -| Implements | TaskInterface, EventsAwareInterface | + +- __Namespace__ + + - `Phalcon\Cli` + +- __Uses__ + + - `Phalcon\Di\Injectable` + - `Phalcon\Events\EventsAwareInterface` + - `Phalcon\Events\ManagerInterface` + +- __Extends__ + + `Injectable` + +- __Implements__ + + - `EventsAwareInterface` + - `TaskInterface` Every command-line task should extend this class that encapsulates all the task functionality @@ -976,7 +1119,7 @@ class HelloTask extends \Phalcon\Cli\Task ``` -## Properties +### Properties ```php /** * @var ManagerInterface @@ -985,7 +1128,7 @@ protected eventsManager; ``` -## Methods +### Methods ```php final public function __construct(); @@ -1007,10 +1150,22 @@ Sets the events manager -

Interface Phalcon\Cli\TaskInterface

+## Cli\TaskInterface ![Abstract](assets/images/interface-blue.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Cli/TaskInterface.zep) -| Namespace | Phalcon\Cli | + +- __Namespace__ + + - `Phalcon\Cli` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Interface for task handlers diff --git a/docs/api/phalcon_config.md b/docs/api/phalcon_config.md index 52db3c2a2..6310ce804 100644 --- a/docs/api/phalcon_config.md +++ b/docs/api/phalcon_config.md @@ -1,21 +1,37 @@ +--- +hide: + - navigation +--- -* [Phalcon\Config\Adapter\Grouped](#config-adapter-grouped) -* [Phalcon\Config\Adapter\Ini](#config-adapter-ini) -* [Phalcon\Config\Adapter\Json](#config-adapter-json) -* [Phalcon\Config\Adapter\Php](#config-adapter-php) -* [Phalcon\Config\Adapter\Yaml](#config-adapter-yaml) -* [Phalcon\Config\Config](#config-config) -* [Phalcon\Config\ConfigFactory](#config-configfactory) -* [Phalcon\Config\ConfigInterface](#config-configinterface) -* [Phalcon\Config\Exception](#config-exception) +!!! info "NOTE" -

Class Phalcon\Config\Adapter\Grouped

+ All classes are prefixed with `Phalcon` + + + +## Config\Adapter\Grouped [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Config/Adapter/Grouped.zep) -| Namespace | Phalcon\Config\Adapter | -| Uses | Phalcon\Config\Config, Phalcon\Config\ConfigFactory, Phalcon\Config\ConfigInterface, Phalcon\Config\Exception, Phalcon\Factory\Exception | -| Extends | Config | + +- __Namespace__ + + - `Phalcon\Config\Adapter` + +- __Uses__ + + - `Phalcon\Config\Config` + - `Phalcon\Config\ConfigFactory` + - `Phalcon\Config\ConfigInterface` + - `Phalcon\Config\Exception` + - `Phalcon\Factory\Exception` + +- __Extends__ + + `Config` + +- __Implements__ + Reads multiple files (or arrays) and merges them all together. @@ -68,7 +84,7 @@ $config = new Grouped( ``` -## Methods +### Methods ```php public function __construct( array $arrayConfig, string $defaultAdapter = string ); @@ -78,13 +94,27 @@ Phalcon\Config\Adapter\Grouped constructor -

Class Phalcon\Config\Adapter\Ini

+## Config\Adapter\Ini [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Config/Adapter/Ini.zep) -| Namespace | Phalcon\Config\Adapter | -| Uses | Phalcon\Config\Config, Phalcon\Config\Exception, Phalcon\Support\Traits\PhpFileTrait | -| Extends | Config | + +- __Namespace__ + + - `Phalcon\Config\Adapter` + +- __Uses__ + + - `Phalcon\Config\Config` + - `Phalcon\Config\Exception` + - `Phalcon\Support\Traits\PhpFileTrait` + +- __Extends__ + + `Config` + +- __Implements__ + Reads ini files and converts them to Phalcon\Config\Config objects. @@ -128,7 +158,7 @@ $config = new \Phalcon\Config\Adapter\Ini( ``` -## Methods +### Methods ```php public function __construct( string $filePath, int $mode = int ); @@ -163,13 +193,26 @@ protected function phpParseIniFile( string $filename, bool $processSections = bo -

Class Phalcon\Config\Adapter\Json

+## Config\Adapter\Json [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Config/Adapter/Json.zep) -| Namespace | Phalcon\Config\Adapter | -| Uses | Phalcon\Config\Config, Phalcon\Support\Helper\Json\Decode | -| Extends | Config | + +- __Namespace__ + + - `Phalcon\Config\Adapter` + +- __Uses__ + + - `Phalcon\Config\Config` + - `Phalcon\Support\Helper\Json\Decode` + +- __Extends__ + + `Config` + +- __Implements__ + Reads JSON files and converts them to Phalcon\Config\Config objects. @@ -191,7 +234,7 @@ echo $config->models->metadata; ``` -## Methods +### Methods ```php public function __construct( string $filePath ); @@ -201,13 +244,25 @@ Phalcon\Config\Adapter\Json constructor -

Class Phalcon\Config\Adapter\Php

+## Config\Adapter\Php [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Config/Adapter/Php.zep) -| Namespace | Phalcon\Config\Adapter | -| Uses | Phalcon\Config\Config | -| Extends | Config | + +- __Namespace__ + + - `Phalcon\Config\Adapter` + +- __Uses__ + + - `Phalcon\Config\Config` + +- __Extends__ + + `Config` + +- __Implements__ + Reads php files and converts them to Phalcon\Config\Config objects. @@ -244,7 +299,7 @@ echo $config->database->username; ``` -## Methods +### Methods ```php public function __construct( string $filePath ); @@ -254,13 +309,26 @@ Phalcon\Config\Adapter\Php constructor -

Class Phalcon\Config\Adapter\Yaml

+## Config\Adapter\Yaml [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Config/Adapter/Yaml.zep) -| Namespace | Phalcon\Config\Adapter | -| Uses | Phalcon\Config\Config, Phalcon\Config\Exception | -| Extends | Config | + +- __Namespace__ + + - `Phalcon\Config\Adapter` + +- __Uses__ + + - `Phalcon\Config\Config` + - `Phalcon\Config\Exception` + +- __Extends__ + + `Config` + +- __Implements__ + Reads YAML files and converts them to Phalcon\Config\Config objects. @@ -299,7 +367,7 @@ echo $config->models->metadata; ``` -## Methods +### Methods ```php public function __construct( string $filePath, array $callbacks = null ); @@ -321,14 +389,26 @@ protected function phpYamlParseFile( mixed $filename, mixed $pos = int, mixed $n -

Class Phalcon\Config\Config

+## Config\Config [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Config/Config.zep) -| Namespace | Phalcon\Config | -| Uses | Phalcon\Support\Collection | -| Extends | Collection | -| Implements | ConfigInterface | + +- __Namespace__ + + - `Phalcon\Config` + +- __Uses__ + + - `Phalcon\Support\Collection` + +- __Extends__ + + `Collection` + +- __Implements__ + + - `ConfigInterface` `Phalcon\Config` is designed to simplify the access to, and the use of, configuration data within applications. It provides a nested object property @@ -355,12 +435,12 @@ $config = new \Phalcon\Config\Config( ``` -## Constants +### Constants ```php const DEFAULT_PATH_DELIMITER = .; ``` -## Properties +### Properties ```php /** * @var string @@ -369,7 +449,7 @@ protected pathDelimiter; ``` -## Methods +### Methods ```php public function getPathDelimiter(): string; @@ -437,13 +517,27 @@ Sets the collection data -

Class Phalcon\Config\ConfigFactory

+## Config\ConfigFactory [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Config/ConfigFactory.zep) -| Namespace | Phalcon\Config | -| Uses | Phalcon\Config\Config, Phalcon\Config\ConfigInterface, Phalcon\Factory\AbstractFactory | -| Extends | AbstractFactory | + +- __Namespace__ + + - `Phalcon\Config` + +- __Uses__ + + - `Phalcon\Config\Config` + - `Phalcon\Config\ConfigInterface` + - `Phalcon\Factory\AbstractFactory` + +- __Extends__ + + `AbstractFactory` + +- __Implements__ + Loads Config Adapter class using 'adapter' option, if no extension is provided it will be added to filePath @@ -460,7 +554,7 @@ $config = (new ConfigFactory())->load($options); ``` -## Methods +### Methods ```php public function __construct( array $services = [] ); @@ -500,20 +594,32 @@ protected function parseConfig( mixed $config ): array; -

Interface Phalcon\Config\ConfigInterface

+## Config\ConfigInterface ![Abstract](assets/images/interface-blue.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Config/ConfigInterface.zep) -| Namespace | Phalcon\Config | -| Uses | Phalcon\Support\Collection\CollectionInterface | -| Extends | CollectionInterface | + +- __Namespace__ + + - `Phalcon\Config` + +- __Uses__ + + - `Phalcon\Support\Collection\CollectionInterface` + +- __Extends__ + + `CollectionInterface` + +- __Implements__ + Phalcon\Config\ConfigInterface Interface for Phalcon\Config\Config class -## Methods +### Methods ```php public function getPathDelimiter(): string; @@ -541,11 +647,23 @@ public function setPathDelimiter( string $delimiter = null ): ConfigInterface; -

Class Phalcon\Config\Exception

+## Config\Exception [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Config/Exception.zep) -| Namespace | Phalcon\Config | -| Extends | \Exception | + +- __Namespace__ + + - `Phalcon\Config` + +- __Uses__ + + +- __Extends__ + + `\Exception` + +- __Implements__ + Exceptions thrown in Phalcon\Config will use this class diff --git a/docs/api/phalcon_datamapper.md b/docs/api/phalcon_datamapper.md index 704059a96..ec8011328 100644 --- a/docs/api/phalcon_datamapper.md +++ b/docs/api/phalcon_datamapper.md @@ -1,39 +1,42 @@ +--- +hide: + - navigation +--- -* [Phalcon\DataMapper\Pdo\Connection](#datamapper-pdo-connection) -* [Phalcon\DataMapper\Pdo\Connection\AbstractConnection](#datamapper-pdo-connection-abstractconnection) -* [Phalcon\DataMapper\Pdo\Connection\ConnectionInterface](#datamapper-pdo-connection-connectioninterface) -* [Phalcon\DataMapper\Pdo\Connection\Decorated](#datamapper-pdo-connection-decorated) -* [Phalcon\DataMapper\Pdo\Connection\PdoInterface](#datamapper-pdo-connection-pdointerface) -* [Phalcon\DataMapper\Pdo\ConnectionLocator](#datamapper-pdo-connectionlocator) -* [Phalcon\DataMapper\Pdo\ConnectionLocatorInterface](#datamapper-pdo-connectionlocatorinterface) -* [Phalcon\DataMapper\Pdo\Exception\CannotDisconnect](#datamapper-pdo-exception-cannotdisconnect) -* [Phalcon\DataMapper\Pdo\Exception\ConnectionNotFound](#datamapper-pdo-exception-connectionnotfound) -* [Phalcon\DataMapper\Pdo\Exception\Exception](#datamapper-pdo-exception-exception) -* [Phalcon\DataMapper\Pdo\Profiler\MemoryLogger](#datamapper-pdo-profiler-memorylogger) -* [Phalcon\DataMapper\Pdo\Profiler\Profiler](#datamapper-pdo-profiler-profiler) -* [Phalcon\DataMapper\Pdo\Profiler\ProfilerInterface](#datamapper-pdo-profiler-profilerinterface) -* [Phalcon\DataMapper\Query\AbstractConditions](#datamapper-query-abstractconditions) -* [Phalcon\DataMapper\Query\AbstractQuery](#datamapper-query-abstractquery) -* [Phalcon\DataMapper\Query\Bind](#datamapper-query-bind) -* [Phalcon\DataMapper\Query\Delete](#datamapper-query-delete) -* [Phalcon\DataMapper\Query\Insert](#datamapper-query-insert) -* [Phalcon\DataMapper\Query\QueryFactory](#datamapper-query-queryfactory) -* [Phalcon\DataMapper\Query\Select](#datamapper-query-select) -* [Phalcon\DataMapper\Query\Update](#datamapper-query-update) - -

Class Phalcon\DataMapper\Pdo\Connection

+!!! info "NOTE" + + All classes are prefixed with `Phalcon` + + + +## DataMapper\Pdo\Connection [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/DataMapper/Pdo/Connection.zep) -| Namespace | Phalcon\DataMapper\Pdo | -| Uses | InvalidArgumentException, Phalcon\DataMapper\Pdo\Connection\AbstractConnection, Phalcon\DataMapper\Pdo\Profiler\Profiler, Phalcon\DataMapper\Pdo\Profiler\ProfilerInterface | -| Extends | AbstractConnection | + +- __Namespace__ + + - `Phalcon\DataMapper\Pdo` + +- __Uses__ + + - `InvalidArgumentException` + - `Phalcon\DataMapper\Pdo\Connection\AbstractConnection` + - `Phalcon\DataMapper\Pdo\Profiler\Profiler` + - `Phalcon\DataMapper\Pdo\Profiler\ProfilerInterface` + +- __Extends__ + + `AbstractConnection` + +- __Implements__ + Provides array quoting, profiling, a new `perform()` method, new `fetch*()` methods -## Properties +### Properties ```php /** * @var array @@ -42,7 +45,7 @@ protected arguments; ``` -## Methods +### Methods ```php public function __construct( string $dsn, string $username = null, string $password = null, array $options = [], array $queries = [], ProfilerInterface $profiler = null ); @@ -73,19 +76,33 @@ Disconnects from the database. -

Abstract Class Phalcon\DataMapper\Pdo\Connection\AbstractConnection

+## DataMapper\Pdo\Connection\AbstractConnection ![Abstract](assets/images/abstract-green.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/DataMapper/Pdo/Connection/AbstractConnection.zep) -| Namespace | Phalcon\DataMapper\Pdo\Connection | -| Uses | BadMethodCallException, Phalcon\DataMapper\Pdo\Exception\CannotBindValue, Phalcon\DataMapper\Pdo\Profiler\ProfilerInterface | -| Implements | ConnectionInterface | + +- __Namespace__ + + - `Phalcon\DataMapper\Pdo\Connection` + +- __Uses__ + + - `BadMethodCallException` + - `Phalcon\DataMapper\Pdo\Exception\CannotBindValue` + - `Phalcon\DataMapper\Pdo\Profiler\ProfilerInterface` + +- __Extends__ + + +- __Implements__ + + - `ConnectionInterface` Provides array quoting, profiling, a new `perform()` method, new `fetch*()` methods -## Properties +### Properties ```php /** * @var \PDO @@ -99,7 +116,7 @@ protected profiler; ``` -## Methods +### Methods ```php public function __call( mixed $name, array $arguments ); @@ -356,19 +373,33 @@ Bind a value using the proper PDO::PARAM_* type. -

Interface Phalcon\DataMapper\Pdo\Connection\ConnectionInterface

+## DataMapper\Pdo\Connection\ConnectionInterface ![Abstract](assets/images/interface-blue.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/DataMapper/Pdo/Connection/ConnectionInterface.zep) -| Namespace | Phalcon\DataMapper\Pdo\Connection | -| Uses | Phalcon\DataMapper\Pdo\Exception\CannotBindValue, Phalcon\DataMapper\Pdo\Parser\ParserInterface, Phalcon\DataMapper\Pdo\Profiler\ProfilerInterface | -| Extends | PdoInterface | + +- __Namespace__ + + - `Phalcon\DataMapper\Pdo\Connection` + +- __Uses__ + + - `Phalcon\DataMapper\Pdo\Exception\CannotBindValue` + - `Phalcon\DataMapper\Pdo\Parser\ParserInterface` + - `Phalcon\DataMapper\Pdo\Profiler\ProfilerInterface` + +- __Extends__ + + `PdoInterface` + +- __Implements__ + Provides array quoting, profiling, a new `perform()` method, new `fetch*()` methods -## Methods +### Methods ```php public function connect(): void; @@ -500,18 +531,32 @@ Sets the Profiler instance. -

Class Phalcon\DataMapper\Pdo\Connection\Decorated

+## DataMapper\Pdo\Connection\Decorated [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/DataMapper/Pdo/Connection/Decorated.zep) -| Namespace | Phalcon\DataMapper\Pdo\Connection | -| Uses | Phalcon\DataMapper\Pdo\Exception\CannotDisconnect, Phalcon\DataMapper\Pdo\Profiler\Profiler, Phalcon\DataMapper\Pdo\Profiler\ProfilerInterface | -| Extends | AbstractConnection | + +- __Namespace__ + + - `Phalcon\DataMapper\Pdo\Connection` + +- __Uses__ + + - `Phalcon\DataMapper\Pdo\Exception\CannotDisconnect` + - `Phalcon\DataMapper\Pdo\Profiler\Profiler` + - `Phalcon\DataMapper\Pdo\Profiler\ProfilerInterface` + +- __Extends__ + + `AbstractConnection` + +- __Implements__ + Decorates an existing PDO instance with the extended methods. -## Methods +### Methods ```php public function __construct( \PDO $pdo, ProfilerInterface $profiler = null ); @@ -538,16 +583,28 @@ Disconnects from the database; disallowed with decorated PDO connections. -

Interface Phalcon\DataMapper\Pdo\Connection\PdoInterface

+## DataMapper\Pdo\Connection\PdoInterface ![Abstract](assets/images/interface-blue.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/DataMapper/Pdo/Connection/PdoInterface.zep) -| Namespace | Phalcon\DataMapper\Pdo\Connection | + +- __Namespace__ + + - `Phalcon\DataMapper\Pdo\Connection` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + An interface to the native PDO object. -## Methods +### Methods ```php public function beginTransaction(): bool; @@ -645,18 +702,31 @@ Set a database connection attribute -

Class Phalcon\DataMapper\Pdo\ConnectionLocator

+## DataMapper\Pdo\ConnectionLocator [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/DataMapper/Pdo/ConnectionLocator.zep) -| Namespace | Phalcon\DataMapper\Pdo | -| Uses | Phalcon\DataMapper\Pdo\Connection\ConnectionInterface, Phalcon\DataMapper\Pdo\Exception\ConnectionNotFound | -| Implements | ConnectionLocatorInterface | + +- __Namespace__ + + - `Phalcon\DataMapper\Pdo` + +- __Uses__ + + - `Phalcon\DataMapper\Pdo\Connection\ConnectionInterface` + - `Phalcon\DataMapper\Pdo\Exception\ConnectionNotFound` + +- __Extends__ + + +- __Implements__ + + - `ConnectionLocatorInterface` Manages Connection instances for default, read, and write connections. -## Properties +### Properties ```php /** * A default Connection connection factory/instance. @@ -688,7 +758,7 @@ private instances; ``` -## Methods +### Methods ```php public function __construct( ConnectionInterface $master, array $read = [], array $write = [] ); @@ -744,17 +814,29 @@ Returns a connection by name. -

Interface Phalcon\DataMapper\Pdo\ConnectionLocatorInterface

+## DataMapper\Pdo\ConnectionLocatorInterface ![Abstract](assets/images/interface-blue.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/DataMapper/Pdo/ConnectionLocatorInterface.zep) -| Namespace | Phalcon\DataMapper\Pdo | -| Uses | Phalcon\DataMapper\Pdo\Connection\ConnectionInterface | + +- __Namespace__ + + - `Phalcon\DataMapper\Pdo` + +- __Uses__ + + - `Phalcon\DataMapper\Pdo\Connection\ConnectionInterface` + +- __Extends__ + + +- __Implements__ + Locates PDO connections for default, read, and write databases. -## Methods +### Methods ```php public function getMaster(): ConnectionInterface; @@ -798,52 +880,103 @@ Sets a write connection registry entry by name. -

Class Phalcon\DataMapper\Pdo\Exception\CannotDisconnect

+## DataMapper\Pdo\Exception\CannotDisconnect [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/DataMapper/Pdo/Exception/CannotDisconnect.zep) -| Namespace | Phalcon\DataMapper\Pdo\Exception | -| Extends | Exception | + +- __Namespace__ + + - `Phalcon\DataMapper\Pdo\Exception` + +- __Uses__ + + +- __Extends__ + + `Exception` + +- __Implements__ + ExtendedPdo could not disconnect; e.g., because its PDO connection was created externally and then injected. -

Class Phalcon\DataMapper\Pdo\Exception\ConnectionNotFound

+## DataMapper\Pdo\Exception\ConnectionNotFound [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/DataMapper/Pdo/Exception/ConnectionNotFound.zep) -| Namespace | Phalcon\DataMapper\Pdo\Exception | -| Extends | Exception | + +- __Namespace__ + + - `Phalcon\DataMapper\Pdo\Exception` + +- __Uses__ + + +- __Extends__ + + `Exception` + +- __Implements__ + Locator could not find a named connection. -

Class Phalcon\DataMapper\Pdo\Exception\Exception

+## DataMapper\Pdo\Exception\Exception [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/DataMapper/Pdo/Exception/Exception.zep) -| Namespace | Phalcon\DataMapper\Pdo\Exception | -| Extends | \Exception | + +- __Namespace__ + + - `Phalcon\DataMapper\Pdo\Exception` + +- __Uses__ + + +- __Extends__ + + `\Exception` + +- __Implements__ + Base Exception class -

Class Phalcon\DataMapper\Pdo\Profiler\MemoryLogger

+## DataMapper\Pdo\Profiler\MemoryLogger [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/DataMapper/Pdo/Profiler/MemoryLogger.zep) -| Namespace | Phalcon\DataMapper\Pdo\Profiler | -| Uses | Phalcon\Logger\Enum, Phalcon\Logger\Adapter\AdapterInterface, Phalcon\Logger\Adapter\Noop, Phalcon\Logger\LoggerInterface | -| Implements | LoggerInterface | + +- __Namespace__ + + - `Phalcon\DataMapper\Pdo\Profiler` + +- __Uses__ + + - `Phalcon\Logger\Adapter\AdapterInterface` + - `Phalcon\Logger\Adapter\Noop` + - `Phalcon\Logger\Enum` + - `Phalcon\Logger\LoggerInterface` + +- __Extends__ + + +- __Implements__ + + - `LoggerInterface` A memory-based logger. -## Properties +### Properties ```php /** * @var array @@ -852,7 +985,7 @@ protected messages; ``` -## Methods +### Methods ```php public function alert( string $message, array $context = [] ): void; @@ -940,18 +1073,33 @@ public function warning( string $message, array $context = [] ): void; -

Class Phalcon\DataMapper\Pdo\Profiler\Profiler

+## DataMapper\Pdo\Profiler\Profiler [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/DataMapper/Pdo/Profiler/Profiler.zep) -| Namespace | Phalcon\DataMapper\Pdo\Profiler | -| Uses | Phalcon\DataMapper\Pdo\Exception\Exception, Phalcon\Logger\Enum, Phalcon\Logger\LoggerInterface, Phalcon\Support\Helper\Json\Encode | -| Implements | ProfilerInterface | + +- __Namespace__ + + - `Phalcon\DataMapper\Pdo\Profiler` + +- __Uses__ + + - `Phalcon\DataMapper\Pdo\Exception\Exception` + - `Phalcon\Logger\Enum` + - `Phalcon\Logger\LoggerInterface` + - `Phalcon\Support\Helper\Json\Encode` + +- __Extends__ + + +- __Implements__ + + - `ProfilerInterface` Sends query profiles to a logger. -## Properties +### Properties ```php /** * @var bool @@ -985,7 +1133,7 @@ private encode; ``` -## Methods +### Methods ```php public function __construct( LoggerInterface $logger = null ); @@ -1049,17 +1197,29 @@ Starts a profile entry. -

Interface Phalcon\DataMapper\Pdo\Profiler\ProfilerInterface

+## DataMapper\Pdo\Profiler\ProfilerInterface ![Abstract](assets/images/interface-blue.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/DataMapper/Pdo/Profiler/ProfilerInterface.zep) -| Namespace | Phalcon\DataMapper\Pdo\Profiler | -| Uses | Phalcon\Logger\LoggerInterface | + +- __Namespace__ + + - `Phalcon\DataMapper\Pdo\Profiler` + +- __Uses__ + + - `Phalcon\Logger\LoggerInterface` + +- __Extends__ + + +- __Implements__ + Interface to send query profiles to a logger. -## Methods +### Methods ```php public function finish( string $statement = null, array $values = [] ): void; @@ -1117,17 +1277,29 @@ Starts a profile entry. -

Abstract Class Phalcon\DataMapper\Query\AbstractConditions

+## DataMapper\Query\AbstractConditions ![Abstract](assets/images/abstract-green.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/DataMapper/Query/AbstractConditions.zep) -| Namespace | Phalcon\DataMapper\Query | -| Extends | AbstractQuery | + +- __Namespace__ + + - `Phalcon\DataMapper\Query` + +- __Uses__ + + +- __Extends__ + + `AbstractQuery` + +- __Implements__ + Class AbstractConditions -## Methods +### Methods ```php public function andWhere( string $condition, mixed $value = null, int $type = int ): AbstractConditions; @@ -1233,17 +1405,29 @@ Processes a value (array or string) and merges it with the store -

Abstract Class Phalcon\DataMapper\Query\AbstractQuery

+## DataMapper\Query\AbstractQuery ![Abstract](assets/images/abstract-green.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/DataMapper/Query/AbstractQuery.zep) -| Namespace | Phalcon\DataMapper\Query | -| Uses | Phalcon\DataMapper\Pdo\Connection | + +- __Namespace__ + + - `Phalcon\DataMapper\Query` + +- __Uses__ + + - `Phalcon\DataMapper\Pdo\Connection` + +- __Extends__ + + +- __Implements__ + Class AbstractQuery -## Properties +### Properties ```php /** * @var Bind @@ -1262,7 +1446,7 @@ protected store; ``` -## Methods +### Methods ```php public function __construct( Connection $connection, Bind $bind ); @@ -1344,16 +1528,28 @@ Indents a collection -

Class Phalcon\DataMapper\Query\Bind

+## DataMapper\Query\Bind [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/DataMapper/Query/Bind.zep) -| Namespace | Phalcon\DataMapper\Query | + +- __Namespace__ + + - `Phalcon\DataMapper\Query` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Class Bind -## Properties +### Properties ```php /** * @var int @@ -1367,7 +1563,7 @@ protected store; ``` -## Methods +### Methods ```php public function bindInline( mixed $value, int $type = int ): string; @@ -1413,18 +1609,30 @@ Processes an array - if passed as an `inline` parameter -

Class Phalcon\DataMapper\Query\Delete

+## DataMapper\Query\Delete [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/DataMapper/Query/Delete.zep) -| Namespace | Phalcon\DataMapper\Query | -| Uses | Phalcon\DataMapper\Pdo\Connection | -| Extends | AbstractConditions | + +- __Namespace__ + + - `Phalcon\DataMapper\Query` + +- __Uses__ + + - `Phalcon\DataMapper\Pdo\Connection` + +- __Extends__ + + `AbstractConditions` + +- __Implements__ + Delete Query -## Methods +### Methods ```php public function __construct( Connection $connection, Bind $bind ); @@ -1458,18 +1666,30 @@ Adds the `RETURNING` clause -

Class Phalcon\DataMapper\Query\Insert

+## DataMapper\Query\Insert [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/DataMapper/Query/Insert.zep) -| Namespace | Phalcon\DataMapper\Query | -| Uses | Phalcon\DataMapper\Pdo\Connection | -| Extends | AbstractQuery | + +- __Namespace__ + + - `Phalcon\DataMapper\Query` + +- __Uses__ + + - `Phalcon\DataMapper\Pdo\Connection` + +- __Extends__ + + `AbstractQuery` + +- __Implements__ + Insert Query -## Methods +### Methods ```php public function __construct( Connection $connection, Bind $bind ); @@ -1527,17 +1747,29 @@ Sets a column = value condition -

Class Phalcon\DataMapper\Query\QueryFactory

+## DataMapper\Query\QueryFactory [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/DataMapper/Query/QueryFactory.zep) -| Namespace | Phalcon\DataMapper\Query | -| Uses | Phalcon\DataMapper\Pdo\Connection | + +- __Namespace__ + + - `Phalcon\DataMapper\Query` + +- __Uses__ + + - `Phalcon\DataMapper\Pdo\Connection` + +- __Extends__ + + +- __Implements__ + QueryFactory -## Properties +### Properties ```php /** * @var string @@ -1546,7 +1778,7 @@ protected selectClass = ; ``` -## Methods +### Methods ```php public function __construct( string $selectClass = string ); @@ -1586,18 +1818,30 @@ Create a new Update object -

Class Phalcon\DataMapper\Query\Select

+## DataMapper\Query\Select [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/DataMapper/Query/Select.zep) -| Namespace | Phalcon\DataMapper\Query | -| Uses | BadMethodCallException | -| Extends | AbstractConditions | + +- __Namespace__ + + - `Phalcon\DataMapper\Query` + +- __Uses__ + + - `BadMethodCallException` + +- __Extends__ + + `AbstractConditions` + +- __Implements__ + Select Query -## Constants +### Constants ```php const JOIN_INNER = INNER; const JOIN_LEFT = LEFT; @@ -1605,7 +1849,7 @@ const JOIN_NATURAL = NATURAL; const JOIN_RIGHT = RIGHT; ``` -## Properties +### Properties ```php /** * @var string @@ -1619,7 +1863,7 @@ protected forUpdate = false; ``` -## Methods +### Methods ```php public function __call( string $method, array $params ); @@ -1652,9 +1896,9 @@ The `AS` statement for the query - useful in sub-queries ```php -public function columns(): Select; +public function columns( array $columns ): Select; ``` -The columns to select from. If a key is set in an array element, the +The columns to select from. If a key is set in the array element, the key will be used as the alias @@ -1744,18 +1988,30 @@ Statement builder -

Class Phalcon\DataMapper\Query\Update

+## DataMapper\Query\Update [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/DataMapper/Query/Update.zep) -| Namespace | Phalcon\DataMapper\Query | -| Uses | Phalcon\DataMapper\Pdo\Connection | -| Extends | AbstractConditions | + +- __Namespace__ + + - `Phalcon\DataMapper\Query` + +- __Uses__ + + - `Phalcon\DataMapper\Pdo\Connection` + +- __Extends__ + + `AbstractConditions` + +- __Implements__ + Update Query -## Methods +### Methods ```php public function __construct( Connection $connection, Bind $bind ); diff --git a/docs/api/phalcon_db.md b/docs/api/phalcon_db.md index d73fccbe8..807aa268c 100644 --- a/docs/api/phalcon_db.md +++ b/docs/api/phalcon_db.md @@ -1,37 +1,32 @@ +--- +hide: + - navigation +--- -* [Phalcon\Db\AbstractDb](#db-abstractdb) -* [Phalcon\Db\Adapter\AbstractAdapter](#db-adapter-abstractadapter) -* [Phalcon\Db\Adapter\AdapterInterface](#db-adapter-adapterinterface) -* [Phalcon\Db\Adapter\Pdo\AbstractPdo](#db-adapter-pdo-abstractpdo) -* [Phalcon\Db\Adapter\Pdo\Mysql](#db-adapter-pdo-mysql) -* [Phalcon\Db\Adapter\Pdo\Postgresql](#db-adapter-pdo-postgresql) -* [Phalcon\Db\Adapter\Pdo\Sqlite](#db-adapter-pdo-sqlite) -* [Phalcon\Db\Adapter\PdoFactory](#db-adapter-pdofactory) -* [Phalcon\Db\Column](#db-column) -* [Phalcon\Db\ColumnInterface](#db-columninterface) -* [Phalcon\Db\Dialect](#db-dialect) -* [Phalcon\Db\Dialect\Mysql](#db-dialect-mysql) -* [Phalcon\Db\Dialect\Postgresql](#db-dialect-postgresql) -* [Phalcon\Db\Dialect\Sqlite](#db-dialect-sqlite) -* [Phalcon\Db\DialectInterface](#db-dialectinterface) -* [Phalcon\Db\Enum](#db-enum) -* [Phalcon\Db\Exception](#db-exception) -* [Phalcon\Db\Index](#db-index) -* [Phalcon\Db\IndexInterface](#db-indexinterface) -* [Phalcon\Db\Profiler](#db-profiler) -* [Phalcon\Db\Profiler\Item](#db-profiler-item) -* [Phalcon\Db\RawValue](#db-rawvalue) -* [Phalcon\Db\Reference](#db-reference) -* [Phalcon\Db\ReferenceInterface](#db-referenceinterface) -* [Phalcon\Db\Result\PdoResult](#db-result-pdoresult) -* [Phalcon\Db\ResultInterface](#db-resultinterface) - -

Abstract Class Phalcon\Db\AbstractDb

+!!! info "NOTE" + + All classes are prefixed with `Phalcon` + + + +## Db\AbstractDb ![Abstract](assets/images/abstract-green.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Db/AbstractDb.zep) -| Namespace | Phalcon\Db | -| Uses | \PDO | + +- __Namespace__ + + - `Phalcon\Db` + +- __Uses__ + + - `\PDO` + +- __Extends__ + + +- __Implements__ + Phalcon\Db and its related classes provide a simple SQL database interface for Phalcon Framework. The Phalcon\Db is the basic class you use to connect @@ -76,7 +71,7 @@ try { ``` -## Methods +### Methods ```php public static function setup( array $options ): void; @@ -86,18 +81,41 @@ Enables/disables options in the Database component -

Abstract Class Phalcon\Db\Adapter\AbstractAdapter

+## Db\Adapter\AbstractAdapter ![Abstract](assets/images/abstract-green.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Db/Adapter/AbstractAdapter.zep) -| Namespace | Phalcon\Db\Adapter | -| Uses | Phalcon\Db\DialectInterface, Phalcon\Db\ColumnInterface, Phalcon\Db\Enum, Phalcon\Db\Exception, Phalcon\Db\Index, Phalcon\Db\IndexInterface, Phalcon\Db\Reference, Phalcon\Db\ReferenceInterface, Phalcon\Db\RawValue, Phalcon\Events\EventsAwareInterface, Phalcon\Events\ManagerInterface | -| Implements | AdapterInterface, EventsAwareInterface | + +- __Namespace__ + + - `Phalcon\Db\Adapter` + +- __Uses__ + + - `Phalcon\Db\ColumnInterface` + - `Phalcon\Db\DialectInterface` + - `Phalcon\Db\Enum` + - `Phalcon\Db\Exception` + - `Phalcon\Db\Index` + - `Phalcon\Db\IndexInterface` + - `Phalcon\Db\RawValue` + - `Phalcon\Db\Reference` + - `Phalcon\Db\ReferenceInterface` + - `Phalcon\Events\EventsAwareInterface` + - `Phalcon\Events\ManagerInterface` + +- __Extends__ + + +- __Implements__ + + - `AdapterInterface` + - `EventsAwareInterface` Base class for Phalcon\Db\Adapter adapters -## Properties +### Properties ```php /** * Connection ID @@ -192,7 +210,7 @@ protected type; ``` -## Methods +### Methods ```php public function __construct( array $descriptor ); @@ -776,17 +794,34 @@ var_dump( -

Interface Phalcon\Db\Adapter\AdapterInterface

+## Db\Adapter\AdapterInterface ![Abstract](assets/images/interface-blue.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Db/Adapter/AdapterInterface.zep) -| Namespace | Phalcon\Db\Adapter | -| Uses | Phalcon\Db\DialectInterface, Phalcon\Db\ResultInterface, Phalcon\Db\ColumnInterface, Phalcon\Db\IndexInterface, Phalcon\Db\RawValue, Phalcon\Db\ReferenceInterface | + +- __Namespace__ + + - `Phalcon\Db\Adapter` + +- __Uses__ + + - `Phalcon\Db\ColumnInterface` + - `Phalcon\Db\DialectInterface` + - `Phalcon\Db\IndexInterface` + - `Phalcon\Db\RawValue` + - `Phalcon\Db\ReferenceInterface` + - `Phalcon\Db\ResultInterface` + +- __Extends__ + + +- __Implements__ + Interface for Phalcon\Db adapters -## Methods +### Methods ```php public function addColumn( string $tableName, string $schemaName, ColumnInterface $column ): bool; @@ -1264,13 +1299,30 @@ Generates SQL checking for the existence of a schema.view -

Abstract Class Phalcon\Db\Adapter\Pdo\AbstractPdo

+## Db\Adapter\Pdo\AbstractPdo ![Abstract](assets/images/abstract-green.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Db/Adapter/Pdo/AbstractPdo.zep) -| Namespace | Phalcon\Db\Adapter\Pdo | -| Uses | Phalcon\Db\Adapter\AbstractAdapter, Phalcon\Db\Column, Phalcon\Db\Exception, Phalcon\Db\Result\PdoResult, Phalcon\Db\ResultInterface, Phalcon\Events\ManagerInterface | -| Extends | AbstractAdapter | + +- __Namespace__ + + - `Phalcon\Db\Adapter\Pdo` + +- __Uses__ + + - `Phalcon\Db\Adapter\AbstractAdapter` + - `Phalcon\Db\Column` + - `Phalcon\Db\Exception` + - `Phalcon\Db\ResultInterface` + - `Phalcon\Db\Result\PdoResult` + - `Phalcon\Events\ManagerInterface` + +- __Extends__ + + `AbstractAdapter` + +- __Implements__ + Phalcon\Db\Adapter\Pdo is the Phalcon\Db that internally uses PDO to connect to a database @@ -1290,7 +1342,7 @@ $connection = new Mysql($config); ``` -## Properties +### Properties ```php /** * Last affected rows @@ -1308,7 +1360,7 @@ protected pdo; ``` -## Methods +### Methods ```php public function __construct( array $descriptor ); @@ -1579,13 +1631,33 @@ Constructs the SQL statement (with parameters) -

Class Phalcon\Db\Adapter\Pdo\Mysql

+## Db\Adapter\Pdo\Mysql [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Db/Adapter/Pdo/Mysql.zep) -| Namespace | Phalcon\Db\Adapter\Pdo | -| Uses | Phalcon\Db\Adapter\Pdo\AbstractPdo, Phalcon\Db\Column, Phalcon\Db\ColumnInterface, Phalcon\Db\Enum, Phalcon\Db\Exception, Phalcon\Db\Index, Phalcon\Db\IndexInterface, Phalcon\Db\Reference, Phalcon\Db\ReferenceInterface | -| Extends | PdoAdapter | + +- __Namespace__ + + - `Phalcon\Db\Adapter\Pdo` + +- __Uses__ + + - `Phalcon\Db\Adapter\Pdo\AbstractPdo` + - `Phalcon\Db\Column` + - `Phalcon\Db\ColumnInterface` + - `Phalcon\Db\Enum` + - `Phalcon\Db\Exception` + - `Phalcon\Db\Index` + - `Phalcon\Db\IndexInterface` + - `Phalcon\Db\Reference` + - `Phalcon\Db\ReferenceInterface` + +- __Extends__ + + `PdoAdapter` + +- __Implements__ + Specific functions for the MySQL database system @@ -1604,7 +1676,7 @@ $connection = new Mysql($config); ``` -## Properties +### Properties ```php /** * @var string @@ -1618,7 +1690,7 @@ protected type = mysql; ``` -## Methods +### Methods ```php public function __construct( array $descriptor ); @@ -1676,13 +1748,33 @@ Returns PDO adapter DSN defaults as a key-value map. -

Class Phalcon\Db\Adapter\Pdo\Postgresql

+## Db\Adapter\Pdo\Postgresql [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Db/Adapter/Pdo/Postgresql.zep) -| Namespace | Phalcon\Db\Adapter\Pdo | -| Uses | Phalcon\Db\Adapter\Pdo\AbstractPdo, Phalcon\Db\Column, Phalcon\Db\ColumnInterface, Phalcon\Db\Enum, Phalcon\Db\Exception, Phalcon\Db\RawValue, Phalcon\Db\Reference, Phalcon\Db\ReferenceInterface, Throwable | -| Extends | PdoAdapter | + +- __Namespace__ + + - `Phalcon\Db\Adapter\Pdo` + +- __Uses__ + + - `Phalcon\Db\Adapter\Pdo\AbstractPdo` + - `Phalcon\Db\Column` + - `Phalcon\Db\ColumnInterface` + - `Phalcon\Db\Enum` + - `Phalcon\Db\Exception` + - `Phalcon\Db\RawValue` + - `Phalcon\Db\Reference` + - `Phalcon\Db\ReferenceInterface` + - `Throwable` + +- __Extends__ + + `PdoAdapter` + +- __Implements__ + Specific functions for the PostgreSQL database system @@ -1701,7 +1793,7 @@ $connection = new Postgresql($config); ``` -## Properties +### Properties ```php /** * @var string @@ -1715,7 +1807,7 @@ protected type = pgsql; ``` -## Methods +### Methods ```php public function __construct( array $descriptor ); @@ -1811,13 +1903,34 @@ Returns PDO adapter DSN defaults as a key-value map. -

Class Phalcon\Db\Adapter\Pdo\Sqlite

+## Db\Adapter\Pdo\Sqlite [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Db/Adapter/Pdo/Sqlite.zep) -| Namespace | Phalcon\Db\Adapter\Pdo | -| Uses | Phalcon\Db\Adapter\Pdo\AbstractPdo, Phalcon\Db\Column, Phalcon\Db\ColumnInterface, Phalcon\Db\Enum, Phalcon\Db\Exception, Phalcon\Db\Index, Phalcon\Db\IndexInterface, Phalcon\Db\RawValue, Phalcon\Db\Reference, Phalcon\Db\ReferenceInterface | -| Extends | PdoAdapter | + +- __Namespace__ + + - `Phalcon\Db\Adapter\Pdo` + +- __Uses__ + + - `Phalcon\Db\Adapter\Pdo\AbstractPdo` + - `Phalcon\Db\Column` + - `Phalcon\Db\ColumnInterface` + - `Phalcon\Db\Enum` + - `Phalcon\Db\Exception` + - `Phalcon\Db\Index` + - `Phalcon\Db\IndexInterface` + - `Phalcon\Db\RawValue` + - `Phalcon\Db\Reference` + - `Phalcon\Db\ReferenceInterface` + +- __Extends__ + + `PdoAdapter` + +- __Implements__ + Specific functions for the SQLite database system @@ -1832,7 +1945,7 @@ $connection = new Sqlite( ``` -## Properties +### Properties ```php /** * @var string @@ -1846,7 +1959,7 @@ protected type = sqlite; ``` -## Methods +### Methods ```php public function __construct( array $descriptor ); @@ -1936,13 +2049,26 @@ Returns PDO adapter DSN defaults as a key-value map. -

Class Phalcon\Db\Adapter\PdoFactory

+## Db\Adapter\PdoFactory [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Db/Adapter/PdoFactory.zep) -| Namespace | Phalcon\Db\Adapter | -| Uses | Phalcon\Factory\AbstractFactory, Phalcon\Support\Helper\Arr\Get | -| Extends | AbstractFactory | + +- __Namespace__ + + - `Phalcon\Db\Adapter` + +- __Uses__ + + - `Phalcon\Factory\AbstractFactory` + - `Phalcon\Support\Helper\Arr\Get` + +- __Extends__ + + `AbstractFactory` + +- __Implements__ + This file is part of the Phalcon Framework. @@ -1952,7 +2078,7 @@ For the full copyright and license information, please view the LICENSE.txt file that was distributed with this source code. -## Methods +### Methods ```php public function __construct( array $services = [] ); @@ -1986,12 +2112,24 @@ Returns the available adapters -

Class Phalcon\Db\Column

+## Db\Column [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Db/Column.zep) -| Namespace | Phalcon\Db | -| Implements | ColumnInterface | + +- __Namespace__ + + - `Phalcon\Db` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + + - `ColumnInterface` Allows to define columns to be used on create or alter table operations @@ -2017,7 +2155,7 @@ $connection->addColumn("robots", null, $column); ``` -## Constants +### Constants ```php const BIND_PARAM_BLOB = 3; const BIND_PARAM_BOOL = 5; @@ -2057,7 +2195,7 @@ const TYPE_VARBINARY = 27; const TYPE_VARCHAR = 2; ``` -## Properties +### Properties ```php /** * Column Position @@ -2175,7 +2313,7 @@ protected unsigned = false; ``` -## Methods +### Methods ```php public function __construct( string $name, array $definition ); @@ -2287,16 +2425,28 @@ Returns true if number column is unsigned -

Interface Phalcon\Db\ColumnInterface

+## Db\ColumnInterface ![Abstract](assets/images/interface-blue.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Db/ColumnInterface.zep) -| Namespace | Phalcon\Db | + +- __Namespace__ + + - `Phalcon\Db` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Interface for Phalcon\Db\Column -## Methods +### Methods ```php public function getAfterPosition(): string | null; @@ -2396,18 +2546,30 @@ Returns true if number column is unsigned -

Abstract Class Phalcon\Db\Dialect

+## Db\Dialect ![Abstract](assets/images/abstract-green.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Db/Dialect.zep) -| Namespace | Phalcon\Db | -| Implements | DialectInterface | + +- __Namespace__ + + - `Phalcon\Db` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + + - `DialectInterface` This is the base class to each database dialect. This implements common methods to transform intermediate code into its RDBMS related syntax -## Properties +### Properties ```php /** * @var string @@ -2421,7 +2583,7 @@ protected customFunctions; ``` -## Methods +### Methods ```php public function createSavepoint( string $name ): string; @@ -2701,18 +2863,36 @@ Prepares table for this RDBMS -

Class Phalcon\Db\Dialect\Mysql

+## Db\Dialect\Mysql [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Db/Dialect/Mysql.zep) -| Namespace | Phalcon\Db\Dialect | -| Uses | Phalcon\Db\Dialect, Phalcon\Db\Column, Phalcon\Db\Exception, Phalcon\Db\IndexInterface, Phalcon\Db\ColumnInterface, Phalcon\Db\ReferenceInterface, Phalcon\Db\DialectInterface | -| Extends | Dialect | + +- __Namespace__ + + - `Phalcon\Db\Dialect` + +- __Uses__ + + - `Phalcon\Db\Column` + - `Phalcon\Db\ColumnInterface` + - `Phalcon\Db\Dialect` + - `Phalcon\Db\DialectInterface` + - `Phalcon\Db\Exception` + - `Phalcon\Db\IndexInterface` + - `Phalcon\Db\ReferenceInterface` + +- __Extends__ + + `Dialect` + +- __Implements__ + Generates database specific SQL for the MySQL RDBMS -## Properties +### Properties ```php /** * @var string @@ -2721,7 +2901,7 @@ protected escapeChar = `; ``` -## Methods +### Methods ```php public function addColumn( string $tableName, string $schemaName, ColumnInterface $column ): string; @@ -2905,18 +3085,36 @@ Generates SQL to add the table creation options -

Class Phalcon\Db\Dialect\Postgresql

+## Db\Dialect\Postgresql [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Db/Dialect/Postgresql.zep) -| Namespace | Phalcon\Db\Dialect | -| Uses | Phalcon\Db\Dialect, Phalcon\Db\Column, Phalcon\Db\Exception, Phalcon\Db\IndexInterface, Phalcon\Db\ColumnInterface, Phalcon\Db\ReferenceInterface, Phalcon\Db\DialectInterface | -| Extends | Dialect | + +- __Namespace__ + + - `Phalcon\Db\Dialect` + +- __Uses__ + + - `Phalcon\Db\Column` + - `Phalcon\Db\ColumnInterface` + - `Phalcon\Db\Dialect` + - `Phalcon\Db\DialectInterface` + - `Phalcon\Db\Exception` + - `Phalcon\Db\IndexInterface` + - `Phalcon\Db\ReferenceInterface` + +- __Extends__ + + `Dialect` + +- __Implements__ + Generates database specific SQL for the PostgreSQL RDBMS -## Properties +### Properties ```php /** * @var string @@ -2925,7 +3123,7 @@ protected escapeChar = \"; ``` -## Methods +### Methods ```php public function addColumn( string $tableName, string $schemaName, ColumnInterface $column ): string; @@ -3104,18 +3302,36 @@ protected function getTableOptions( array $definition ): string; -

Class Phalcon\Db\Dialect\Sqlite

+## Db\Dialect\Sqlite [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Db/Dialect/Sqlite.zep) -| Namespace | Phalcon\Db\Dialect | -| Uses | Phalcon\Db\Column, Phalcon\Db\Exception, Phalcon\Db\IndexInterface, Phalcon\Db\Dialect, Phalcon\Db\DialectInterface, Phalcon\Db\ColumnInterface, Phalcon\Db\ReferenceInterface | -| Extends | Dialect | + +- __Namespace__ + + - `Phalcon\Db\Dialect` + +- __Uses__ + + - `Phalcon\Db\Column` + - `Phalcon\Db\ColumnInterface` + - `Phalcon\Db\Dialect` + - `Phalcon\Db\DialectInterface` + - `Phalcon\Db\Exception` + - `Phalcon\Db\IndexInterface` + - `Phalcon\Db\ReferenceInterface` + +- __Extends__ + + `Dialect` + +- __Implements__ + Generates database specific SQL for the SQLite RDBMS -## Properties +### Properties ```php /** * @var string @@ -3124,7 +3340,7 @@ protected escapeChar = \"; ``` -## Methods +### Methods ```php public function addColumn( string $tableName, string $schemaName, ColumnInterface $column ): string; @@ -3316,16 +3532,28 @@ Generates SQL checking for the existence of a schema.view -

Interface Phalcon\Db\DialectInterface

+## Db\DialectInterface ![Abstract](assets/images/interface-blue.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Db/DialectInterface.zep) -| Namespace | Phalcon\Db | + +- __Namespace__ + + - `Phalcon\Db` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Interface for Phalcon\Db dialects -## Methods +### Methods ```php public function addColumn( string $tableName, string $schemaName, ColumnInterface $column ): string; @@ -3534,16 +3762,28 @@ Generates SQL checking for the existence of a schema.view -

Class Phalcon\Db\Enum

+## Db\Enum [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Db/Enum.zep) -| Namespace | Phalcon\Db | + +- __Namespace__ + + - `Phalcon\Db` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Constants for Phalcon\Db -## Constants +### Constants ```php const FETCH_ASSOC; const FETCH_BOTH; @@ -3567,23 +3807,47 @@ const FETCH_UNIQUE; ``` -

Class Phalcon\Db\Exception

+## Db\Exception [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Db/Exception.zep) -| Namespace | Phalcon\Db | -| Extends | \Exception | + +- __Namespace__ + + - `Phalcon\Db` + +- __Uses__ + + +- __Extends__ + + `\Exception` + +- __Implements__ + Exceptions thrown in Phalcon\Db will use this class -

Class Phalcon\Db\Index

+## Db\Index [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Db/Index.zep) -| Namespace | Phalcon\Db | -| Implements | IndexInterface | + +- __Namespace__ + + - `Phalcon\Db` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + + - `IndexInterface` Allows to define indexes to be used on tables. Indexes are a common way to enhance database performance. An index allows the database server to find @@ -3614,7 +3878,7 @@ $connection->addIndex("robots", null, $index_primary); ``` -## Properties +### Properties ```php /** * Index columns @@ -3639,7 +3903,7 @@ protected type; ``` -## Methods +### Methods ```php public function __construct( string $name, array $columns, string $type = string ); @@ -3667,16 +3931,28 @@ Index type -

Interface Phalcon\Db\IndexInterface

+## Db\IndexInterface ![Abstract](assets/images/interface-blue.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Db/IndexInterface.zep) -| Namespace | Phalcon\Db | + +- __Namespace__ + + - `Phalcon\Db` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Interface for Phalcon\Db\Index -## Methods +### Methods ```php public function getColumns(): array; @@ -3698,12 +3974,24 @@ Gets the index type -

Class Phalcon\Db\Profiler

+## Db\Profiler [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Db/Profiler.zep) -| Namespace | Phalcon\Db | -| Uses | Phalcon\Db\Profiler\Item | + +- __Namespace__ + + - `Phalcon\Db` + +- __Uses__ + + - `Phalcon\Db\Profiler\Item` + +- __Extends__ + + +- __Implements__ + Instances of Phalcon\Db can generate execution profiles on SQL statements sent to the relational database. Profiled @@ -3756,7 +4044,7 @@ echo "Total Elapsed Time: ", $profile->getTotalElapsedSeconds(), "\n"; ``` -## Properties +### Properties ```php /** * Active Item @@ -3781,7 +4069,7 @@ protected totalNanoseconds = 0; ``` -## Methods +### Methods ```php public function getLastProfile(): Item; @@ -3839,16 +4127,28 @@ Stops the active profile -

Class Phalcon\Db\Profiler\Item

+## Db\Profiler\Item [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Db/Profiler/Item.zep) -| Namespace | Phalcon\Db\Profiler | + +- __Namespace__ + + - `Phalcon\Db\Profiler` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + This class identifies each profile in a Phalcon\Db\Profiler -## Properties +### Properties ```php /** * Timestamp when the profile ended @@ -3887,7 +4187,7 @@ protected sqlVariables; ``` -## Methods +### Methods ```php public function getFinalTime(): double; @@ -3969,11 +4269,23 @@ Return the SQL variables related to the profile -

Class Phalcon\Db\RawValue

+## Db\RawValue [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Db/RawValue.zep) -| Namespace | Phalcon\Db | + +- __Namespace__ + + - `Phalcon\Db` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + This class allows to insert/update raw data without quoting or formatting. @@ -3989,7 +4301,7 @@ $subscriber->save(); ``` -## Properties +### Properties ```php /** * Raw value without quoting or formatting @@ -4000,7 +4312,7 @@ protected value; ``` -## Methods +### Methods ```php public function __construct( mixed $value ); @@ -4022,12 +4334,24 @@ public function getValue(): string; -

Class Phalcon\Db\Reference

+## Db\Reference [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Db/Reference.zep) -| Namespace | Phalcon\Db | -| Implements | ReferenceInterface | + +- __Namespace__ + + - `Phalcon\Db` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + + - `ReferenceInterface` Allows to define reference constraints on tables @@ -4050,7 +4374,7 @@ $reference = new \Phalcon\Db\Reference( ``` -## Properties +### Properties ```php /** * Local reference columns @@ -4110,7 +4434,7 @@ protected onUpdate; ``` -## Methods +### Methods ```php public function __construct( string $name, array $definition ); @@ -4168,16 +4492,28 @@ Schema name -

Interface Phalcon\Db\ReferenceInterface

+## Db\ReferenceInterface ![Abstract](assets/images/interface-blue.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Db/ReferenceInterface.zep) -| Namespace | Phalcon\Db | + +- __Namespace__ + + - `Phalcon\Db` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Interface for Phalcon\Db\Reference -## Methods +### Methods ```php public function getColumns(): array; @@ -4229,13 +4565,27 @@ Gets the schema where referenced table is -

Class Phalcon\Db\Result\PdoResult

+## Db\Result\PdoResult [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Db/Result/PdoResult.zep) -| Namespace | Phalcon\Db\Result | -| Uses | Phalcon\Db\Enum, Phalcon\Db\ResultInterface, Phalcon\Db\Adapter\AdapterInterface | -| Implements | ResultInterface | + +- __Namespace__ + + - `Phalcon\Db\Result` + +- __Uses__ + + - `Phalcon\Db\Adapter\AdapterInterface` + - `Phalcon\Db\Enum` + - `Phalcon\Db\ResultInterface` + +- __Extends__ + + +- __Implements__ + + - `ResultInterface` Encapsulates the resultset internals @@ -4252,7 +4602,7 @@ while ($robot = $result->fetchArray()) { ``` -## Properties +### Properties ```php /** * @var array @@ -4301,7 +4651,7 @@ protected sqlStatement; ``` -## Methods +### Methods ```php public function __construct( AdapterInterface $connection, \PDOStatement $result, mixed $sqlStatement = null, mixed $bindParams = null, mixed $bindTypes = null ); @@ -4344,7 +4694,7 @@ or FALSE if there are no more rows. This method is affected by the active fetch flag set using `Phalcon\Db\Result\Pdo::setFetchMode()` ```php -$result = $connection->query("SELECT * FROM robots ORDER BY name"); +$result = $connection->query("SELECTFROM robots ORDER BY name"); $result->setFetchMode( \Phalcon\Enum::FETCH_OBJ @@ -4357,7 +4707,7 @@ while ($robot = $result->fetch()) { ```php -public function fetchAll( int $mode = Enum::FETCH_DEFAULT, mixed $fetchArgument = Enum::FETCH_ORI_NEXT, mixed $constructorArgs = null ): array; +public function fetchAll( int $mode = static-constant-access, mixed $fetchArgument = static-constant-access, mixed $constructorArgs = null ): array; ``` Returns an array of arrays containing all the records in the result This method is affected by the active fetch flag set using @@ -4365,7 +4715,7 @@ This method is affected by the active fetch flag set using ```php $result = $connection->query( - "SELECT * FROM robots ORDER BY name" + "SELECTFROM robots ORDER BY name" ); $robots = $result->fetchAll(); @@ -4380,7 +4730,7 @@ if there are no more rows. This method is affected by the active fetch flag set using `Phalcon\Db\Result\Pdo::setFetchMode()` ```php -$result = $connection->query("SELECT * FROM robots robots ORDER BY name"); +$result = $connection->query("SELECTFROM robots ORDER BY name"); $result->setFetchMode( \Phalcon\Enum::FETCH_NUM @@ -4405,7 +4755,7 @@ Gets number of rows returned by a resultset ```php $result = $connection->query( - "SELECT * FROM robots robots ORDER BY name" + "SELECTFROM robots ORDER BY name" ); echo "There are ", $result->numRows(), " rows in the resultset"; @@ -4442,16 +4792,28 @@ $result->setFetchMode( -

Interface Phalcon\Db\ResultInterface

+## Db\ResultInterface ![Abstract](assets/images/interface-blue.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Db/ResultInterface.zep) -| Namespace | Phalcon\Db | + +- __Namespace__ + + - `Phalcon\Db` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Interface for Phalcon\Db\Result objects -## Methods +### Methods ```php public function dataSeek( int $number ); diff --git a/docs/api/phalcon_di.md b/docs/api/phalcon_di.md index c659e2392..196a411c7 100644 --- a/docs/api/phalcon_di.md +++ b/docs/api/phalcon_di.md @@ -1,30 +1,37 @@ +--- +hide: + - navigation +--- -* [Phalcon\Di\AbstractInjectionAware](#di-abstractinjectionaware) -* [Phalcon\Di\Di](#di-di) -* [Phalcon\Di\DiInterface](#di-diinterface) -* [Phalcon\Di\Exception](#di-exception) -* [Phalcon\Di\Exception\ServiceResolutionException](#di-exception-serviceresolutionexception) -* [Phalcon\Di\FactoryDefault](#di-factorydefault) -* [Phalcon\Di\FactoryDefault\Cli](#di-factorydefault-cli) -* [Phalcon\Di\InitializationAwareInterface](#di-initializationawareinterface) -* [Phalcon\Di\Injectable](#di-injectable) -* [Phalcon\Di\InjectionAwareInterface](#di-injectionawareinterface) -* [Phalcon\Di\Service](#di-service) -* [Phalcon\Di\Service\Builder](#di-service-builder) -* [Phalcon\Di\ServiceInterface](#di-serviceinterface) -* [Phalcon\Di\ServiceProviderInterface](#di-serviceproviderinterface) - -

Abstract Class Phalcon\Di\AbstractInjectionAware

+!!! info "NOTE" + + All classes are prefixed with `Phalcon` + + + +## Di\AbstractInjectionAware ![Abstract](assets/images/abstract-green.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Di/AbstractInjectionAware.zep) -| Namespace | Phalcon\Di | -| Implements | InjectionAwareInterface | + +- __Namespace__ + + - `Phalcon\Di` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + + - `InjectionAwareInterface` This abstract class offers common access to the DI in a class -## Properties +### Properties ```php /** * Dependency Injector @@ -35,7 +42,7 @@ protected container; ``` -## Methods +### Methods ```php public function getDI(): DiInterface; @@ -51,13 +58,36 @@ Sets the dependency injector -

Class Phalcon\Di\Di

+## Di\Di [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Di/Di.zep) -| Namespace | Phalcon\Di | -| Uses | Phalcon\Di\Service, Phalcon\Di\DiInterface, Phalcon\Di\Exception, Phalcon\Di\Exception\ServiceResolutionException, Phalcon\Config\Adapter\Php, Phalcon\Config\Adapter\Yaml, Phalcon\Config\ConfigInterface, Phalcon\Di\ServiceInterface, Phalcon\Events\ManagerInterface, Phalcon\Di\InitializationAwareInterface, Phalcon\Di\InjectionAwareInterface, Phalcon\Di\ServiceProviderInterface | -| Implements | DiInterface | + +- __Namespace__ + + - `Phalcon\Di` + +- __Uses__ + + - `Phalcon\Config\Adapter\Php` + - `Phalcon\Config\Adapter\Yaml` + - `Phalcon\Config\ConfigInterface` + - `Phalcon\Di\DiInterface` + - `Phalcon\Di\Exception` + - `Phalcon\Di\Exception\ServiceResolutionException` + - `Phalcon\Di\InitializationAwareInterface` + - `Phalcon\Di\InjectionAwareInterface` + - `Phalcon\Di\Service` + - `Phalcon\Di\ServiceInterface` + - `Phalcon\Di\ServiceProviderInterface` + - `Phalcon\Events\ManagerInterface` + +- __Extends__ + + +- __Implements__ + + - `DiInterface` Phalcon\Di\Di is a component that implements Dependency Injection/Service Location of services and it's itself a container for them. @@ -97,7 +127,7 @@ $request = $di->getRequest(); ``` -## Properties +### Properties ```php /** * List of registered services @@ -129,7 +159,7 @@ protected static defaultDi; ``` -## Methods +### Methods ```php public function __call( string $method, array $arguments = [] ): mixed | null; @@ -379,18 +409,30 @@ Loads services from a Config object. -

Interface Phalcon\Di\DiInterface

+## Di\DiInterface ![Abstract](assets/images/interface-blue.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Di/DiInterface.zep) -| Namespace | Phalcon\Di | -| Uses | ArrayAccess | -| Extends | ArrayAccess | + +- __Namespace__ + + - `Phalcon\Di` + +- __Uses__ + + - `ArrayAccess` + +- __Extends__ + + `ArrayAccess` + +- __Implements__ + Interface for Phalcon\Di\Di -## Methods +### Methods ```php public function attempt( string $name, mixed $definition, bool $shared = bool ): ServiceInterface | bool; @@ -481,35 +523,71 @@ Registers an "always shared" service in the services container -

Class Phalcon\Di\Exception

+## Di\Exception [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Di/Exception.zep) -| Namespace | Phalcon\Di | -| Extends | \Exception | + +- __Namespace__ + + - `Phalcon\Di` + +- __Uses__ + + +- __Extends__ + + `\Exception` + +- __Implements__ + Exceptions thrown in Phalcon\Di will use this class -

Class Phalcon\Di\Exception\ServiceResolutionException

+## Di\Exception\ServiceResolutionException [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Di/Exception/ServiceResolutionException.zep) -| Namespace | Phalcon\Di\Exception | -| Extends | \Phalcon\Di\Exception | + +- __Namespace__ + + - `Phalcon\Di\Exception` + +- __Uses__ + + +- __Extends__ + + `\Phalcon\Di\Exception` + +- __Implements__ + Phalcon\Di\Exception\ServiceResolutionException -

Class Phalcon\Di\FactoryDefault

+## Di\FactoryDefault [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Di/FactoryDefault.zep) -| Namespace | Phalcon\Di | -| Uses | Phalcon\Filter\FilterFactory | -| Extends | \Phalcon\Di\Di | + +- __Namespace__ + + - `Phalcon\Di` + +- __Uses__ + + - `Phalcon\Filter\FilterFactory` + +- __Extends__ + + `\Phalcon\Di\Di` + +- __Implements__ + This is a variant of the standard Phalcon\Di\Di. By default it automatically registers all the services provided by the framework. Thanks to this, the @@ -517,7 +595,7 @@ developer does not need to register each service individually providing a full stack framework -## Methods +### Methods ```php public function __construct(); @@ -527,13 +605,27 @@ Phalcon\Di\FactoryDefault constructor -

Class Phalcon\Di\FactoryDefault\Cli

+## Di\FactoryDefault\Cli [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Di/FactoryDefault/Cli.zep) -| Namespace | Phalcon\Di\FactoryDefault | -| Uses | Phalcon\Di\FactoryDefault, Phalcon\Di\Service, Phalcon\Filter\FilterFactory | -| Extends | FactoryDefault | + +- __Namespace__ + + - `Phalcon\Di\FactoryDefault` + +- __Uses__ + + - `Phalcon\Di\FactoryDefault` + - `Phalcon\Di\Service` + - `Phalcon\Filter\FilterFactory` + +- __Extends__ + + `FactoryDefault` + +- __Implements__ + Phalcon\Di\FactoryDefault\Cli @@ -543,7 +635,7 @@ Thanks to this, the developer does not need to register each service individuall This class is specially suitable for CLI applications -## Methods +### Methods ```php public function __construct(); @@ -553,16 +645,28 @@ Phalcon\Di\FactoryDefault\Cli constructor -

Interface Phalcon\Di\InitializationAwareInterface

+## Di\InitializationAwareInterface ![Abstract](assets/images/interface-blue.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Di/InitializationAwareInterface.zep) -| Namespace | Phalcon\Di | + +- __Namespace__ + + - `Phalcon\Di` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Interface for components that have `initialize()` -## Methods +### Methods ```php public function initialize(): void; @@ -572,19 +676,59 @@ public function initialize(): void; -

Abstract Class Phalcon\Di\Injectable

+## Di\Injectable ![Abstract](assets/images/abstract-green.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Di/Injectable.zep) -| Namespace | Phalcon\Di | -| Uses | stdClass, Phalcon\Di\Di, Phalcon\Session\BagInterface | -| Extends | stdClass | -| Implements | InjectionAwareInterface | + +- __Namespace__ + + - `Phalcon\Di` + +- __Uses__ + + - `Phalcon\Di\Di` + - `Phalcon\Session\BagInterface` + - `stdClass` + +- __Extends__ + + `stdClass` + +- __Implements__ + + - `InjectionAwareInterface` This class allows to access services in the services container by just only accessing a public property with the same name of a registered service -## Properties +@property \Phalcon\Mvc\Dispatcher|\Phalcon\Mvc\DispatcherInterface $dispatcher +@property \Phalcon\Mvc\Router|\Phalcon\Mvc\RouterInterface $router +@property \Phalcon\Mvc\Url|\Phalcon\Mvc\Url\UrlInterface $url +@property \Phalcon\Http\Request|\Phalcon\Http\RequestInterface $request +@property \Phalcon\Http\Response|\Phalcon\Http\ResponseInterface $response +@property \Phalcon\Http\Response\Cookies|\Phalcon\Http\Response\CookiesInterface $cookies +@property \Phalcon\Filter\Filter $filter +@property \Phalcon\Flash\Direct $flash +@property \Phalcon\Flash\Session $flashSession +@property \Phalcon\Session\ManagerInterface $session +@property \Phalcon\Events\Manager|\Phalcon\Events\ManagerInterface $eventsManager +@property \Phalcon\Db\Adapter\AdapterInterface $db +@property \Phalcon\Encryption\Security $security +@property \Phalcon\Encryption\Crypt|\Phalcon\Encryption\Crypt\CryptInterface $crypt +@property \Phalcon\Html\TagFactory $tag +@property \Phalcon\Html\Escaper|\Phalcon\Html\Escaper\EscaperInterface $escaper +@property \Phalcon\Annotations\Adapter\Memory|\Phalcon\Annotations\Adapter $annotations +@property \Phalcon\Mvc\Model\Manager|\Phalcon\Mvc\Model\ManagerInterface $modelsManager +@property \Phalcon\Mvc\Model\MetaData\Memory|\Phalcon\Mvc\Model\MetadataInterface $modelsMetadata +@property \Phalcon\Mvc\Model\Transaction\Manager|\Phalcon\Mvc\Model\Transaction\ManagerInterface $transactionManager +@property \Phalcon\Assets\Manager $assets +@property \Phalcon\Di\Di|\Phalcon\Di\Di\DiInterface $di +@property \Phalcon\Session\Bag|\Phalcon\Session\BagInterface $persistent +@property \Phalcon\Mvc\View|\Phalcon\Mvc\ViewInterface $view + + +### Properties ```php /** * Dependency Injector @@ -595,7 +739,7 @@ protected container; ``` -## Methods +### Methods ```php public function __get( string $propertyName ): mixed | null; @@ -623,17 +767,29 @@ Sets the dependency injector -

Interface Phalcon\Di\InjectionAwareInterface

+## Di\InjectionAwareInterface ![Abstract](assets/images/interface-blue.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Di/InjectionAwareInterface.zep) -| Namespace | Phalcon\Di | + +- __Namespace__ + + - `Phalcon\Di` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + This interface must be implemented in those classes that uses internally the Phalcon\Di\Di that creates them -## Methods +### Methods ```php public function getDI(): DiInterface; @@ -649,13 +805,27 @@ Sets the dependency injector -

Class Phalcon\Di\Service

+## Di\Service [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Di/Service.zep) -| Namespace | Phalcon\Di | -| Uses | Closure, Phalcon\Di\Exception\ServiceResolutionException, Phalcon\Di\Service\Builder | -| Implements | ServiceInterface | + +- __Namespace__ + + - `Phalcon\Di` + +- __Uses__ + + - `Closure` + - `Phalcon\Di\Exception\ServiceResolutionException` + - `Phalcon\Di\Service\Builder` + +- __Extends__ + + +- __Implements__ + + - `ServiceInterface` Represents individually a service in the services container @@ -669,7 +839,7 @@ $request = service->resolve(); ``` -## Properties +### Properties ```php /** * @var mixed @@ -693,7 +863,7 @@ protected sharedInstance; ``` -## Methods +### Methods ```php final public function __construct( mixed $definition, bool $shared = bool ); @@ -757,19 +927,32 @@ Sets/Resets the shared instance related to the service -

Class Phalcon\Di\Service\Builder

+## Di\Service\Builder [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Di/Service/Builder.zep) -| Namespace | Phalcon\Di\Service | -| Uses | Phalcon\Di\DiInterface, Phalcon\Di\Exception | + +- __Namespace__ + + - `Phalcon\Di\Service` + +- __Uses__ + + - `Phalcon\Di\DiInterface` + - `Phalcon\Di\Exception` + +- __Extends__ + + +- __Implements__ + Phalcon\Di\Service\Builder This class builds instances based on complex definitions -## Methods +### Methods ```php public function build( DiInterface $container, array $definition, mixed $parameters = null ); @@ -779,16 +962,28 @@ Builds a service using a complex service definition -

Interface Phalcon\Di\ServiceInterface

+## Di\ServiceInterface ![Abstract](assets/images/interface-blue.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Di/ServiceInterface.zep) -| Namespace | Phalcon\Di | + +- __Namespace__ + + - `Phalcon\Di` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Represents a service in the services container -## Methods +### Methods ```php public function getDefinition(): mixed; @@ -840,11 +1035,23 @@ Sets if the service is shared or not -

Interface Phalcon\Di\ServiceProviderInterface

+## Di\ServiceProviderInterface ![Abstract](assets/images/interface-blue.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Di/ServiceProviderInterface.zep) -| Namespace | Phalcon\Di | + +- __Namespace__ + + - `Phalcon\Di` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Should be implemented by service providers, or such components, which register a service in the service container. @@ -870,7 +1077,7 @@ class SomeServiceProvider implements ServiceProviderInterface ``` -## Methods +### Methods ```php public function register( DiInterface $di ): void; diff --git a/docs/api/phalcon_dispatcher.md b/docs/api/phalcon_dispatcher.md index 40be2f523..3ccab6a2c 100644 --- a/docs/api/phalcon_dispatcher.md +++ b/docs/api/phalcon_dispatcher.md @@ -1,23 +1,50 @@ +--- +hide: + - navigation +--- -* [Phalcon\Dispatcher\AbstractDispatcher](#dispatcher-abstractdispatcher) -* [Phalcon\Dispatcher\DispatcherInterface](#dispatcher-dispatcherinterface) -* [Phalcon\Dispatcher\Exception](#dispatcher-exception) +!!! info "NOTE" -

Abstract Class Phalcon\Dispatcher\AbstractDispatcher

+ All classes are prefixed with `Phalcon` + + + +## Dispatcher\AbstractDispatcher ![Abstract](assets/images/abstract-green.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Dispatcher/AbstractDispatcher.zep) -| Namespace | Phalcon\Dispatcher | -| Uses | Exception, Phalcon\Di\DiInterface, Phalcon\Di\AbstractInjectionAware, Phalcon\Dispatcher\Exception, Phalcon\Events\EventsAwareInterface, Phalcon\Events\ManagerInterface, Phalcon\Filter\FilterInterface, Phalcon\Mvc\Model\Binder, Phalcon\Mvc\Model\BinderInterface | -| Extends | AbstractInjectionAware | -| Implements | DispatcherInterface, EventsAwareInterface | + +- __Namespace__ + + - `Phalcon\Dispatcher` + +- __Uses__ + + - `Exception` + - `Phalcon\Di\AbstractInjectionAware` + - `Phalcon\Di\DiInterface` + - `Phalcon\Dispatcher\Exception` + - `Phalcon\Events\EventsAwareInterface` + - `Phalcon\Events\ManagerInterface` + - `Phalcon\Filter\FilterInterface` + - `Phalcon\Mvc\Model\Binder` + - `Phalcon\Mvc\Model\BinderInterface` + +- __Extends__ + + `AbstractInjectionAware` + +- __Implements__ + + - `DispatcherInterface` + - `EventsAwareInterface` This is the base class for Phalcon\Mvc\Dispatcher and Phalcon\Cli\Dispatcher. This class can't be instantiated directly, you can use it to create your own dispatchers. -## Properties +### Properties ```php /** * @var object|null @@ -30,9 +57,9 @@ protected activeHandler; protected activeMethodMap; /** - * @var string|null + * @var string */ -protected actionName; +protected actionName = ; /** * @var string @@ -50,14 +77,14 @@ protected camelCaseMap; protected defaultAction = ; /** - * @var string|null + * @var string */ -protected defaultNamespace; +protected defaultNamespace = ; /** - * @var string|null + * @var string */ -protected defaultHandler; +protected defaultHandler = ; /** * @var array @@ -65,9 +92,9 @@ protected defaultHandler; protected handlerHashes; /** - * @var string|null + * @var string */ -protected handlerName; +protected handlerName = ; /** * @var string @@ -110,14 +137,14 @@ protected modelBinder; protected modelBinding = false; /** - * @var string|null + * @var string */ -protected moduleName; +protected moduleName = ; /** - * @var string|null + * @var string */ -protected namespaceName; +protected namespaceName = ; /** * @var array @@ -127,17 +154,17 @@ protected params; /** * @var string|null */ -protected previousActionName; +protected previousActionName = ; /** * @var string|null */ -protected previousHandlerName; +protected previousHandlerName = ; /** * @var string|null */ -protected previousNamespaceName; +protected previousNamespaceName = ; /** * @var string|null @@ -146,7 +173,7 @@ protected returnedValue; ``` -## Methods +### Methods ```php public function callActionMethod( mixed $handler, string $actionMethod, array $params = [] ); @@ -429,16 +456,28 @@ protected function toCamelCase( string $input ): string; -

Interface Phalcon\Dispatcher\DispatcherInterface

+## Dispatcher\DispatcherInterface ![Abstract](assets/images/interface-blue.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Dispatcher/DispatcherInterface.zep) -| Namespace | Phalcon\Dispatcher | + +- __Namespace__ + + - `Phalcon\Dispatcher` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Interface for Phalcon\Dispatcher\AbstractDispatcher -## Methods +### Methods ```php public function dispatch(): mixed | bool; @@ -569,17 +608,29 @@ Sets action params to be dispatched -

Class Phalcon\Dispatcher\Exception

+## Dispatcher\Exception [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Dispatcher/Exception.zep) -| Namespace | Phalcon\Dispatcher | -| Extends | \Exception | + +- __Namespace__ + + - `Phalcon\Dispatcher` + +- __Uses__ + + +- __Extends__ + + `\Exception` + +- __Implements__ + Exceptions thrown in Phalcon\Dispatcher/* will use this class -## Constants +### Constants ```php const EXCEPTION_ACTION_NOT_FOUND = 5; const EXCEPTION_CYCLIC_ROUTING = 1; diff --git a/docs/api/phalcon_domain.md b/docs/api/phalcon_domain.md index 451b0adf6..cc8101656 100644 --- a/docs/api/phalcon_domain.md +++ b/docs/api/phalcon_domain.md @@ -1,23 +1,38 @@ +--- +hide: + - navigation +--- -* [Phalcon\Domain\Payload\Payload](#domain-payload-payload) -* [Phalcon\Domain\Payload\PayloadFactory](#domain-payload-payloadfactory) -* [Phalcon\Domain\Payload\PayloadInterface](#domain-payload-payloadinterface) -* [Phalcon\Domain\Payload\ReadableInterface](#domain-payload-readableinterface) -* [Phalcon\Domain\Payload\Status](#domain-payload-status) -* [Phalcon\Domain\Payload\WriteableInterface](#domain-payload-writeableinterface) +!!! info "NOTE" -

Class Phalcon\Domain\Payload\Payload

+ All classes are prefixed with `Phalcon` + + + +## Domain\Payload\Payload [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Domain/Payload/Payload.zep) -| Namespace | Phalcon\Domain\Payload | -| Uses | Throwable | -| Implements | PayloadInterface | + +- __Namespace__ + + - `Phalcon\Domain\Payload` + +- __Uses__ + + - `Throwable` + +- __Extends__ + + +- __Implements__ + + - `PayloadInterface` Holds the payload -## Properties +### Properties ```php /** * Exception if any @@ -63,7 +78,7 @@ protected output; ``` -## Methods +### Methods ```php public function getException(): Throwable | null; @@ -139,16 +154,28 @@ Sets the payload status. -

Class Phalcon\Domain\Payload\PayloadFactory

+## Domain\Payload\PayloadFactory [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Domain/Payload/PayloadFactory.zep) -| Namespace | Phalcon\Domain\Payload | + +- __Namespace__ + + - `Phalcon\Domain\Payload` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Factory to create payload objects -## Methods +### Methods ```php public function newInstance(): PayloadInterface; @@ -158,28 +185,52 @@ Instantiate a new object -

Interface Phalcon\Domain\Payload\PayloadInterface

+## Domain\Payload\PayloadInterface ![Abstract](assets/images/interface-blue.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Domain/Payload/PayloadInterface.zep) -| Namespace | Phalcon\Domain\Payload | -| Extends | ReadableInterface | + +- __Namespace__ + + - `Phalcon\Domain\Payload` + +- __Uses__ + + +- __Extends__ + + `ReadableInterface` + +- __Implements__ + This interface is used for consumers -

Interface Phalcon\Domain\Payload\ReadableInterface

+## Domain\Payload\ReadableInterface ![Abstract](assets/images/interface-blue.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Domain/Payload/ReadableInterface.zep) -| Namespace | Phalcon\Domain\Payload | -| Uses | Throwable | + +- __Namespace__ + + - `Phalcon\Domain\Payload` + +- __Uses__ + + - `Throwable` + +- __Extends__ + + +- __Implements__ + This interface is used for consumers (read only) -## Methods +### Methods ```php public function getException(): Throwable | null; @@ -219,16 +270,28 @@ Gets the status of this payload. -

Class Phalcon\Domain\Payload\Status

+## Domain\Payload\Status [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Domain/Payload/Status.zep) -| Namespace | Phalcon\Domain\Payload | + +- __Namespace__ + + - `Phalcon\Domain\Payload` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Holds the status codes for the payload -## Constants +### Constants ```php const ACCEPTED = ACCEPTED; const AUTHENTICATED = AUTHENTICATED; @@ -252,7 +315,7 @@ const UPDATED = UPDATED; const VALID = VALID; ``` -## Methods +### Methods ```php final private function __construct(); @@ -262,17 +325,29 @@ Instantiation not allowed. -

Interface Phalcon\Domain\Payload\WriteableInterface

+## Domain\Payload\WriteableInterface ![Abstract](assets/images/interface-blue.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Domain/Payload/WriteableInterface.zep) -| Namespace | Phalcon\Domain\Payload | -| Uses | Throwable | + +- __Namespace__ + + - `Phalcon\Domain\Payload` + +- __Uses__ + + - `Throwable` + +- __Extends__ + + +- __Implements__ + This interface is used for consumers (write) -## Methods +### Methods ```php public function setException( Throwable $exception ): PayloadInterface; diff --git a/docs/api/phalcon_encryption.md b/docs/api/phalcon_encryption.md index 4ab925b00..f91f626d6 100644 --- a/docs/api/phalcon_encryption.md +++ b/docs/api/phalcon_encryption.md @@ -1,42 +1,36 @@ +--- +hide: + - navigation +--- -* [Phalcon\Encryption\Crypt](#encryption-crypt) -* [Phalcon\Encryption\Crypt\CryptInterface](#encryption-crypt-cryptinterface) -* [Phalcon\Encryption\Crypt\Exception\Exception](#encryption-crypt-exception-exception) -* [Phalcon\Encryption\Crypt\Exception\Mismatch](#encryption-crypt-exception-mismatch) -* [Phalcon\Encryption\Crypt\PadFactory](#encryption-crypt-padfactory) -* [Phalcon\Encryption\Crypt\Padding\Ansi](#encryption-crypt-padding-ansi) -* [Phalcon\Encryption\Crypt\Padding\Iso10126](#encryption-crypt-padding-iso10126) -* [Phalcon\Encryption\Crypt\Padding\IsoIek](#encryption-crypt-padding-isoiek) -* [Phalcon\Encryption\Crypt\Padding\Noop](#encryption-crypt-padding-noop) -* [Phalcon\Encryption\Crypt\Padding\PadInterface](#encryption-crypt-padding-padinterface) -* [Phalcon\Encryption\Crypt\Padding\Pkcs7](#encryption-crypt-padding-pkcs7) -* [Phalcon\Encryption\Crypt\Padding\Space](#encryption-crypt-padding-space) -* [Phalcon\Encryption\Crypt\Padding\Zero](#encryption-crypt-padding-zero) -* [Phalcon\Encryption\Security](#encryption-security) -* [Phalcon\Encryption\Security\Exception](#encryption-security-exception) -* [Phalcon\Encryption\Security\JWT\Builder](#encryption-security-jwt-builder) -* [Phalcon\Encryption\Security\JWT\Exceptions\UnsupportedAlgorithmException](#encryption-security-jwt-exceptions-unsupportedalgorithmexception) -* [Phalcon\Encryption\Security\JWT\Exceptions\ValidatorException](#encryption-security-jwt-exceptions-validatorexception) -* [Phalcon\Encryption\Security\JWT\Signer\AbstractSigner](#encryption-security-jwt-signer-abstractsigner) -* [Phalcon\Encryption\Security\JWT\Signer\Hmac](#encryption-security-jwt-signer-hmac) -* [Phalcon\Encryption\Security\JWT\Signer\None](#encryption-security-jwt-signer-none) -* [Phalcon\Encryption\Security\JWT\Signer\SignerInterface](#encryption-security-jwt-signer-signerinterface) -* [Phalcon\Encryption\Security\JWT\Token\AbstractItem](#encryption-security-jwt-token-abstractitem) -* [Phalcon\Encryption\Security\JWT\Token\Enum](#encryption-security-jwt-token-enum) -* [Phalcon\Encryption\Security\JWT\Token\Item](#encryption-security-jwt-token-item) -* [Phalcon\Encryption\Security\JWT\Token\Parser](#encryption-security-jwt-token-parser) -* [Phalcon\Encryption\Security\JWT\Token\Signature](#encryption-security-jwt-token-signature) -* [Phalcon\Encryption\Security\JWT\Token\Token](#encryption-security-jwt-token-token) -* [Phalcon\Encryption\Security\JWT\Validator](#encryption-security-jwt-validator) -* [Phalcon\Encryption\Security\Random](#encryption-security-random) - -

Class Phalcon\Encryption\Crypt

+!!! info "NOTE" + + All classes are prefixed with `Phalcon` + + + +## Encryption\Crypt [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Encryption/Crypt.zep) -| Namespace | Phalcon\Encryption | -| Uses | Phalcon\Encryption\Crypt\CryptInterface, Phalcon\Encryption\Crypt\Exception\Exception, Phalcon\Encryption\Crypt\Exception\Mismatch, Phalcon\Encryption\Crypt\PadFactory | -| Implements | CryptInterface | + +- __Namespace__ + + - `Phalcon\Encryption` + +- __Uses__ + + - `Phalcon\Encryption\Crypt\CryptInterface` + - `Phalcon\Encryption\Crypt\Exception\Exception` + - `Phalcon\Encryption\Crypt\Exception\Mismatch` + - `Phalcon\Encryption\Crypt\PadFactory` + +- __Extends__ + + +- __Implements__ + + - `CryptInterface` Provides encryption capabilities to Phalcon applications. @@ -57,7 +51,7 @@ echo $crypt->decrypt($encrypted, $key); ``` -## Constants +### Constants ```php const DEFAULT_ALGORITHM = sha256; const DEFAULT_CIPHER = aes-256-cfb; @@ -70,7 +64,7 @@ const PADDING_SPACE = 6; const PADDING_ZERO = 5; ``` -## Properties +### Properties ```php /** * @var string @@ -137,7 +131,7 @@ protected useSigning = true; ``` -## Methods +### Methods ```php public function __construct( string $cipher = static-constant-access, bool $useSigning = bool, PadFactory $padFactory = null ); @@ -370,16 +364,28 @@ protected function phpOpensslRandomPseudoBytes( int $length ); -

Interface Phalcon\Encryption\Crypt\CryptInterface

+## Encryption\Crypt\CryptInterface ![Abstract](assets/images/interface-blue.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Encryption/Crypt/CryptInterface.zep) -| Namespace | Phalcon\Encryption\Crypt | + +- __Namespace__ + + - `Phalcon\Encryption\Crypt` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Interface for Phalcon\Crypt -## Methods +### Methods ```php public function decrypt( string $input, string $key = null ): string; @@ -485,42 +491,81 @@ Sets if the calculating message digest must be used. -

Class Phalcon\Encryption\Crypt\Exception\Exception

+## Encryption\Crypt\Exception\Exception [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Encryption/Crypt/Exception/Exception.zep) -| Namespace | Phalcon\Encryption\Crypt\Exception | -| Extends | \Exception | + +- __Namespace__ + + - `Phalcon\Encryption\Crypt\Exception` + +- __Uses__ + + +- __Extends__ + + `\Exception` + +- __Implements__ + Exceptions thrown in Phalcon\Crypt use this class -

Class Phalcon\Encryption\Crypt\Exception\Mismatch

+## Encryption\Crypt\Exception\Mismatch [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Encryption/Crypt/Exception/Mismatch.zep) -| Namespace | Phalcon\Encryption\Crypt\Exception | -| Extends | Exception | + +- __Namespace__ + + - `Phalcon\Encryption\Crypt\Exception` + +- __Uses__ + + +- __Extends__ + + `Exception` + +- __Implements__ + Exceptions thrown in Phalcon\Crypt will use this class. -

Class Phalcon\Encryption\Crypt\PadFactory

+## Encryption\Crypt\PadFactory [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Encryption/Crypt/PadFactory.zep) -| Namespace | Phalcon\Encryption\Crypt | -| Uses | Phalcon\Encryption\Crypt, Phalcon\Encryption\Crypt\Padding\PadInterface, Phalcon\Factory\AbstractFactory, Phalcon\Support\Helper\Arr\Get | -| Extends | AbstractFactory | + +- __Namespace__ + + - `Phalcon\Encryption\Crypt` + +- __Uses__ + + - `Phalcon\Encryption\Crypt` + - `Phalcon\Encryption\Crypt\Padding\PadInterface` + - `Phalcon\Factory\AbstractFactory` + - `Phalcon\Support\Helper\Arr\Get` + +- __Extends__ + + `AbstractFactory` + +- __Implements__ + Class PadFactory @package Phalcon\Crypt -## Properties +### Properties ```php /** * @var string @@ -529,7 +574,7 @@ protected exception = Phalcon\\Encryption\\Crypt\\Exception\\Exception; ``` -## Methods +### Methods ```php public function __construct( array $services = [] ); @@ -558,19 +603,31 @@ protected function getServices(): array; -

Class Phalcon\Encryption\Crypt\Padding\Ansi

+## Encryption\Crypt\Padding\Ansi [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Encryption/Crypt/Padding/Ansi.zep) -| Namespace | Phalcon\Encryption\Crypt\Padding | -| Implements | PadInterface | + +- __Namespace__ + + - `Phalcon\Encryption\Crypt\Padding` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + + - `PadInterface` Class Ansi @package Phalcon\Encryption\Crypt\Padding -## Methods +### Methods ```php public function pad( int $paddingSize ): string; @@ -586,19 +643,31 @@ public function unpad( string $input, int $blockSize ): int; -

Class Phalcon\Encryption\Crypt\Padding\Iso10126

+## Encryption\Crypt\Padding\Iso10126 [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Encryption/Crypt/Padding/Iso10126.zep) -| Namespace | Phalcon\Encryption\Crypt\Padding | -| Implements | PadInterface | + +- __Namespace__ + + - `Phalcon\Encryption\Crypt\Padding` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + + - `PadInterface` Class Iso10126 @package Phalcon\Encryption\Crypt\Padding -## Methods +### Methods ```php public function pad( int $paddingSize ): string; @@ -614,19 +683,31 @@ public function unpad( string $input, int $blockSize ): int; -

Class Phalcon\Encryption\Crypt\Padding\IsoIek

+## Encryption\Crypt\Padding\IsoIek [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Encryption/Crypt/Padding/IsoIek.zep) -| Namespace | Phalcon\Encryption\Crypt\Padding | -| Implements | PadInterface | + +- __Namespace__ + + - `Phalcon\Encryption\Crypt\Padding` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + + - `PadInterface` Class IsoIek @package Phalcon\Encryption\Crypt\Padding -## Methods +### Methods ```php public function pad( int $paddingSize ): string; @@ -642,19 +723,31 @@ public function unpad( string $input, int $blockSize ): int; -

Class Phalcon\Encryption\Crypt\Padding\Noop

+## Encryption\Crypt\Padding\Noop [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Encryption/Crypt/Padding/Noop.zep) -| Namespace | Phalcon\Encryption\Crypt\Padding | -| Implements | PadInterface | + +- __Namespace__ + + - `Phalcon\Encryption\Crypt\Padding` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + + - `PadInterface` Class Noop @package Phalcon\Encryption\Crypt\Padding -## Methods +### Methods ```php public function pad( int $paddingSize ): string; @@ -670,16 +763,28 @@ public function unpad( string $input, int $blockSize ): int; -

Interface Phalcon\Encryption\Crypt\Padding\PadInterface

+## Encryption\Crypt\Padding\PadInterface ![Abstract](assets/images/interface-blue.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Encryption/Crypt/Padding/PadInterface.zep) -| Namespace | Phalcon\Encryption\Crypt\Padding | + +- __Namespace__ + + - `Phalcon\Encryption\Crypt\Padding` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Interface for Phalcon\Encryption\Crypt\Padding -## Methods +### Methods ```php public function pad( int $paddingSize ): string; @@ -695,19 +800,31 @@ public function unpad( string $input, int $blockSize ): int; -

Class Phalcon\Encryption\Crypt\Padding\Pkcs7

+## Encryption\Crypt\Padding\Pkcs7 [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Encryption/Crypt/Padding/Pkcs7.zep) -| Namespace | Phalcon\Encryption\Crypt\Padding | -| Implements | PadInterface | + +- __Namespace__ + + - `Phalcon\Encryption\Crypt\Padding` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + + - `PadInterface` Class Pkcs7 @package Phalcon\Encryption\Crypt\Padding -## Methods +### Methods ```php public function pad( int $paddingSize ): string; @@ -723,19 +840,31 @@ public function unpad( string $input, int $blockSize ): int; -

Class Phalcon\Encryption\Crypt\Padding\Space

+## Encryption\Crypt\Padding\Space [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Encryption/Crypt/Padding/Space.zep) -| Namespace | Phalcon\Encryption\Crypt\Padding | -| Implements | PadInterface | + +- __Namespace__ + + - `Phalcon\Encryption\Crypt\Padding` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + + - `PadInterface` Class Space @package Phalcon\Encryption\Crypt\Padding -## Methods +### Methods ```php public function pad( int $paddingSize ): string; @@ -751,19 +880,31 @@ public function unpad( string $input, int $blockSize ): int; -

Class Phalcon\Encryption\Crypt\Padding\Zero

+## Encryption\Crypt\Padding\Zero [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Encryption/Crypt/Padding/Zero.zep) -| Namespace | Phalcon\Encryption\Crypt\Padding | -| Implements | PadInterface | + +- __Namespace__ + + - `Phalcon\Encryption\Crypt\Padding` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + + - `PadInterface` Class Zero @package Phalcon\Encryption\Crypt\Padding -## Methods +### Methods ```php public function pad( int $paddingSize ): string; @@ -779,13 +920,30 @@ public function unpad( string $input, int $blockSize ): int; -

Class Phalcon\Encryption\Security

+## Encryption\Security [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Encryption/Security.zep) -| Namespace | Phalcon\Encryption | -| Uses | Phalcon\Di\DiInterface, Phalcon\Di\AbstractInjectionAware, Phalcon\Http\RequestInterface, Phalcon\Encryption\Security\Random, Phalcon\Encryption\Security\Exception, Phalcon\Session\ManagerInterface | -| Extends | AbstractInjectionAware | + +- __Namespace__ + + - `Phalcon\Encryption` + +- __Uses__ + + - `Phalcon\Di\AbstractInjectionAware` + - `Phalcon\Di\DiInterface` + - `Phalcon\Encryption\Security\Exception` + - `Phalcon\Encryption\Security\Random` + - `Phalcon\Http\RequestInterface` + - `Phalcon\Session\ManagerInterface` + +- __Extends__ + + `AbstractInjectionAware` + +- __Implements__ + This component provides a set of functions to improve the security in Phalcon applications @@ -804,7 +962,7 @@ if ($user) { ``` -## Constants +### Constants ```php const CRYPT_ARGON2I = 10; const CRYPT_ARGON2ID = 11; @@ -821,7 +979,7 @@ const CRYPT_SHA512 = 9; const CRYPT_STD_DES = 1; ``` -## Properties +### Properties ```php /** * @var int @@ -880,7 +1038,7 @@ private localRequest; ``` -## Methods +### Methods ```php public function __construct( SessionInterface $session = null, RequestInterface $request = null ); @@ -1017,12 +1175,24 @@ protected function getLocalService( string $name, string $property ); -

Class Phalcon\Encryption\Security\Exception

+## Encryption\Security\Exception [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Encryption/Security/Exception.zep) -| Namespace | Phalcon\Encryption\Security | -| Extends | \Exception | + +- __Namespace__ + + - `Phalcon\Encryption\Security` + +- __Uses__ + + +- __Extends__ + + `\Exception` + +- __Implements__ + Phalcon\Encryption\Security\Exception @@ -1030,19 +1200,46 @@ Exceptions thrown in Phalcon\Security will use this class -

Class Phalcon\Encryption\Security\JWT\Builder

+## Encryption\Security\JWT\Builder [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Encryption/Security/JWT/Builder.zep) -| Namespace | Phalcon\Encryption\Security\JWT | -| Uses | Phalcon\Encryption\Security\JWT\Exceptions\ValidatorException, Phalcon\Encryption\Security\JWT\Signer\SignerInterface, Phalcon\Encryption\Security\JWT\Token\Enum, Phalcon\Encryption\Security\JWT\Token\Item, Phalcon\Encryption\Security\JWT\Token\Signature, Phalcon\Encryption\Security\JWT\Token\Token, Phalcon\Support\Collection, Phalcon\Support\Collection\CollectionInterface, Phalcon\Support\Helper\Json\Encode | -JWT Builder +- __Namespace__ + + - `Phalcon\Encryption\Security\JWT` + +- __Uses__ + + - `Phalcon\Encryption\Security\JWT\Exceptions\ValidatorException` + - `Phalcon\Encryption\Security\JWT\Signer\SignerInterface` + - `Phalcon\Encryption\Security\JWT\Token\Enum` + - `Phalcon\Encryption\Security\JWT\Token\Item` + - `Phalcon\Encryption\Security\JWT\Token\Signature` + - `Phalcon\Encryption\Security\JWT\Token\Token` + - `Phalcon\Support\Collection` + - `Phalcon\Support\Collection\CollectionInterface` + - `Phalcon\Support\Helper\Json\Encode` + +- __Extends__ + + +- __Implements__ + + +Builder + +The builder offers + +@property CollectionInterface $claims +@property CollectionInterface $jose +@property string $passphrase +@property SignerInterface $signer @link https://tools.ietf.org/html/rfc7519 -## Properties +### Properties ```php /** * @var CollectionInterface @@ -1071,7 +1268,7 @@ private signer; ``` -## Methods +### Methods ```php public function __construct( SignerInterface $signer ); @@ -1088,7 +1285,7 @@ Adds a custom claim ```php public function addHeader( string $name, mixed $value ): Builder; ``` -Adds a custom header +Adds a custom claim ```php @@ -1272,50 +1469,86 @@ Sets a registered claim -

Class Phalcon\Encryption\Security\JWT\Exceptions\UnsupportedAlgorithmException

+## Encryption\Security\JWT\Exceptions\UnsupportedAlgorithmException [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Encryption/Security/JWT/Exceptions/UnsupportedAlgorithmException.zep) -| Namespace | Phalcon\Encryption\Security\JWT\Exceptions | -| Uses | Exception | -| Extends | Exception | + +- __Namespace__ + + - `Phalcon\Encryption\Security\JWT\Exceptions` + +- __Uses__ + + - `Exception` + +- __Extends__ + + `Exception` + +- __Implements__ + Exception thrown when the algorithm is not supported for JWT -

Class Phalcon\Encryption\Security\JWT\Exceptions\ValidatorException

+## Encryption\Security\JWT\Exceptions\ValidatorException [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Encryption/Security/JWT/Exceptions/ValidatorException.zep) -| Namespace | Phalcon\Encryption\Security\JWT\Exceptions | -| Uses | Exception | -| Extends | Exception | + +- __Namespace__ + + - `Phalcon\Encryption\Security\JWT\Exceptions` + +- __Uses__ + + - `Exception` + +- __Extends__ + + `Exception` + +- __Implements__ + Exception thrown when the validation does not pass for JWT -

Abstract Class Phalcon\Encryption\Security\JWT\Signer\AbstractSigner

+## Encryption\Security\JWT\Signer\AbstractSigner ![Abstract](assets/images/abstract-green.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Encryption/Security/JWT/Signer/AbstractSigner.zep) -| Namespace | Phalcon\Encryption\Security\JWT\Signer | -| Implements | SignerInterface | + +- __Namespace__ + + - `Phalcon\Encryption\Security\JWT\Signer` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + + - `SignerInterface` Abstract class helping with the signer classes -## Properties +### Properties ```php /** * @var string */ -protected algorithm = ""; +protected algorithm = ; ``` -## Methods +### Methods ```php public function getAlgorithm(): string; @@ -1325,18 +1558,30 @@ public function getAlgorithm(): string; -

Class Phalcon\Encryption\Security\JWT\Signer\Hmac

+## Encryption\Security\JWT\Signer\Hmac [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Encryption/Security/JWT/Signer/Hmac.zep) -| Namespace | Phalcon\Encryption\Security\JWT\Signer | -| Uses | Phalcon\Encryption\Security\JWT\Exceptions\UnsupportedAlgorithmException | -| Extends | AbstractSigner | + +- __Namespace__ + + - `Phalcon\Encryption\Security\JWT\Signer` + +- __Uses__ + + - `Phalcon\Encryption\Security\JWT\Exceptions\UnsupportedAlgorithmException` + +- __Extends__ + + `AbstractSigner` + +- __Implements__ + HMAC signing class -## Methods +### Methods ```php public function __construct( string $algo = string ); @@ -1364,17 +1609,29 @@ Verify a passed source with a payload and passphrase -

Class Phalcon\Encryption\Security\JWT\Signer\None

+## Encryption\Security\JWT\Signer\None [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Encryption/Security/JWT/Signer/None.zep) -| Namespace | Phalcon\Encryption\Security\JWT\Signer | -| Implements | SignerInterface | + +- __Namespace__ + + - `Phalcon\Encryption\Security\JWT\Signer` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + + - `SignerInterface` No signing class -## Methods +### Methods ```php public function getAlgHeader(): string; @@ -1402,16 +1659,28 @@ Verify a passed source with a payload and passphrase -

Interface Phalcon\Encryption\Security\JWT\Signer\SignerInterface

+## Encryption\Security\JWT\Signer\SignerInterface ![Abstract](assets/images/interface-blue.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Encryption/Security/JWT/Signer/SignerInterface.zep) -| Namespace | Phalcon\Encryption\Security\JWT\Signer | + +- __Namespace__ + + - `Phalcon\Encryption\Security\JWT\Signer` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Interface for JWT Signer classes -## Methods +### Methods ```php public function getAlgHeader(): string; @@ -1439,16 +1708,28 @@ Verify a passed source with a payload and passphrase -

Abstract Class Phalcon\Encryption\Security\JWT\Token\AbstractItem

+## Encryption\Security\JWT\Token\AbstractItem ![Abstract](assets/images/abstract-green.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Encryption/Security/JWT/Token/AbstractItem.zep) -| Namespace | Phalcon\Encryption\Security\JWT\Token | + +- __Namespace__ + + - `Phalcon\Encryption\Security\JWT\Token` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Abstract helper class for Tokens -## Properties +### Properties ```php /** * @var array @@ -1457,7 +1738,7 @@ protected data; ``` -## Methods +### Methods ```php public function getEncoded(): string; @@ -1467,18 +1748,30 @@ public function getEncoded(): string; -

Class Phalcon\Encryption\Security\JWT\Token\Enum

+## Encryption\Security\JWT\Token\Enum [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Encryption/Security/JWT/Token/Enum.zep) -| Namespace | Phalcon\Encryption\Security\JWT\Token | + +- __Namespace__ + + - `Phalcon\Encryption\Security\JWT\Token` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Constants for Tokens. It offers constants for Headers as well as Claims @link https://tools.ietf.org/html/rfc7519 -## Constants +### Constants ```php const ALGO = alg; const AUDIENCE = aud; @@ -1493,17 +1786,29 @@ const TYPE = typ; ``` -

Class Phalcon\Encryption\Security\JWT\Token\Item

+## Encryption\Security\JWT\Token\Item [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Encryption/Security/JWT/Token/Item.zep) -| Namespace | Phalcon\Encryption\Security\JWT\Token | -| Extends | AbstractItem | + +- __Namespace__ + + - `Phalcon\Encryption\Security\JWT\Token` + +- __Uses__ + + +- __Extends__ + + `AbstractItem` + +- __Implements__ + Storage class for a Token Item -## Methods +### Methods ```php public function __construct( array $payload, string $encoded ); @@ -1531,12 +1836,25 @@ public function has( string $name ): bool; -

Class Phalcon\Encryption\Security\JWT\Token\Parser

+## Encryption\Security\JWT\Token\Parser [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Encryption/Security/JWT/Token/Parser.zep) -| Namespace | Phalcon\Encryption\Security\JWT\Token | -| Uses | InvalidArgumentException, Phalcon\Support\Helper\Json\Decode | + +- __Namespace__ + + - `Phalcon\Encryption\Security\JWT\Token` + +- __Uses__ + + - `InvalidArgumentException` + - `Phalcon\Support\Helper\Json\Decode` + +- __Extends__ + + +- __Implements__ + Token Parser class. @@ -1545,7 +1863,7 @@ three parts. The headers are decoded, then the claims and finally the signature. It returns a token object populated with the decoded information. -## Properties +### Properties ```php /** * @var Decode @@ -1554,7 +1872,7 @@ private decode; ``` -## Methods +### Methods ```php public function __construct( Decode $decode = null ); @@ -1570,17 +1888,29 @@ Parse a token and return it -

Class Phalcon\Encryption\Security\JWT\Token\Signature

+## Encryption\Security\JWT\Token\Signature [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Encryption/Security/JWT/Token/Signature.zep) -| Namespace | Phalcon\Encryption\Security\JWT\Token | -| Extends | AbstractItem | + +- __Namespace__ + + - `Phalcon\Encryption\Security\JWT\Token` + +- __Uses__ + + +- __Extends__ + + `AbstractItem` + +- __Implements__ + Signature class containing the encoded data and the hash. -## Methods +### Methods ```php public function __construct( string $hash = string, string $encoded = string ); @@ -1596,12 +1926,25 @@ public function getHash(): string; -

Class Phalcon\Encryption\Security\JWT\Token\Token

+## Encryption\Security\JWT\Token\Token [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Encryption/Security/JWT/Token/Token.zep) -| Namespace | Phalcon\Encryption\Security\JWT\Token | -| Uses | Phalcon\Encryption\Security\JWT\Signer\SignerInterface, Phalcon\Encryption\Security\JWT\Validator | + +- __Namespace__ + + - `Phalcon\Encryption\Security\JWT\Token` + +- __Uses__ + + - `Phalcon\Encryption\Security\JWT\Signer\SignerInterface` + - `Phalcon\Encryption\Security\JWT\Validator` + +- __Extends__ + + +- __Implements__ + Token Class. @@ -1611,7 +1954,7 @@ and payload. It also calculates and returns the token string. @link https://tools.ietf.org/html/rfc7519 -## Properties +### Properties ```php /** * @var Item @@ -1630,7 +1973,7 @@ private signature; ``` -## Methods +### Methods ```php public function __construct( Item $headers, Item $claims, Signature $signature ); @@ -1682,17 +2025,32 @@ Verify the signature -

Class Phalcon\Encryption\Security\JWT\Validator

+## Encryption\Security\JWT\Validator [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Encryption/Security/JWT/Validator.zep) -| Namespace | Phalcon\Encryption\Security\JWT | -| Uses | Phalcon\Encryption\Security\JWT\Exceptions\ValidatorException, Phalcon\Encryption\Security\JWT\Signer\SignerInterface, Phalcon\Encryption\Security\JWT\Token\Enum, Phalcon\Encryption\Security\JWT\Token\Token | + +- __Namespace__ + + - `Phalcon\Encryption\Security\JWT` + +- __Uses__ + + - `Phalcon\Encryption\Security\JWT\Exceptions\ValidatorException` + - `Phalcon\Encryption\Security\JWT\Signer\SignerInterface` + - `Phalcon\Encryption\Security\JWT\Token\Enum` + - `Phalcon\Encryption\Security\JWT\Token\Token` + +- __Extends__ + + +- __Implements__ + Class Validator -## Properties +### Properties ```php /** * @var array @@ -1716,7 +2074,7 @@ private token; ``` -## Methods +### Methods ```php public function __construct( Token $token, int $timeShift = int ); @@ -1792,11 +2150,23 @@ Validate the signature of the token -

Class Phalcon\Encryption\Security\Random

+## Encryption\Security\Random [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Encryption/Security/Random.zep) -| Namespace | Phalcon\Encryption\Security | + +- __Namespace__ + + - `Phalcon\Encryption\Security` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Phalcon\Encryption\Security\Random @@ -1863,7 +2233,7 @@ This class partially borrows SecureRandom library from Ruby @link https://ruby-doc.org/stdlib-2.2.2/libdoc/securerandom/rdoc/SecureRandom.html -## Methods +### Methods ```php public function base58( int $len = null ): string; diff --git a/docs/api/phalcon_events.md b/docs/api/phalcon_events.md index 7c62fdd9e..bbe6bb572 100644 --- a/docs/api/phalcon_events.md +++ b/docs/api/phalcon_events.md @@ -1,22 +1,37 @@ -* [Phalcon\Events\AbstractEventsAware](#events-abstracteventsaware) -* [Phalcon\Events\Event](#events-event) -* [Phalcon\Events\EventInterface](#events-eventinterface) -* [Phalcon\Events\EventsAwareInterface](#events-eventsawareinterface) -* [Phalcon\Events\Exception](#events-exception) -* [Phalcon\Events\Manager](#events-manager) -* [Phalcon\Events\ManagerInterface](#events-managerinterface) +--- +hide: + - navigation +--- -

Abstract Class Phalcon\Events\AbstractEventsAware

+!!! info "NOTE" + + All classes are prefixed with `Phalcon` + + + +## Events\AbstractEventsAware ![Abstract](assets/images/abstract-green.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Events/AbstractEventsAware.zep) -| Namespace | Phalcon\Events | -| Uses | Phalcon\Events\ManagerInterface | + +- __Namespace__ + + - `Phalcon\Events` + +- __Uses__ + + - `Phalcon\Events\ManagerInterface` + +- __Extends__ + + +- __Implements__ + This abstract class offers access to the events manager -## Properties +### Properties ```php /** * @var ManagerInterface|null @@ -25,7 +40,7 @@ protected eventsManager; ``` -## Methods +### Methods ```php public function getEventsManager(): ManagerInterface | null; @@ -47,12 +62,24 @@ Helper method to fire an event -

Class Phalcon\Events\Event

+## Events\Event [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Events/Event.zep) -| Namespace | Phalcon\Events | -| Implements | EventInterface | + +- __Namespace__ + + - `Phalcon\Events` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + + - `EventInterface` This class offers contextual information of a fired event in the EventsManager @@ -67,7 +94,7 @@ if ($event->isCancelable()) { ``` -## Properties +### Properties ```php /** * Is event cancelable? @@ -106,7 +133,7 @@ protected type; ``` -## Methods +### Methods ```php public function __construct( string $type, mixed $source = null, mixed $data = null, bool $cancelable = bool ); @@ -176,16 +203,28 @@ if ($event->isCancelable()) { -

Interface Phalcon\Events\EventInterface

+## Events\EventInterface ![Abstract](assets/images/interface-blue.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Events/EventInterface.zep) -| Namespace | Phalcon\Events | + +- __Namespace__ + + - `Phalcon\Events` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Interface for Phalcon\Events\Event class -## Methods +### Methods ```php public function getData(): mixed; @@ -231,17 +270,29 @@ Stops the event preventing propagation -

Interface Phalcon\Events\EventsAwareInterface

+## Events\EventsAwareInterface ![Abstract](assets/images/interface-blue.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Events/EventsAwareInterface.zep) -| Namespace | Phalcon\Events | + +- __Namespace__ + + - `Phalcon\Events` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + This interface must for those classes that accept an EventsManager and dispatch events -## Methods +### Methods ```php public function getEventsManager(): ManagerInterface | null; @@ -257,24 +308,49 @@ Sets the events manager -

Class Phalcon\Events\Exception

+## Events\Exception [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Events/Exception.zep) -| Namespace | Phalcon\Events | -| Extends | \Exception | + +- __Namespace__ + + - `Phalcon\Events` + +- __Uses__ + + +- __Extends__ + + `\Exception` + +- __Implements__ + Exceptions thrown in Phalcon\Events will use this class -

Class Phalcon\Events\Manager

+## Events\Manager [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Events/Manager.zep) -| Namespace | Phalcon\Events | -| Uses | Closure, SplPriorityQueue | -| Implements | ManagerInterface | + +- __Namespace__ + + - `Phalcon\Events` + +- __Uses__ + + - `Closure` + - `SplPriorityQueue` + +- __Extends__ + + +- __Implements__ + + - `ManagerInterface` Phalcon Events Manager, offers an easy way to intercept and manipulate, if needed, the normal flow of operation. With the EventsManager the developer @@ -282,12 +358,12 @@ can create hooks or plugins that will offer monitoring of data, manipulation, conditional execution and much more. -## Constants +### Constants ```php const DEFAULT_PRIORITY = 100; ``` -## Properties +### Properties ```php /** * @var bool @@ -311,7 +387,7 @@ protected responses; ``` -## Methods +### Methods ```php public function arePrioritiesEnabled(): bool; @@ -409,16 +485,28 @@ public function isValidHandler( mixed $handler ): bool; -

Interface Phalcon\Events\ManagerInterface

+## Events\ManagerInterface ![Abstract](assets/images/interface-blue.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Events/ManagerInterface.zep) -| Namespace | Phalcon\Events | + +- __Namespace__ + + - `Phalcon\Events` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Interface for Phalcon\Events managers. -## Methods +### Methods ```php public function attach( string $eventType, mixed $handler ): void; diff --git a/docs/api/phalcon_factory.md b/docs/api/phalcon_factory.md index 47df47ee2..7df38d68e 100644 --- a/docs/api/phalcon_factory.md +++ b/docs/api/phalcon_factory.md @@ -1,14 +1,32 @@ +--- +hide: + - navigation +--- -* [Phalcon\Factory\AbstractConfigFactory](#factory-abstractconfigfactory) -* [Phalcon\Factory\AbstractFactory](#factory-abstractfactory) -* [Phalcon\Factory\Exception](#factory-exception) +!!! info "NOTE" -

Abstract Class Phalcon\Factory\AbstractConfigFactory

+ All classes are prefixed with `Phalcon` + + + +## Factory\AbstractConfigFactory ![Abstract](assets/images/abstract-green.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Factory/AbstractConfigFactory.zep) -| Namespace | Phalcon\Factory | -| Uses | Phalcon\Config\ConfigInterface | + +- __Namespace__ + + - `Phalcon\Factory` + +- __Uses__ + + - `Phalcon\Config\ConfigInterface` + +- __Extends__ + + +- __Implements__ + This file is part of the Phalcon Framework. @@ -18,7 +36,7 @@ For the full copyright and license information, please view the LICENSE.txt file that was distributed with this source code. -## Methods +### Methods ```php protected function checkConfig( mixed $config ): array; @@ -46,13 +64,25 @@ protected function getExceptionClass(): string; -

Abstract Class Phalcon\Factory\AbstractFactory

+## Factory\AbstractFactory ![Abstract](assets/images/abstract-green.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Factory/AbstractFactory.zep) -| Namespace | Phalcon\Factory | -| Uses | Phalcon\Config\ConfigInterface | -| Extends | AbstractConfigFactory | + +- __Namespace__ + + - `Phalcon\Factory` + +- __Uses__ + + - `Phalcon\Config\ConfigInterface` + +- __Extends__ + + `AbstractConfigFactory` + +- __Implements__ + This file is part of the Phalcon Framework. @@ -62,7 +92,7 @@ For the full copyright and license information, please view the LICENSE.txt file that was distributed with this source code. -## Properties +### Properties ```php /** * @var array @@ -76,7 +106,7 @@ protected services; ``` -## Methods +### Methods ```php protected function getService( string $name ): mixed; @@ -98,12 +128,24 @@ Initialize services/add new services -

Class Phalcon\Factory\Exception

+## Factory\Exception [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Factory/Exception.zep) -| Namespace | Phalcon\Factory | -| Extends | \Exception | + +- __Namespace__ + + - `Phalcon\Factory` + +- __Uses__ + + +- __Extends__ + + `\Exception` + +- __Implements__ + This file is part of the Phalcon Framework. diff --git a/docs/api/phalcon_filter.md b/docs/api/phalcon_filter.md index 70f66f1b8..2154f53f7 100644 --- a/docs/api/phalcon_filter.md +++ b/docs/api/phalcon_filter.md @@ -1,77 +1,32 @@ +--- +hide: + - navigation +--- -* [Phalcon\Filter\Exception](#filter-exception) -* [Phalcon\Filter\Filter](#filter-filter) -* [Phalcon\Filter\FilterFactory](#filter-filterfactory) -* [Phalcon\Filter\FilterInterface](#filter-filterinterface) -* [Phalcon\Filter\Sanitize\AbsInt](#filter-sanitize-absint) -* [Phalcon\Filter\Sanitize\Alnum](#filter-sanitize-alnum) -* [Phalcon\Filter\Sanitize\Alpha](#filter-sanitize-alpha) -* [Phalcon\Filter\Sanitize\BoolVal](#filter-sanitize-boolval) -* [Phalcon\Filter\Sanitize\Email](#filter-sanitize-email) -* [Phalcon\Filter\Sanitize\FloatVal](#filter-sanitize-floatval) -* [Phalcon\Filter\Sanitize\IntVal](#filter-sanitize-intval) -* [Phalcon\Filter\Sanitize\Lower](#filter-sanitize-lower) -* [Phalcon\Filter\Sanitize\LowerFirst](#filter-sanitize-lowerfirst) -* [Phalcon\Filter\Sanitize\Regex](#filter-sanitize-regex) -* [Phalcon\Filter\Sanitize\Remove](#filter-sanitize-remove) -* [Phalcon\Filter\Sanitize\Replace](#filter-sanitize-replace) -* [Phalcon\Filter\Sanitize\Special](#filter-sanitize-special) -* [Phalcon\Filter\Sanitize\SpecialFull](#filter-sanitize-specialfull) -* [Phalcon\Filter\Sanitize\StringVal](#filter-sanitize-stringval) -* [Phalcon\Filter\Sanitize\StringValLegacy](#filter-sanitize-stringvallegacy) -* [Phalcon\Filter\Sanitize\Striptags](#filter-sanitize-striptags) -* [Phalcon\Filter\Sanitize\Trim](#filter-sanitize-trim) -* [Phalcon\Filter\Sanitize\Upper](#filter-sanitize-upper) -* [Phalcon\Filter\Sanitize\UpperFirst](#filter-sanitize-upperfirst) -* [Phalcon\Filter\Sanitize\UpperWords](#filter-sanitize-upperwords) -* [Phalcon\Filter\Sanitize\Url](#filter-sanitize-url) -* [Phalcon\Filter\Validation](#filter-validation) -* [Phalcon\Filter\Validation\AbstractCombinedFieldsValidator](#filter-validation-abstractcombinedfieldsvalidator) -* [Phalcon\Filter\Validation\AbstractValidator](#filter-validation-abstractvalidator) -* [Phalcon\Filter\Validation\AbstractValidatorComposite](#filter-validation-abstractvalidatorcomposite) -* [Phalcon\Filter\Validation\Exception](#filter-validation-exception) -* [Phalcon\Filter\Validation\ValidationInterface](#filter-validation-validationinterface) -* [Phalcon\Filter\Validation\Validator\Alnum](#filter-validation-validator-alnum) -* [Phalcon\Filter\Validation\Validator\Alpha](#filter-validation-validator-alpha) -* [Phalcon\Filter\Validation\Validator\Between](#filter-validation-validator-between) -* [Phalcon\Filter\Validation\Validator\Callback](#filter-validation-validator-callback) -* [Phalcon\Filter\Validation\Validator\Confirmation](#filter-validation-validator-confirmation) -* [Phalcon\Filter\Validation\Validator\CreditCard](#filter-validation-validator-creditcard) -* [Phalcon\Filter\Validation\Validator\Date](#filter-validation-validator-date) -* [Phalcon\Filter\Validation\Validator\Digit](#filter-validation-validator-digit) -* [Phalcon\Filter\Validation\Validator\Email](#filter-validation-validator-email) -* [Phalcon\Filter\Validation\Validator\Exception](#filter-validation-validator-exception) -* [Phalcon\Filter\Validation\Validator\ExclusionIn](#filter-validation-validator-exclusionin) -* [Phalcon\Filter\Validation\Validator\File](#filter-validation-validator-file) -* [Phalcon\Filter\Validation\Validator\File\AbstractFile](#filter-validation-validator-file-abstractfile) -* [Phalcon\Filter\Validation\Validator\File\MimeType](#filter-validation-validator-file-mimetype) -* [Phalcon\Filter\Validation\Validator\File\Resolution\Equal](#filter-validation-validator-file-resolution-equal) -* [Phalcon\Filter\Validation\Validator\File\Resolution\Max](#filter-validation-validator-file-resolution-max) -* [Phalcon\Filter\Validation\Validator\File\Resolution\Min](#filter-validation-validator-file-resolution-min) -* [Phalcon\Filter\Validation\Validator\File\Size\Equal](#filter-validation-validator-file-size-equal) -* [Phalcon\Filter\Validation\Validator\File\Size\Max](#filter-validation-validator-file-size-max) -* [Phalcon\Filter\Validation\Validator\File\Size\Min](#filter-validation-validator-file-size-min) -* [Phalcon\Filter\Validation\Validator\Identical](#filter-validation-validator-identical) -* [Phalcon\Filter\Validation\Validator\InclusionIn](#filter-validation-validator-inclusionin) -* [Phalcon\Filter\Validation\Validator\Ip](#filter-validation-validator-ip) -* [Phalcon\Filter\Validation\Validator\Numericality](#filter-validation-validator-numericality) -* [Phalcon\Filter\Validation\Validator\PresenceOf](#filter-validation-validator-presenceof) -* [Phalcon\Filter\Validation\Validator\Regex](#filter-validation-validator-regex) -* [Phalcon\Filter\Validation\Validator\StringLength](#filter-validation-validator-stringlength) -* [Phalcon\Filter\Validation\Validator\StringLength\Max](#filter-validation-validator-stringlength-max) -* [Phalcon\Filter\Validation\Validator\StringLength\Min](#filter-validation-validator-stringlength-min) -* [Phalcon\Filter\Validation\Validator\Uniqueness](#filter-validation-validator-uniqueness) -* [Phalcon\Filter\Validation\Validator\Url](#filter-validation-validator-url) -* [Phalcon\Filter\Validation\ValidatorCompositeInterface](#filter-validation-validatorcompositeinterface) -* [Phalcon\Filter\Validation\ValidatorFactory](#filter-validation-validatorfactory) -* [Phalcon\Filter\Validation\ValidatorInterface](#filter-validation-validatorinterface) - -

Class Phalcon\Filter\Exception

+!!! info "NOTE" + + All classes are prefixed with `Phalcon` + + + +## Filter\Exception [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Exception.zep) -| Namespace | Phalcon\Filter | -| Extends | \Exception | + +- __Namespace__ + + - `Phalcon\Filter` + +- __Uses__ + + +- __Extends__ + + `\Exception` + +- __Implements__ + Phalcon\Filter\Exception @@ -79,16 +34,55 @@ Exceptions thrown in Phalcon\Filter will use this class -

Class Phalcon\Filter\Filter

+## Filter\Filter [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Filter.zep) -| Namespace | Phalcon\Filter | -| Implements | FilterInterface | + +- __Namespace__ + + - `Phalcon\Filter` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + + - `FilterInterface` Lazy loads, stores and exposes sanitizer objects -## Constants +@method absint(mixed $input): int +@method alnum(mixed $input): string +@method alpha(mixed $input): string +@method bool(mixed $input): bool +@method email(string $input): string +@method float(mixed $input): float +@method int(string $input): int +@method lower(string $input): string +@method lowerfirst(string $input): string +@method regex(mixed $input, mixed $pattern, mixed $replace): mixed +@method remove(mixed $input, mixed $replace): mixed +@method replace(mixed $input, mixed $source, mixed $target): mixed +@method special(string $input): string +@method specialfull(string $input): string +@method string(string $input): string +@method stringlegacy(mixed $input): string +@method striptags(string $input): string +@method trim(string $input): string +@method upper(string $input): string +@method upperFirst(string $input): string +@method upperWords(string $input): string|null +@method url(string $input): string|null + +@property array $mapper +@property array $services + + +### Constants ```php const FILTER_ABSINT = absint; const FILTER_ALNUM = alnum; @@ -114,7 +108,7 @@ const FILTER_UPPERWORDS = upperwords; const FILTER_URL = url; ``` -## Properties +### Properties ```php /** * @var array @@ -128,7 +122,7 @@ protected services; ``` -## Methods +### Methods ```php public function __call( string $name, array $args ); @@ -175,19 +169,31 @@ Loads the objects in the internal mapper array -

Class Phalcon\Filter\FilterFactory

+## Filter\FilterFactory [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/FilterFactory.zep) -| Namespace | Phalcon\Filter | -| Uses | Phalcon\Filter\Filter | + +- __Namespace__ + + - `Phalcon\Filter` + +- __Uses__ + + - `Phalcon\Filter\Filter` + +- __Extends__ + + +- __Implements__ + Class FilterFactory @package Phalcon\Filter -## Methods +### Methods ```php public function newInstance(): FilterInterface; @@ -204,16 +210,28 @@ Returns the available adapters -

Interface Phalcon\Filter\FilterInterface

+## Filter\FilterInterface ![Abstract](assets/images/interface-blue.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/FilterInterface.zep) -| Namespace | Phalcon\Filter | + +- __Namespace__ + + - `Phalcon\Filter` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Lazy loads, stores and exposes sanitizer objects -## Methods +### Methods ```php public function sanitize( mixed $value, mixed $sanitizers, bool $noRecursive = bool ): mixed; @@ -223,18 +241,30 @@ Sanitizes a value with a specified single or set of sanitizers -

Class Phalcon\Filter\Sanitize\AbsInt

+## Filter\Sanitize\AbsInt [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Sanitize/AbsInt.zep) -| Namespace | Phalcon\Filter\Sanitize | + +- __Namespace__ + + - `Phalcon\Filter\Sanitize` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Phalcon\Filter\Sanitize\AbsInt Sanitizes a value to absolute integer -## Methods +### Methods ```php public function __invoke( mixed $input ); @@ -244,18 +274,30 @@ public function __invoke( mixed $input ); -

Class Phalcon\Filter\Sanitize\Alnum

+## Filter\Sanitize\Alnum [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Sanitize/Alnum.zep) -| Namespace | Phalcon\Filter\Sanitize | + +- __Namespace__ + + - `Phalcon\Filter\Sanitize` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Phalcon\Filter\Sanitize\Alnum Sanitizes a value to an alphanumeric value -## Methods +### Methods ```php public function __invoke( mixed $input ); @@ -265,18 +307,30 @@ public function __invoke( mixed $input ); -

Class Phalcon\Filter\Sanitize\Alpha

+## Filter\Sanitize\Alpha [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Sanitize/Alpha.zep) -| Namespace | Phalcon\Filter\Sanitize | + +- __Namespace__ + + - `Phalcon\Filter\Sanitize` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Phalcon\Filter\Sanitize\Alpha Sanitizes a value to an alpha value -## Methods +### Methods ```php public function __invoke( mixed $input ); @@ -286,18 +340,30 @@ public function __invoke( mixed $input ); -

Class Phalcon\Filter\Sanitize\BoolVal

+## Filter\Sanitize\BoolVal [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Sanitize/BoolVal.zep) -| Namespace | Phalcon\Filter\Sanitize | + +- __Namespace__ + + - `Phalcon\Filter\Sanitize` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Phalcon\Filter\Sanitize\BoolVal Sanitizes a value to boolean -## Methods +### Methods ```php public function __invoke( mixed $input ); @@ -307,18 +373,30 @@ public function __invoke( mixed $input ); -

Class Phalcon\Filter\Sanitize\Email

+## Filter\Sanitize\Email [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Sanitize/Email.zep) -| Namespace | Phalcon\Filter\Sanitize | + +- __Namespace__ + + - `Phalcon\Filter\Sanitize` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Phalcon\Filter\Sanitize\Email Sanitizes an email string -## Methods +### Methods ```php public function __invoke( mixed $input ); @@ -328,18 +406,30 @@ public function __invoke( mixed $input ); -

Class Phalcon\Filter\Sanitize\FloatVal

+## Filter\Sanitize\FloatVal [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Sanitize/FloatVal.zep) -| Namespace | Phalcon\Filter\Sanitize | + +- __Namespace__ + + - `Phalcon\Filter\Sanitize` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Phalcon\Filter\Sanitize\FloatVal Sanitizes a value to float -## Methods +### Methods ```php public function __invoke( mixed $input ); @@ -349,18 +439,30 @@ public function __invoke( mixed $input ); -

Class Phalcon\Filter\Sanitize\IntVal

+## Filter\Sanitize\IntVal [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Sanitize/IntVal.zep) -| Namespace | Phalcon\Filter\Sanitize | + +- __Namespace__ + + - `Phalcon\Filter\Sanitize` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Phalcon\Filter\Sanitize\IntVal Sanitizes a value to integer -## Methods +### Methods ```php public function __invoke( mixed $input ); @@ -370,18 +472,30 @@ public function __invoke( mixed $input ); -

Class Phalcon\Filter\Sanitize\Lower

+## Filter\Sanitize\Lower [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Sanitize/Lower.zep) -| Namespace | Phalcon\Filter\Sanitize | + +- __Namespace__ + + - `Phalcon\Filter\Sanitize` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Phalcon\Filter\Sanitize\Lower Sanitizes a value to lowercase -## Methods +### Methods ```php public function __invoke( string $input ); @@ -391,18 +505,30 @@ public function __invoke( string $input ); -

Class Phalcon\Filter\Sanitize\LowerFirst

+## Filter\Sanitize\LowerFirst [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Sanitize/LowerFirst.zep) -| Namespace | Phalcon\Filter\Sanitize | + +- __Namespace__ + + - `Phalcon\Filter\Sanitize` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Phalcon\Filter\Sanitize\LowerFirst Sanitizes a value to lcfirst -## Methods +### Methods ```php public function __invoke( string $input ); @@ -412,18 +538,30 @@ public function __invoke( string $input ); -

Class Phalcon\Filter\Sanitize\Regex

+## Filter\Sanitize\Regex [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Sanitize/Regex.zep) -| Namespace | Phalcon\Filter\Sanitize | + +- __Namespace__ + + - `Phalcon\Filter\Sanitize` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Phalcon\Filter\Sanitize\Regex Sanitizes a value performing preg_replace -## Methods +### Methods ```php public function __invoke( mixed $input, mixed $pattern, mixed $replace ); @@ -433,18 +571,30 @@ public function __invoke( mixed $input, mixed $pattern, mixed $replace ); -

Class Phalcon\Filter\Sanitize\Remove

+## Filter\Sanitize\Remove [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Sanitize/Remove.zep) -| Namespace | Phalcon\Filter\Sanitize | + +- __Namespace__ + + - `Phalcon\Filter\Sanitize` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Phalcon\Filter\Sanitize\Remove Sanitizes a value removing parts of a string -## Methods +### Methods ```php public function __invoke( mixed $input, mixed $replace ); @@ -454,18 +604,30 @@ public function __invoke( mixed $input, mixed $replace ); -

Class Phalcon\Filter\Sanitize\Replace

+## Filter\Sanitize\Replace [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Sanitize/Replace.zep) -| Namespace | Phalcon\Filter\Sanitize | + +- __Namespace__ + + - `Phalcon\Filter\Sanitize` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Phalcon\Filter\Sanitize\Replace Sanitizes a value replacing parts of a string -## Methods +### Methods ```php public function __invoke( mixed $input, mixed $from, mixed $to ); @@ -475,18 +637,30 @@ public function __invoke( mixed $input, mixed $from, mixed $to ); -

Class Phalcon\Filter\Sanitize\Special

+## Filter\Sanitize\Special [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Sanitize/Special.zep) -| Namespace | Phalcon\Filter\Sanitize | + +- __Namespace__ + + - `Phalcon\Filter\Sanitize` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Phalcon\Filter\Sanitize\Special Sanitizes a value special characters -## Methods +### Methods ```php public function __invoke( mixed $input ); @@ -496,18 +670,30 @@ public function __invoke( mixed $input ); -

Class Phalcon\Filter\Sanitize\SpecialFull

+## Filter\Sanitize\SpecialFull [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Sanitize/SpecialFull.zep) -| Namespace | Phalcon\Filter\Sanitize | + +- __Namespace__ + + - `Phalcon\Filter\Sanitize` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Phalcon\Filter\Sanitize\SpecialFull Sanitizes a value special characters (htmlspecialchars() and ENT_QUOTES) -## Methods +### Methods ```php public function __invoke( mixed $input ); @@ -517,16 +703,28 @@ public function __invoke( mixed $input ); -

Class Phalcon\Filter\Sanitize\StringVal

+## Filter\Sanitize\StringVal [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Sanitize/StringVal.zep) -| Namespace | Phalcon\Filter\Sanitize | + +- __Namespace__ + + - `Phalcon\Filter\Sanitize` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Sanitizes a value to string -## Methods +### Methods ```php public function __invoke( string $input, int $flags = int ): string; @@ -536,11 +734,23 @@ public function __invoke( string $input, int $flags = int ): string; -

Class Phalcon\Filter\Sanitize\StringValLegacy

+## Filter\Sanitize\StringValLegacy [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Sanitize/StringValLegacy.zep) -| Namespace | Phalcon\Filter\Sanitize | + +- __Namespace__ + + - `Phalcon\Filter\Sanitize` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Sanitizes a value to string using `filter_var()`. The filter provides backwards compatibility with versions prior to v5. For PHP higher or equal to @@ -548,7 +758,7 @@ backwards compatibility with versions prior to v5. For PHP higher or equal to string is passed, the method will return false -## Methods +### Methods ```php public function __invoke( mixed $input ); @@ -558,18 +768,30 @@ public function __invoke( mixed $input ); -

Class Phalcon\Filter\Sanitize\Striptags

+## Filter\Sanitize\Striptags [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Sanitize/Striptags.zep) -| Namespace | Phalcon\Filter\Sanitize | + +- __Namespace__ + + - `Phalcon\Filter\Sanitize` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Phalcon\Filter\Sanitize\Striptags Sanitizes a value striptags -## Methods +### Methods ```php public function __invoke( string $input ); @@ -579,18 +801,30 @@ public function __invoke( string $input ); -

Class Phalcon\Filter\Sanitize\Trim

+## Filter\Sanitize\Trim [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Sanitize/Trim.zep) -| Namespace | Phalcon\Filter\Sanitize | + +- __Namespace__ + + - `Phalcon\Filter\Sanitize` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Phalcon\Filter\Sanitize\Trim Sanitizes a value removing leading and trailing spaces -## Methods +### Methods ```php public function __invoke( string $input ); @@ -600,18 +834,30 @@ public function __invoke( string $input ); -

Class Phalcon\Filter\Sanitize\Upper

+## Filter\Sanitize\Upper [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Sanitize/Upper.zep) -| Namespace | Phalcon\Filter\Sanitize | + +- __Namespace__ + + - `Phalcon\Filter\Sanitize` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Phalcon\Filter\Sanitize\Upper Sanitizes a value to uppercase -## Methods +### Methods ```php public function __invoke( string $input ); @@ -621,18 +867,30 @@ public function __invoke( string $input ); -

Class Phalcon\Filter\Sanitize\UpperFirst

+## Filter\Sanitize\UpperFirst [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Sanitize/UpperFirst.zep) -| Namespace | Phalcon\Filter\Sanitize | + +- __Namespace__ + + - `Phalcon\Filter\Sanitize` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Phalcon\Filter\Sanitize\UpperFirst Sanitizes a value to ucfirst -## Methods +### Methods ```php public function __invoke( string $input ); @@ -642,18 +900,30 @@ public function __invoke( string $input ); -

Class Phalcon\Filter\Sanitize\UpperWords

+## Filter\Sanitize\UpperWords [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Sanitize/UpperWords.zep) -| Namespace | Phalcon\Filter\Sanitize | + +- __Namespace__ + + - `Phalcon\Filter\Sanitize` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Phalcon\Filter\Sanitize\UpperWords Sanitizes a value to uppercase the first character of each word -## Methods +### Methods ```php public function __invoke( string $input ); @@ -663,18 +933,30 @@ public function __invoke( string $input ); -

Class Phalcon\Filter\Sanitize\Url

+## Filter\Sanitize\Url [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Sanitize/Url.zep) -| Namespace | Phalcon\Filter\Sanitize | + +- __Namespace__ + + - `Phalcon\Filter\Sanitize` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Phalcon\Filter\Sanitize\Url Sanitizes a value url -## Methods +### Methods ```php public function __invoke( mixed $input ); @@ -684,19 +966,40 @@ public function __invoke( mixed $input ); -

Class Phalcon\Filter\Validation

+## Filter\Validation [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Validation.zep) -| Namespace | Phalcon\Filter | -| Uses | Phalcon\Di\Di, Phalcon\Di\DiInterface, Phalcon\Di\Injectable, Phalcon\Filter\FilterInterface, Phalcon\Messages\MessageInterface, Phalcon\Messages\Messages, Phalcon\Filter\Validation\ValidationInterface, Phalcon\Filter\Validation\Exception, Phalcon\Filter\Validation\ValidatorInterface, Phalcon\Filter\Validation\AbstractCombinedFieldsValidator | -| Extends | Injectable | -| Implements | ValidationInterface | + +- __Namespace__ + + - `Phalcon\Filter` + +- __Uses__ + + - `Phalcon\Di\Di` + - `Phalcon\Di\DiInterface` + - `Phalcon\Di\Injectable` + - `Phalcon\Filter\FilterInterface` + - `Phalcon\Filter\Validation\AbstractCombinedFieldsValidator` + - `Phalcon\Filter\Validation\Exception` + - `Phalcon\Filter\Validation\ValidationInterface` + - `Phalcon\Filter\Validation\ValidatorInterface` + - `Phalcon\Messages\MessageInterface` + - `Phalcon\Messages\Messages` + +- __Extends__ + + `Injectable` + +- __Implements__ + + - `ValidationInterface` Allows to validate data using custom or built-in validators -## Properties +### Properties ```php /** * @var array @@ -744,7 +1047,7 @@ protected values; ``` -## Methods +### Methods ```php public function __construct( array $validators = [] ); @@ -875,42 +1178,68 @@ Internal validations, if it returns true, then skip the current validator -

Abstract Class Phalcon\Filter\Validation\AbstractCombinedFieldsValidator

+## Filter\Validation\AbstractCombinedFieldsValidator ![Abstract](assets/images/abstract-green.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Validation/AbstractCombinedFieldsValidator.zep) -| Namespace | Phalcon\Filter\Validation | -| Extends | AbstractValidator | + +- __Namespace__ + + - `Phalcon\Filter\Validation` + +- __Uses__ + + +- __Extends__ + + `AbstractValidator` + +- __Implements__ + This is a base class for combined fields validators -

Abstract Class Phalcon\Filter\Validation\AbstractValidator

+## Filter\Validation\AbstractValidator ![Abstract](assets/images/abstract-green.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Validation/AbstractValidator.zep) -| Namespace | Phalcon\Filter\Validation | -| Uses | Phalcon\Support\Helper\Arr\Whitelist, Phalcon\Messages\Message, Phalcon\Filter\Validation | -| Implements | ValidatorInterface | + +- __Namespace__ + + - `Phalcon\Filter\Validation` + +- __Uses__ + + - `Phalcon\Filter\Validation` + - `Phalcon\Messages\Message` + - `Phalcon\Support\Helper\Arr\Whitelist` + +- __Extends__ + + +- __Implements__ + + - `ValidatorInterface` This is a base class for validators -## Properties +### Properties ```php /** - * Message template - * - * @var string|null - */ + * Message template + * + * @var string|null + */ protected template; /** - * Message templates - * - * @var array - */ + * Message templates + * + * @var array + */ protected templates; /** @@ -920,7 +1249,7 @@ protected options; ``` -## Methods +### Methods ```php public function __construct( array $options = [] ); @@ -968,17 +1297,13 @@ Sets an option in the validator ```php public function setTemplate( string $template ): ValidatorInterface; ``` - Set a new template message - - +Set a new template message ```php public function setTemplates( array $templates ): ValidatorInterface; ``` - Clear current templates and set new from an array, - - +Clear current templates and set new from an array, ```php @@ -993,6 +1318,13 @@ protected function allowEmpty( mixed $field, mixed $value ): bool; Checks if field can be empty. +```php +protected function checkArray( mixed $value, string $field ): mixed; +``` +Checks if a value is an array and returns the element based on the +passed field name + + ```php protected function prepareCode( string $field ): int; ``` @@ -1007,19 +1339,31 @@ Prepares a label for the field. -

Abstract Class Phalcon\Filter\Validation\AbstractValidatorComposite

+## Filter\Validation\AbstractValidatorComposite ![Abstract](assets/images/abstract-green.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Validation/AbstractValidatorComposite.zep) -| Namespace | Phalcon\Filter\Validation | -| Uses | Phalcon\Filter\Validation | -| Extends | AbstractValidator | -| Implements | ValidatorCompositeInterface | + +- __Namespace__ + + - `Phalcon\Filter\Validation` + +- __Uses__ + + - `Phalcon\Filter\Validation` + +- __Extends__ + + `AbstractValidator` + +- __Implements__ + + - `ValidatorCompositeInterface` This is a base class for combined fields validators -## Properties +### Properties ```php /** * @var array @@ -1028,7 +1372,7 @@ protected validators; ``` -## Methods +### Methods ```php public function getValidators(): array; @@ -1044,28 +1388,54 @@ Executes the validation -

Class Phalcon\Filter\Validation\Exception

+## Filter\Validation\Exception [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Validation/Exception.zep) -| Namespace | Phalcon\Filter\Validation | -| Extends | \Exception | + +- __Namespace__ + + - `Phalcon\Filter\Validation` + +- __Uses__ + + +- __Extends__ + + `\Exception` + +- __Implements__ + Exceptions thrown in Phalcon\Filter\Validation\* classes will use this class -

Interface Phalcon\Filter\Validation\ValidationInterface

+## Filter\Validation\ValidationInterface ![Abstract](assets/images/interface-blue.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Validation/ValidationInterface.zep) -| Namespace | Phalcon\Filter\Validation | -| Uses | Phalcon\Di\Injectable, Phalcon\Messages\MessageInterface, Phalcon\Messages\Messages | + +- __Namespace__ + + - `Phalcon\Filter\Validation` + +- __Uses__ + + - `Phalcon\Di\Injectable` + - `Phalcon\Messages\MessageInterface` + - `Phalcon\Messages\Messages` + +- __Extends__ + + +- __Implements__ + Interface for the Phalcon\Filter\Validation component -## Methods +### Methods ```php public function add( mixed $field, ValidatorInterface $validator ): ValidationInterface; @@ -1154,13 +1524,26 @@ Validate a set of data according to a set of rules -

Class Phalcon\Filter\Validation\Validator\Alnum

+## Filter\Validation\Validator\Alnum [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Validation/Validator/Alnum.zep) -| Namespace | Phalcon\Filter\Validation\Validator | -| Uses | Phalcon\Filter\Validation, Phalcon\Filter\Validation\AbstractValidator | -| Extends | AbstractValidator | + +- __Namespace__ + + - `Phalcon\Filter\Validation\Validator` + +- __Uses__ + + - `Phalcon\Filter\Validation` + - `Phalcon\Filter\Validation\AbstractValidator` + +- __Extends__ + + `AbstractValidator` + +- __Implements__ + Check for alphanumeric character(s) @@ -1196,14 +1579,14 @@ $validator->add( ``` -## Properties +### Properties ```php // protected template = Field :field must contain only letters and numbers; ``` -## Methods +### Methods ```php public function __construct( array $options = [] ); @@ -1219,13 +1602,27 @@ Executes the validation -

Class Phalcon\Filter\Validation\Validator\Alpha

+## Filter\Validation\Validator\Alpha [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Validation/Validator/Alpha.zep) -| Namespace | Phalcon\Filter\Validation\Validator | -| Uses | Phalcon\Messages\Message, Phalcon\Filter\Validation, Phalcon\Filter\Validation\AbstractValidator | -| Extends | AbstractValidator | + +- __Namespace__ + + - `Phalcon\Filter\Validation\Validator` + +- __Uses__ + + - `Phalcon\Filter\Validation` + - `Phalcon\Filter\Validation\AbstractValidator` + - `Phalcon\Messages\Message` + +- __Extends__ + + `AbstractValidator` + +- __Implements__ + Check for alphabetic character(s) @@ -1261,14 +1658,14 @@ $validator->add( ``` -## Properties +### Properties ```php // protected template = Field :field must contain only letters; ``` -## Methods +### Methods ```php public function __construct( array $options = [] ); @@ -1284,13 +1681,27 @@ Executes the validation -

Class Phalcon\Filter\Validation\Validator\Between

+## Filter\Validation\Validator\Between [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Validation/Validator/Between.zep) -| Namespace | Phalcon\Filter\Validation\Validator | -| Uses | Phalcon\Messages\Message, Phalcon\Filter\Validation, Phalcon\Filter\Validation\AbstractValidator | -| Extends | AbstractValidator | + +- __Namespace__ + + - `Phalcon\Filter\Validation\Validator` + +- __Uses__ + + - `Phalcon\Filter\Validation` + - `Phalcon\Filter\Validation\AbstractValidator` + - `Phalcon\Messages\Message` + +- __Extends__ + + `AbstractValidator` + +- __Implements__ + Validates that a value is between an inclusive range of two values. For a value x, the test is passed if minimum<=x<=maximum. @@ -1337,14 +1748,14 @@ $validator->add( ``` -## Properties +### Properties ```php // protected template = Field :field must be within the range of :min to :max; ``` -## Methods +### Methods ```php public function __construct( array $options = [] ); @@ -1360,13 +1771,28 @@ Executes the validation -

Class Phalcon\Filter\Validation\Validator\Callback

+## Filter\Validation\Validator\Callback [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Validation/Validator/Callback.zep) -| Namespace | Phalcon\Filter\Validation\Validator | -| Uses | Phalcon\Messages\Message, Phalcon\Filter\Validation, Phalcon\Filter\Validation\ValidatorInterface, Phalcon\Filter\Validation\AbstractValidator | -| Extends | AbstractValidator | + +- __Namespace__ + + - `Phalcon\Filter\Validation\Validator` + +- __Uses__ + + - `Phalcon\Filter\Validation` + - `Phalcon\Filter\Validation\AbstractValidator` + - `Phalcon\Filter\Validation\ValidatorInterface` + - `Phalcon\Messages\Message` + +- __Extends__ + + `AbstractValidator` + +- __Implements__ + Calls user function for validation @@ -1412,14 +1838,14 @@ $validator->add( ``` -## Properties +### Properties ```php // protected template = Field :field must match the callback function; ``` -## Methods +### Methods ```php public function __construct( array $options = [] ); @@ -1435,13 +1861,28 @@ Executes the validation -

Class Phalcon\Filter\Validation\Validator\Confirmation

+## Filter\Validation\Validator\Confirmation [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Validation/Validator/Confirmation.zep) -| Namespace | Phalcon\Filter\Validation\Validator | -| Uses | Phalcon\Messages\Message, Phalcon\Filter\Validation, Phalcon\Filter\Validation\Exception, Phalcon\Filter\Validation\AbstractValidator | -| Extends | AbstractValidator | + +- __Namespace__ + + - `Phalcon\Filter\Validation\Validator` + +- __Uses__ + + - `Phalcon\Filter\Validation` + - `Phalcon\Filter\Validation\AbstractValidator` + - `Phalcon\Filter\Validation\Exception` + - `Phalcon\Messages\Message` + +- __Extends__ + + `AbstractValidator` + +- __Implements__ + Checks that two values have the same value @@ -1482,14 +1923,14 @@ $validator->add( ``` -## Properties +### Properties ```php // protected template = Field :field must be the same as :with; ``` -## Methods +### Methods ```php public function __construct( array $options = [] ); @@ -1511,13 +1952,27 @@ Compare strings -

Class Phalcon\Filter\Validation\Validator\CreditCard

+## Filter\Validation\Validator\CreditCard [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Validation/Validator/CreditCard.zep) -| Namespace | Phalcon\Filter\Validation\Validator | -| Uses | Phalcon\Messages\Message, Phalcon\Filter\Validation, Phalcon\Filter\Validation\AbstractValidator | -| Extends | AbstractValidator | + +- __Namespace__ + + - `Phalcon\Filter\Validation\Validator` + +- __Uses__ + + - `Phalcon\Filter\Validation` + - `Phalcon\Filter\Validation\AbstractValidator` + - `Phalcon\Messages\Message` + +- __Extends__ + + `AbstractValidator` + +- __Implements__ + Checks if a value has a valid credit card number @@ -1553,14 +2008,14 @@ $validator->add( ``` -## Properties +### Properties ```php // protected template = Field :field is not valid for a credit card number; ``` -## Methods +### Methods ```php public function __construct( array $options = [] ); @@ -1576,13 +2031,28 @@ Executes the validation -

Class Phalcon\Filter\Validation\Validator\Date

+## Filter\Validation\Validator\Date [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Validation/Validator/Date.zep) -| Namespace | Phalcon\Filter\Validation\Validator | -| Uses | DateTime, Phalcon\Messages\Message, Phalcon\Filter\Validation, Phalcon\Filter\Validation\AbstractValidator | -| Extends | AbstractValidator | + +- __Namespace__ + + - `Phalcon\Filter\Validation\Validator` + +- __Uses__ + + - `DateTime` + - `Phalcon\Filter\Validation` + - `Phalcon\Filter\Validation\AbstractValidator` + - `Phalcon\Messages\Message` + +- __Extends__ + + `AbstractValidator` + +- __Implements__ + Checks if a value is a valid date @@ -1623,14 +2093,14 @@ $validator->add( ``` -## Properties +### Properties ```php // protected template = Field :field is not a valid date; ``` -## Methods +### Methods ```php public function __construct( array $options = [] ); @@ -1646,13 +2116,27 @@ Executes the validation -

Class Phalcon\Filter\Validation\Validator\Digit

+## Filter\Validation\Validator\Digit [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Validation/Validator/Digit.zep) -| Namespace | Phalcon\Filter\Validation\Validator | -| Uses | Phalcon\Messages\Message, Phalcon\Filter\Validation, Phalcon\Filter\Validation\AbstractValidator | -| Extends | AbstractValidator | + +- __Namespace__ + + - `Phalcon\Filter\Validation\Validator` + +- __Uses__ + + - `Phalcon\Filter\Validation` + - `Phalcon\Filter\Validation\AbstractValidator` + - `Phalcon\Messages\Message` + +- __Extends__ + + `AbstractValidator` + +- __Implements__ + Check for numeric character(s) @@ -1688,14 +2172,14 @@ $validator->add( ``` -## Properties +### Properties ```php // protected template = Field :field must be numeric; ``` -## Methods +### Methods ```php public function __construct( array $options = [] ); @@ -1711,13 +2195,27 @@ Executes the validation -

Class Phalcon\Filter\Validation\Validator\Email

+## Filter\Validation\Validator\Email [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Validation/Validator/Email.zep) -| Namespace | Phalcon\Filter\Validation\Validator | -| Uses | Phalcon\Messages\Message, Phalcon\Filter\Validation, Phalcon\Filter\Validation\AbstractValidator | -| Extends | AbstractValidator | + +- __Namespace__ + + - `Phalcon\Filter\Validation\Validator` + +- __Uses__ + + - `Phalcon\Filter\Validation` + - `Phalcon\Filter\Validation\AbstractValidator` + - `Phalcon\Messages\Message` + +- __Extends__ + + `AbstractValidator` + +- __Implements__ + Checks if a value has a correct e-mail format @@ -1753,14 +2251,14 @@ $validator->add( ``` -## Properties +### Properties ```php // protected template = Field :field must be an email address; ``` -## Methods +### Methods ```php public function __construct( array $options = [] ); @@ -1776,25 +2274,52 @@ Executes the validation -

Class Phalcon\Filter\Validation\Validator\Exception

+## Filter\Validation\Validator\Exception [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Validation/Validator/Exception.zep) -| Namespace | Phalcon\Filter\Validation\Validator | -| Extends | \Exception | + +- __Namespace__ + + - `Phalcon\Filter\Validation\Validator` + +- __Uses__ + + +- __Extends__ + + `\Exception` + +- __Implements__ + Exceptions thrown in Phalcon\Filter\Validation\Validator\* classes will use this class -

Class Phalcon\Filter\Validation\Validator\ExclusionIn

+## Filter\Validation\Validator\ExclusionIn [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Validation/Validator/ExclusionIn.zep) -| Namespace | Phalcon\Filter\Validation\Validator | -| Uses | Phalcon\Messages\Message, Phalcon\Filter\Validation, Phalcon\Filter\Validation\AbstractValidator, Phalcon\Filter\Validation\Exception | -| Extends | AbstractValidator | + +- __Namespace__ + + - `Phalcon\Filter\Validation\Validator` + +- __Uses__ + + - `Phalcon\Filter\Validation` + - `Phalcon\Filter\Validation\AbstractValidator` + - `Phalcon\Filter\Validation\Exception` + - `Phalcon\Messages\Message` + +- __Extends__ + + `AbstractValidator` + +- __Implements__ + Check if a value is not included into a list of values @@ -1841,14 +2366,14 @@ $validator->add( ``` -## Properties +### Properties ```php // protected template = Field :field must not be a part of list: :domain; ``` -## Methods +### Methods ```php public function __construct( array $options = [] ); @@ -1864,13 +2389,35 @@ Executes the validation -

Class Phalcon\Filter\Validation\Validator\File

+## Filter\Validation\Validator\File [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Validation/Validator/File.zep) -| Namespace | Phalcon\Filter\Validation\Validator | -| Uses | Phalcon\Messages\Message, Phalcon\Support\Helper\Arr\Get, Phalcon\Filter\Validation, Phalcon\Filter\Validation\AbstractValidatorComposite, Phalcon\Filter\Validation\Validator\File\MimeType, Phalcon\Filter\Validation\Validator\File\Resolution\Equal, Phalcon\Filter\Validation\Validator\File\Resolution\Max, Phalcon\Filter\Validation\Validator\File\Resolution\Min, Phalcon\Filter\Validation\Validator\File\Size\Equal, Phalcon\Filter\Validation\Validator\File\Size\Max, Phalcon\Filter\Validation\Validator\File\Size\Min | -| Extends | AbstractValidatorComposite | + +- __Namespace__ + + - `Phalcon\Filter\Validation\Validator` + +- __Uses__ + + - `Phalcon\Filter\Validation` + - `Phalcon\Filter\Validation\AbstractValidatorComposite` + - `Phalcon\Filter\Validation\Validator\File\MimeType` + - `Phalcon\Filter\Validation\Validator\File\Resolution\Equal` + - `Phalcon\Filter\Validation\Validator\File\Resolution\Max` + - `Phalcon\Filter\Validation\Validator\File\Resolution\Min` + - `Phalcon\Filter\Validation\Validator\File\Size\Equal` + - `Phalcon\Filter\Validation\Validator\File\Size\Max` + - `Phalcon\Filter\Validation\Validator\File\Size\Min` + - `Phalcon\Messages\Message` + - `Phalcon\Support\Helper\Arr\Get` + +- __Extends__ + + `AbstractValidatorComposite` + +- __Implements__ + Checks if a value has a correct file @@ -1942,7 +2489,7 @@ $validator->add( ``` -## Methods +### Methods ```php public function __construct( array $options = [] ); @@ -1952,13 +2499,27 @@ Constructor -

Abstract Class Phalcon\Filter\Validation\Validator\File\AbstractFile

+## Filter\Validation\Validator\File\AbstractFile ![Abstract](assets/images/abstract-green.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Validation/Validator/File/AbstractFile.zep) -| Namespace | Phalcon\Filter\Validation\Validator\File | -| Uses | Phalcon\Messages\Message, Phalcon\Filter\Validation, Phalcon\Filter\Validation\AbstractValidator | -| Extends | AbstractValidator | + +- __Namespace__ + + - `Phalcon\Filter\Validation\Validator\File` + +- __Uses__ + + - `Phalcon\Filter\Validation` + - `Phalcon\Filter\Validation\AbstractValidator` + - `Phalcon\Messages\Message` + +- __Extends__ + + `AbstractValidator` + +- __Implements__ + Checks if a value has a correct file @@ -1999,7 +2560,7 @@ $validator->add( ``` -## Properties +### Properties ```php /** * Empty is empty @@ -2024,46 +2585,36 @@ protected messageValid = Field :field is not valid; ``` -## Methods +### Methods ```php -public function checkUpload( Validation $validation, mixed $field ): bool; +public function checkUpload( Validation $validation, string $field ): bool; ``` - Check upload - - +Check upload ```php -public function checkUploadIsEmpty( Validation $validation, mixed $field ): bool; +public function checkUploadIsEmpty( Validation $validation, string $field ): bool; ``` - Check if upload is empty - - +Check if upload is empty ```php -public function checkUploadIsValid( Validation $validation, mixed $field ): bool; +public function checkUploadIsValid( Validation $validation, string $field ): bool; ``` - Check if upload is valid - - +Check if upload is valid ```php -public function checkUploadMaxSize( Validation $validation, mixed $field ): bool; +public function checkUploadMaxSize( Validation $validation, string $field ): bool; ``` - Check if uploaded file is larger than PHP allowed size - - +Check if uploaded file is larger than PHP allowed size ```php public function getFileSizeInBytes( string $size ): double; ``` - Convert a string like "2.5MB" in bytes - - +Convert a string like "2.5MB" in bytes ```php @@ -2112,18 +2663,32 @@ File is not valid protected function checkIsUploadedFile( string $name ): bool; ``` Checks if a file has been uploaded; Internal check that can be -overriden in a subclass if you do not want to check uploaded files +overridden in a subclass if you do not want to check uploaded files -

Class Phalcon\Filter\Validation\Validator\File\MimeType

+## Filter\Validation\Validator\File\MimeType [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Validation/Validator/File/MimeType.zep) -| Namespace | Phalcon\Filter\Validation\Validator\File | -| Uses | Phalcon\Messages\Message, Phalcon\Filter\Validation, Phalcon\Filter\Validation\Exception | -| Extends | AbstractFile | + +- __Namespace__ + + - `Phalcon\Filter\Validation\Validator\File` + +- __Uses__ + + - `Phalcon\Filter\Validation` + - `Phalcon\Filter\Validation\Exception` + - `Phalcon\Messages\Message` + +- __Extends__ + + `AbstractFile` + +- __Implements__ + Checks if a value has a correct file mime type @@ -2173,14 +2738,14 @@ $validator->add( ``` -## Properties +### Properties ```php // protected template = File :field must be of type: :types; ``` -## Methods +### Methods ```php public function validate( Validation $validation, mixed $field ): bool; @@ -2190,13 +2755,27 @@ Executes the validation -

Class Phalcon\Filter\Validation\Validator\File\Resolution\Equal

+## Filter\Validation\Validator\File\Resolution\Equal [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Validation/Validator/File/Resolution/Equal.zep) -| Namespace | Phalcon\Filter\Validation\Validator\File\Resolution | -| Uses | Phalcon\Messages\Message, Phalcon\Filter\Validation, Phalcon\Filter\Validation\Validator\File\AbstractFile | -| Extends | AbstractFile | + +- __Namespace__ + + - `Phalcon\Filter\Validation\Validator\File\Resolution` + +- __Uses__ + + - `Phalcon\Filter\Validation` + - `Phalcon\Filter\Validation\Validator\File\AbstractFile` + - `Phalcon\Messages\Message` + +- __Extends__ + + `AbstractFile` + +- __Implements__ + Checks if a file has the right resolution @@ -2237,14 +2816,14 @@ $validator->add( ``` -## Properties +### Properties ```php // protected template = The resolution of the field :field has to be equal :resolution; ``` -## Methods +### Methods ```php public function __construct( array $options = [] ); @@ -2260,13 +2839,27 @@ Executes the validation -

Class Phalcon\Filter\Validation\Validator\File\Resolution\Max

+## Filter\Validation\Validator\File\Resolution\Max [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Validation/Validator/File/Resolution/Max.zep) -| Namespace | Phalcon\Filter\Validation\Validator\File\Resolution | -| Uses | Phalcon\Messages\Message, Phalcon\Filter\Validation, Phalcon\Filter\Validation\Validator\File\AbstractFile | -| Extends | AbstractFile | + +- __Namespace__ + + - `Phalcon\Filter\Validation\Validator\File\Resolution` + +- __Uses__ + + - `Phalcon\Filter\Validation` + - `Phalcon\Filter\Validation\Validator\File\AbstractFile` + - `Phalcon\Messages\Message` + +- __Extends__ + + `AbstractFile` + +- __Implements__ + Checks if a file has the right resolution @@ -2312,14 +2905,14 @@ $validator->add( ``` -## Properties +### Properties ```php // protected template = File :field exceeds the maximum resolution of :resolution; ``` -## Methods +### Methods ```php public function __construct( array $options = [] ); @@ -2335,13 +2928,27 @@ Executes the validation -

Class Phalcon\Filter\Validation\Validator\File\Resolution\Min

+## Filter\Validation\Validator\File\Resolution\Min [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Validation/Validator/File/Resolution/Min.zep) -| Namespace | Phalcon\Filter\Validation\Validator\File\Resolution | -| Uses | Phalcon\Messages\Message, Phalcon\Filter\Validation, Phalcon\Filter\Validation\Validator\File\AbstractFile | -| Extends | AbstractFile | + +- __Namespace__ + + - `Phalcon\Filter\Validation\Validator\File\Resolution` + +- __Uses__ + + - `Phalcon\Filter\Validation` + - `Phalcon\Filter\Validation\Validator\File\AbstractFile` + - `Phalcon\Messages\Message` + +- __Extends__ + + `AbstractFile` + +- __Implements__ + Checks if a file has the right resolution @@ -2387,14 +2994,14 @@ $validator->add( ``` -## Properties +### Properties ```php // protected template = File :field can not have the minimum resolution of :resolution; ``` -## Methods +### Methods ```php public function __construct( array $options = [] ); @@ -2410,13 +3017,26 @@ Executes the validation -

Class Phalcon\Filter\Validation\Validator\File\Size\Equal

+## Filter\Validation\Validator\File\Size\Equal [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Validation/Validator/File/Size/Equal.zep) -| Namespace | Phalcon\Filter\Validation\Validator\File\Size | -| Uses | Phalcon\Messages\Message, Phalcon\Filter\Validation, Phalcon\Filter\Validation\Validator\File\AbstractFile | -| Extends | AbstractFile | + +- __Namespace__ + + - `Phalcon\Filter\Validation\Validator\File\Size` + +- __Uses__ + + - `Phalcon\Filter\Validation` + - `Phalcon\Filter\Validation\Validator\File\AbstractFile` + +- __Extends__ + + `AbstractFile` + +- __Implements__ + Checks if a value has a correct file @@ -2462,36 +3082,49 @@ $validator->add( ``` -## Properties +### Properties ```php -// +/** + * @var string|null + */ protected template = File :field does not have the exact :size file size; ``` -## Methods +### Methods ```php -public function __construct( array $options = [] ); +public function validate( Validation $validation, mixed $field ): bool; ``` -Constructor +Executes the validation ```php -public function validate( Validation $validation, mixed $field ): bool; +protected function getConditional( double $source, double $target, bool $included = bool ); ``` -Executes the validation +Executes the conditional -

Class Phalcon\Filter\Validation\Validator\File\Size\Max

+## Filter\Validation\Validator\File\Size\Max [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Validation/Validator/File/Size/Max.zep) -| Namespace | Phalcon\Filter\Validation\Validator\File\Size | -| Uses | Phalcon\Messages\Message, Phalcon\Filter\Validation, Phalcon\Filter\Validation\Validator\File\AbstractFile | -| Extends | AbstractFile | + +- __Namespace__ + + - `Phalcon\Filter\Validation\Validator\File\Size` + +- __Uses__ + + +- __Extends__ + + `Equal` + +- __Implements__ + Checks if a value has a correct file @@ -2537,36 +3170,43 @@ $validator->add( ``` -## Properties +### Properties ```php -// +/** + * @var string|null + */ protected template = File :field exceeds the size of :size; ``` -## Methods +### Methods ```php -public function __construct( array $options = [] ); +protected function getConditional( double $source, double $target, bool $included = bool ); ``` -Constructor +Executes the conditional -```php -public function validate( Validation $validation, mixed $field ): bool; -``` -Executes the validation +## Filter\Validation\Validator\File\Size\Min +[Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Validation/Validator/File/Size/Min.zep) -

Class Phalcon\Filter\Validation\Validator\File\Size\Min

-[Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Validation/Validator/File/Size/Min.zep) +- __Namespace__ + + - `Phalcon\Filter\Validation\Validator\File\Size` + +- __Uses__ + + +- __Extends__ + + `Equal` -| Namespace | Phalcon\Filter\Validation\Validator\File\Size | -| Uses | Phalcon\Messages\Message, Phalcon\Filter\Validation, Phalcon\Filter\Validation\Validator\File\AbstractFile | -| Extends | AbstractFile | +- __Implements__ + Checks if a value has a correct file @@ -2612,36 +3252,46 @@ $validator->add( ``` -## Properties +### Properties ```php -// +/** + * @var string|null + */ protected template = File :field can not have the minimum size of :size; ``` -## Methods +### Methods ```php -public function __construct( array $options = [] ); +protected function getConditional( double $source, double $target, bool $included = bool ); ``` -Constructor +Executes the conditional -```php -public function validate( Validation $validation, mixed $field ): bool; -``` -Executes the validation +## Filter\Validation\Validator\Identical +[Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Validation/Validator/Identical.zep) -

Class Phalcon\Filter\Validation\Validator\Identical

-[Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Validation/Validator/Identical.zep) +- __Namespace__ -| Namespace | Phalcon\Filter\Validation\Validator | -| Uses | Phalcon\Messages\Message, Phalcon\Filter\Validation, Phalcon\Filter\Validation\AbstractValidator | -| Extends | AbstractValidator | + - `Phalcon\Filter\Validation\Validator` + +- __Uses__ + + - `Phalcon\Filter\Validation` + - `Phalcon\Filter\Validation\AbstractValidator` + - `Phalcon\Messages\Message` + +- __Extends__ + + `AbstractValidator` + +- __Implements__ + Checks if a value is identical to other @@ -2682,14 +3332,14 @@ $validator->add( ``` -## Properties +### Properties ```php // protected template = Field :field does not have the expected value; ``` -## Methods +### Methods ```php public function __construct( array $options = [] ); @@ -2705,13 +3355,28 @@ Executes the validation -

Class Phalcon\Filter\Validation\Validator\InclusionIn

+## Filter\Validation\Validator\InclusionIn [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Validation/Validator/InclusionIn.zep) -| Namespace | Phalcon\Filter\Validation\Validator | -| Uses | Phalcon\Messages\Message, Phalcon\Filter\Validation, Phalcon\Filter\Validation\AbstractValidator, Phalcon\Filter\Validation\Exception | -| Extends | AbstractValidator | + +- __Namespace__ + + - `Phalcon\Filter\Validation\Validator` + +- __Uses__ + + - `Phalcon\Filter\Validation` + - `Phalcon\Filter\Validation\AbstractValidator` + - `Phalcon\Filter\Validation\Exception` + - `Phalcon\Messages\Message` + +- __Extends__ + + `AbstractValidator` + +- __Implements__ + Check if a value is included into a list of values @@ -2752,14 +3417,14 @@ $validator->add( ``` -## Properties +### Properties ```php // protected template = Field :field must be a part of list: :domain; ``` -## Methods +### Methods ```php public function __construct( array $options = [] ); @@ -2775,13 +3440,27 @@ Executes the validation -

Class Phalcon\Filter\Validation\Validator\Ip

+## Filter\Validation\Validator\Ip [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Validation/Validator/Ip.zep) -| Namespace | Phalcon\Filter\Validation\Validator | -| Uses | Phalcon\Filter\Validation, Phalcon\Filter\Validation\AbstractValidator, Phalcon\Messages\Message | -| Extends | AbstractValidator | + +- __Namespace__ + + - `Phalcon\Filter\Validation\Validator` + +- __Uses__ + + - `Phalcon\Filter\Validation` + - `Phalcon\Filter\Validation\AbstractValidator` + - `Phalcon\Messages\Message` + +- __Extends__ + + `AbstractValidator` + +- __Implements__ + Check for IP addresses @@ -2834,20 +3513,20 @@ $validator->add( ``` -## Constants +### Constants ```php const VERSION_4 = FILTER_FLAG_IPV4; const VERSION_6 = FILTER_FLAG_IPV6; ``` -## Properties +### Properties ```php // protected template = Field :field must be a valid IP address; ``` -## Methods +### Methods ```php public function __construct( array $options = [] ); @@ -2863,13 +3542,27 @@ Executes the validation -

Class Phalcon\Filter\Validation\Validator\Numericality

+## Filter\Validation\Validator\Numericality [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Validation/Validator/Numericality.zep) -| Namespace | Phalcon\Filter\Validation\Validator | -| Uses | Phalcon\Messages\Message, Phalcon\Filter\Validation, Phalcon\Filter\Validation\AbstractValidator | -| Extends | AbstractValidator | + +- __Namespace__ + + - `Phalcon\Filter\Validation\Validator` + +- __Uses__ + + - `Phalcon\Filter\Validation` + - `Phalcon\Filter\Validation\AbstractValidator` + - `Phalcon\Messages\Message` + +- __Extends__ + + `AbstractValidator` + +- __Implements__ + Check for a valid numeric value @@ -2905,14 +3598,14 @@ $validator->add( ``` -## Properties +### Properties ```php // protected template = Field :field does not have a valid numeric format; ``` -## Methods +### Methods ```php public function __construct( array $options = [] ); @@ -2928,13 +3621,27 @@ Executes the validation -

Class Phalcon\Filter\Validation\Validator\PresenceOf

+## Filter\Validation\Validator\PresenceOf [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Validation/Validator/PresenceOf.zep) -| Namespace | Phalcon\Filter\Validation\Validator | -| Uses | Phalcon\Messages\Message, Phalcon\Filter\Validation, Phalcon\Filter\Validation\AbstractValidator | -| Extends | AbstractValidator | + +- __Namespace__ + + - `Phalcon\Filter\Validation\Validator` + +- __Uses__ + + - `Phalcon\Filter\Validation` + - `Phalcon\Filter\Validation\AbstractValidator` + - `Phalcon\Messages\Message` + +- __Extends__ + + `AbstractValidator` + +- __Implements__ + Validates that a value is not null or empty string @@ -2970,14 +3677,14 @@ $validator->add( ``` -## Properties +### Properties ```php // protected template = Field :field is required; ``` -## Methods +### Methods ```php public function __construct( array $options = [] ); @@ -2993,13 +3700,27 @@ Executes the validation -

Class Phalcon\Filter\Validation\Validator\Regex

+## Filter\Validation\Validator\Regex [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Validation/Validator/Regex.zep) -| Namespace | Phalcon\Filter\Validation\Validator | -| Uses | Phalcon\Messages\Message, Phalcon\Filter\Validation, Phalcon\Filter\Validation\AbstractValidator | -| Extends | AbstractValidator | + +- __Namespace__ + + - `Phalcon\Filter\Validation\Validator` + +- __Uses__ + + - `Phalcon\Filter\Validation` + - `Phalcon\Filter\Validation\AbstractValidator` + - `Phalcon\Messages\Message` + +- __Extends__ + + `AbstractValidator` + +- __Implements__ + Allows validate if the value of a field matches a regular expression @@ -3040,14 +3761,14 @@ $validator->add( ``` -## Properties +### Properties ```php // protected template = Field :field does not match the required format; ``` -## Methods +### Methods ```php public function __construct( array $options = [] ); @@ -3063,13 +3784,30 @@ Executes the validation -

Class Phalcon\Filter\Validation\Validator\StringLength

+## Filter\Validation\Validator\StringLength [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Validation/Validator/StringLength.zep) -| Namespace | Phalcon\Filter\Validation\Validator | -| Uses | Phalcon\Messages\Message, Phalcon\Filter\Validation\AbstractValidator, Phalcon\Filter\Validation\AbstractValidatorComposite, Phalcon\Filter\Validation\Validator\StringLength\Max, Phalcon\Filter\Validation\Validator\StringLength\Min, Phalcon\Filter\Validation\Exception | -| Extends | AbstractValidatorComposite | + +- __Namespace__ + + - `Phalcon\Filter\Validation\Validator` + +- __Uses__ + + - `Phalcon\Filter\Validation\AbstractValidator` + - `Phalcon\Filter\Validation\AbstractValidatorComposite` + - `Phalcon\Filter\Validation\Exception` + - `Phalcon\Filter\Validation\Validator\StringLength\Max` + - `Phalcon\Filter\Validation\Validator\StringLength\Min` + - `Phalcon\Messages\Message` + +- __Extends__ + + `AbstractValidatorComposite` + +- __Implements__ + Validates that a string has the specified maximum and minimum constraints The test is passed if for a string's length L, min<=L<=max, i.e. L must @@ -3133,7 +3871,7 @@ $validation->add( ``` -## Methods +### Methods ```php public function __construct( array $options = [] ); @@ -3143,13 +3881,28 @@ Constructor -

Class Phalcon\Filter\Validation\Validator\StringLength\Max

+## Filter\Validation\Validator\StringLength\Max [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Validation/Validator/StringLength/Max.zep) -| Namespace | Phalcon\Filter\Validation\Validator\StringLength | -| Uses | Phalcon\Messages\Message, Phalcon\Filter\Validation, Phalcon\Filter\Validation\AbstractValidator, Phalcon\Filter\Validation\Exception | -| Extends | AbstractValidator | + +- __Namespace__ + + - `Phalcon\Filter\Validation\Validator\StringLength` + +- __Uses__ + + - `Phalcon\Filter\Validation` + - `Phalcon\Filter\Validation\AbstractValidator` + - `Phalcon\Filter\Validation\Exception` + - `Phalcon\Messages\Message` + +- __Extends__ + + `AbstractValidator` + +- __Implements__ + Validates that a string has the specified maximum constraints The test is passed if for a string's length L, L<=max, i.e. L must @@ -3197,14 +3950,14 @@ $validation->add( ``` -## Properties +### Properties ```php // protected template = Field :field must not exceed :max characters long; ``` -## Methods +### Methods ```php public function __construct( array $options = [] ); @@ -3220,13 +3973,28 @@ Executes the validation -

Class Phalcon\Filter\Validation\Validator\StringLength\Min

+## Filter\Validation\Validator\StringLength\Min [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Validation/Validator/StringLength/Min.zep) -| Namespace | Phalcon\Filter\Validation\Validator\StringLength | -| Uses | Phalcon\Messages\Message, Phalcon\Filter\Validation, Phalcon\Filter\Validation\AbstractValidator, Phalcon\Filter\Validation\Exception | -| Extends | AbstractValidator | + +- __Namespace__ + + - `Phalcon\Filter\Validation\Validator\StringLength` + +- __Uses__ + + - `Phalcon\Filter\Validation` + - `Phalcon\Filter\Validation\AbstractValidator` + - `Phalcon\Filter\Validation\Exception` + - `Phalcon\Messages\Message` + +- __Extends__ + + `AbstractValidator` + +- __Implements__ + Validates that a string has the specified minimum constraints The test is passed if for a string's length L, min<=L, i.e. L must @@ -3274,14 +4042,14 @@ $validation->add( ``` -## Properties +### Properties ```php // protected template = Field :field must be at least :min characters long; ``` -## Methods +### Methods ```php public function __construct( array $options = [] ); @@ -3297,13 +4065,30 @@ Executes the validation -

Class Phalcon\Filter\Validation\Validator\Uniqueness

+## Filter\Validation\Validator\Uniqueness [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Validation/Validator/Uniqueness.zep) -| Namespace | Phalcon\Filter\Validation\Validator | -| Uses | Phalcon\Messages\Message, Phalcon\Mvc\Model, Phalcon\Mvc\ModelInterface, Phalcon\Filter\Validation, Phalcon\Filter\Validation\AbstractCombinedFieldsValidator, Phalcon\Filter\Validation\Exception | -| Extends | AbstractCombinedFieldsValidator | + +- __Namespace__ + + - `Phalcon\Filter\Validation\Validator` + +- __Uses__ + + - `Phalcon\Filter\Validation` + - `Phalcon\Filter\Validation\AbstractCombinedFieldsValidator` + - `Phalcon\Filter\Validation\Exception` + - `Phalcon\Messages\Message` + - `Phalcon\Mvc\Model` + - `Phalcon\Mvc\ModelInterface` + +- __Extends__ + + `AbstractCombinedFieldsValidator` + +- __Implements__ + Check that a field is unique in the related table @@ -3375,7 +4160,7 @@ $validator->add( ``` -## Properties +### Properties ```php // protected template = Field :field must be unique; @@ -3387,7 +4172,7 @@ private columnMap; ``` -## Methods +### Methods ```php public function __construct( array $options = [] ); @@ -3421,13 +4206,27 @@ Uniqueness method used for model -

Class Phalcon\Filter\Validation\Validator\Url

+## Filter\Validation\Validator\Url [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Validation/Validator/Url.zep) -| Namespace | Phalcon\Filter\Validation\Validator | -| Uses | Phalcon\Messages\Message, Phalcon\Filter\Validation, Phalcon\Filter\Validation\AbstractValidator | -| Extends | AbstractValidator | + +- __Namespace__ + + - `Phalcon\Filter\Validation\Validator` + +- __Uses__ + + - `Phalcon\Filter\Validation` + - `Phalcon\Filter\Validation\AbstractValidator` + - `Phalcon\Messages\Message` + +- __Extends__ + + `AbstractValidator` + +- __Implements__ + Checks if a value has a url format @@ -3463,14 +4262,14 @@ $validator->add( ``` -## Properties +### Properties ```php // protected template = Field :field must be a url; ``` -## Methods +### Methods ```php public function __construct( array $options = [] ); @@ -3486,17 +4285,29 @@ Executes the validation -

Interface Phalcon\Filter\Validation\ValidatorCompositeInterface

+## Filter\Validation\ValidatorCompositeInterface ![Abstract](assets/images/interface-blue.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Validation/ValidatorCompositeInterface.zep) -| Namespace | Phalcon\Filter\Validation | -| Uses | Phalcon\Filter\Validation | + +- __Namespace__ + + - `Phalcon\Filter\Validation` + +- __Uses__ + + - `Phalcon\Filter\Validation` + +- __Extends__ + + +- __Implements__ + This is a base class for combined fields validators -## Methods +### Methods ```php public function getValidators(): array; @@ -3512,13 +4323,25 @@ Executes the validation -

Class Phalcon\Filter\Validation\ValidatorFactory

+## Filter\Validation\ValidatorFactory [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Validation/ValidatorFactory.zep) -| Namespace | Phalcon\Filter\Validation | -| Uses | Phalcon\Factory\AbstractFactory | -| Extends | AbstractFactory | + +- __Namespace__ + + - `Phalcon\Filter\Validation` + +- __Uses__ + + - `Phalcon\Factory\AbstractFactory` + +- __Extends__ + + `AbstractFactory` + +- __Implements__ + This file is part of the Phalcon Framework. @@ -3528,7 +4351,7 @@ For the full copyright and license information, please view the LICENSE.txt file that was distributed with this source code. -## Methods +### Methods ```php public function __construct( array $services = [] ); @@ -3556,17 +4379,29 @@ Returns the available adapters -

Interface Phalcon\Filter\Validation\ValidatorInterface

+## Filter\Validation\ValidatorInterface ![Abstract](assets/images/interface-blue.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Validation/ValidatorInterface.zep) -| Namespace | Phalcon\Filter\Validation | -| Uses | Phalcon\Filter\Validation | + +- __Namespace__ + + - `Phalcon\Filter\Validation` + +- __Uses__ + + - `Phalcon\Filter\Validation` + +- __Extends__ + + +- __Implements__ + Interface for Phalcon\Filter\Validation\AbstractValidator -## Methods +### Methods ```php public function getOption( string $key, mixed $defaultValue = null ): mixed; @@ -3578,17 +4413,13 @@ Returns null if the option hasn't set ```php public function getTemplate( string $field ): string; ``` - Get the template message - - +Get the template message ```php public function getTemplates(): array; ``` - Get message templates - - +Get message templates ```php @@ -3600,17 +4431,13 @@ Checks if an option is defined ```php public function setTemplate( string $template ): ValidatorInterface; ``` - Set a new template message - - +Set a new template message ```php public function setTemplates( array $templates ): ValidatorInterface; ``` - Clear current template and set new from an array, - - +Clear current template and set new from an array, ```php diff --git a/docs/api/phalcon_flash.md b/docs/api/phalcon_flash.md index 435f70b1b..6cdfa4868 100644 --- a/docs/api/phalcon_flash.md +++ b/docs/api/phalcon_flash.md @@ -1,18 +1,39 @@ +--- +hide: + - navigation +--- -* [Phalcon\Flash\AbstractFlash](#flash-abstractflash) -* [Phalcon\Flash\Direct](#flash-direct) -* [Phalcon\Flash\Exception](#flash-exception) -* [Phalcon\Flash\FlashInterface](#flash-flashinterface) -* [Phalcon\Flash\Session](#flash-session) +!!! info "NOTE" -

Abstract Class Phalcon\Flash\AbstractFlash

+ All classes are prefixed with `Phalcon` + + + +## Flash\AbstractFlash ![Abstract](assets/images/abstract-green.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Flash/AbstractFlash.zep) -| Namespace | Phalcon\Flash | -| Uses | Phalcon\Di\Di, Phalcon\Di\DiInterface, Phalcon\Di\AbstractInjectionAware, Phalcon\Html\Escaper\EscaperInterface, Phalcon\Session\ManagerInterface, Phalcon\Support\Helper\Str\Interpolate | -| Extends | AbstractInjectionAware | -| Implements | FlashInterface | + +- __Namespace__ + + - `Phalcon\Flash` + +- __Uses__ + + - `Phalcon\Di\AbstractInjectionAware` + - `Phalcon\Di\Di` + - `Phalcon\Di\DiInterface` + - `Phalcon\Html\Escaper\EscaperInterface` + - `Phalcon\Session\ManagerInterface` + - `Phalcon\Support\Helper\Str\Interpolate` + +- __Extends__ + + `AbstractInjectionAware` + +- __Implements__ + + - `FlashInterface` Shows HTML notifications related to different circumstances. Classes can be stylized using CSS @@ -27,7 +48,7 @@ Class AbstractFlash @package Phalcon\Flash -## Properties +### Properties ```php /** * @var bool @@ -81,7 +102,7 @@ protected sessionService; ``` -## Methods +### Methods ```php public function __construct( EscaperInterface $escaper = null, SessionInterface $session = null ); @@ -226,19 +247,31 @@ $flash->warning("Hey, this is important"); -

Class Phalcon\Flash\Direct

+## Flash\Direct [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Flash/Direct.zep) -| Namespace | Phalcon\Flash | -| Extends | AbstractFlash | + +- __Namespace__ + + - `Phalcon\Flash` + +- __Uses__ + + +- __Extends__ + + `AbstractFlash` + +- __Implements__ + Class Direct @package Phalcon\Flash -## Methods +### Methods ```php public function message( string $type, mixed $message ): string | null; @@ -254,29 +287,53 @@ Prints the messages accumulated in the flasher -

Class Phalcon\Flash\Exception

+## Flash\Exception [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Flash/Exception.zep) -| Namespace | Phalcon\Flash | -| Extends | \Exception | + +- __Namespace__ + + - `Phalcon\Flash` + +- __Uses__ + + +- __Extends__ + + `\Exception` + +- __Implements__ + Exceptions thrown in Phalcon\Flash classes will use this class -

Interface Phalcon\Flash\FlashInterface

+## Flash\FlashInterface ![Abstract](assets/images/interface-blue.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Flash/FlashInterface.zep) -| Namespace | Phalcon\Flash | + +- __Namespace__ + + - `Phalcon\Flash` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Interface FlashInterface @package Phalcon\Flash -## Methods +### Methods ```php public function error( string $message ): string | null; @@ -310,13 +367,25 @@ Shows a HTML warning message -

Class Phalcon\Flash\Session

+## Flash\Session [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Flash/Session.zep) -| Namespace | Phalcon\Flash | -| Uses | Phalcon\Session\ManagerInterface | -| Extends | AbstractFlash | + +- __Namespace__ + + - `Phalcon\Flash` + +- __Uses__ + + - `Phalcon\Session\ManagerInterface` + +- __Extends__ + + `AbstractFlash` + +- __Implements__ + This is an implementation of the Phalcon\Flash\FlashInterface that temporarily stores the messages in session, then messages can be printed in @@ -327,12 +396,12 @@ Class Session @package Phalcon\Flash -## Constants +### Constants ```php const SESSION_KEY = _flashMessages; ``` -## Methods +### Methods ```php public function clear(): void; diff --git a/docs/api/phalcon_forms.md b/docs/api/phalcon_forms.md index 35b33e75e..812b70563 100644 --- a/docs/api/phalcon_forms.md +++ b/docs/api/phalcon_forms.md @@ -1,34 +1,47 @@ +--- +hide: + - navigation +--- -* [Phalcon\Forms\Element\AbstractElement](#forms-element-abstractelement) -* [Phalcon\Forms\Element\Check](#forms-element-check) -* [Phalcon\Forms\Element\Date](#forms-element-date) -* [Phalcon\Forms\Element\ElementInterface](#forms-element-elementinterface) -* [Phalcon\Forms\Element\Email](#forms-element-email) -* [Phalcon\Forms\Element\File](#forms-element-file) -* [Phalcon\Forms\Element\Hidden](#forms-element-hidden) -* [Phalcon\Forms\Element\Numeric](#forms-element-numeric) -* [Phalcon\Forms\Element\Password](#forms-element-password) -* [Phalcon\Forms\Element\Radio](#forms-element-radio) -* [Phalcon\Forms\Element\Select](#forms-element-select) -* [Phalcon\Forms\Element\Submit](#forms-element-submit) -* [Phalcon\Forms\Element\Text](#forms-element-text) -* [Phalcon\Forms\Element\TextArea](#forms-element-textarea) -* [Phalcon\Forms\Exception](#forms-exception) -* [Phalcon\Forms\Form](#forms-form) -* [Phalcon\Forms\Manager](#forms-manager) - -

Abstract Class Phalcon\Forms\Element\AbstractElement

+!!! info "NOTE" + + All classes are prefixed with `Phalcon` + + + +## Forms\Element\AbstractElement ![Abstract](assets/images/abstract-green.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Forms/Element/AbstractElement.zep) -| Namespace | Phalcon\Forms\Element | -| Uses | InvalidArgumentException, Phalcon\Di\DiInterface, Phalcon\Di\Di, Phalcon\Filter\Validation\ValidatorInterface, Phalcon\Forms\Form, Phalcon\Forms\Exception, Phalcon\Html\Escaper, Phalcon\Html\TagFactory, Phalcon\Messages\MessageInterface, Phalcon\Messages\Messages | -| Implements | ElementInterface | + +- __Namespace__ + + - `Phalcon\Forms\Element` + +- __Uses__ + + - `InvalidArgumentException` + - `Phalcon\Di\Di` + - `Phalcon\Di\DiInterface` + - `Phalcon\Filter\Validation\ValidatorInterface` + - `Phalcon\Forms\Exception` + - `Phalcon\Forms\Form` + - `Phalcon\Html\Escaper` + - `Phalcon\Html\TagFactory` + - `Phalcon\Messages\MessageInterface` + - `Phalcon\Messages\Messages` + +- __Extends__ + + +- __Implements__ + + - `ElementInterface` This is a base class for form elements -## Properties +### Properties ```php /** * @var array @@ -87,7 +100,7 @@ protected value; ``` -## Methods +### Methods ```php public function __construct( string $name, array $attributes = [] ); @@ -303,17 +316,29 @@ Returns the tagFactory; throws exception if not present -

Class Phalcon\Forms\Element\Check

+## Forms\Element\Check [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Forms/Element/Check.zep) -| Namespace | Phalcon\Forms\Element | -| Extends | AbstractElement | + +- __Namespace__ + + - `Phalcon\Forms\Element` + +- __Uses__ + + +- __Extends__ + + `AbstractElement` + +- __Implements__ + Component INPUT[type=check] for forms -## Properties +### Properties ```php /** * @var string @@ -323,18 +348,30 @@ protected method = inputCheckbox; ``` -

Class Phalcon\Forms\Element\Date

+## Forms\Element\Date [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Forms/Element/Date.zep) -| Namespace | Phalcon\Forms\Element | -| Uses | Phalcon\Tag | -| Extends | AbstractElement | + +- __Namespace__ + + - `Phalcon\Forms\Element` + +- __Uses__ + + - `Phalcon\Tag` + +- __Extends__ + + `AbstractElement` + +- __Implements__ + Component INPUT[type=date] for forms -## Properties +### Properties ```php /** * @var string @@ -344,17 +381,32 @@ protected method = inputDate; ``` -

Interface Phalcon\Forms\Element\ElementInterface

+## Forms\Element\ElementInterface ![Abstract](assets/images/interface-blue.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Forms/Element/ElementInterface.zep) -| Namespace | Phalcon\Forms\Element | -| Uses | Phalcon\Forms\Form, Phalcon\Messages\MessageInterface, Phalcon\Messages\Messages, Phalcon\Filter\Validation\ValidatorInterface | + +- __Namespace__ + + - `Phalcon\Forms\Element` + +- __Uses__ + + - `Phalcon\Filter\Validation\ValidatorInterface` + - `Phalcon\Forms\Form` + - `Phalcon\Messages\MessageInterface` + - `Phalcon\Messages\Messages` + +- __Extends__ + + +- __Implements__ + Interface for Phalcon\Forms\Element classes -## Methods +### Methods ```php public function addFilter( string $filter ): ElementInterface; @@ -540,18 +592,30 @@ Sets options for the element -

Class Phalcon\Forms\Element\Email

+## Forms\Element\Email [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Forms/Element/Email.zep) -| Namespace | Phalcon\Forms\Element | -| Uses | Phalcon\Tag | -| Extends | AbstractElement | + +- __Namespace__ + + - `Phalcon\Forms\Element` + +- __Uses__ + + - `Phalcon\Tag` + +- __Extends__ + + `AbstractElement` + +- __Implements__ + Component INPUT[type=email] for forms -## Properties +### Properties ```php /** * @var string @@ -561,18 +625,30 @@ protected method = inputEmail; ``` -

Class Phalcon\Forms\Element\File

+## Forms\Element\File [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Forms/Element/File.zep) -| Namespace | Phalcon\Forms\Element | -| Uses | Phalcon\Tag | -| Extends | AbstractElement | + +- __Namespace__ + + - `Phalcon\Forms\Element` + +- __Uses__ + + - `Phalcon\Tag` + +- __Extends__ + + `AbstractElement` + +- __Implements__ + Component INPUT[type=file] for forms -## Properties +### Properties ```php /** * @var string @@ -582,18 +658,30 @@ protected method = inputFile; ``` -

Class Phalcon\Forms\Element\Hidden

+## Forms\Element\Hidden [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Forms/Element/Hidden.zep) -| Namespace | Phalcon\Forms\Element | -| Uses | Phalcon\Tag | -| Extends | AbstractElement | + +- __Namespace__ + + - `Phalcon\Forms\Element` + +- __Uses__ + + - `Phalcon\Tag` + +- __Extends__ + + `AbstractElement` + +- __Implements__ + Component INPUT[type=hidden] for forms -## Properties +### Properties ```php /** * @var string @@ -603,18 +691,30 @@ protected method = inputHidden; ``` -

Class Phalcon\Forms\Element\Numeric

+## Forms\Element\Numeric [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Forms/Element/Numeric.zep) -| Namespace | Phalcon\Forms\Element | -| Uses | Phalcon\Tag | -| Extends | AbstractElement | + +- __Namespace__ + + - `Phalcon\Forms\Element` + +- __Uses__ + + - `Phalcon\Tag` + +- __Extends__ + + `AbstractElement` + +- __Implements__ + Component INPUT[type=number] for forms -## Properties +### Properties ```php /** * @var string @@ -624,18 +724,30 @@ protected method = inputNumeric; ``` -

Class Phalcon\Forms\Element\Password

+## Forms\Element\Password [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Forms/Element/Password.zep) -| Namespace | Phalcon\Forms\Element | -| Uses | Phalcon\Tag | -| Extends | AbstractElement | + +- __Namespace__ + + - `Phalcon\Forms\Element` + +- __Uses__ + + - `Phalcon\Tag` + +- __Extends__ + + `AbstractElement` + +- __Implements__ + Component INPUT[type=password] for forms -## Properties +### Properties ```php /** * @var string @@ -645,18 +757,30 @@ protected method = inputPassword; ``` -

Class Phalcon\Forms\Element\Radio

+## Forms\Element\Radio [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Forms/Element/Radio.zep) -| Namespace | Phalcon\Forms\Element | -| Uses | Phalcon\Tag | -| Extends | AbstractElement | + +- __Namespace__ + + - `Phalcon\Forms\Element` + +- __Uses__ + + - `Phalcon\Tag` + +- __Extends__ + + `AbstractElement` + +- __Implements__ + Component INPUT[type=radio] for forms -## Properties +### Properties ```php /** * @var string @@ -666,18 +790,30 @@ protected method = inputRadio; ``` -

Class Phalcon\Forms\Element\Select

+## Forms\Element\Select [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Forms/Element/Select.zep) -| Namespace | Phalcon\Forms\Element | -| Uses | Phalcon\Tag\Select | -| Extends | AbstractElement | + +- __Namespace__ + + - `Phalcon\Forms\Element` + +- __Uses__ + + - `Phalcon\Tag\Select` + +- __Extends__ + + `AbstractElement` + +- __Implements__ + Component SELECT (choice) for forms -## Properties +### Properties ```php /** * @var object|array|null @@ -686,7 +822,7 @@ protected optionsValues; ``` -## Methods +### Methods ```php public function __construct( string $name, mixed $options = null, array $attributes = [] ); @@ -727,18 +863,30 @@ helpers according to the element parameters -

Class Phalcon\Forms\Element\Submit

+## Forms\Element\Submit [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Forms/Element/Submit.zep) -| Namespace | Phalcon\Forms\Element | -| Uses | Phalcon\Tag | -| Extends | AbstractElement | + +- __Namespace__ + + - `Phalcon\Forms\Element` + +- __Uses__ + + - `Phalcon\Tag` + +- __Extends__ + + `AbstractElement` + +- __Implements__ + Component INPUT[type=submit] for forms -## Properties +### Properties ```php /** * @var string @@ -748,30 +896,54 @@ protected method = inputSubmit; ``` -

Class Phalcon\Forms\Element\Text

+## Forms\Element\Text [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Forms/Element/Text.zep) -| Namespace | Phalcon\Forms\Element | -| Uses | Phalcon\Forms\Exception | -| Extends | AbstractElement | + +- __Namespace__ + + - `Phalcon\Forms\Element` + +- __Uses__ + + - `Phalcon\Forms\Exception` + +- __Extends__ + + `AbstractElement` + +- __Implements__ + Component INPUT[type=text] for forms -

Class Phalcon\Forms\Element\TextArea

+## Forms\Element\TextArea [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Forms/Element/TextArea.zep) -| Namespace | Phalcon\Forms\Element | -| Uses | Phalcon\Tag | -| Extends | AbstractElement | + +- __Namespace__ + + - `Phalcon\Forms\Element` + +- __Uses__ + + - `Phalcon\Tag` + +- __Extends__ + + `AbstractElement` + +- __Implements__ + Component TEXTAREA for forms -## Properties +### Properties ```php /** * @var string @@ -781,30 +953,68 @@ protected method = inputTextarea; ``` -

Class Phalcon\Forms\Exception

+## Forms\Exception [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Forms/Exception.zep) -| Namespace | Phalcon\Forms | -| Extends | \Exception | + +- __Namespace__ + + - `Phalcon\Forms` + +- __Uses__ + + +- __Extends__ + + `\Exception` + +- __Implements__ + Exceptions thrown in Phalcon\Forms will use this class -

Class Phalcon\Forms\Form

+## Forms\Form [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Forms/Form.zep) -| Namespace | Phalcon\Forms | -| Uses | Countable, Iterator, Phalcon\Di\Injectable, Phalcon\Di\DiInterface, Phalcon\Filter\FilterInterface, Phalcon\Forms\Element\ElementInterface, Phalcon\Html\Attributes, Phalcon\Html\Attributes\AttributesInterface, Phalcon\Html\TagFactory, Phalcon\Messages\Messages, Phalcon\Tag, Phalcon\Filter\Validation, Phalcon\Filter\Validation\ValidationInterface | -| Extends | Injectable | -| Implements | Countable, Iterator, AttributesInterface | + +- __Namespace__ + + - `Phalcon\Forms` + +- __Uses__ + + - `Countable` + - `Iterator` + - `Phalcon\Di\DiInterface` + - `Phalcon\Di\Injectable` + - `Phalcon\Filter\FilterInterface` + - `Phalcon\Filter\Validation` + - `Phalcon\Filter\Validation\ValidationInterface` + - `Phalcon\Forms\Element\ElementInterface` + - `Phalcon\Html\Attributes` + - `Phalcon\Html\Attributes\AttributesInterface` + - `Phalcon\Html\TagFactory` + - `Phalcon\Messages\Messages` + - `Phalcon\Tag` + +- __Extends__ + + `Injectable` + +- __Implements__ + + - `AttributesInterface` + - `Countable` + - `Iterator` This component allows to build forms using an object-oriented interface -## Properties +### Properties ```php /** * @var AttributesInterface|null @@ -868,7 +1078,7 @@ protected whitelist; ``` -## Methods +### Methods ```php public function __construct( mixed $entity = null, array $userOptions = [] ); @@ -1118,16 +1328,28 @@ Check if the current element in the iterator is valid -

Class Phalcon\Forms\Manager

+## Forms\Manager [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Forms/Manager.zep) -| Namespace | Phalcon\Forms | + +- __Namespace__ + + - `Phalcon\Forms` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Forms Manager -## Properties +### Properties ```php /** * @var array @@ -1136,7 +1358,7 @@ protected forms; ``` -## Methods +### Methods ```php public function create( string $name, mixed $entity = null ): Form; diff --git a/docs/api/phalcon_html.md b/docs/api/phalcon_html.md index ad4b642bb..cf8b762db 100644 --- a/docs/api/phalcon_html.md +++ b/docs/api/phalcon_html.md @@ -1,85 +1,40 @@ +--- +hide: + - navigation +--- -* [Phalcon\Html\Attributes](#html-attributes) -* [Phalcon\Html\Attributes\AttributesInterface](#html-attributes-attributesinterface) -* [Phalcon\Html\Attributes\RenderInterface](#html-attributes-renderinterface) -* [Phalcon\Html\Breadcrumbs](#html-breadcrumbs) -* [Phalcon\Html\Escaper](#html-escaper) -* [Phalcon\Html\Escaper\EscaperInterface](#html-escaper-escaperinterface) -* [Phalcon\Html\Escaper\Exception](#html-escaper-exception) -* [Phalcon\Html\EscaperFactory](#html-escaperfactory) -* [Phalcon\Html\Exception](#html-exception) -* [Phalcon\Html\Helper\AbstractHelper](#html-helper-abstracthelper) -* [Phalcon\Html\Helper\AbstractList](#html-helper-abstractlist) -* [Phalcon\Html\Helper\AbstractSeries](#html-helper-abstractseries) -* [Phalcon\Html\Helper\Anchor](#html-helper-anchor) -* [Phalcon\Html\Helper\Base](#html-helper-base) -* [Phalcon\Html\Helper\Body](#html-helper-body) -* [Phalcon\Html\Helper\Button](#html-helper-button) -* [Phalcon\Html\Helper\Close](#html-helper-close) -* [Phalcon\Html\Helper\Doctype](#html-helper-doctype) -* [Phalcon\Html\Helper\Element](#html-helper-element) -* [Phalcon\Html\Helper\Form](#html-helper-form) -* [Phalcon\Html\Helper\Img](#html-helper-img) -* [Phalcon\Html\Helper\Input\AbstractInput](#html-helper-input-abstractinput) -* [Phalcon\Html\Helper\Input\Checkbox](#html-helper-input-checkbox) -* [Phalcon\Html\Helper\Input\Color](#html-helper-input-color) -* [Phalcon\Html\Helper\Input\Date](#html-helper-input-date) -* [Phalcon\Html\Helper\Input\DateTime](#html-helper-input-datetime) -* [Phalcon\Html\Helper\Input\DateTimeLocal](#html-helper-input-datetimelocal) -* [Phalcon\Html\Helper\Input\Email](#html-helper-input-email) -* [Phalcon\Html\Helper\Input\File](#html-helper-input-file) -* [Phalcon\Html\Helper\Input\Hidden](#html-helper-input-hidden) -* [Phalcon\Html\Helper\Input\Image](#html-helper-input-image) -* [Phalcon\Html\Helper\Input\Input](#html-helper-input-input) -* [Phalcon\Html\Helper\Input\Month](#html-helper-input-month) -* [Phalcon\Html\Helper\Input\Numeric](#html-helper-input-numeric) -* [Phalcon\Html\Helper\Input\Password](#html-helper-input-password) -* [Phalcon\Html\Helper\Input\Radio](#html-helper-input-radio) -* [Phalcon\Html\Helper\Input\Range](#html-helper-input-range) -* [Phalcon\Html\Helper\Input\Search](#html-helper-input-search) -* [Phalcon\Html\Helper\Input\Select](#html-helper-input-select) -* [Phalcon\Html\Helper\Input\Submit](#html-helper-input-submit) -* [Phalcon\Html\Helper\Input\Tel](#html-helper-input-tel) -* [Phalcon\Html\Helper\Input\Text](#html-helper-input-text) -* [Phalcon\Html\Helper\Input\Textarea](#html-helper-input-textarea) -* [Phalcon\Html\Helper\Input\Time](#html-helper-input-time) -* [Phalcon\Html\Helper\Input\Url](#html-helper-input-url) -* [Phalcon\Html\Helper\Input\Week](#html-helper-input-week) -* [Phalcon\Html\Helper\Label](#html-helper-label) -* [Phalcon\Html\Helper\Link](#html-helper-link) -* [Phalcon\Html\Helper\Meta](#html-helper-meta) -* [Phalcon\Html\Helper\Ol](#html-helper-ol) -* [Phalcon\Html\Helper\Script](#html-helper-script) -* [Phalcon\Html\Helper\Style](#html-helper-style) -* [Phalcon\Html\Helper\Title](#html-helper-title) -* [Phalcon\Html\Helper\Ul](#html-helper-ul) -* [Phalcon\Html\Link\AbstractLink](#html-link-abstractlink) -* [Phalcon\Html\Link\AbstractLinkProvider](#html-link-abstractlinkprovider) -* [Phalcon\Html\Link\EvolvableLink](#html-link-evolvablelink) -* [Phalcon\Html\Link\EvolvableLinkProvider](#html-link-evolvablelinkprovider) -* [Phalcon\Html\Link\Interfaces\EvolvableLinkInterface](#html-link-interfaces-evolvablelinkinterface) -* [Phalcon\Html\Link\Interfaces\EvolvableLinkProviderInterface](#html-link-interfaces-evolvablelinkproviderinterface) -* [Phalcon\Html\Link\Interfaces\LinkInterface](#html-link-interfaces-linkinterface) -* [Phalcon\Html\Link\Interfaces\LinkProviderInterface](#html-link-interfaces-linkproviderinterface) -* [Phalcon\Html\Link\Link](#html-link-link) -* [Phalcon\Html\Link\LinkProvider](#html-link-linkprovider) -* [Phalcon\Html\Link\Serializer\Header](#html-link-serializer-header) -* [Phalcon\Html\Link\Serializer\SerializerInterface](#html-link-serializer-serializerinterface) -* [Phalcon\Html\TagFactory](#html-tagfactory) - -

Class Phalcon\Html\Attributes

+!!! info "NOTE" + + All classes are prefixed with `Phalcon` + + + +## Html\Attributes [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Html/Attributes.zep) -| Namespace | Phalcon\Html | -| Uses | Phalcon\Support\Collection, Phalcon\Html\Attributes\RenderInterface | -| Extends | Collection | -| Implements | RenderInterface | + +- __Namespace__ + + - `Phalcon\Html` + +- __Uses__ + + - `Phalcon\Html\Attributes\RenderInterface` + - `Phalcon\Support\Collection` + +- __Extends__ + + `Collection` + +- __Implements__ + + - `RenderInterface` This class helps to work with HTML Attributes -## Methods +### Methods ```php public function __toString(): string; @@ -101,19 +56,31 @@ protected function renderAttributes( array $attributes ): string; -

Interface Phalcon\Html\Attributes\AttributesInterface

+## Html\Attributes\AttributesInterface ![Abstract](assets/images/interface-blue.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Html/Attributes/AttributesInterface.zep) -| Namespace | Phalcon\Html\Attributes | -| Uses | Phalcon\Html\Attributes | + +- __Namespace__ + + - `Phalcon\Html\Attributes` + +- __Uses__ + + - `Phalcon\Html\Attributes` + +- __Extends__ + + +- __Implements__ + * Phalcon\Html\Attributes\AttributesInterface * * Interface Phalcon\Html\Attributes\AttributesInterface */ -## Methods +### Methods ```php public function getAttributes(): Attributes; @@ -129,18 +96,30 @@ Set Attributes -

Interface Phalcon\Html\Attributes\RenderInterface

+## Html\Attributes\RenderInterface ![Abstract](assets/images/interface-blue.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Html/Attributes/RenderInterface.zep) -| Namespace | Phalcon\Html\Attributes | + +- __Namespace__ + + - `Phalcon\Html\Attributes` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + * Phalcon\Html\Attributes\RenderInterface * * Interface Phalcon\Html\Attributes\RenderInterface */ -## Methods +### Methods ```php public function render(): string; @@ -150,12 +129,24 @@ Generate a string represetation -

Class Phalcon\Html\Breadcrumbs

+## Html\Breadcrumbs [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Html/Breadcrumbs.zep) -| Namespace | Phalcon\Html | -| Uses | Phalcon\Di\DiInterface | + +- __Namespace__ + + - `Phalcon\Html` + +- __Uses__ + + - `Phalcon\Di\DiInterface` + +- __Extends__ + + +- __Implements__ + Phalcon\Html\Breadcrumbs @@ -164,7 +155,7 @@ The resulting HTML when calling `render()` will have each breadcrumb enclosed in `
` tags, while the whole string is enclosed in `
` tags. -## Properties +### Properties ```php /** * Keeps all the breadcrumbs @@ -189,7 +180,7 @@ private template =
%label%
; ``` -## Methods +### Methods ```php public function add( string $label, string $link = string ): Breadcrumbs; @@ -258,13 +249,25 @@ Returns the internal breadcrumbs array -

Class Phalcon\Html\Escaper

+## Html\Escaper [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Html/Escaper.zep) -| Namespace | Phalcon\Html | -| Uses | Phalcon\Html\Escaper\EscaperInterface | -| Implements | EscaperInterface | + +- __Namespace__ + + - `Phalcon\Html` + +- __Uses__ + + - `Phalcon\Html\Escaper\EscaperInterface` + +- __Extends__ + + +- __Implements__ + + - `EscaperInterface` Phalcon\Html\Escaper @@ -283,7 +286,7 @@ echo $escaped; // font\2D family\3A \20 \3C Verdana\3E ``` -## Properties +### Properties ```php /** * @var bool @@ -304,7 +307,7 @@ protected flags = 11; ``` -## Methods +### Methods ```php public function attributes( mixed $input ): string; @@ -451,16 +454,28 @@ Proxy method for testing -

Interface Phalcon\Html\Escaper\EscaperInterface

+## Html\Escaper\EscaperInterface ![Abstract](assets/images/interface-blue.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Html/Escaper/EscaperInterface.zep) -| Namespace | Phalcon\Html\Escaper | + +- __Namespace__ + + - `Phalcon\Html\Escaper` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Interface for Phalcon\Html\Escaper -## Methods +### Methods ```php public function attributes( string $input ): string; @@ -514,27 +529,51 @@ Escapes a URL. Internally uses rawurlencode -

Class Phalcon\Html\Escaper\Exception

+## Html\Escaper\Exception [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Html/Escaper/Exception.zep) -| Namespace | Phalcon\Html\Escaper | -| Extends | \Exception | + +- __Namespace__ + + - `Phalcon\Html\Escaper` + +- __Uses__ + + +- __Extends__ + + `\Exception` + +- __Implements__ + Exceptions thrown in Phalcon\Html\Escaper will use this class -

Class Phalcon\Html\EscaperFactory

+## Html\EscaperFactory [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Html/EscaperFactory.zep) -| Namespace | Phalcon\Html | + +- __Namespace__ + + - `Phalcon\Html` + +- __Uses__ + + +- __Extends__ + + +- __Implements__ + Class EscaperFactory -## Methods +### Methods ```php public function newInstance(): Escaper; @@ -544,12 +583,24 @@ Create a new instance of the object -

Class Phalcon\Html\Exception

+## Html\Exception [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Html/Exception.zep) -| Namespace | Phalcon\Html | -| Extends | \Exception | + +- __Namespace__ + + - `Phalcon\Html` + +- __Uses__ + + +- __Extends__ + + `\Exception` + +- __Implements__ + Phalcon\Html\Tag\Exception @@ -557,14 +608,33 @@ Exceptions thrown in Phalcon\Html\Tag will use this class -

Abstract Class Phalcon\Html\Helper\AbstractHelper

+## Html\Helper\AbstractHelper ![Abstract](assets/images/abstract-green.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Html/Helper/AbstractHelper.zep) -| Namespace | Phalcon\Html\Helper | -| Uses | Phalcon\Html\Escaper\EscaperInterface, Phalcon\Html\Exception | -## Properties +- __Namespace__ + + - `Phalcon\Html\Helper` + +- __Uses__ + + - `Phalcon\Html\Escaper\EscaperInterface` + - `Phalcon\Html\Exception` + +- __Extends__ + + +- __Implements__ + + +@property string $delimiter +@property EscaperInterface $escaper +@property string $indent +@property int $indentLevel + + +### Properties ```php /** * @var string @@ -588,7 +658,7 @@ protected indentLevel = 1; ``` -## Methods +### Methods ```php public function __construct( EscaperInterface $escaper ); @@ -653,18 +723,30 @@ Produces a self close tag i.e. -

Abstract Class Phalcon\Html\Helper\AbstractList

+## Html\Helper\AbstractList ![Abstract](assets/images/abstract-green.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Html/Helper/AbstractList.zep) -| Namespace | Phalcon\Html\Helper | -| Uses | Phalcon\Html\Exception | -| Extends | AbstractHelper | + +- __Namespace__ + + - `Phalcon\Html\Helper` + +- __Uses__ + + - `Phalcon\Html\Exception` + +- __Extends__ + + `AbstractHelper` + +- __Implements__ + Class AbstractList -## Properties +### Properties ```php /** * @var array @@ -683,7 +765,7 @@ protected store; ``` -## Methods +### Methods ```php public function __invoke( string $indent = string, string $delimiter = null, array $attributes = [] ): AbstractList; @@ -705,14 +787,30 @@ Returns the tag name. -

Abstract Class Phalcon\Html\Helper\AbstractSeries

+## Html\Helper\AbstractSeries ![Abstract](assets/images/abstract-green.png) [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Html/Helper/AbstractSeries.zep) -| Namespace | Phalcon\Html\Helper | -| Extends | AbstractHelper | -## Properties +- __Namespace__ + + - `Phalcon\Html\Helper` + +- __Uses__ + + +- __Extends__ + + `AbstractHelper` + +- __Implements__ + + +@property array $attributes +@property array $store + + +### Properties ```php /** * @var array @@ -726,7 +824,7 @@ protected store; ``` -## Methods +### Methods ```php public function __invoke( string $indent = string, string $delimiter = null ): AbstractSeries; @@ -740,6 +838,12 @@ public function __toString(); Generates and returns the HTML for the list. +```php +public function reset(): AbstractSeries; +``` +Resets the internal store. + + ```php abstract protected function getTag(): string; ``` @@ -748,18 +852,30 @@ Returns the tag name. -

Class Phalcon\Html\Helper\Anchor

+## Html\Helper\Anchor [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Html/Helper/Anchor.zep) -| Namespace | Phalcon\Html\Helper | -| Uses | Phalcon\Html\Exception | -| Extends | AbstractHelper | + +- __Namespace__ + + - `Phalcon\Html\Helper` + +- __Uses__ + + - `Phalcon\Html\Exception` + +- __Extends__ + + `AbstractHelper` + +- __Implements__ + Class Anchor -## Methods +### Methods ```php public function __invoke( string $href, string $text, array $attributes = [], bool $raw = bool ): string; @@ -775,18 +891,30 @@ protected function processAttributes( string $href, array $attributes ): array; -

Class Phalcon\Html\Helper\Base

+## Html\Helper\Base [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Html/Helper/Base.zep) -| Namespace | Phalcon\Html\Helper | -| Uses | Phalcon\Html\Exception | -| Extends | AbstractHelper | + +- __Namespace__ + + - `Phalcon\Html\Helper` + +- __Uses__ + + - `Phalcon\Html\Exception` + +- __Extends__ + + `AbstractHelper` + +- __Implements__ + Class Base -## Methods +### Methods ```php public function __invoke( string $href = null, array $attributes = [] ): string; @@ -796,18 +924,30 @@ Produce a `` tag. -

Class Phalcon\Html\Helper\Body

+## Html\Helper\Body [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Html/Helper/Body.zep) -| Namespace | Phalcon\Html\Helper | -| Uses | Phalcon\Html\Exception | -| Extends | AbstractHelper | + +- __Namespace__ + + - `Phalcon\Html\Helper` + +- __Uses__ + + - `Phalcon\Html\Exception` + +- __Extends__ + + `AbstractHelper` + +- __Implements__ + Class Body -## Methods +### Methods ```php public function __invoke( array $attributes = [] ): string; @@ -817,18 +957,30 @@ Produce a `` tag. -

Class Phalcon\Html\Helper\Button

+## Html\Helper\Button [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Html/Helper/Button.zep) -| Namespace | Phalcon\Html\Helper | -| Uses | Phalcon\Html\Exception | -| Extends | AbstractHelper | + +- __Namespace__ + + - `Phalcon\Html\Helper` + +- __Uses__ + + - `Phalcon\Html\Exception` + +- __Extends__ + + `AbstractHelper` + +- __Implements__ + Class Button -## Methods +### Methods ```php public function __invoke( string $text, array $attributes = [], bool $raw = bool ): string; @@ -838,17 +990,29 @@ Produce a `