SiteTreeLinkTracking
class SiteTreeLinkTracking extends DataExtension (View source)
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.
Properties
| DataObject|SiteTreeLinkTracking | $owner | ||
| static private array | $dependencies | Inject parser for each page |
|
| static private bool | $show_sitetree_link_tracking | Controls visibility of the Link Tracking tab |
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 {@link DataObject::$extensions} or {@link Object::add_extension()}.
Invoke extension point. This will prefer explicit extend prefixed
methods.
Edit the given query object to support queries for this extension
No description
No description
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. {@link DataObject->getCMSFields()}.
This function is used to provide modifications to the form used for front end forms. {@link DataObject->getFrontEndFields()}
This is used to provide modifications to the form actions used in the CMS. {@link 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']
Parser for link tracking
Public method to call when triggering symlink extension. Can be called externally, or overridden by class implementations.
Find HTMLText fields on {@link owner} to scrape for links that need tracking
Scrape the content of a field to detect anly links to local SiteTree pages or files
List of site pages linked on this dataobject
Details
__construct()
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()
object
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 {@link DataObject::$extensions} or {@link Object::add_extension()}.
mixed
invokeExtension(object $owner, string $method, array ...$arguments)
Invoke extension point. This will prefer explicit extend prefixed
methods.
static
unload_extra_statics($class, $extension)
validate(ValidationResult $validationResult)
Hook for extension-specific validation.
augmentSQL(SQLSelect $query, DataQuery $dataQuery = null)
Edit the given query object to support queries for this extension
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.
augmentWrite(array $manipulation)
Augment a write-record request.
onBeforeWrite()
onAfterWrite()
onBeforeDelete()
onAfterDelete()
requireDefaultRecords()
populateDefaults()
can($member)
canEdit($member)
canDelete($member)
canCreate($member)
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. {@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.
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.
updateCMSActions(FieldList $actions)
This is used to provide modifications to the form actions used in the CMS. {@link 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']
SiteTreeLinkTracking_Parser
getParser()
Parser for link tracking
$this
setParser(SiteTreeLinkTracking_Parser $parser = null)
syncLinkTracking()
Public method to call when triggering symlink extension. Can be called externally, or overridden by class implementations.
{see \SilverStripe\CMS\Model\SiteTreeLinkTracking::augmentSyncLinkTracking}
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