Secciones

Abstract Class Phalcon\Forms\Element\AbstractElement

Código fuente en GitHub

Namespace Phalcon\Forms\Element   Uses InvalidArgumentException, Phalcon\Forms\Form, Phalcon\Forms\Exception, Phalcon\Messages\MessageInterface, Phalcon\Messages\Messages, Phalcon\Tag, Phalcon\Validation\ValidatorInterface   Implements ElementInterface

This is a base class for form elements

Propiedades

//
protected attributes;

//
protected filters;

//
protected form;

//
protected label;

//
protected messages;

//
protected name;

//
protected options;

/**
 * @var array
 */
protected validators;

//
protected value;

Métodos

public function __construct( string $name, array $attributes = [] );

Phalcon\Forms\Element constructor

public function __toString(): string;

Magic method __toString renders the widget without attributes

public function addFilter( string $filter ): ElementInterface;

Adds a filter to current list of filters

public function addValidator( ValidatorInterface $validator ): ElementInterface;

Adds a validator to the element

public function addValidators( array $validators, bool $merge = bool ): ElementInterface;

Adds a group of validators

public function appendMessage( MessageInterface $message ): ElementInterface;

Appends a message to the internal message list

public function clear(): ElementInterface;

Clears element to its default value

public function getAttribute( string $attribute, mixed $defaultValue = null ): mixed;

Returns the value of an attribute if present

public function getAttributes(): array;

Returns the default attributes for the element

public function getDefault(): mixed;

Returns the default value assigned to the element

public function getFilters();

Returns the element filters

public function getForm(): Form;

Returns the parent form to the element

public function getLabel(): string;

Returns the element label

public function getMessages(): Messages;

Returns the messages that belongs to the element The element needs to be attached to a form

public function getName(): string;

Returns the element name

public function getUserOption( string $option, mixed $defaultValue = null ): mixed;

Returns the value of an option if present

public function getUserOptions(): array;

Devuelve las opciones del elemento

public function getValidators(): ValidatorInterface[];

Returns the validators registered for the element

public function getValue(): mixed;

Returns the element’s value

public function hasMessages(): bool;

Checks whether there are messages attached to the element

public function label( array $attributes = [] ): string;

Generate the HTML to label the element

public function prepareAttributes( array $attributes = [], bool $useChecked = bool ): array;

Returns an array of prepared attributes for Phalcon\Tag helpers according to the element parameters

public function setAttribute( string $attribute, mixed $value ): ElementInterface;

Sets a default attribute for the element

public function setAttributes( array $attributes ): ElementInterface;

Sets default attributes for the element

public function setDefault( mixed $value ): ElementInterface;

Sets a default value in case the form does not use an entity or there is no value available for the element in _POST

public function setFilters( mixed $filters ): ElementInterface;

Sets the element filters

public function setForm( Form $form ): ElementInterface;

Sets the parent form to the element

public function setLabel( string $label ): ElementInterface;

Sets the element label

public function setMessages( Messages $messages ): ElementInterface;

Sets the validation messages related to the element

public function setName( string $name ): ElementInterface;

Sets the element name

public function setUserOption( string $option, mixed $value ): ElementInterface;

Sets an option for the element

public function setUserOptions( array $options ): ElementInterface;

Sets options for the element

Class Phalcon\Forms\Element\Check

Código fuente en GitHub

Namespace Phalcon\Forms\Element   Uses Phalcon\Tag   Extends AbstractElement

Phalcon\Forms\Element\Check

Component INPUT[type=check] for forms

Métodos

public function render( array $attributes = [] ): string;

Renders the element widget returning HTML

Class Phalcon\Forms\Element\Date

Código fuente en GitHub

Namespace Phalcon\Forms\Element   Uses Phalcon\Tag   Extends AbstractElement

Component INPUT[type=date] for forms

Métodos

public function render( array $attributes = [] ): string;

Renders the element widget returning html

Interface Phalcon\Forms\Element\ElementInterface

Código fuente en GitHub

Namespace Phalcon\Forms\Element   Uses Phalcon\Forms\Form, Phalcon\Messages\MessageInterface, Phalcon\Messages\Messages, Phalcon\Validation\ValidatorInterface

Interface for Phalcon\Forms\Element classes

Métodos

public function addFilter( string $filter ): ElementInterface;

Adds a filter to current list of filters

public function addValidator( ValidatorInterface $validator ): ElementInterface;

Adds a validator to the element

public function addValidators( array $validators, bool $merge = bool ): ElementInterface;

Adds a group of validators

public function appendMessage( MessageInterface $message ): ElementInterface;

Appends a message to the internal message list

public function clear(): ElementInterface;

Clears every element in the form to its default value

public function getAttribute( string $attribute, mixed $defaultValue = null ): mixed;

Returns the value of an attribute if present

