FluentSiteTree

class FluentSiteTree extends FluentExtension (View source)

SiteTree extension class for translatable objects

Properties

protected SS_Object $owner

The object this extension is applied to.

 from  Extension
protected DataObject $ownerBaseClass

The base class that this extension was applied to; $this->owner must be one of these

 from  Extension
public $class from  Extension
protected static bool $disable_fluent_fields

Hook allowing temporary disabling of extra fluent fields

 from  FluentExtension
protected static array $translated_fields_for_cache

Cache for list of translated fields for all inspected classes

 from  FluentExtension
protected static $_enable_write_augmentation from  FluentExtension

Methods

public
__construct()

No description

from  Extension
public static 
add_to_class(string $class, string $extensionClass, mixed $args = null)

Called when this extension is added to a particular class

from  Extension
public
setOwner(SS_Object $owner, string $ownerBaseClass = null)

Set the owner of this extension.

from  Extension
public
clearOwner()

No description

from  Extension
public
SS_Object
getOwner()

Returns the owner of this extension.

from  Extension
public static 
string
get_classname_without_arguments(string $extensionStr)

Helper method to strip eval'ed arguments from a string thats passed to DataObject::$extensions or Object::add_extension().

from  Extension
public static 
get_extra_config($class, $extension, $args)

No description

from  FluentExtension
public static 
unload_extra_statics($class, $extension)

No description

from  DataExtension
public
validate(ValidationResult $validationResult)

Hook for extension-specific validation.

from  DataExtension
public
augmentSQL(SQLQuery $query, DataQuery $dataQuery = null)

Edit the given query object to support queries for this extension

from  FluentExtension
public
augmentDatabase()

Update the database schema as required by this extension.

from  DataExtension
public
augmentWrite(array $manipulation)

Augment a write-record request.

from  FluentExtension
public
onBeforeWrite()

No description

public
onAfterWrite()

No description

from  DataExtension
public
onBeforeDelete()

No description

from  DataExtension
public
onAfterDelete()

No description

from  DataExtension
public
requireDefaultRecords()

No description

from  DataExtension
public
populateDefaults()

No description

from  DataExtension
public
can($member)

No description

from  DataExtension
public
canEdit($member)

No description

from  DataExtension
public
canDelete($member)

No description

from  DataExtension
public
canCreate($member)

No description

from  DataExtension
public
array
extraStatics($class = null, $extension = null)

Define extra database fields

from  DataExtension
public
updateCMSFields(FieldList $fields)

No description

public
updateFrontEndFields(FieldList $fields)

This function is used to provide modifications to the form used for front end forms. DataObject->getFrontEndFields()

from  DataExtension
public
updateCMSActions(FieldList $actions)

This is used to provide modifications to the form actions used in the CMS. DataObject->getCMSActions().

from  DataExtension
public
updateSummaryFields(array $fields)

this function is used to provide modifications to the summary fields in CMS by the extension By default, the summaryField() of its owner will merge more fields defined in the extension's $extra_fields['summary_fields']

from  DataExtension
public
updateFieldLabels(array $labels)

this function is used to provide modifications to the fields labels in CMS by the extension By default, the fieldLabels() of its owner will merge more fields defined in the extension's $extra_fields['field_labels']

from  DataExtension
protected static 
mixed
without_fluent_fields(callable $callback)

Executes a callback with extra fluent fields disabled

from  FluentExtension
public static 
array
translated_fields_for($class)

Determines the fields to translate on the given class

from  FluentExtension
public static 
base_indexes($class)

No description

from  FluentExtension
protected
array
getTranslatedTables()

Get all database tables in the class ancestry and their respective translatable fields

from  FluentExtension
protected static 
array
explode_column_string(string $spec)

Splits a spec string safely, considering quoted columns, whitespace, and cleaning brackets

from  FluentExtension
protected static 
string
implode_column_list(array $columns)

Builds a properly quoted column list from an array

from  FluentExtension
protected static 
string
quote_column_spec_string(string $spec)

Given an index specification in the form of a string ensure that each column name is property quoted, stripping brackets and modifiers.

from  FluentExtension
protected static 
string
determine_index_type(type $spec)

Given an index spec determines the index type

from  FluentExtension
protected static 
array
parse_index_spec($name, string|array $spec)

Converts an array or string index spec into a universally useful array

from  FluentExtension
public static 
generate_extra_config(string $class)

Generates the extra DB fields for a class (not including subclasses)

from  FluentExtension
public
ArrayList
Locales()

Templatable list of all locales

from  FluentExtension
public
string
LocaleLink(string $locale)

Determine the link to this object given the specified $locale.

public
string
BaseURLForLocale(string $locale = null)

Determine the baseurl within a specified $locale.

from  FluentExtension
public
ArrayData
LocaleInformation(string $locale = null)

Retrieves information about this object in the specified locale

from  FluentExtension
public
string
CurrentLocale()

Current locale code

from  FluentExtension
public
augmentDataQueryCreation(SQLQuery $query, DataQuery $dataQuery)

