class SiteTreePublishingEngine extends DataExtension (View source)

This extension couples to the StaticallyPublishable and StaticPublishingTrigger implementations on the SiteTree objects and makes sure the actual change to SiteTree is triggered/enqueued.

Provides the following information as a context to StaticPublishingTrigger:

  • action - name of the executed action: publish or unpublish

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 URLArrayObject $urlArrayObject

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(SS_Object $owner, string $ownerBaseClass = null)

Set the owner of this extension.

public
clearOwner()

No description

public
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 thats passed to DataObject::$extensions or Object::add_extension().

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

No description

public static 
unload_extra_statics($class, $extension)

No description

public
validate(ValidationResult $validationResult)

Hook for extension-specific validation.

public
augmentSQL(SQLQuery $query)

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

No description

public
onAfterWrite()

No description

public
onBeforeDelete()

No description

public
onAfterDelete()

No description

public
requireDefaultRecords()

No description

public
populateDefaults()

No description

public
can($member)

No description

public
canEdit($member)

No description

public
canDelete($member)

No description

public
canCreate($member)

No description

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

Define extra database fields

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

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
setUrlArrayObject($o)

No description

public
getUrlArrayObject()

No description

public
getToUpdate()

No description

public
getToDelete()

No description

public
setToUpdate($toUpdate)

No description

public
setToDelete($toDelete)

No description

public
onAfterPublish()

No description

public
onBeforeUnpublish()

No description

public
onAfterUnpublish()

No description

public
collectChanges($context)

Collect all changes for the given context.

public
flushChanges()

Execute URL deletions, enqueue URL updates.

public
convertUrlsToPathMap(array $urls)

Converts the array of urls into an array of paths.

public
deleteStaleFiles(array $paths)

Remove the stale variants of the cache files.

public
deleteRegularFiles(array $paths)

Remove the cache files.

public
deleteFromCacheDir(string $path)

Helper method for deleting existing files in the cache directory.

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(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'.

clearOwner()

No description

SS_Object getOwner()

Returns the owner of this extension.

Return Value

SS_Object

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"

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

No description

Parameters

$class
$extension
$args

static unload_extra_statics($class, $extension)

No description

Parameters

$class
$extension

validate(ValidationResult $validationResult)

Hook for extension-specific validation.

Parameters

ValidationResult $validationResult

Local validation result

Exceptions

ValidationException

augmentSQL(SQLQuery $query)

Edit the given query object to support queries for this extension

Parameters

SQLQuery $query

Query to augment.

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

No description

onAfterWrite()

No description

onBeforeDelete()

No description

onAfterDelete()

No description

requireDefaultRecords()

No description

populateDefaults()

No description

can($member)

No description

Parameters

$member

canEdit($member)

No description

Parameters

$member

canDelete($member)

No description

Parameters

$member

canCreate($member)

No description

Parameters

$member

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.

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.

Parameters

FieldList $fields

FieldList with a contained TabSet

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

setUrlArrayObject($o)

No description

Parameters

$o

getUrlArrayObject()

No description

getToUpdate()

No description

getToDelete()

No description

setToUpdate($toUpdate)

No description

Parameters

$toUpdate

setToDelete($toDelete)

No description

Parameters

$toDelete

onAfterPublish()

No description

onBeforeUnpublish()

No description

onAfterUnpublish()

No description

collectChanges($context)

Collect all changes for the given context.

Parameters

$context

flushChanges()

Execute URL deletions, enqueue URL updates.

convertUrlsToPathMap(array $urls)

Converts the array of urls into an array of paths.

This function is subsite-aware: these files could either sit in the top-level cache (no subsites), or sit in the subdirectories (main site and subsites).

See BuildStaticCacheFromQueue::createCachedFiles for similar subsite-specific conditional handling.

Parameters

array $urls

An array of URLs to generate paths for.

deleteStaleFiles(array $paths)

Remove the stale variants of the cache files.

Parameters

array $paths

List of paths relative to the cache root.

deleteRegularFiles(array $paths)

Remove the cache files.

Parameters

array $paths

List of paths relative to the cache root.

deleteFromCacheDir(string $path)

Helper method for deleting existing files in the cache directory.

Parameters

string $path

Path relative to the cache root.