public function getAttributes(): array;

Returns the default attributes for the element

public function getDefault(): mixed;

Returns the default value assigned to the element

public function getFilters();

Returns the element’s filters

public function getForm(): Form;

Returns the parent form to the element

public function getLabel(): string;

Returns the element’s label

public function getMessages(): Messages;

Returns the messages that belongs to the element The element needs to be attached to a form

public function getName(): string;

Returns the element’s name

public function getUserOption( string $option, mixed $defaultValue = null ): mixed;

Returns the value of an option if present

public function getUserOptions(): array;

Devuelve las opciones del elemento

public function getValidators(): ValidatorInterface[];

Returns the validators registered for the element

public function getValue(): mixed;

Returns the element’s value

public function hasMessages(): bool;

Checks whether there are messages attached to the element

public function label(): string;

Generate the HTML to label the element

public function prepareAttributes( array $attributes = [], bool $useChecked = bool ): array;

Returns an array of prepared attributes for Phalcon\Tag helpers according to the element’s parameters

public function render( array $attributes = [] ): string;

Renders the element widget

public function setAttribute( string $attribute, mixed $value ): ElementInterface;

Sets a default attribute for the element

public function setAttributes( array $attributes ): ElementInterface;

Sets default attributes for the element

public function setDefault( mixed $value ): ElementInterface;

Sets a default value in case the form does not use an entity or there is no value available for the element in _POST

public function setFilters( mixed $filters ): ElementInterface;

Sets the element’s filters

public function setForm( Form $form ): ElementInterface;

Sets the parent form to the element

public function setLabel( string $label ): ElementInterface;

Sets the element label

public function setMessages( Messages $messages ): ElementInterface;

Sets the validation messages related to the element

public function setName( string $name ): ElementInterface;

Sets the element’s name

public function setUserOption( string $option, mixed $value ): ElementInterface;

Sets an option for the element

public function setUserOptions( array $options ): ElementInterface;

Sets options for the element

Class Phalcon\Forms\Element\Email

Código fuente en GitHub

Namespace Phalcon\Forms\Element   Uses Phalcon\Tag   Extends AbstractElement

Phalcon\Forms\Element\Email

Component INPUT[type=email] for forms

Métodos

public function render( array $attributes = [] ): string;

Renders the element widget returning HTML

Class Phalcon\Forms\Element\File

Código fuente en GitHub

Namespace Phalcon\Forms\Element   Uses Phalcon\Tag   Extends AbstractElement

Component INPUT[type=file] for forms

Métodos

public function render( array $attributes = [] ): string;

Renders the element widget returning HTML

Class Phalcon\Forms\Element\Hidden

Código fuente en GitHub

Namespace Phalcon\Forms\Element   Uses Phalcon\Tag   Extends AbstractElement

Phalcon\Forms\Element\Hidden

Component INPUT[type=hidden] for forms

Métodos

public function render( array $attributes = [] ): string;

Renders the element widget returning HTML

Class Phalcon\Forms\Element\Numeric

Código fuente en GitHub

Namespace Phalcon\Forms\Element   Uses Phalcon\Tag   Extends AbstractElement

Phalcon\Forms\Element\Numeric

Component INPUT[type=number] for forms

Métodos

public function render( array $attributes = [] ): string;

Renders the element widget returning HTML

Class Phalcon\Forms\Element\Password

Código fuente en GitHub

Namespace Phalcon\Forms\Element   Uses Phalcon\Tag   Extends AbstractElement

Phalcon\Forms\Element\Password

Component INPUT[type=password] for forms

Métodos

public function render( array $attributes = [] ): string;

Renders the element widget returning HTML

Class Phalcon\Forms\Element\Radio

Código fuente en GitHub

Namespace Phalcon\Forms\Element   Uses Phalcon\Tag   Extends AbstractElement

Phalcon\Forms\Element\Radio

Component INPUT[type=radio] for forms

Métodos

public function render( array $attributes = [] ): string;

Renders the element widget returning HTML

Class Phalcon\Forms\Element\Select

Código fuente en GitHub

Namespace Phalcon\Forms\Element   Uses Phalcon\Tag\Select   Extends AbstractElement

Phalcon\Forms\Element\Select

Component SELECT (choice) for forms

Propiedades

//
protected optionsValues;

Métodos

public function __construct( string $name, mixed $options = null, mixed $attributes = null );

Phalcon\Forms\Element constructor

public function addOption( mixed $option ): ElementInterface;

Adds an option to the current options

public function getOptions();

Returns the choices’ options

public function render( array $attributes = [] ): string;

Renders the element widget returning HTML

public function setOptions( mixed $options ): ElementInterface;

Set the choice’s options

Class Phalcon\Forms\Element\Submit

Código fuente en GitHub

Namespace Phalcon\Forms\Element   Uses Phalcon\Tag   Extends AbstractElement

