Grid
The main Table class.
Responsible for creating the products grid from the specified args and returning the complete grid.
The main functions provided are get_grid() and get_data().
Tags
Table of Contents
- $args : mixed
- Helper classes phpcs:ignore Squiz.Commenting.VariableComment.MissingVar
- $content : mixed
- $id : mixed
- $attributes : mixed
- $cells_added : mixed
- $current_row : mixed
- $data_factory : mixed
- $grid : mixed
- $grid_initialised : mixed
- Internal flags phpcs:ignore Squiz.Commenting.VariableComment.MissingVar
- $has_column_images : mixed
- $product_id : mixed
- $use_table_tags : mixed
- __construct() : mixed
- add_attribute() : mixed
- get_add_to_cart_text() : mixed
- get_product_id() : string|int
- Get the product ID.
- render() : mixed
- render_cell() : mixed
- render_grid() : mixed
- reset() : mixed
- reset_data() : mixed
- add_attributes() : mixed
- add_cell() : mixed
- add_cells() : mixed
- add_dimension_headers() : mixed
- add_footer() : mixed
- add_headers() : mixed
- get_add_to_cart_button_html() : mixed
- get_grid_style_attribute() : mixed
- get_table_tag() : mixed
- is_even_term() : mixed
- non_breakable() : mixed
- prepare_header() : mixed
Properties
$args
Helper classes phpcs:ignore Squiz.Commenting.VariableComment.MissingVar
public
mixed
$args
$content
public
mixed
$content
$id
public
mixed
$id
$attributes
private
mixed
$attributes
$cells_added
private
mixed
$cells_added
= false
$current_row
private
mixed
$current_row
= 0
$data_factory
private
mixed
$data_factory
$grid
private
mixed
$grid
$grid_initialised
Internal flags phpcs:ignore Squiz.Commenting.VariableComment.MissingVar
private
mixed
$grid_initialised
= false
$has_column_images
private
mixed
$has_column_images
= false
$product_id
private
mixed
$product_id
$use_table_tags
private
mixed
$use_table_tags
Methods
__construct()
public
__construct(mixed $id[, mixed $args = [] ]) : mixed
Parameters
- $id : mixed
- $args : mixed = []
Return values
mixed —add_attribute()
public
add_attribute(mixed $name, mixed $value) : mixed
Parameters
- $name : mixed
- $value : mixed
Return values
mixed —get_add_to_cart_text()
public
get_add_to_cart_text() : mixed
Return values
mixed —get_product_id()
Get the product ID.
public
get_product_id() : string|int
Return values
string|int —render()
public
render() : mixed
Return values
mixed —render_cell()
public
render_cell(mixed $cell) : mixed
Parameters
- $cell : mixed
Return values
mixed —render_grid()
public
render_grid([mixed $content_only = false ]) : mixed
Parameters
- $content_only : mixed = false
Return values
mixed —reset()
public
reset() : mixed
Return values
mixed —reset_data()
public
reset_data() : mixed
Return values
mixed —add_attributes()
private
add_attributes() : mixed
Return values
mixed —add_cell()
private
add_cell(mixed $column[, mixed $row = null ]) : mixed
Parameters
- $column : mixed
- $row : mixed = null
Return values
mixed —add_cells()
private
add_cells() : mixed
Return values
mixed —add_dimension_headers()
private
add_dimension_headers(mixed $terms[, mixed $type = 'col' ]) : mixed
Parameters
- $terms : mixed
- $type : mixed = 'col'
Return values
mixed —add_footer()
private
add_footer() : mixed
Return values
mixed —add_headers()
private
add_headers() : mixed
Return values
mixed —get_add_to_cart_button_html()
private
get_add_to_cart_button_html(mixed $button_text) : mixed
Parameters
- $button_text : mixed
Return values
mixed —get_grid_style_attribute()
private
get_grid_style_attribute() : mixed
Return values
mixed —get_table_tag()
private
get_table_tag(mixed $type) : mixed
Parameters
- $type : mixed
Return values
mixed —is_even_term()
private
is_even_term(mixed $term[, mixed $dimension_index = 1 ]) : mixed
Parameters
- $term : mixed
- $dimension_index : mixed = 1
Return values
mixed —non_breakable()
private
non_breakable(mixed $string) : mixed
Parameters
- $string : mixed
Return values
mixed —prepare_header()
private
prepare_header(mixed $term[, mixed $type = 'col' ]) : mixed
Parameters
- $term : mixed
- $type : mixed = 'col'