FluentFilteredExtension
class FluentFilteredExtension extends DataExtension (View source)
Traits
Shared functionality between both FluentExtension and FluentFilteredExtension
Constants
| SUFFIX | 
                     The table suffix that will be applied to a DataObject's base table.  | 
            
Properties
| $owner | DataObject | from UsesDeletePolicy | 
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.
Update the database schema as required by this extension.
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 form in the CMS by the extension. By default, no changes are made. DataObject->getCMSFields().
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
This method is only called if the Extension has been applied to SiteTree. If you are using this Extension on other DataObjects you will need to implement your own Extension or method on that DataObject for flagging the "filtered" state.
There are two different DRAFT modes. One when browsing stage, and one when browsing archive. Both modes have "Stage" at the very end of their reading_mode name.
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.
        
                            
    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.
        
                            
    onBeforeWrite()
        
    
    Extend the owner's onBeforeWrite() logic
See DataObject::onBeforeWrite() for context.
        
                            
    onAfterWrite()
        
    
    Extend the owner's onAfterWrite() logic
See DataObject::onAfterWrite() for context.
        
                            
    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)
        
    
    This function is used to provide modifications to the form in the CMS by the extension. By default, no changes are made. DataObject->getCMSFields().
Please consider using updateFormFields() to globally add formfields to the record. The method updateCMSFields() should just be used to add or modify tabs, or fields which are specific to the CMS-context.
Caution: Use FieldList->addFieldToTab() to add fields.
        
                            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)
        
    
    No description
        
                            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
        
                            
    updateStatusFlags(array $flags)
        
    
    This method is only called if the Extension has been applied to SiteTree. If you are using this Extension on other DataObjects you will need to implement your own Extension or method on that DataObject for flagging the "filtered" state.
        
                            bool
    isAvailableInLocale(string|Locale|null $locale = null)
        
    
    No description
        
                    protected        Locale|null
    getDataQueryLocale(DataQuery $dataQuery = null)
        
    
    Get current locale from given dataquery
        
                    protected        bool
    getModeIsStage()
        
    
    There are two different DRAFT modes. One when browsing stage, and one when browsing archive. Both modes have "Stage" at the very end of their reading_mode name.
        
                            void
    ManyManyList() $Locale> FilteredLocales()
        
    
    No description