class FilesystemPublisher extends DataExtension (View source)

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
public static $dependencies
protected string $destFolder
protected string $fileExtension

Methods

public
__construct($destFolder = 'cache', $fileExtension = null)

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 static 
set_static_base_url($url) deprecated

Set a different base URL for the static copy of the site.

public
array
urlsToPaths(array $urls)

Transforms relative or absolute URLs to their static path equivalent.

public
array
publishPages(array $urls)

Uses Director::test() to perform in-memory HTTP requests on the passed-in URLs.

protected
string
generatePHPCacheFile(string $content, string $age, string $lastModified, string $contentType)

Generate the templated content for a PHP script that can serve up the given piece of content with the given age and expiry.

protected
string
generatePHPCacheRedirection(string $destination)

Generate the templated content for a PHP script that can serve up a 301 redirect to the given destination.

public
string
getDestDir()

No description

public
array
getExistingStaticCacheFiles()

Return an array of all the existing static cache files, as a map of URL => file. Only returns cache files that will actually map to a URL, based on urlsToPaths.

public
array
getMetadata(string $url)

No description

Details

__construct($destFolder = 'cache', $fileExtension = null)

No description

Parameters

$destFolder

The folder to save the cached site into. This needs to be set in framework/static-main.php as well through the $cacheBaseDir variable.

$fileExtension

The file extension to use, e.g 'html'.
If omitted, then each page will be placed in its own directory, with the filename 'index.html'. If you set the extension to PHP, then a simple PHP script will be generated that can do appropriate cache & redirect header negotation.

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

static set_static_base_url($url) deprecated

deprecated 3.2 Use the "FilesystemPublisher.static_base_url" config setting instead

Set a different base URL for the static copy of the site.

This can be useful if you are running the CMS on a different domain from the website.

Parameters

$url

array urlsToPaths(array $urls)

Transforms relative or absolute URLs to their static path equivalent.

This needs to be the same logic that's used to look up these paths through framework/static-main.php. Does not include the $destFolder prefix.

URL filtering will have already taken place for direct SiteTree links via SiteTree->generateURLSegment()). For all other links (e.g. custom controller actions), we assume that they're pre-sanitized to suit the filesystem needs, as its impossible to sanitize them without risking to break the underlying naming assumptions in URL routing (e.g. controller method names).

Examples (without $domain_based_caching):

Examples (with $domain_based_caching):

Parameters

array $urls

Absolute or relative URLs

Return Value

array

Map of original URLs to filesystem paths (relative to $destFolder).

array publishPages(array $urls)

Uses Director::test() to perform in-memory HTTP requests on the passed-in URLs.

Parameters

array $urls

Relative URLs

Return Value

array

Result, keyed by URL. Keys:

  • "statuscode": The HTTP status code
  • "redirect": A redirect location (if applicable)
  • "path": The filesystem path where the cache has been written

protected string generatePHPCacheFile(string $content, string $age, string $lastModified, string $contentType)

Generate the templated content for a PHP script that can serve up the given piece of content with the given age and expiry.

Parameters

string $content
string $age
string $lastModified
string $contentType

Return Value

string

protected string generatePHPCacheRedirection(string $destination)

Generate the templated content for a PHP script that can serve up a 301 redirect to the given destination.

Parameters

string $destination

Return Value

string

string getDestDir()

No description

Return Value

string

array getExistingStaticCacheFiles()

Return an array of all the existing static cache files, as a map of URL => file. Only returns cache files that will actually map to a URL, based on urlsToPaths.

Return Value

array

array getMetadata(string $url)

No description

Parameters

string $url

Return Value

array