Class View

A view on provided data.

ICanBoogie\Object implements ICanBoogie\ToArrayRecursive uses ICanBoogie\ToArrayRecursiveTrait, ICanBoogie\PrototypeTrait

Icybee\Modules\Views\View

Direct known subclasses

Icybee\Modules\Articles\ArchivesView, Icybee\Modules\Pages\ListView

Namespace: Icybee\Modules\Views
Located at vendor/icanboogie-modules/views/lib/view.php

Methods summary

`protected`	# `get_id( )`
`protected`	# `get_options( )`
`protected`	# `lazy_get_module( )`
`protected`	# `get_data( )`
`public`	# `__construct( mixed $id, array $options, mixed $engine, mixed $document, mixed $page, mixed $template = null )`
`public mixed`	# `__invoke( )` Renders the view. Renders the view. Returns `mixed`
`protected BlueTihi\Context`	# `alter_context( BlueTihi\Context $context )` Alters template context. Alters template context. Parameters `$context` `BlueTihi\Context` $context Returns `BlueTihi\Context`
`protected`	# `add_assets( Brickrouge\Document $document, array $assets = array() )` Adds view's assets to the document. Adds view's assets to the document. Parameters `$document` `WdDocument` $document `$assets` `array` $assets
`protected mixed`	# `fire_render_before( array $params = array() )` Fires the `render:before` event on the view using the specified parameters. Fires the `render:before` event on the view using the specified parameters. Parameters `$params` `array` $params Returns `mixed`
`protected mixed`	# `fire_render( array $params = array() )` Fires the `render` event on the view using the specified parameters. Fires the `render` event on the view using the specified parameters. Parameters `$params` `array` $params Returns `mixed`
`protected string`	# `render_empty_inner_html( )` Returns the placeholder for the empty view. Returns the placeholder for the empty view. Returns `string`
`protected mixed`	# `fire_render_empty_inner_html( array $payload = array() )` Fires `Icybee\Modules\Views\View\RescueEvent` using the specified payload. Fires `Icybee\Modules\Views\View\RescueEvent` using the specified payload. Parameters `$payload` `array` $payload Returns `mixed`
`protected`	# `init_range( )`
`protected`	# `provide( mixed $provider, mixed & $context, array $conditions )`
`protected string`	# `render_inner_html( mixed $template_path, mixed $engine )` Renders the inner HTML of the view. Renders the inner HTML of the view. If the data provided implements `Brickrouge\CSSClassNames`, the class names of the record are added those of the view element. Returns `string` The inner HTML of the view element. Throws `ICanBoogie\Exception`
`protected`	# `get_element( )`
`protected`	# `alter_element( Brickrouge\Element $element )`
`protected string`	# `render_outer_html( )` Returns the HTML representation of the view element and its content. Returns the HTML representation of the view element and its content. Returns `string`
`protected Icybee\Modules\Views\TemplateResolver`	# `lazy_get_template_resolver( )` Returns the template resolver of the view. Returns the template resolver of the view. Returns `Icybee\Modules\Views\TemplateResolver`
`protected string`	# `resolve_template_location( )` Resolves the template location of the view. Resolves the template location of the view. The template location is resolved using a `Icybee\Modules\Views\TemplateResolver` instance. Returns `string` Throws `ICanBoogie\Exception` if the template location could not be resolved.
`protected boolean`	# `validate_access( )` Checks if the view access is valid. Checks if the view access is valid. Returns `boolean` true Throws `ICanBoogie\HTTP\HTTPError` when the view access requires authentication.

Magic methods summary

Constants summary

`string`	`ACCESS_CALLBACK`	`'access_callback'`	#
`string`	`ASSETS`	`'assets'`	#
`string`	`CLASSNAME`	`'class'`	#
`string`	`PROVIDER`	`'provider'`	#
`string`	`RENDERS`	`'renders'`	#
`integer`	`RENDERS_ONE`	`1`	#
`integer`	`RENDERS_MANY`	`2`	#
`integer`	`RENDERS_OTHER`	`3`	#
`string`	`TITLE`	`'title'`	#

Properties summary

`protected mixed`	`$id`	#
`protected integer`	`$renders`	# The amount of data the view is rendering. The amount of data the view is rendering. RENDERS_ONE: Renders a record. RENDERS_MANY: Renders an array of records. A 'range' value is added to the rendering context the following properties: - (int) limit: The maximum number of record to render. - (int) page: The starting page. - (int) count: The total number of records. This value is to be entered by the provider. RENDERS_OTHER: Renders an unknown amount of data. The property is read-only.
`protected mixed`	`$options`	#
`protected mixed`	`$engine`	#
`protected mixed`	`$document`	#
`protected mixed`	`$page`	#
`protected mixed`	`$template`	#
`protected mixed`	`$module`	#
`public mixed`	`$module_id`	#
`public mixed`	`$type`	#
`protected mixed`	`$element`	#

Magic properties

`public read-only string`	`$id`		# The identifier of the view. The identifier of the view.
`public read-only mixed`	`$data`		# The data provided by the view's provider. The data provided by the view's provider.

Magic properties inherited from ICanBoogie\Object

$prototype

Namespaces

Classes

Class View

Direct known subclasses

Methods summary

Returns

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Throws

Returns

Returns

Returns

Throws

Returns

Throws

Methods inherited from ICanBoogie\Object

Methods inherited from ICanBoogie\ToArrayRecursive

Methods used from ICanBoogie\ToArrayRecursiveTrait

Methods used from ICanBoogie\PrototypeTrait

Magic methods summary

Constants summary

Properties summary

Magic properties

Magic properties inherited from ICanBoogie\Object