Amend freshly created DataQuery objects with the current locale and frontend status

from  FluentExtension
public static 
set_enable_write_augmentation($enabled)

No description

from  FluentExtension
protected
array
detectFilterColumn(string $condition, array $includedTables)

Determines the table/column identifier that first appears in the $condition, and returns the localised version of that column.

from  FluentExtension
protected
string
localiseFilterCondition(string $condition, array $includedTables, string $locale)

Replaces all columns in the given condition with any localised

from  FluentExtension
protected
string
localiseSelect(string $class, string $select, string $fallback)

Generates a select fragment based on a field with a fallback

from  FluentExtension
public
bool
isFieldNullable(string $field)

Can this field be left empty?

from  FluentExtension
protected
$this
addLocaleIndicatorMessage(FieldList $fields)

Adds a UI message to indicate whether you're editing in the default locale or not

from  FluentExtension
public
MetaTags($tags)

No description

public
contentcontrollerInit(ContentController $controller)

Ensure that the controller is correctly initialised

public
updateRelativeLink($base, $action)

No description

Details

in Extension at line 42
__construct()

No description

in Extension at line 54
static add_to_class(string $class, string $extensionClass, mixed $args = null)

Called when this extension is added to a particular class

Parameters

string $class
string $extensionClass
mixed $args

in Extension at line 66
setOwner(SS_Object $owner, string $ownerBaseClass = null)

Set the owner of this extension.

Parameters

SS_Object $owner

The owner object,
string $ownerBaseClass

The base class that the extension is applied to; this may be the class of owner, or it may be a parent. For example, if Versioned was applied to SiteTree, and then a Page object was instantiated, $owner would be a Page object, but $ownerBaseClass would be 'SiteTree'.

in Extension at line 74
clearOwner()

No description

in Extension at line 85
SS_Object getOwner()

Returns the owner of this extension.

Return Value

SS_Object

in Extension at line 97
static string get_classname_without_arguments(string $extensionStr)

Helper method to strip eval'ed arguments from a string thats passed to DataObject::$extensions or Object::add_extension().

Parameters

string $extensionStr

E.g. "Versioned('Stage','Live')"

Return Value

string

Extension classname, e.g. "Versioned"

in FluentExtension at line 303
static get_extra_config($class, $extension, $args)

No description

Parameters

$class
$extension
$args

in DataExtension at line 32
static unload_extra_statics($class, $extension)

No description

Parameters

$class
$extension

in DataExtension at line 42
validate(ValidationResult $validationResult)

Hook for extension-specific validation.

Parameters

ValidationResult $validationResult

Local validation result

Exceptions

ValidationException

in FluentExtension at line 561
augmentSQL(SQLQuery $query, DataQuery $dataQuery = null)

Edit the given query object to support queries for this extension

Parameters

SQLQuery $query

Query to augment.
DataQuery $dataQuery

in DataExtension at line 59
augmentDatabase()

Update the database schema as required by this extension.

When duplicating a table's structure, remember to duplicate the create options as well. See Versioned->augmentDatabase for an example.

in FluentExtension at line 697
augmentWrite(array $manipulation)

Augment a write-record request.

Parameters

array $manipulation

Array of operations to augment.

at line 17
onBeforeWrite()

No description

in DataExtension at line 73
onAfterWrite()

No description

in DataExtension at line 76
onBeforeDelete()

No description

in DataExtension at line 79
onAfterDelete()

No description

in DataExtension at line 82
requireDefaultRecords()

No description

in DataExtension at line 85
populateDefaults()

No description

in DataExtension at line 88
can($member)

No description

Parameters

$member

in DataExtension at line 91
canEdit($member)

No description

Parameters

$member

in DataExtension at line 94
canDelete($member)

No description

Parameters

$member

in DataExtension at line 97
canCreate($member)

No description

Parameters

$member

in DataExtension at line 112
array extraStatics($class = null, $extension = null)

Define extra database fields

Return a map where the keys are db, has_one, etc, and the values are additional fields/relations to be defined.

Parameters

$class

since this method might be called on the class directly
$extension

since this can help to extract parameters to help set indexes

Return Value

array

Returns a map where the keys are db, has_one, etc, and the values are additional fields/relations to be defined.

at line 95
updateCMSFields(FieldList $fields)

No description

Parameters

FieldList $fields

FieldList with a contained TabSet

in DataExtension at line 140
updateFrontEndFields(FieldList $fields)

This function is used to provide modifications to the form used for front end forms. DataObject->getFrontEndFields()

Caution: Use FieldList->push() to add fields.

Parameters

FieldList $fields

FieldList without TabSet nesting

in DataExtension at line 149
updateCMSActions(FieldList $actions)

This is used to provide modifications to the form actions used in the CMS. DataObject->getCMSActions().

Parameters

FieldList $actions FieldList

in DataExtension at line 160
updateSummaryFields(array $fields)

