Password extends Text
Password.
Table of Contents
- $args : array<string|int, mixed>
- Field arguments.
- $attributes : array<string|int, mixed>
- HTML attributes.
- $context : array<string|int, mixed>
- Object context values.
- $description : string
- Field description.
- $disabled : bool
- Disable this field?
- $display_template : string
- Display template.
- $display_type : string
- Display type.
- $errors : array<string|int, mixed>
- Field errors.
- $filter : mixed
- SQL filter.
- $html : mixed
- Allow HTML?
- $label : string
- Field label.
- $max_length : int
- Maximum text length.
- $meta : array<string|int, mixed>
- Class meta values.
- $min_length : int
- Minimum text length.
- $name : string
- Field name.
- $parent_value : mixed
- Parent field value.
- $pattern : string
- Regex pattern.
- $placeholder : string
- Field placeholder.
- $readonly : bool
- Make text read-only?
- $required : bool
- Is value required?
- $statuses : array<string|int, mixed>
- Field statuses.
- $value : mixed
- Field value.
- __construct() : mixed
- Class constructor.
- display() : string
- Displays field HTML.
- get_arg() : mixed
- Gets field argument.
- get_args() : array<string|int, mixed>
- Gets field arguments.
- get_context() : mixed
- Gets object context values.
- get_description() : string
- Gets field description.
- get_display_type() : string
- Gets display type.
- get_display_value() : mixed
- Gets field value for display.
- get_errors() : array<string|int, mixed>
- Gets field errors.
- get_filter() : mixed
- Gets SQL filter.
- get_label() : string
- Gets field label.
- get_meta() : mixed
- Gets class meta values.
- get_name() : string
- Gets field name.
- get_slug() : string
- Gets field slug.
- get_statuses() : array<string|int, mixed>
- Gets field statuses.
- get_value() : mixed
- Gets field value.
- init() : mixed
- Class initializer.
- is_disabled() : bool
- Checks if field is disabled.
- is_required() : bool
- Checks if field is required.
- render() : string
- Renders field HTML.
- set_parent_value() : object
- Sets parent field value.
- set_value() : object
- Sets field value.
- update_filter() : mixed
- Updates SQL filter.
- validate() : bool
- Validates field value.
- add_errors() : mixed
- Adds field errors.
- add_filter() : mixed
- Adds SQL filter.
- boot() : mixed
- Bootstraps field properties.
- normalize() : mixed
- Normalizes field value.
- sanitize() : mixed
- Sanitizes field value.
- set_display_template() : mixed
- Sets field display template.
- set_meta() : mixed
- Sets class meta values.
- set_property() : mixed
- Sets a property value.
Properties
$args
Field arguments.
protected
array<string|int, mixed>
$args
= []
$attributes
HTML attributes.
protected
array<string|int, mixed>
$attributes
= []
$context
Object context values.
protected
array<string|int, mixed>
$context
= []
$description
Field description.
protected
string
$description
$disabled
Disable this field?
protected
bool
$disabled
= false
$display_template
Display template.
protected
string
$display_template
$display_type
Display type.
protected
string
$display_type
$errors
Field errors.
protected
array<string|int, mixed>
$errors
= []
$filter
SQL filter.
protected
mixed
$filter
$html
Allow HTML?
protected
mixed
$html
= false
$label
Field label.
protected
string
$label
$max_length
Maximum text length.
protected
int
$max_length
$meta
Class meta values.
protected
static array<string|int, mixed>
$meta
= []
$min_length
Minimum text length.
protected
int
$min_length
$name
Field name.
protected
string
$name
$parent_value
Parent field value.
protected
mixed
$parent_value
$pattern
Regex pattern.
protected
string
$pattern
$placeholder
Field placeholder.
protected
string
$placeholder
$readonly
Make text read-only?
protected
bool
$readonly
= false
$required
Is value required?
protected
bool
$required
= false
$statuses
Field statuses.
protected
array<string|int, mixed>
$statuses
= []
$value
Field value.
protected
mixed
$value
Methods
__construct()
Class constructor.
public
__construct([array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $args : array<string|int, mixed> = []
-
Field arguments.
Return values
mixed —display()
Displays field HTML.
public
display() : string
Return values
string —get_arg()
Gets field argument.
public
final get_arg(string $name) : mixed
Parameters
- $name : string
-
Argument name.
Return values
mixed —get_args()
Gets field arguments.
public
final get_args() : array<string|int, mixed>
Return values
array<string|int, mixed> —get_context()
Gets object context values.
public
final get_context([string $name = null ][, mixed $default = null ]) : mixed
Parameters
- $name : string = null
-
Context name.
- $default : mixed = null
-
Default value.
Return values
mixed —get_description()
Gets field description.
public
final get_description() : string
Return values
string —get_display_type()
Gets display type.
public
final get_display_type() : string
Return values
string —get_display_value()
Gets field value for display.
public
get_display_value() : mixed
Return values
mixed —get_errors()
Gets field errors.
public
final get_errors() : array<string|int, mixed>
Return values
array<string|int, mixed> —get_filter()
Gets SQL filter.
public
final get_filter() : mixed
Return values
mixed —get_label()
Gets field label.
public
final get_label([mixed $default = null ]) : string
Parameters
- $default : mixed = null
-
Default label.
Return values
string —get_meta()
Gets class meta values.
public
final static get_meta([string $name = '' ]) : mixed
Parameters
- $name : string = ''
-
Meta name.
Return values
mixed —get_name()
Gets field name.
public
final get_name() : string
Return values
string —get_slug()
Gets field slug.
public
final get_slug() : string
Return values
string —get_statuses()
Gets field statuses.
public
final get_statuses() : array<string|int, mixed>
Return values
array<string|int, mixed> —get_value()
Gets field value.
public
final get_value() : mixed
Return values
mixed —init()
Class initializer.
public
static init([array<string|int, mixed> $meta = [] ]) : mixed
Parameters
- $meta : array<string|int, mixed> = []
-
Class meta values.
Return values
mixed —is_disabled()
Checks if field is disabled.
public
final is_disabled() : bool
Return values
bool —is_required()
Checks if field is required.
public
final is_required() : bool
Return values
bool —render()
Renders field HTML.
public
render() : string
Return values
string —set_parent_value()
Sets parent field value.
public
set_parent_value(mixed $value) : object
Parameters
- $value : mixed
-
Field value.
Return values
object —set_value()
Sets field value.
public
set_value(mixed $value) : object
Parameters
- $value : mixed
-
Field value.
Return values
object —update_filter()
Updates SQL filter.
public
final update_filter([bool $force = false ]) : mixed
Parameters
- $force : bool = false
-
Force update?
Return values
mixed —validate()
Validates field value.
public
validate() : bool
Return values
bool —add_errors()
Adds field errors.
protected
final add_errors(mixed $errors) : mixed
Parameters
- $errors : mixed
-
Field errors.
Return values
mixed —add_filter()
Adds SQL filter.
protected
add_filter() : mixed
Return values
mixed —boot()
Bootstraps field properties.
protected
boot() : mixed
Return values
mixed —normalize()
Normalizes field value.
protected
normalize() : mixed
Return values
mixed —sanitize()
Sanitizes field value.
protected
sanitize() : mixed
Return values
mixed —set_display_template()
Sets field display template.
protected
set_display_template(string $display_template) : mixed
Parameters
- $display_template : string
-
Display template.
Return values
mixed —set_meta()
Sets class meta values.
protected
final static set_meta(array<string|int, mixed> $meta) : mixed
Parameters
- $meta : array<string|int, mixed>
-
Meta values.
Return values
mixed —set_property()
Sets a property value.
protected
final set_property(string $name, mixed $value[, string $prefix = '' ]) : mixed
Parameters
- $name : string
-
Property name.
- $value : mixed
-
Property value.
- $prefix : string = ''
-
Method prefix.