class FluentExtension extends DataExtension (View source)

Basic fluent extension

When determining whether a field is localised, the following config options are checked in order:

  • translate (uninherited, for each class in the chain)
  • field_exclude
  • field_include
  • data_exclude
  • data_include

Traits

Shared functionality between both FluentExtension and FluentFilteredExtension

Constants

SUFFIX

The table suffix that will be applied to create localisation tables

TRANSLATE_NONE

translate config key to disable localisations for this table

INHERITANCE_MODE_EXACT

Content inheritance - content will be served from the following sources in this order: current locale

INHERITANCE_MODE_FALLBACK

Content inheritance - content will be served from the following sources in this order: current locale, fallback locale

INHERITANCE_MODE_ANY

Content inheritance - content will be served from the following sources in this order: current locale, fallback locale, base record

Properties

$owner DataObject from  UsesDeletePolicy
protected $localisedFields

Cache of localised fields for this model

protected bool $localisedCopyActive

Global state of localised copy feature

Methods

public
__construct()

No description

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

Called when this extension is added to a particular class

public
setOwner(object $owner)

Set the owner of this extension.

public
mixed
withOwner(mixed $owner, callable $callback, array $args = [])

Temporarily modify the owner. The original owner is ensured to be restored

public
clearOwner()

Clear the current owner, and restore extension to the state prior to the last setOwner()

public
T
getOwner()

Returns the owner of this extension.

public static 
string
get_classname_without_arguments(string $extensionStr)

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

public
mixed
invokeExtension(object $owner, string $method, array ...$arguments)

Invoke extension point. This will prefer explicit extend prefixed methods.

public
validate(ValidationResult $validationResult)

Hook for extension-specific validation.

public
augmentSQL(SQLSelect $query, DataQuery $dataQuery = null)

Edit the given query object to support queries for this extension

public
augmentDatabase()

Update the database schema as required by this extension.

public
augmentWrite(array $manipulation)

Augment a write-record request.

public
onBeforeWrite()

Force all changes, since we may need to cross-publish unchanged records between locales. Without this, loading a page in a different locale and pressing "save" won't actually make the record available in this locale.

public
onAfterWrite()

No description

public
onBeforeDelete()

Extend the owner's onBeforeDelete() logic

public
onAfterDelete()

Extend the owner's onAfterDelete() logic

public
requireDefaultRecords()

Extend the owner's requireDefaultRecords() logic

public
populateDefaults()

Extend the owner's populateDefaults() logic

public
onAfterBuild()

Extend the owner's onAfterBuild() logic

public
bool|null
can(Member $member)

Influence the owner's can() permission check value to be disallowed (false), allowed (true) if no other processed results are to disallow, or open (null) to not affect the outcome.

public
bool|null
canEdit(Member $member)

Influence the owner's canEdit() permission check value to be disallowed (false), allowed (true) if no other processed results are to disallow, or open (null) to not affect the outcome.

public
bool|null
canDelete(Member $member)

Influence the owner's canDelete() permission check value to be disallowed (false), allowed (true) if no other processed results are to disallow, or open (null) to not affect the outcome.

public
bool|null
canCreate(Member $member)

Influence the owner's canCreate() permission check value to be disallowed (false), allowed (true) if no other processed results are to disallow, or open (null) to not affect the outcome.

public
array
extraStatics(string $class = null, string $extension = null)

Define extra database fields

public
updateCMSFields(FieldList $fields)

No description

public
void
updateCMSCompositeValidator(CompositeValidator $compositeValidator)

This function is used to provide modifications to the Validators used on a DataObject.

public
updateFrontEndFields(FieldList $fields)

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

public
updateCMSActions(FieldList $actions)

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

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']

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']

public
updateDeleteTables(array $queriedTables)

Override delete behaviour.

public
updateLocalisationTabColumns($summaryColumns)

No description

public
updateLocalisationTabConfig(GridFieldConfig $config)

Add copy actions to each locale Note that permissions for these actions are resolved within the GridField components themselves

public
Locale>
LinkedLocales()

Gets list of all Locale dataobjects, linked to this record

public
augmentDataQueryCreation(SQLSelect $query, DataQuery $dataQuery)

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

protected
updateFluentCMSFields(FieldList $fields)

Update CMS fields for fluent objects.

public
array
getLocalisedFields(string $class = null)

Get list of fields that are localised

protected
bool
isFieldLocalised(string $field, string $type, string $class)

Check if a field is marked for localisation

public
array
getLocalisedTables()

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

protected
bool
anyMatch(string $value, array $patterns)

Helper function to check if the value given is present in any of the patterns.

protected
bool
validateBaseConfig()

Ensure only one instance of this extension is applied to this class

protected
bool
validateChildConfig()

Non-base classes should never have fluent applied; Do this at the root only!

