Document_Grid_Html

Handles the display of a Document_Grid

Tags
author

Barn2 Plugins support@barn2.com

license

GPL-3.0

copyright

Barn2 Media Ltd

Table of Contents

$args  : mixed
$grid_cards  : mixed
$id  : mixed
$query  : mixed
$documents  : mixed
$html  : mixed
$html_parts  : mixed
__construct()  : mixed
Constructor.
generate_html()  : string
Generates the grid HTML.
get_html()  : string
Get the grid HTML.
get_html_parts()  : array<string|int, mixed>
Get the grid HTML parts.
generate_html_parts()  : string
Generate the grid HTML parts
get_filters_html()  : string
Gets the Filters HTML.
get_footer_html()  : string
Gets the Grid Footer HTML.
get_grid_html()  : string
Gets the Main Grid Section HTML.
get_header_html()  : string
Get thes the Grid Header HTML.
get_pagination_html()  : string
Gets the Pagination HTML.
get_reset_button()  : string
Gets the Reset Button HTML
get_result_count()  : string
Gets the Result Count HTML.
get_search_box()  : string
Gets the Search Box HTML.
get_totals_html()  : string
Gets the Totals HTML.

Properties

Methods

generate_html()

Generates the grid HTML.

public generate_html() : string
Tags
Return values
string

get_html()

Get the grid HTML.

public get_html() : string
Tags
Return values
string

get_html_parts()

Get the grid HTML parts.

public get_html_parts() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>

generate_html_parts()

Generate the grid HTML parts

private generate_html_parts() : string
Tags
Return values
string

get_filters_html()

Gets the Filters HTML.

private get_filters_html([string $context = 'top' ]) : string
Parameters
$context : string = 'top'
Tags
Return values
string

Gets the Grid Footer HTML.

private get_footer_html() : string
Tags
Return values
string

get_grid_html()

Gets the Main Grid Section HTML.

private get_grid_html() : string
Tags
Return values
string

get_header_html()

Get thes the Grid Header HTML.

private get_header_html() : string
Tags
Return values
string

get_pagination_html()

Gets the Pagination HTML.

private get_pagination_html([string $context = 'top' ]) : string
Parameters
$context : string = 'top'
Tags
Return values
string

get_reset_button()

Gets the Reset Button HTML

private get_reset_button() : string
Tags
Return values
string

get_result_count()

Gets the Result Count HTML.

private get_result_count() : string
Tags
Return values
string

Gets the Search Box HTML.

private get_search_box() : string
Tags
Return values
string

get_totals_html()

Gets the Totals HTML.

private get_totals_html([string $context = 'top' ]) : string
Parameters
$context : string = 'top'
Tags
Return values
string

Search results