\DataObjectOutputConfiguration
APIwesome CMS JSON/XML output configuration of an individual data object type.
@author Nathan Glasl <nathan@symbiote.com.au>
Synopsis
class DataObjectOutputConfiguration
extends DataObject
{
- // members
- private static array $db = ;
- private static string $default_sort = 'IsFor';
- private static array $searchable_fields = ;
- private static array $summary_fields = ;
- private static array $field_labels = ;
- private static array $exclusions = ;
- private static array $custom_exclusions = ;
- private static array $custom_inclusions = ;
- private static boolean $disabled = false;
- // methods
- public static void customise_data_objects()
- public void requireDefaultRecords()
- public void getTitle()
- public void getCMSFields()
- public void onBeforeWrite()
- private void addConfiguration()
- private void deleteConfiguration()
Hierarchy
Extends
- DataObject
Members
private
-
$custom_exclusions
The custom data objects to exclude, defined under project configuration. -
$custom_inclusions
The custom data objects to include, defined under project configuration. - $db
- $default_sort
-
$disabled
Flag used to prevent data object output, defined under project configuration. -
$exclusions
The default data objects to exclude. - $field_labels
- $searchable_fields
- $summary_fields
Methods
private
- addConfiguration() — Add an output configuration for a new data object.
- deleteConfiguration() — Delete an existing output configuration for a data object now excluded.
public
- customise_data_objects() — Set JSON/XML data object exclusions/inclusions.
- getCMSFields() — Display CMS JSON/XML output visibility configuration.
- getTitle() — Print the data object name associated with this configuration.
- onBeforeWrite() — Save the JSON/XML output visibility customisation for each associated data object.
- requireDefaultRecords() — The process to automatically construct data object output configurations, executed on project build.