FluentVersionedExtension
class FluentVersionedExtension extends FluentExtension implements Resettable (View source)
Extension for versioned localised objects
Important: If adding this to a custom object, this extension must be added AFTER the versioned extension.
Use yaml after to enforce this
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 |
| SUFFIX_LIVE |
Live table suffix |
| SUFFIX_VERSIONS |
Versions table suffix |
| CACHE_COMPLETE |
Indicates that record is missing in this locale and the cache search for it is complete so we can avoid multiple lookups of a missing record |
Properties
| $owner | DataObject | from UsesDeletePolicy | ||
| protected | $localisedFields | Cache of localised fields for this model |
from FluentExtension | |
| protected | bool | $localisedCopyActive | Global state of localised copy feature |
from FluentExtension |
| protected | array | $defaultVersionsFields | Default version table fields. _Versions has extra Version column. |
|
| protected | array | $defaultVersionsIndexes | Default version table indexes, including unique index to include Version column. |
|
| protected | array | $versionsCache | Cache for versions related data lookups |
|
| protected static | int[][][] | $idsInLocaleCache | Array of objectIds keyed by table (ie. stage) and locale. This knows ALL object IDs that exist in the given table and locale. |
Methods
Called when this extension is added to a particular class
Temporarily modify the owner. The original owner is ensured to be restored
Clear the current owner, and restore extension to the state prior to the last setOwner()
Helper method to strip eval'ed arguments from a string that's passed to DataObject::$extensions or Object::add_extension().
Invoke extension point. This will prefer explicit extend prefixed
methods.
Edit the given query object to support queries for this extension
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.
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.
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.
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.
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.
Define extra database fields
This function is used to provide modifications to the Validators used on a DataObject.
This function is used to provide modifications to the form used for front end forms. DataObject->getFrontEndFields()
This is used to provide modifications to the form actions used in the CMS. DataObject->getCMSActions().
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']
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']
Gets list of all Locale dataobjects, linked to this record
Amend freshly created DataQuery objects with the current locale and frontend status
Get list of fields that are localised
Check if a field is marked for localisation
Get all database tables in the class ancestry and their respective translatable fields
Helper function to check if the value given is present in any of the patterns.
Ensure only one instance of this extension is applied to this class
Non-base classes should never have fluent applied; Do this at the root only!
Require the given localisation table
If an object is duplicated also duplicate existing localised values from original to new object.
If an object is changed to another class, we should trigger localised copy
Localise a database manipluation from one table to another
Get the localised table name with the localised suffix and optionally with a locale suffix for aliases
Public accessor for getDeleteTableTarget
Decorate table to delete with _Live suffix as necessary
Generates a select fragment based on a field with a fallback
Generate a where fragment based on a field with a fallback.
Get locale this record was originally queried from, or belongs to
Returns the source locale that will display the content for this record
Extract the RecordID value for the given write
Templatable list of all locale information for this record
Retrieves information about this object in the specified locale
Get list of locales where record is localised in draft mode
Determine the baseurl within a specified $locale.
Update preview link to null if the object isn't in the current locale and we can't fallback cleanly.
Require that this record is saved in the given locale for it to be visible
Detect a localised field within a SQL fragment.
Check if this record exists (in either state) in this locale
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.
Localised copy global state manipulation useful for disabling localised copy feature in parts of the code
Copy data object content from current locale to the target locale
Duplicate related objects based on configuration Provides an extension hook for custom duplication
Update all joins to include Version as well as Locale / Record
Rename all localised tables to the "live" equivalent name (note: alias remains unchanged)
Narrow down the list of versions down to only those which are related to current locale
Check if this record is published in this locale
Check if this record has modifications in this locale Fluent friendly version of Versioned::stagesDiffer()
Check to see whether or not a record exists for a specific Locale in a specific stage.
Hook into Hierarchy::prepopulateTreeDataCache.
Prepopulate the cache of IDs in a locale, to optimise batch calls to isLocalisedInStage.
Localise archived state Extension point in Versioned::isArchived()
Check if the record has previously existed in a locale
Localise max version lookup Extension point in Versioned::prepareMaxVersionSubSelect()
Localise version cache populate Extension point in Versioned::prepopulate_versionnumber_cache()
Localise version lookup Extension point in Versioned::get_versionnumber_by_stage()
List versions for all objects in current locale (or a subset based on provided ids)
No description
No description
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
setOwner(object $owner)
Set the owner of this extension.
mixed
withOwner(mixed $owner, callable $callback, array $args = [])
Temporarily modify the owner. The original owner is ensured to be restored
clearOwner()
Clear the current owner, and restore extension to the state prior to the last setOwner()
T
getOwner()
Returns the owner of this extension.
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().
mixed
invokeExtension(object $owner, string $method, array ...$arguments)
Invoke extension point. This will prefer explicit extend prefixed
methods.
validate(ValidationResult $validationResult)
Hook for extension-specific validation.
augmentSQL(SQLSelect $query, DataQuery $dataQuery = null)
Edit the given query object to support queries for this extension
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)
Apply versioning to write
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
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.
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.
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.
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.
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.
updateCMSFields(FieldList $fields)
No description
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.
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.
updateCMSActions(FieldList $actions)
This is used to provide modifications to the form actions used in the CMS. DataObject->getCMSActions().
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']
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']
updateDeleteTables(array $queriedTables)
Override delete behaviour.
Hooks into {\TractorCow\Fluent\Model\Delete\DataObject::delete()}
updateLocalisationTabColumns($summaryColumns)
No description
updateLocalisationTabConfig(GridFieldConfig $config)
Add versioning extensions for gridfield
Locale>
LinkedLocales()
Gets list of all Locale dataobjects, linked to this record
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.
These fields are added in addition to those added by specific extensions
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
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.
This function is case sensitive by default.
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
void
onAfterDuplicate($original, $doWrite, $relations)
If an object is duplicated also duplicate existing localised values from original to new object.
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
string
getLocalisedTable(string $tableName, string $locale = '')
Get the localised table name with the localised suffix and optionally with a locale suffix for aliases
string
deleteTableTarget(string $tableName, string $locale = '')
Public accessor for getDeleteTableTarget
protected string
getDeleteTableTarget(string $tableName, string $locale = '')
Decorate table to delete with _Live suffix as necessary
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.
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.
protected Locale|null
getDataQueryLocale(DataQuery $dataQuery = null)
Get current locale from given dataquery
updateFluentLocalisedFields(FieldList $fields)
Add / refresh fluent badges to all localised fields.
Note: Idempotent and safe to call multiple times
protected Locale|null
getRecordLocale()
Get locale this record was originally queried from, or belongs to
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
RecordLocale>
Locales()
Templatable list of all locale information for this record
RecordLocale
LocaleInformation(string $locale = null)
Retrieves information about this object in the specified locale
array
getLocaleInstances()
Get list of locales where record is localised in draft mode
string
BaseURLForLocale(string $locale)
Determine the baseurl within a specified $locale.
string
cacheKeyComponent()
Ensure has_one cache is segmented by locale
updateFluentCMSField(FormField $field)
Add fluent tooltip to given field.
You can use this to add fluent tag to custom fields.
void
updatePreviewLink(?string $link)
Update preview link to null if the object isn't in the current locale and we can't fallback cleanly.
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.
Works with either select / sort fragments
If successful, return an array [ thetable, thefield, fqn ] Otherwise [ null, null ]
RecordLocale
getSelectedLanguage()
Returns the selected language
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.
bool
getLocalisedCopyActive()
No description
DataObject
setLocalisedCopyActive(bool $active)
No description
mixed
withLocalisedCopyState(callable $callback)
Localised copy global state manipulation useful for disabling localised copy feature in parts of the code
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
protected
rewriteVersionedTables(SQLSelect $query, array $tables, Locale $locale)
Rewrite all joined tables
protected
addLocaleFallbackChain(SQLSelect $query, string $tableName, Locale $locale)
Update all joins to include Version as well as Locale / Record
protected
renameLocalisedTables(SQLSelect $query, array $tables)
Rename all localised tables to the "live" equivalent name (note: alias remains unchanged)
protected
localiseVersionsLookup(SQLSelect $query, Locale $locale)
Narrow down the list of versions down to only those which are related to current locale
bool
isDraftedInLocale(string $locale = null)
Check if this record is saved in this locale
bool
isPublishedInLocale(string $locale = null)
Check if this record is published in this locale
bool
stagesDifferInLocale(string|null $locale = null)
Check if this record has modifications in this locale Fluent friendly version of Versioned::stagesDiffer()
protected bool
isLocalisedInStage(string $stage, string $locale = null)
Check to see whether or not a record exists for a specific Locale in a specific stage.
flushCache()
deprecated
deprecated 7.3.0 Will be renamed to onFlushCache()
Clear internal static property caches
void
flushVersionsCache()
No description
static
reset()
Reset the local cache of this object
onPrepopulateTreeDataCache(DataList|array $recordList = null, array $options = [])
Hook into Hierarchy::prepopulateTreeDataCache.
static
prepoulateIdsInLocale(string $locale, string $dataObjectClass, bool $populateLive = true, bool $populateDraft = true)
Prepopulate the cache of IDs in a locale, to optimise batch calls to isLocalisedInStage.
void
updateStagesDiffer(bool $stagesDiffer)
Extension point in Versioned::stagesDiffer()
void
updateIsArchived(bool $isArchived)
Localise archived state Extension point in Versioned::isArchived()
bool|null
isArchivedInLocale(string|null $locale = null)
No description
bool|null
hasArchiveInLocale(string $locale = null)
Check if the record has previously existed in a locale
void
augmentMaxVersionSubSelect(SQLSelect $subSelect, DataQuery $dataQuery, bool $shouldApplySubSelectAsCondition)
Localise max version lookup Extension point in Versioned::prepareMaxVersionSubSelect()
void
updatePrePopulateVersionNumberCache(array $versions, DataObject|string $class, string $stage, array|null $idList)
Localise version cache populate Extension point in Versioned::prepopulate_versionnumber_cache()
void
updateGetVersionNumberByStage(int|null $version, DataObject|string $class, string $stage, int $id, bool $cache)
Localise version lookup Extension point in Versioned::get_versionnumber_by_stage()
protected array
getCurrentVersionNumbers(string $class, string $stage, array|null $ids = null)
List versions for all objects in current locale (or a subset based on provided ids)
protected int|bool|null
getVersionCacheItem(string $class, string $stage, string $locale, int $id)
No description
protected void
setVersionCacheItem(string $class, string $stage, string $locale, mixed $key, int|null $value = 0)
No description