Set
extends AbstractElement
in package
Set element
Can group categories of entities (Posts, Data, and their child classes).
Tags
Table of Contents
Properties
- $directory : mixed
Methods
- __construct() : mixed
- Construct an element with an associated directory
- metadata() : mixed
- Return the metadata of the element
- metadata_fields() : array<string|int, mixed>
- Return the metadata fields of the element.
Properties
$directory
public
static mixed
$directory
Methods
__construct()
Construct an element with an associated directory
public
__construct(string $directory) : mixed
Parameters
- $directory : string
-
the path to the associated directory.
Tags
metadata()
Return the metadata of the element
public
metadata() : mixed
Every element has a metadata.json file in the associated directory.
This method loads and returns that JSON.
Tags
Return values
mixed —The loaded json metadata file in appropriate PHP type.
metadata_fields()
Return the metadata fields of the element.
public
metadata_fields() : array<string|int, mixed>
By default, every element metadata should contain at least:
-
name: the display name, -
description: a descriptive text of the element.
Tags
Return values
array<string|int, mixed> —Names of the metadata fields of the element