SiteTreeFileExtension

class SiteTreeFileExtension extends DataExtension

Properties

$class from Extension

Methods

__construct()

No description

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

Called when this extension is added to a particular class

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

Set the owner of this extension.

from Extension
clearOwner()

No description

from Extension
SS_Object
getOwner()

Returns the owner of this extension.

from Extension
static string
get_classname_without_arguments(string $extensionStr)

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

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

No description

from DataExtension
static 
unload_extra_statics($class, $extension)

No description

from DataExtension
validate(ValidationResult $validationResult)

Hook for extension-specific validation.

from DataExtension
augmentSQL(SQLQuery $query)

Edit the given query object to support queries for this extension

from DataExtension
augmentDatabase()

Update the database schema as required by this extension.

from DataExtension
augmentWrite(array $manipulation)

Augment a write-record request.

from DataExtension
onBeforeWrite()

No description

from DataExtension
onAfterWrite()

No description

from DataExtension
onBeforeDelete()

No description

from DataExtension
onAfterDelete()

Updates link tracking.

requireDefaultRecords()

No description

from DataExtension
populateDefaults()

No description

from DataExtension
can($member)

No description

from DataExtension
canEdit($member)

No description

from DataExtension
canDelete($member)

No description

from DataExtension
canCreate($member)

No description

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

Define extra database fields

from DataExtension
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. {@link DataObject->getCMSFields()}.

updateFrontEndFields(FieldList $fields)

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

from DataExtension
updateCMSActions(FieldList $actions)

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

from DataExtension
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
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
string
BackLinkHTMLList()

Generate an HTML list which provides links to where a file is used.

ManyManyList
BackLinkTracking(string|array $filter = null, string $sort = null, string $join = null, string $limit = null)

Extend through {@link updateBackLinkTracking()} in your own {@link Extension}.

integer
BackLinkTrackingCount()

No description

updateLinks(string $old, string $new)

Rewrite links to the $old file to now point to the $new file.

Details

in Extension at line 42
__construct()

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()

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 {@link DataObject::$extensions} or {@link Object::add_extension()}.

Parameters

string $extensionStr E.g. "Versioned('Stage','Live')"

Return Value

string Extension classname, e.g. "Versioned"

in DataExtension at line 10
static get_extra_config($class, $extension, $args)

Parameters

$class
$extension
$args

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

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 DataExtension at line 50
augmentSQL(SQLQuery $query)

Edit the given query object to support queries for this extension

Parameters

SQLQuery $query Query to augment.

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 {@link Versioned->augmentDatabase} for an example.

in DataExtension at line 67
augmentWrite(array $manipulation)

Augment a write-record request.

Parameters

array $manipulation Array of operations to augment.

in DataExtension at line 70
onBeforeWrite()

in DataExtension at line 73
onAfterWrite()

in DataExtension at line 76
onBeforeDelete()

at line 108
onAfterDelete()

Updates link tracking.

in DataExtension at line 82
requireDefaultRecords()

in DataExtension at line 85
populateDefaults()

in DataExtension at line 88
can($member)

Parameters

$member

in DataExtension at line 91
canEdit($member)

Parameters

$member

in DataExtension at line 94
canDelete($member)

Parameters

$member

in DataExtension at line 97
canCreate($member)

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 12
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. {@link DataObject->getCMSFields()}.

Please consider using {@link updateFormFields()} to globally add formfields to the record. The method {@link updateCMSFields()} should just be used to add or modify tabs, or fields which are specific to the CMS-context.

Caution: Use {@link FieldList->addFieldToTab()} to add fields.

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. {@link DataObject->getFrontEndFields()}

Caution: Use {@link 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. {@link 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

at line 29
string BackLinkHTMLList()

Generate an HTML list which provides links to where a file is used.

Return Value

string

at line 57
ManyManyList BackLinkTracking(string|array $filter = null, string $sort = null, string $join = null, string $limit = null)

Extend through {@link updateBackLinkTracking()} in your own {@link Extension}.

Parameters

string|array $filter
string $sort
string $join
string $limit

Return Value

ManyManyList

at line 96
integer BackLinkTrackingCount()

Return Value

integer

Rewrite links to the $old file to now point to the $new file.

Parameters

string $old File path relative to the webroot
string $new File path relative to the webroot