protected
augmentDatabaseDontRequire($localisedTable)

No description

protected
augmentDatabaseRequireTable(string $localisedTable, array $fields, array $indexes)

Require the given localisation table

protected
void
handleClassChanged()

If an object is changed to another class, we should trigger localised copy

protected
localiseManipulationTable(array $manipulation, string $table, string $localeTable, array $localisedFields, Locale $locale)

Localise a database manipluation from one table to another

public
string
getLocalisedTable(string $tableName, string $locale = '')

Get the localised table name with the localised suffix and optionally with a locale suffix for aliases

public
string
deleteTableTarget(string $tableName, string $locale = '')

Public accessor for getDeleteTableTarget

protected
string
getDeleteTableTarget(string $tableName, string $locale = '')

Get real table name for deleting records (Note: Must have all table replacements applied)

protected
string
localiseSelect(string $table, string $field, Locale $locale)

Generates a select fragment based on a field with a fallback

protected
string
localiseCondition(string $table, string $field, Locale $locale)

Generate a where fragment based on a field with a fallback.

protected
Locale|null
getDataQueryLocale(DataQuery $dataQuery = null)

Get current locale from given dataquery

public
updateFluentLocalisedFields(FieldList $fields)

Add / refresh fluent badges to all localised fields.

protected
Locale|null
getRecordLocale()

Get locale this record was originally queried from, or belongs to

public
Locale|null
getSourceLocale()

Returns the source locale that will display the content for this record

protected
null|int
getManipulationRecordID(array $updates)

Extract the RecordID value for the given write

public
RecordLocale>
Locales()

Templatable list of all locale information for this record

public
LocaleInformation(string $locale = null)

Retrieves information about this object in the specified locale

public
array
getLocaleInstances()

Get list of locales where record is localised in draft mode

public
string
BaseURLForLocale(string $locale)

Determine the baseurl within a specified $locale.

public
string
cacheKeyComponent()

Ensure has_one cache is segmented by locale

public
updateFluentCMSField(FormField $field)

Add fluent tooltip to given field.

protected
string
getInheritanceMode()

Require that this record is saved in the given locale for it to be visible

protected
array
detectLocalisedTableField(array $tables, string $sql)

Detect a localised field within a SQL fragment.

public
getSelectedLanguage()

Returns the selected language

public
bool
existsInLocale(string $locale = null)

Check if this record exists (in either state) in this locale

protected
bool
findRecordInLocale(string $locale, string $table, int $id)

Checks whether the given record ID exists in the given locale, in the given table. Skips using the ORM because we don't need it for this call.

public
bool
getLocalisedCopyActive()

No description

public
setLocalisedCopyActive(bool $active)

No description

public
mixed
withLocalisedCopyState(callable $callback)

Localised copy global state manipulation useful for disabling localised copy feature in parts of the code

public
void
copyToLocale(string $toLocale)

Copy data object content from current locale to the target locale

protected
void
makeLocalisedCopy()

Duplicate related objects based on configuration Provides an extension hook for custom duplication

protected
bool
localisedCopyNeeded()

Determine if localised copy is needed

Details

__construct()

No description

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

setOwner(object $owner)

Set the owner of this extension.

Parameters

object $owner

The owner object

mixed withOwner(mixed $owner, callable $callback, array $args = [])

Temporarily modify the owner. The original owner is ensured to be restored

Parameters

mixed $owner

Owner to set

callable $callback

Callback to invoke

array $args

Args to pass to callback

Return Value

mixed

clearOwner()

Clear the current owner, and restore extension to the state prior to the last setOwner()

T getOwner()

Returns the owner of this extension.

Return Value

T

static string get_classname_without_arguments(string $extensionStr)

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

Parameters

string $extensionStr

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

Return Value

string

Extension classname, e.g. "Versioned"

mixed invokeExtension(object $owner, string $method, array ...$arguments)

Invoke extension point. This will prefer explicit extend prefixed methods.

Parameters

object $owner
string $method
array ...$arguments

Return Value

mixed

validate(ValidationResult $validationResult)

Hook for extension-specific validation.

Parameters

ValidationResult $validationResult

Local validation result

Exceptions

ValidationException

augmentSQL(SQLSelect $query, DataQuery $dataQuery = null)

Edit the given query object to support queries for this extension

Parameters

SQLSelect $query

Query to augment.

DataQuery $dataQuery

Container DataQuery for this SQLSelect

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.

augmentWrite(array $manipulation)

Augment a write-record request.

Parameters

array $manipulation

Array of operations to augment.

onBeforeWrite()

Force all changes, since we may need to cross-publish unchanged records between locales. Without this, loading a page in a different locale and pressing "save" won't actually make the record available in this locale.

onAfterWrite()

No description

