Document_Grid

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  : array<string|int, Document>
The Documents to be displayed.
$cache  : mixed
$grid_html  : mixed
$grid_initialised  : mixed
$hooks  : mixed
__construct()  : mixed
Constructor.
get_grid()  : string
Initiliase and/or retrive a grid.
update()  : mixed
Update the grid
add_default_grid_args()  : array<string|int, mixed>
Add default args which always apply to the grid.
fetch_documents()  : mixed
Fetch the documents.

Properties

$grid_initialised

private mixed $grid_initialised = false
Tags

Methods

__construct()

Constructor.

public __construct(mixed $id, array<string|int, mixed> $args) : mixed
Parameters
$id : mixed
$args : array<string|int, mixed>
Tags
Return values
mixed

get_grid()

Initiliase and/or retrive a grid.

public get_grid([string $output = 'html' ]) : string
Parameters
$output : string = 'html'
Tags
Return values
string

update()

Update the grid

public update(int|array<string|int, mixed> $args) : mixed
Parameters
$args : int|array<string|int, mixed>
Tags
Return values
mixed

add_default_grid_args()

Add default args which always apply to the grid.

private static add_default_grid_args(array<string|int, mixed> $args) : array<string|int, mixed>
Parameters
$args : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>

fetch_documents()

Fetch the documents.

private fetch_documents() : mixed
Tags
Return values
mixed

Search results