Listing_Hide_Toggle extends Toggle
Renders the listing hide toggle.
Table of Contents
- $active : bool
- Is toggle active?
- $args : array<string|int, mixed>
- Block arguments.
- $attributes : array<string|int, mixed>
- HTML attributes.
- $captions : array<string|int, mixed>
- Toggle captions.
- $context : array<string|int, mixed>
- Object context values.
- $icon : string
- Icon name.
- $meta : array<string|int, mixed>
- Class meta values.
- $name : string
- Block name.
- $states : array<string|int, mixed>
- Toggle states.
- $url : string
- Request URL.
- $view : string
- Toggle view.
- __construct() : mixed
- Class constructor.
- get_arg() : mixed
- Gets block argument.
- get_args() : array<string|int, mixed>
- Get block arguments.
- get_context() : mixed
- Gets object context values.
- get_meta() : mixed
- Gets class meta values.
- init() : mixed
- Class initializer.
- render() : string
- Renders block HTML.
- boot() : mixed
- Bootstraps block properties.
- set_context() : mixed
- Sets object context value.
- set_meta() : mixed
- Sets class meta values.
- set_property() : mixed
- Sets a property value.
Properties
$active
Is toggle active?
protected
bool
$active
= false
$args
Block arguments.
protected
array<string|int, mixed>
$args
= []
$attributes
HTML attributes.
protected
array<string|int, mixed>
$attributes
= []
$captions
Toggle captions.
protected
array<string|int, mixed>
$captions
= []
$context
Object context values.
protected
array<string|int, mixed>
$context
= []
$icon
Icon name.
protected
string
$icon
$meta
Class meta values.
protected
static array<string|int, mixed>
$meta
= []
$name
Block name.
protected
string
$name
$states
Toggle states.
protected
array<string|int, mixed>
$states
= []
$url
Request URL.
protected
string
$url
$view
Toggle view.
protected
string
$view
= 'link'
Methods
__construct()
Class constructor.
public
__construct([array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $args : array<string|int, mixed> = []
-
Block arguments.
Return values
mixed —get_arg()
Gets block argument.
public
final get_arg(string $name) : mixed
Parameters
- $name : string
-
Argument name.
Return values
mixed —get_args()
Get block 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_meta()
Gets class meta values.
public
final static get_meta([string $name = '' ]) : mixed
Parameters
- $name : string = ''
-
Meta name.
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 —render()
Renders block HTML.
public
abstract render() : string
Return values
string —boot()
Bootstraps block properties.
protected
boot() : mixed
Return values
mixed —set_context()
Sets object context value.
protected
final set_context(string $name[, mixed $value = null ]) : mixed
Parameters
- $name : string
-
Context name.
- $value : mixed = null
-
Context value.
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.