RteLibraryHasCategories
extends RteLibrary
in package
AbstractYes
Abstract richtext library for bog-standard "has categories" modules, such as news articles, blog posts, etc.
Table of Contents
Properties
- $main_columns : array<string|int, mixed>
- $main_order : array<string|int, mixed>
- $main_table : string
- $name : mixed
- $search_columns : array<string|int, mixed>
Methods
- __construct() : mixed
- Validates configuration
- browse() : array<string|int, mixed>
- Do a library browse
- getName() : mixed
- Return the name of this library
- search() : array<string|int, mixed>
- Do a library search
- getIdentifier() : mixed
- For a given database row, return the display identifier of the record
- getLinkAttrs() : array<string|int, mixed>
- For a given database row, return an array of link attributes
Properties
$main_columns
protected
array<string|int, mixed>
$main_columns
= ['id', 'name']
Columns to pull when fetching records from the main table
$main_order
protected
array<string|int, mixed>
$main_order
= ['name']
Columns for the ORDER BY clause
$main_table
protected
string
$main_table
Main table name
$name
protected
mixed
$name
$search_columns
protected
array<string|int, mixed>
$search_columns
= ['name']
Columns to search against
Methods
__construct()
Validates configuration
public
__construct() : mixed
browse()
Do a library browse
public
browse(mixed $path) : array<string|int, mixed>
Parameters
- $path : mixed
Return values
array<string|int, mixed> —of RteLibContainer and RteLibObject objects
getName()
Return the name of this library
public
final getName() : mixed
search()
Do a library search
public
search(mixed $term) : array<string|int, mixed>
Parameters
- $term : mixed
Return values
array<string|int, mixed> —of RteLibObject objects
getIdentifier()
For a given database row, return the display identifier of the record
protected
getIdentifier(array<string|int, mixed> $row) : mixed
Parameters
- $row : array<string|int, mixed>
getLinkAttrs()
For a given database row, return an array of link attributes
protected
abstract getLinkAttrs(array<string|int, mixed> $row) : array<string|int, mixed>
Parameters
- $row : array<string|int, mixed>
-
From the database
Return values
array<string|int, mixed> —HTML attributes, e.g. 'href' or 'title'