4.0
섹션

Abstract Class Phalcon\Forms\Element\AbstractElement

Source on 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

Properties

//
protected attributes;

//
protected filters;

//
protected form;

//
protected label;

//
protected messages;

//
protected name;

//
protected options;

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

//
protected value;

Methods

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;

Returns the options for the element

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

Source on GitHub

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

Phalcon\Forms\Element\Check

Component INPUT[type=check] for forms

Methods

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

Renders the element widget returning HTML

Class Phalcon\Forms\Element\Date

Source on GitHub

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

Component INPUT[type=date] for forms

Methods

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

Renders the element widget returning html

Interface Phalcon\Forms\Element\ElementInterface

Source on GitHub

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

Interface for Phalcon\Forms\Element classes

Methods

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;

Returns the options for the element

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

Source on GitHub

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

Phalcon\Forms\Element\Email

Component INPUT[type=email] for forms

Methods

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

Renders the element widget returning HTML

Class Phalcon\Forms\Element\File

Source on GitHub

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

Component INPUT[type=file] for forms

Methods

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

Renders the element widget returning HTML

Class Phalcon\Forms\Element\Hidden

Source on GitHub

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

Phalcon\Forms\Element\Hidden

Component INPUT[type=hidden] for forms

Methods

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

Renders the element widget returning HTML

Class Phalcon\Forms\Element\Numeric

Source on GitHub

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

Phalcon\Forms\Element\Numeric

Component INPUT[type=number] for forms

Methods

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

Renders the element widget returning HTML

Class Phalcon\Forms\Element\Password

Source on GitHub

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

Phalcon\Forms\Element\Password

Component INPUT[type=password] for forms

Methods

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

Renders the element widget returning HTML

Class Phalcon\Forms\Element\Radio

Source on GitHub

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

Phalcon\Forms\Element\Radio

Component INPUT[type=radio] for forms

Methods

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

Renders the element widget returning HTML

Class Phalcon\Forms\Element\Select

Source on GitHub

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

Phalcon\Forms\Element\Select

Component SELECT (choice) for forms

Properties

//
protected optionsValues;

Methods

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

Source on GitHub

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

Component INPUT[type=submit] for forms

Methods

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

Renders the element widget

Class Phalcon\Forms\Element\Text

Source on GitHub

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

Phalcon\Forms\Element\Text

Component INPUT[type=text] for forms

Methods

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

Renders the element widget

Class Phalcon\Forms\Element\TextArea

Source on GitHub

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

Component TEXTAREA for forms

Methods

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

Renders the element widget

Class Phalcon\Forms\Exception

Source on GitHub

Namespace Phalcon\Forms   Extends \Phalcon\Exception

Exceptions thrown in Phalcon\Forms will use this class

Class Phalcon\Forms\Form

Source on 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

Properties

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

//
protected data;

//
protected elements;

//
protected elementsIndexed;

//
protected entity;

//
protected messages;

//
protected position;

//
protected options;

//
protected validation;

Methods

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;

Returns the number of elements in the form

public function current(): ElementInterface | bool;

Returns the current element in the iterator

public function get( string $name ): ElementInterface;

Returns an element added to the form by its name

public function getAction(): string;

Returns the form’s action

public function getAttributes(): Attributes;

Get Form attributes collection

public function getElements(): ElementInterface[];

Returns the form elements added to the form

public function getEntity();

Returns the entity related to the model

public function getLabel( string $name ): string;

Returns a label for an element

public function getMessages(): Messages | array;

Returns the messages generated in the validation.

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

    foreach ($messages as $message) {
        echo $message, "<br>";
    }
}

public function getMessagesFor( string $name ): Messages;

Returns the messages generated for a specific element

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

Returns the value of an option if present

public function getUserOptions(): array;

Returns the options for the element

public function getValidation()

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

Gets a value from the internal related entity or from the default value

public function has( string $name ): bool;

Check if the form contains an element

public function hasMessagesFor( string $name ): bool;

Check if messages were generated for a specific element

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

Validates the form

public function key(): int;

Returns the current position/key in the iterator

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;

Moves the internal iteration pointer to the next position

public function remove( string $name ): bool;

Removes an element from the form

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

Renders a specific item in the form

public function rewind(): void;

Rewinds the internal iterator

public function setAction( string $action ): Form;

Sets the form’s action

public function setAttributes( Attributes $attributes ): AttributesInterface;

Set form attributes collection

public function setEntity( mixed $entity ): Form;

Sets the entity related to the model

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;

Check if the current element in the iterator is valid

Class Phalcon\Forms\Manager

Source on GitHub

Namespace Phalcon\Forms

Forms Manager

Properties

//
protected forms;

Methods

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

일반 정보
소 개
릴리스 노트
업그레이드
후원자
기여하기
개요
Pull Requests
NFR
Backtrace 생성
재현가능한 테스트
테스트 환경
코딩 표준
시작하기
설치
웹서버 설정
개발환경
Devilbox
Nanobox
개발 도구
개발도구
디버그
마이그레이션
Unit Testing
튜토리얼
기초
Invo
REST
Vokuro
활용 예시
성능
핵심
API 인덱스
어플리케이션
마이크로
Cli
DI 컨테이너
MVC
네임스페이스
서비스
캐시
구성
Escaper
로더
로거
데이터베이스
레이어
PHQL
ODM
모델
Behaviors
캐시
이벤트
메타데이터
관계
트랜잭션
검사기
페이지 나누기
마이그레이션
프론트 엔드
Assets
플래시 메신저
Forms
이미지
태그
뷰
Volt
비즈니스 로직
접근제어목록(ACL)
주석
컨트롤러
디스패쳐
이벤트 관리자
필터
라우팅
세션
Url
유효성 검사
HTTP
쿠키
요청
응답
보안
암호화
보안
JWT
PSR
PSR-3 로거
PSR-0, PSR-4 로더
PSR-7 HTTP 요청
PSR-7 HTTP 응답
PSR-7 HTTP 서버 요청
PSR-7 HTTP 스트림
PSR-7 HTTP UploadedFile
PSR-7 HTTP Uri
PSR-11 컨테이너
PSR-13 HTML 링크
PSR-17 HTTP 팩토리
i18n
다국어 지원
번역
유틸리티
컬렉션
도메인
HTML
헬퍼
레지스트리