Listing_Search extends Form
Searches listings.
Table of Contents
- $action : string
- Action URL.
- $attributes : array<string|int, mixed>
- HTML attributes.
- $button : object
- Form button.
- $description : string
- Form description.
- $errors : array<string|int, mixed>
- Form errors.
- $fields : array<string|int, mixed>
- Form fields.
- $footer : string
- Footer HTML.
- $header : string
- Header HTML.
- $message : string
- Success message.
- $meta : array<string|int, mixed>
- Class meta values.
- $method : string
- HTTP method.
- $redirect : mixed
- Redirect on success?
- $reset : bool
- Reset on success?
- __construct() : mixed
- Class constructor.
- get_errors() : array<string|int, mixed>
- Gets form errors.
- get_fields() : array<string|int, mixed>
- Gets form fields.
- get_meta() : mixed
- Gets class meta values.
- get_method() : string
- Gets HTTP method.
- get_value() : mixed
- Gets field value.
- get_values() : array<string|int, mixed>
- Gets field values.
- init() : mixed
- Class initializer.
- render() : string
- Renders form HTML.
- set_value() : object
- Sets field value.
- set_values() : object
- Sets field values.
- validate() : bool
- Validates field values.
- add_errors() : mixed
- Adds form errors.
- boot() : mixed
- Bootstraps form properties.
- set_button() : mixed
- Sets form button.
- set_fields() : mixed
- Sets form fields.
- set_meta() : mixed
- Sets class meta values.
- set_property() : mixed
- Sets a property value.
Properties
$action
Action URL.
protected
string
$action
= ''
$attributes
HTML attributes.
protected
array<string|int, mixed>
$attributes
= []
$button
Form button.
protected
object
$button
$description
Form description.
protected
string
$description
$errors
Form errors.
protected
array<string|int, mixed>
$errors
= []
$fields
Form fields.
protected
array<string|int, mixed>
$fields
= []
$footer
Footer HTML.
protected
string
$footer
$header
Header HTML.
protected
string
$header
$message
Success message.
protected
string
$message
$meta
Class meta values.
protected
static array<string|int, mixed>
$meta
= []
$method
HTTP method.
protected
string
$method
= 'POST'
$redirect
Redirect on success?
protected
mixed
$redirect
$reset
Reset on success?
protected
bool
$reset
= false
Methods
__construct()
Class constructor.
public
__construct([array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $args : array<string|int, mixed> = []
-
Form arguments.
Return values
mixed —get_errors()
Gets form errors.
public
final get_errors() : array<string|int, mixed>
Return values
array<string|int, mixed> —get_fields()
Gets form fields.
public
final get_fields() : array<string|int, mixed>
Return values
array<string|int, mixed> —get_meta()
Gets class meta values.
public
final static get_meta([string $name = '' ]) : mixed
Parameters
- $name : string = ''
-
Meta name.
Return values
mixed —get_method()
Gets HTTP method.
public
final get_method() : string
Return values
string —get_value()
Gets field value.
public
final get_value(string $name) : mixed
Parameters
- $name : string
-
Field name.
Return values
mixed —get_values()
Gets field values.
public
final get_values() : array<string|int, mixed>
Return values
array<string|int, 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 —render()
Renders form HTML.
public
final render() : string
Return values
string —set_value()
Sets field value.
public
final set_value(string $name, mixed $value) : object
Parameters
- $name : string
-
Field name.
- $value : mixed
-
Field value.
Return values
object —set_values()
Sets field values.
public
set_values(array<string|int, mixed> $values[, bool $override = false ]) : object
Parameters
- $values : array<string|int, mixed>
-
Field values.
- $override : bool = false
-
Override only passed values?
Return values
object —validate()
Validates field values.
public
final validate() : bool
Return values
bool —add_errors()
Adds form errors.
protected
final add_errors(array<string|int, mixed> $errors) : mixed
Parameters
- $errors : array<string|int, mixed>
-
Form errors.
Return values
mixed —boot()
Bootstraps form properties.
protected
boot() : mixed
Return values
mixed —set_button()
Sets form button.
protected
final set_button(array<string|int, mixed> $button) : mixed
Parameters
- $button : array<string|int, mixed>
-
Button arguments.
Return values
mixed —set_fields()
Sets form fields.
protected
set_fields(array<string|int, mixed> $fields) : mixed
Parameters
- $fields : array<string|int, mixed>
-
Form fields.
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.