Document_Grid_Html
Handles the display of a Document_Grid
Tags
Table of Contents
- $args : mixed
- $columns : mixed
- $config : 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.
- build_taxonomy_options() : string
- Build taxonomy HTML <option>'s
- 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_page_length() : string
- Gets the Page Length 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_taxonomy_filters() : string
- Get taxonomy filters
- get_totals_html() : string
- Gets the Totals HTML.
Properties
$args
public
mixed
$args
$columns
public
mixed
$columns
$config
public
mixed
$config
$grid_cards
public
mixed
$grid_cards
$id
public
mixed
$id
$query
public
mixed
$query
$documents
protected
mixed
$documents
$html
private
mixed
$html
$html_parts
private
mixed
$html_parts
Methods
__construct()
Constructor.
public
__construct(mixed $id, array<string|int, mixed> $grid_cards, Grid_Query $query, Table_Args $args) : mixed
Parameters
- $id : mixed
- $grid_cards : array<string|int, mixed>
- $query : Grid_Query
- $args : Table_Args
Return values
mixed —generate_html()
Generates the grid HTML.
public
generate_html() : string
Return values
string —get_html()
Get the grid HTML.
public
get_html() : string
Return values
string —get_html_parts()
Get the grid HTML parts.
public
get_html_parts() : array<string|int, mixed>
Return values
array<string|int, mixed> —build_taxonomy_options()
Build taxonomy HTML <option>'s
private
build_taxonomy_options(array<string|int, mixed> $terms, int $indent) : string
Parameters
- $terms : array<string|int, mixed>
- $indent : int
Return values
string —$taxonomy_options
generate_html_parts()
Generate the grid HTML parts
private
generate_html_parts() : string
Return values
string —get_filters_html()
Gets the Filters HTML.
private
get_filters_html([string $context = 'top' ]) : string
Parameters
- $context : string = 'top'
Return values
string —get_footer_html()
Gets the Grid Footer HTML.
private
get_footer_html() : string
Return values
string —get_grid_html()
Gets the Main Grid Section HTML.
private
get_grid_html() : string
Return values
string —get_header_html()
Get thes the Grid Header HTML.
private
get_header_html() : string
Return values
string —get_page_length()
Gets the Page Length HTML.
private
get_page_length() : string
Return values
string —get_pagination_html()
Gets the Pagination HTML.
private
get_pagination_html([string $context = 'top' ]) : string
Parameters
- $context : string = 'top'
Return values
string —get_reset_button()
Gets the Reset Button HTML
private
get_reset_button() : string
Return values
string —get_result_count()
Gets the Result Count HTML.
private
get_result_count() : string
Return values
string —get_search_box()
Gets the Search Box HTML.
private
get_search_box() : string
Return values
string —get_taxonomy_filters()
Get taxonomy filters
private
get_taxonomy_filters() : string
Return values
string —get_totals_html()
Gets the Totals HTML.
private
get_totals_html([string $context = 'top' ]) : string
Parameters
- $context : string = 'top'