1. class
  2. SilverStripe
  3. \
  4. CMS
  5. \
  6. Model
  7. \
  8. SiteTreeLinkTracking

SiteTreeLinkTracking

class SiteTreeLinkTracking extends DataExtension

Adds tracking of links in any HTMLText fields which reference SiteTree or File items.

Attaching this to any DataObject will add four fields which contain all links to SiteTree and File items referenced in any HTMLText fields, and two booleans to indicate if there are any broken links. Call augmentSyncLinkTracking to update those fields with any changes to those fields.

Note that since both SiteTree and File are versioned, LinkTracking and FileTracking will only be enabled for the Stage record.

Note: To support HasBrokenLink for non-SiteTree classes, add a boolean HasBrokenLink field to your db config and this extension will ensure it's flagged appropriately.

Config options

dependencies array Inject parser for each page
show_sitetree_link_tracking boolean Controls visibility of the Link Tracking tab

Properties

DataObject|SiteTreeLinkTracking $owner

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(object $owner)

Set the owner of this extension.

from Extension
mixed
withOwner(mixed $owner, callable $callback, array $args = [])

Temporarily modify the owner. The original owner is ensured to be restored

from Extension
clearOwner()

Clear the current owner, and restore extension to the state prior to the last setOwner()

from Extension
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 that's passed to {@link DataObject::$extensions} or {@link Object::add_extension()}.

from Extension
static 
unload_extra_statics($class, $extension)

No description

from DataExtension
validate(ValidationResult $validationResult)

Hook for extension-specific validation.

from DataExtension
augmentSQL(SQLSelect $query, DataQuery $dataQuery = null)

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

onAfterWrite()

No description

from DataExtension
onBeforeDelete()

No description

from DataExtension
onAfterDelete()

No description

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(string $class = null, string $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
SiteTreeLinkTracking_Parser
getParser()

Parser for link tracking

$this
setParser(SiteTreeLinkTracking_Parser $parser = null)

No description

syncLinkTracking()

Public method to call when triggering symlink extension. Can be called externally, or overridden by class implementations.

augmentSyncLinkTracking()

Find HTMLText fields on {@link owner} to scrape for links that need tracking

int[]
trackLinksInField(string $fieldName, bool $anyBroken = false)

Scrape the content of a field to detect anly links to local SiteTree pages or files

ManyManyThroughList
LinkTracking()

List of site pages linked on this dataobject

Details

in Extension at line 39
__construct()

in Extension at line 50
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 60
setOwner(object $owner)

Set the owner of this extension.

Parameters

object $owner The owner object

in Extension at line 74
mixed withOwner(mixed $owner, callable $callback, array $args = [])

Temporarily modify the owner. The original owner is ensured to be restored

Parameters

mixed $owner Owner to set
callable $callback Callback to invoke
array $args Args to pass to callback

Return Value

mixed

in Extension at line 87
clearOwner()

Clear the current owner, and restore extension to the state prior to the last setOwner()

in Extension at line 100
Object getOwner()

Returns the owner of this extension.

Return Value

Object

in Extension at line 113
static string get_classname_without_arguments(string $extensionStr)

Helper method to strip eval'ed arguments from a string that's 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 19
static unload_extra_statics($class, $extension)

Parameters

$class
$extension

in DataExtension at line 30
validate(ValidationResult $validationResult)

Hook for extension-specific validation.

Parameters

ValidationResult $validationResult Local validation result

Exceptions

ValidationException

in DataExtension at line 40
augmentSQL(SQLSelect $query, DataQuery $dataQuery = null)

Edit the given query object to support queries for this extension

Parameters

SQLSelect $query Query to augment.
DataQuery $dataQuery Container DataQuery for this SQLSelect

in DataExtension at line 50
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 59
augmentWrite(array $manipulation)

Augment a write-record request.

Parameters

array $manipulation Array of operations to augment.

at line 86
onBeforeWrite()

in DataExtension at line 67
onAfterWrite()

in DataExtension at line 71
onBeforeDelete()

at line 137
onAfterDelete()

in DataExtension at line 79
requireDefaultRecords()

in DataExtension at line 83
populateDefaults()

in DataExtension at line 87
can($member)

Parameters

$member

in DataExtension at line 91
canEdit($member)

Parameters

$member

in DataExtension at line 95
canDelete($member)

Parameters

$member

in DataExtension at line 99
canCreate($member)

Parameters

$member

in DataExtension at line 114
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.

Parameters

string $class since this method might be called on the class directly
string $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 209
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 144
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 154
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 166
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 189
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 71
SiteTreeLinkTracking_Parser getParser()

Parser for link tracking

Return Value

SiteTreeLinkTracking_Parser

at line 80
$this setParser(SiteTreeLinkTracking_Parser $parser = null)

Parameters

SiteTreeLinkTracking_Parser $parser

Return Value

$this

at line 100
syncLinkTracking()

Public method to call when triggering symlink extension. Can be called externally, or overridden by class implementations.

{see SiteTreeLinkTracking::augmentSyncLinkTracking}

at line 108
augmentSyncLinkTracking()

Find HTMLText fields on {@link owner} to scrape for links that need tracking

at line 154
int[] trackLinksInField(string $fieldName, bool $anyBroken = false)

Scrape the content of a field to detect anly links to local SiteTree pages or files

Parameters

string $fieldName The name of the field on {@link @owner} to scrape
bool $anyBroken &$anyBroken Will be flagged to true (by reference) if a link is broken.

Return Value

int[] Array of page IDs found (associative array)

at line 32
ManyManyThroughList LinkTracking()

List of site pages linked on this dataobject

Return Value

ManyManyThroughList