Component INPUT[type=submit] for forms

Métodos

public function render( array $attributes = [] ): string;

Renders the element widget

Class Phalcon\Forms\Element\Text

Código fuente en GitHub

Namespace Phalcon\Forms\Element   Uses Phalcon\Tag   Extends AbstractElement

Phalcon\Forms\Element\Text

Component INPUT[type=text] for forms

Métodos

public function render( array $attributes = [] ): string;

Renders the element widget

Class Phalcon\Forms\Element\TextArea

Código fuente en GitHub

Namespace Phalcon\Forms\Element   Uses Phalcon\Tag   Extends AbstractElement

Component TEXTAREA for forms

Métodos

public function render( array $attributes = [] ): string;

Renders the element widget

Class Phalcon\Forms\Exception

Código fuente en GitHub

Namespace Phalcon\Forms   Extends \Phalcon\Exception

Exceptions thrown in Phalcon\Forms will use this class

Class Phalcon\Forms\Form

Código fuente en GitHub

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\Messages\Messages, Phalcon\Tag, Phalcon\Validation, Phalcon\Validation\ValidationInterface   Extends Injectable   Implements Countable, Iterator, AttributesInterface

This component allows to build forms using an object-oriented interface

Propiedades

/**
 * @var Attributes | null
 */
protected attributes;

//
protected data;

//
protected elements;

//
protected elementsIndexed;

//
protected entity;

//
protected messages;

//
protected position;

//
protected options;

//
protected validation;

Métodos

public function __construct( mixed $entity = null, array $userOptions = [] );

Phalcon\Forms\Form constructor

public function add( ElementInterface $element, string $position = null, bool $type = null ): Form;

Adds an element to the form

public function bind( array $data, mixed $entity, mixed $whitelist = null ): Form;

Binds data to the entity

public function clear( mixed $fields = null ): Form;

Clears every element in the form to its default value

public function count(): int;

Devuelve el número de elementos en la colección

public function current(): ElementInterface | bool;

Devuelve el elemento actual de la iteración

public function get( string $name ): ElementInterface;

Returns an element added to the form by its name

public function getAction(): string;

Devuelve la acción del formulario

public function getAttributes(): Attributes;

Get Form attributes collection

public function getElements(): ElementInterface[];

Devuelve los elementos añadidos al formulario

public function getEntity();

Devuelve la entidad relacionada con el modelo

public function getLabel( string $name ): string;

Returns a label for an element

public function getMessages(): Messages | array;

Devuelve los mensajes generados en la validación.

if ($form->isValid($_POST) == false) {
    $messages = $form->getMessages();

    foreach ($messages as $message) {
        echo $message, "<br>";
    }
}
public function getMessagesFor( string $name ): Messages;

Devuelve los mensajes generados para un elemento específico

public function getUserOption( string $option, mixed $defaultValue = null ): mixed;

Returns the value of an option if present

public function getUserOptions(): array;

Devuelve las opciones del elemento

public function getValidation()
public function getValue( string $name ): mixed | null;

Obtiene un valor de la entidad interna relacionada o del valor por defecto

public function has( string $name ): bool;

Comprueba si el formulario contiene un elemento

public function hasMessagesFor( string $name ): bool;

Comprueba si se han generado mensajes para un elemento específico

public function isValid( mixed $data = null, mixed $entity = null ): bool;

Validates the form

public function key(): int;

Devuelve la clave/posición actual del iterador

public function label( string $name, array $attributes = null ): string;

Generate the label of an element added to the form including HTML

public function next(): void;

Mueve el puntero interno de iteración a la siguiente posición

public function remove( string $name ): bool;

Elimina un elemento del formulario

public function render( string $name, array $attributes = [] ): string;

Renders a specific item in the form

public function rewind(): void;

Rebobina el iterador interno

public function setAction( string $action ): Form;

Establece la acción del formulario

public function setAttributes( Attributes $attributes ): AttributesInterface;

Establece la colección de atributos del formulario

public function setEntity( mixed $entity ): Form;

Establece la entidad relacionada con el modelo

public function setUserOption( string $option, mixed $value ): Form;

Sets an option for the form

public function setUserOptions( array $options ): Form;

Sets options for the element

public function setValidation( $validation )
public function valid(): bool;

Comprueba si el elemento actual en el iterador es válido

Class Phalcon\Forms\Manager

Código fuente en GitHub

Namespace Phalcon\Forms

Forms Manager

Propiedades

//
protected forms;

Métodos

public function create( string $name, mixed $entity = null ): Form;

Creates a form registering it in the forms manager

public function get( string $name ): Form;

Returns a form by its name

public function has( string $name ): bool;

Checks if a form is registered in the forms manager

public function set( string $name, Form $form ): Manager;

Registers a form in the Forms Manager