this function is used to provide modifications to the summary fields in CMS by the extension By default, the summaryField() of its owner will merge more fields defined in the extension's $extra_fields['summary_fields']

Parameters

array $fields

Array of field names

in DataExtension at line 180
updateFieldLabels(array $labels)

this function is used to provide modifications to the fields labels in CMS by the extension By default, the fieldLabels() of its owner will merge more fields defined in the extension's $extra_fields['field_labels']

Parameters

array $labels

Array of field labels

in FluentExtension at line 38
static protected mixed without_fluent_fields(callable $callback)

Executes a callback with extra fluent fields disabled

Parameters

callable $callback

Return Value

mixed

in FluentExtension at line 59
static array translated_fields_for($class)

Determines the fields to translate on the given class

Parameters

$class

Return Value

array

List of field names and data types

in FluentExtension at line 103
static base_indexes($class)

No description

Parameters

$class

in FluentExtension at line 116
protected array getTranslatedTables()

Get all database tables in the class ancestry and their respective translatable fields

Return Value

array

in FluentExtension at line 145
static protected array explode_column_string(string $spec)

Splits a spec string safely, considering quoted columns, whitespace, and cleaning brackets

Parameters

string $spec

The input index specification

Return Value

array

List of columns in the spec

in FluentExtension at line 162
static protected string implode_column_list(array $columns)

Builds a properly quoted column list from an array

Parameters

array $columns

List of columns to implode

Return Value

string

A properly quoted list of column names

in FluentExtension at line 178
static protected string quote_column_spec_string(string $spec)

Given an index specification in the form of a string ensure that each column name is property quoted, stripping brackets and modifiers.

This index may also be in the form of a "CREATE INDEX..." sql fragment

Parameters

string $spec

The input specification or query. E.g. 'unique (Column1, Column2)'

Return Value

string

The properly quoted column list. E.g. '"Column1", "Column2"'

in FluentExtension at line 190
static protected string determine_index_type(type $spec)

Given an index spec determines the index type

Parameters

type $spec

Return Value

string

in FluentExtension at line 208
static protected array parse_index_spec($name, string|array $spec)

Converts an array or string index spec into a universally useful array

Parameters

$name
string|array $spec

Return Value

array

The resulting spec array with the required fields name, type, and value

in FluentExtension at line 234
static generate_extra_config(string $class)

Generates the extra DB fields for a class (not including subclasses)

Parameters

string $class

in FluentExtension at line 332
ArrayList Locales()

Templatable list of all locales

Return Value

ArrayList

Determine the link to this object given the specified $locale.

Returns null for DataObjects that do not have a 'Link' function.

Parameters

string $locale

Return Value

string

in FluentExtension at line 380
string BaseURLForLocale(string $locale = null)

Determine the baseurl within a specified $locale.

Parameters

string $locale

Locale, or null to use current locale

Return Value

string

in FluentExtension at line 391
ArrayData LocaleInformation(string $locale = null)

Retrieves information about this object in the specified locale

Parameters

string $locale

The locale information to request, or null to use the default locale

Return Value

ArrayData

Mapped list of locale properties

in FluentExtension at line 431
string CurrentLocale()

Current locale code

Return Value

string

Locale code

in FluentExtension at line 446
augmentDataQueryCreation(SQLQuery $query, DataQuery $dataQuery)

Amend freshly created DataQuery objects with the current locale and frontend status

Parameters

SQLQuery $query
DataQuery $dataQuery

in FluentExtension at line 497
static set_enable_write_augmentation($enabled)

No description

Parameters

$enabled

in FluentExtension at line 510
protected array detectFilterColumn(string $condition, array $includedTables)

Determines the table/column identifier that first appears in the $condition, and returns the localised version of that column.

Parameters

string $condition

Condition SQL string
array $includedTables

Return Value

array

Array with items [$table, $column], or null if not found

in FluentExtension at line 532
protected string localiseFilterCondition(string $condition, array $includedTables, string $locale)

Replaces all columns in the given condition with any localised

Parameters

string $condition

Condition SQL string
array $includedTables
string $locale

Locale to localise to

Return Value

string

$condition parameter with column names replaced

in FluentExtension at line 553
protected string localiseSelect(string $class, string $select, string $fallback)

Generates a select fragment based on a field with a fallback

Parameters

string $class

Table/Class name
string $select

Column to select from
string $fallback

Column to fallback to if $select is empty

Return Value

string

Select fragment

in FluentExtension at line 686
bool isFieldNullable(string $field)

Can this field be left empty?

Parameters

string $field

Return Value

bool

False if the field inherits, true if it is nullable

in FluentExtension at line 826
protected $this addLocaleIndicatorMessage(FieldList $fields)

Adds a UI message to indicate whether you're editing in the default locale or not

Parameters

FieldList $fields

Return Value

$this

at line 12
MetaTags($tags)

No description

Parameters

$tags

at line 33
contentcontrollerInit(ContentController $controller)

Ensure that the controller is correctly initialised

Parameters

ContentController $controller

No description

Parameters

$base
$action