Código fuente en GitHub
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 |
Esta es una clase base para elementos de formulario
Propiedades
/**
* @var array
*/
protected attributes;
/**
* @var array
*/
protected filters;
/**
* @var Form|null
*/
protected form;
/**
* @var string|null
*/
protected label;
/**
* @var string
*/
protected method = inputText;
/**
* @var Messages
*/
protected messages;
/**
* @var string
*/
protected name;
/**
* @var array
*/
protected options;
/**
* @var TagFactory|null
*/
protected tagFactory;
/**
* @var array
*/
protected validators;
/**
* @var mixed|null
*/
protected value;
Métodos
public function __construct( string $name, array $attributes = [] );
Constructor
public function __toString(): string;
El método mágico __toString renderiza el widget sin atributos
public function addFilter( string $filter ): ElementInterface;
Añade un filtro a la lista actual de filtros
public function addValidator( ValidatorInterface $validator ): ElementInterface;
Añade una validación al elemento
public function addValidators( array $validators, bool $merge = bool ): ElementInterface;
Añade un grupo de validaciones
public function appendMessage( MessageInterface $message ): ElementInterface;
Añade un mensaje a la lista interna de mensajes
public function clear(): ElementInterface;
Restablece el elemento a su valor por defecto
public function getAttribute( string $attribute, mixed $defaultValue = null ): mixed;
Devuelve el valor de un atributo si existe
public function getAttributes(): array;
Devuelve los valores por defecto de los atributos del elemento
public function getDefault(): mixed;
Devuelve el valor por defecto asignado al elemento
public function getFilters();
Devuelve los filtros del elemento
public function getForm(): Form;
Devuelve el formulario padre al elemento
public function getLabel(): string;
Devuelve la etiqueta del elemento
public function getMessages(): Messages;
Devuelve los mensajes que pertenecen al elemento El elemento necesita ser parte de un formulario
public function getName(): string;
Devuelve el nombre del elemento
public function getTagFactory(): TagFactory | null;
Returns the tagFactory; throws exception if not present
public function getUserOption( string $option, mixed $defaultValue = null ): mixed;
Devuelve el valor de una opción si existe
public function getUserOptions(): array;
Devuelve las opciones del elemento
public function getValidators(): ValidatorInterface[];
Devuelve los validadores registrados para el elemento
public function getValue(): mixed;
Devuelve el valor del elemento
public function hasMessages(): bool;
Comprueba si hay mensajes vinculados al elemento
public function label( array $attributes = [] ): string;
Genera el HTML para etiquetar al elemento
public function render( array $attributes = [] ): string;
Renderiza el widget del elemento devolviendo HTML
public function setAttribute( string $attribute, mixed $value ): ElementInterface;
Establece un atributo predeterminado para el elemento
public function setAttributes( array $attributes ): ElementInterface;
Establece atributos predeterminados para el elemento
public function setDefault( mixed $value ): ElementInterface;
Establece un valor predeterminado en caso de que el formulario no use una entidad o no tenga ningún valor disponible para el elemento en el _POST
public function setFilters( mixed $filters ): ElementInterface;
Establece los filtros del elemento
public function setForm( Form $form ): ElementInterface;
Establece el formulario padre del elemento
public function setLabel( string $label ): ElementInterface;
Establece la etiqueta del elemento
public function setMessages( Messages $messages ): ElementInterface;
Establece los mensajes de validación relacionados con el elemento
public function setName( string $name ): ElementInterface;
Establece el nombre del elemento
public function setTagFactory( TagFactory $tagFactory ): AbstractElement;
Sets the TagFactory
public function setUserOption( string $option, mixed $value ): ElementInterface;
Establece una opción para el elemento
public function setUserOptions( array $options ): ElementInterface;
Establece las opciones para el elemento
protected function getLocalTagFactory(): TagFactory;
Returns the tagFactory; throws exception if not present
Código fuente en GitHub
Namespace |
Phalcon\Forms\Element |
|
Extends |
AbstractElement |
Componente INPUT[type=check] para formularios
Propiedades
/**
* @var string
*/
protected method = inputCheckbox;
Código fuente en GitHub
Namespace |
Phalcon\Forms\Element |
|
Uses |
Phalcon\Tag |
|
Extends |
AbstractElement |
Componente INPUT[type=date] para formularios
Propiedades
/**
* @var string
*/
protected method = inputDate;
Código fuente en GitHub
Namespace |
Phalcon\Forms\Element |
|
Uses |
Phalcon\Forms\Form, Phalcon\Messages\MessageInterface, Phalcon\Messages\Messages, Phalcon\Filter\Validation\ValidatorInterface |
Interfaz para clases Phalcon\Forms\Element
Métodos
public function addFilter( string $filter ): ElementInterface;
Añade un filtro a la lista actual de filtros
public function addValidator( ValidatorInterface $validator ): ElementInterface;
Añade una validación al elemento
public function addValidators( array $validators, bool $merge = bool ): ElementInterface;
Añade un grupo de validaciones
public function appendMessage( MessageInterface $message ): ElementInterface;
Añade un mensaje a la lista interna de mensajes
public function clear(): ElementInterface;
Restaura cada elemento del formulario a su valor predeterminado
public function getAttribute( string $attribute, mixed $defaultValue = null ): mixed;
Devuelve el valor de un atributo si existe
public function getAttributes(): array;
Devuelve los valores por defecto de los atributos del elemento
public function getDefault(): mixed;
Devuelve el valor por defecto asignado al elemento
public function getFilters();
Devuelve los filtros del elemento
public function getForm(): Form;
Devuelve el formulario padre al elemento
public function getLabel(): string;
Devuelve la etiqueta del elemento
public function getMessages(): Messages;
Devuelve los mensajes que pertenecen al elemento El elemento necesita ser parte de un formulario
public function getName(): string;
Devuelve el nombre del elemento
public function getUserOption( string $option, mixed $defaultValue = null ): mixed;
Devuelve el valor de una opción si existe
public function getUserOptions(): array;
Devuelve las opciones del elemento
public function getValidators(): ValidatorInterface[];
Devuelve los validadores registrados para el elemento
public function getValue(): mixed;
Devuelve el valor del elemento
public function hasMessages(): bool;
Comprueba si hay mensajes vinculados al elemento
public function label(): string;
Genera el HTML para etiquetar al elemento
public function render( array $attributes = [] ): string;
Renderiza el widget del elemento
public function setAttribute( string $attribute, mixed $value ): ElementInterface;
Establece un atributo predeterminado para el elemento
public function setAttributes( array $attributes ): ElementInterface;
Establece atributos predeterminados para el elemento
public function setDefault( mixed $value ): ElementInterface;
Establece un valor predeterminado en caso de que el formulario no use una entidad o no tenga ningún valor disponible para el elemento en el _POST
public function setFilters( mixed $filters ): ElementInterface;
Establece los filtros del elemento
public function setForm( Form $form ): ElementInterface;
Establece el formulario padre del elemento
public function setLabel( string $label ): ElementInterface;
Establece la etiqueta del elemento
public function setMessages( Messages $messages ): ElementInterface;
Establece los mensajes de validación relacionados con el elemento
public function setName( string $name ): ElementInterface;
Establece el nombre del elemento
public function setUserOption( string $option, mixed $value ): ElementInterface;
Establece una opción para el elemento
public function setUserOptions( array $options ): ElementInterface;
Establece las opciones para el elemento
Código fuente en GitHub
Namespace |
Phalcon\Forms\Element |
|
Uses |
Phalcon\Tag |
|
Extends |
AbstractElement |
Componente INPUT[type=email] para formularios
Propiedades
/**
* @var string
*/
protected method = inputEmail;
Código fuente en GitHub
Namespace |
Phalcon\Forms\Element |
|
Uses |
Phalcon\Tag |
|
Extends |
AbstractElement |
Componente INPUT[type=file] para formularios
Propiedades
/**
* @var string
*/
protected method = inputFile;
Código fuente en GitHub
Namespace |
Phalcon\Forms\Element |
|
Uses |
Phalcon\Tag |
|
Extends |
AbstractElement |
Componente INPUT[type=hidden] para formularios
Propiedades
/**
* @var string
*/
protected method = inputHidden;
Código fuente en GitHub
Namespace |
Phalcon\Forms\Element |
|
Uses |
Phalcon\Tag |
|
Extends |
AbstractElement |
Componente INPUT[type=number] para formularios
Propiedades
/**
* @var string
*/
protected method = inputNumeric;
Código fuente en GitHub
Namespace |
Phalcon\Forms\Element |
|
Uses |
Phalcon\Tag |
|
Extends |
AbstractElement |
Componente INPUT[type=password] para formularios
Propiedades
/**
* @var string
*/
protected method = inputPassword;
Código fuente en GitHub
Namespace |
Phalcon\Forms\Element |
|
Uses |
Phalcon\Tag |
|
Extends |
AbstractElement |
Componente INPUT[type=radio] para formularios
Propiedades
/**
* @var string
*/
protected method = inputRadio;
Código fuente en GitHub
Namespace |
Phalcon\Forms\Element |
|
Uses |
Phalcon\Tag\Select |
|
Extends |
AbstractElement |
Componente SELECT (elección) para formularios
Propiedades
/**
* @var object|array|null
*/
protected optionsValues;
Métodos
public function __construct( string $name, mixed $options = null, array $attributes = [] );
Constructor
public function addOption( mixed $option ): ElementInterface;
Añade una opción a las opciones actuales
public function getOptions();
Devuelve las opciones de selección
public function render( array $attributes = [] ): string;
Renderiza el widget del elemento devolviendo HTML
public function setOptions( mixed $options ): ElementInterface;
Establece las opciones a elegir
protected function prepareAttributes( array $attributes = [] ): array;
Returns an array of prepared attributes for Phalcon\Html\TagFactory helpers according to the element parameters
Código fuente en GitHub
Namespace |
Phalcon\Forms\Element |
|
Uses |
Phalcon\Tag |
|
Extends |
AbstractElement |
Componente INPUT[type=submit] para formularios
Propiedades
/**
* @var string
*/
protected method = inputSubmit;
Class Phalcon\Forms\Element\Text
Código fuente en GitHub
Namespace |
Phalcon\Forms\Element |
|
Uses |
Phalcon\Forms\Exception |
|
Extends |
AbstractElement |
Componente INPUT[type=text] para formularios
Class Phalcon\Forms\Element\TextArea
Código fuente en GitHub
Namespace |
Phalcon\Forms\Element |
|
Uses |
Phalcon\Tag |
|
Extends |
AbstractElement |
Componente TEXTAREA para formularios
Propiedades
/**
* @var string
*/
protected method = inputTextarea;
Código fuente en GitHub
Namespace |
Phalcon\Forms |
|
Extends |
\Exception |
Las excepciones lanzadas en Phalcon\Forms usarán esta clase
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\Html\TagFactory, Phalcon\Messages\Messages, Phalcon\Tag, Phalcon\Filter\Validation, Phalcon\Filter\Validation\ValidationInterface |
|
Extends |
Injectable |
|
Implements |
Countable, Iterator, AttributesInterface |
Este componente permite construir formularios usando un interfaz orientado a objetos
Propiedades
/**
* @var AttributesInterface|null
*/
protected attributes;
/**
* @var array
*/
protected data;
/**
* @var array
*/
protected filteredData;
/**
* @var array
*/
protected elements;
/**
* @var array
*/
protected elementsIndexed;
/**
* @var object|null
*/
protected entity;
/**
* @var Messages|array|null
*/
protected messages;
/**
* @var int
*/
protected position = 0;
/**
* @var array
*/
protected options;
/**
* @var TagFactory|null
*/
protected tagFactory;
/**
* @var ValidationInterface|null
*/
protected validation;
/**
* @var array
*/
protected whitelist;
Métodos
public function __construct( mixed $entity = null, array $userOptions = [] );
Constructor Phalcon\Forms\Form
public function add( ElementInterface $element, string $position = null, bool $type = null ): Form;
Añade un elemento al formulario
public function bind( array $data, mixed $entity = null, array $whitelist = [] ): Form;
Vincula datos a la entidad
public function clear( mixed $fields = null ): Form;
Restaura cada elemento del formulario a su valor predeterminado
public function count(): int;
Devuelve el número de elementos en la colección
public function current(): mixed;
Devuelve el elemento actual de la iteración
public function get( string $name ): ElementInterface;
Devuelve un elemento añadido al formulario por su nombre
public function getAction(): string;
Devuelve la acción del formulario
public function getAttributes(): Attributes;
Devuelve la colección de atributos del Formulario
public function getElements(): ElementInterface[];
Devuelve los elementos añadidos al formulario
public function getEntity();
Devuelve la entidad relacionada con el modelo
public function getFilteredValue( string $name ): mixed | null;
Gets a value from the internal filtered data or calls getValue(name)
public function getLabel( string $name ): string;
Devuelve una etiqueta para un elemento
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 getTagFactory(): TagFactory | null;
Returns the tagFactory object
public function getUserOption( string $option, mixed $defaultValue = null ): mixed;
Devuelve el valor de una opción si existe
public function getUserOptions(): array;
Devuelve las opciones del elemento
public function getValidation(): ValidationInterface | null;
return ValidationInterface|null
public function getValue( string $name ): mixed | null;
Obtiene un valor de la entidad interna relacionada o del valor por defecto
public function getWhitelist(): array;
return array
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, array $whitelist = [] ): bool;
Valida el formulario
public function key(): int;
Devuelve la clave/posición actual del iterador
public function label( string $name, array $attributes = [] ): string;
Genera la etiqueta de un elemento añadido al formulario incluyendo 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;
Renderiza un objeto específico en el formulario
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 setTagFactory( TagFactory $tagFactory ): Form;
Sets the tagFactory for the form
public function setUserOption( string $option, mixed $value ): Form;
Establece una opción para el formulario
public function setUserOptions( array $options ): Form;
Establece las opciones para el elemento
public function setValidation( ValidationInterface $validation ): Form;
Sets the default validation
public function setWhitelist( array $whitelist ): Form;
Sets the default whitelist
public function valid(): bool;
Comprueba si el elemento actual en el iterador es válido
Código fuente en GitHub
Gestor de Formularios
Propiedades
/**
* @var array
*/
protected forms;
Métodos
public function create( string $name, mixed $entity = null ): Form;
Crea un formulario registrándolo en el gestor de formularios
public function get( string $name ): Form;
Devuelve un formulario por su nombre
public function has( string $name ): bool;
Comprueba si un formulario está registrado en el gestor de formularios
public function set( string $name, Form $form ): Manager;
Registra un formulario en el Gestor de Formularios