Exceptions

ValidationException

onBeforeDelete()

Extend the owner's onBeforeDelete() logic

See DataObject::onBeforeDelete() for context.

onAfterDelete()

Extend the owner's onAfterDelete() logic

See DataObject::onAfterDelete() for context.

requireDefaultRecords()

Extend the owner's requireDefaultRecords() logic

See DataObject::requireDefaultRecords() for context.

populateDefaults()

Extend the owner's populateDefaults() logic

See DataObject::populateDefaults() for context.

onAfterBuild()

Extend the owner's onAfterBuild() logic

See DataObject::onAfterBuild() for context.

bool|null can(Member $member)

Influence the owner's can() permission check value to be disallowed (false), allowed (true) if no other processed results are to disallow, or open (null) to not affect the outcome.

See DataObject::can()} and {@link DataObject::extendedCan() for context.

Parameters

Member $member

Return Value

bool|null

bool|null canEdit(Member $member)

Influence the owner's canEdit() permission check value to be disallowed (false), allowed (true) if no other processed results are to disallow, or open (null) to not affect the outcome.

See DataObject::canEdit()} and {@link DataObject::extendedCan() for context.

Parameters

Member $member

Return Value

bool|null

bool|null canDelete(Member $member)

Influence the owner's canDelete() permission check value to be disallowed (false), allowed (true) if no other processed results are to disallow, or open (null) to not affect the outcome.

See DataObject::canDelete()} and {@link DataObject::extendedCan() for context.

Parameters

Member $member

Return Value

bool|null

bool|null canCreate(Member $member)

Influence the owner's canCreate() permission check value to be disallowed (false), allowed (true) if no other processed results are to disallow, or open (null) to not affect the outcome.

See DataObject::canCreate()} and {@link DataObject::extendedCan() for context.

Parameters

Member $member

Return Value

bool|null

array extraStatics(string $class = null, string $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

string $class

since this method might be called on the class directly

string $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.

updateCMSFields(FieldList $fields)

No description

Parameters

FieldList $fields

FieldList with a contained TabSet

void updateCMSCompositeValidator(CompositeValidator $compositeValidator)

This function is used to provide modifications to the Validators used on a DataObject.

Caution: Use CompositeValidator->addValidator() to add Validators.

Parameters

CompositeValidator $compositeValidator

Return Value

void

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

updateCMSActions(FieldList $actions)

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

Parameters

FieldList $actions FieldList

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

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

updateDeleteTables(array $queriedTables)

Override delete behaviour.

Hooks into {\TractorCow\Fluent\Model\Delete\DataObject::delete()}

Parameters

array $queriedTables

updateLocalisationTabColumns($summaryColumns)

No description

Parameters

$summaryColumns

See also

FluentObjectTrait::updateFluentCMSFields

updateLocalisationTabConfig(GridFieldConfig $config)

Add copy actions to each locale Note that permissions for these actions are resolved within the GridField components themselves

Parameters

GridFieldConfig $config

Locale> LinkedLocales()

Gets list of all Locale dataobjects, linked to this record

Return Value

Locale>

See also

Locale::RecordLocale

augmentDataQueryCreation(SQLSelect $query, DataQuery $dataQuery)

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

Parameters

SQLSelect $query
DataQuery $dataQuery

protected updateFluentCMSFields(FieldList $fields)

Update CMS fields for fluent objects.

These fields are added in addition to those added by specific extensions

Parameters

FieldList $fields

array getLocalisedFields(string $class = null)

Get list of fields that are localised

Parameters

string $class

Class to get fields for (if parent)

Return Value

array

protected bool isFieldLocalised(string $field, string $type, string $class)

Check if a field is marked for localisation

Parameters

string $field

Field name

string $type

Field type

string $class

Class this field is defined in

Return Value

bool

array getLocalisedTables()

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

Return Value

array

protected bool anyMatch(string $value, array $patterns)

Helper function to check if the value given is present in any of the patterns.

This function is case sensitive by default.

Parameters

string $value

A string value to check against, potentially with parameters (E.g. 'Varchar(1023)')

array $patterns

A list of strings, some of which may be regular expressions

Return Value

bool

True if this $value is present in any of the $patterns

protected bool validateBaseConfig()

Ensure only one instance of this extension is applied to this class

Return Value

bool

protected bool validateChildConfig()

Non-base classes should never have fluent applied; Do this at the root only!

Return Value

bool

protected augmentDatabaseDontRequire($localisedTable)

No description

Parameters

$localisedTable

protected augmentDatabaseRequireTable(string $localisedTable, array $fields, array $indexes)

Require the given localisation table

Parameters

string $localisedTable
array $fields
array $indexes

protected void handleClassChanged()

If an object is changed to another class, we should trigger localised copy

Return Value

void

Exceptions

ValidationException

protected localiseManipulationTable(array $manipulation, string $table, string $localeTable, array $localisedFields, Locale $locale)

Localise a database manipluation from one table to another

Parameters

array $manipulation
string $table

Table in manipulation to copy from

string $localeTable

Table to copy manipulation to

array $localisedFields

List of fields to filter write to

Locale $locale

string getLocalisedTable(string $tableName, string $locale = '')

Get the localised table name with the localised suffix and optionally with a locale suffix for aliases

Parameters

string $tableName
string $locale

Return Value

string

string deleteTableTarget(string $tableName, string $locale = '')

Public accessor for getDeleteTableTarget

Parameters

string $tableName
string $locale

Return Value

string

protected string getDeleteTableTarget(string $tableName, string $locale = '')

Get real table name for deleting records (Note: Must have all table replacements applied)

Parameters

string $tableName
string $locale

If passed, this is the locale we wish to delete in. If empty this is the root table

Return Value

string

protected string localiseSelect(string $table, string $field, Locale $locale)

Generates a select fragment based on a field with a fallback

Parameters

string $table
string $field
Locale $locale

Return Value

string

Select fragment

protected string localiseCondition(string $table, string $field, Locale $locale)

Generate a where fragment based on a field with a fallback.

This will be used as a search replacement in all where conditions matching the "Table"."Field" name. Note that unlike localiseSelect, this uses a simple COLASECLE() for performance and to reduce overall query size.

Parameters

string $table
string $field
Locale $locale

Return Value

string

Localised where replacement

protected Locale|null getDataQueryLocale(DataQuery $dataQuery = null)

Get current locale from given dataquery

Parameters

DataQuery $dataQuery

Return Value

Locale|null

updateFluentLocalisedFields(FieldList $fields)

Add / refresh fluent badges to all localised fields.

Note: Idempotent and safe to call multiple times

Parameters

FieldList $fields

protected Locale|null getRecordLocale()

Get locale this record was originally queried from, or belongs to

Return Value

Locale|null

Locale|null getSourceLocale()

Returns the source locale that will display the content for this record

Return Value

Locale|null

protected null|int getManipulationRecordID(array $updates)

Extract the RecordID value for the given write

Parameters

array $updates

Updates for the current table

Return Value

null|int

Record ID, or null if not found

RecordLocale> Locales()

Templatable list of all locale information for this record

Return Value

RecordLocale>

RecordLocale LocaleInformation(string $locale = null)

Retrieves information about this object in the specified locale

Parameters

string $locale

The locale (code) information to request, or null to use the default locale

Return Value

RecordLocale

array getLocaleInstances()

Get list of locales where record is localised in draft mode

Return Value

array

string BaseURLForLocale(string $locale)

Determine the baseurl within a specified $locale.

Parameters

string $locale Locale

Return Value

string

string cacheKeyComponent()

Ensure has_one cache is segmented by locale

Return Value

string

updateFluentCMSField(FormField $field)

Add fluent tooltip to given field.

You can use this to add fluent tag to custom fields.

Parameters

FormField $field

protected string getInheritanceMode()

Require that this record is saved in the given locale for it to be visible

Return Value

string

protected array detectLocalisedTableField(array $tables, string $sql)

Detect a localised field within a SQL fragment.

Works with either select / sort fragments

If successful, return an array [ thetable, thefield, fqn ] Otherwise [ null, null ]

Parameters

array $tables

Map of known table and nested fields to search

string $sql

The SQL string to inspect

Return Value

array

Three item array with table and field and a flag for whether the fragment is fully quolified

RecordLocale getSelectedLanguage()

Returns the selected language

Return Value

RecordLocale

bool existsInLocale(string $locale = null)

Check if this record exists (in either state) in this locale

Parameters

string $locale

Return Value

bool

protected bool findRecordInLocale(string $locale, string $table, int $id)

Checks whether the given record ID exists in the given locale, in the given table. Skips using the ORM because we don't need it for this call.

Parameters

string $locale
string $table
int $id

Return Value

bool

bool getLocalisedCopyActive()

No description

Return Value

bool

DataObject setLocalisedCopyActive(bool $active)

No description

Parameters

bool $active

Return Value

DataObject

mixed withLocalisedCopyState(callable $callback)

Localised copy global state manipulation useful for disabling localised copy feature in parts of the code

Parameters

callable $callback

Return Value

mixed

void copyToLocale(string $toLocale)

Copy data object content from current locale to the target locale

Parameters

string $toLocale

Return Value

void

Exceptions

ValidationException

protected void makeLocalisedCopy()

Duplicate related objects based on configuration Provides an extension hook for custom duplication

Return Value

void

protected bool localisedCopyNeeded()

Determine if localised copy is needed

Return Value

bool