FileLinkTracking
class FileLinkTracking extends DataExtension
Adds tracking of links in any HTMLText fields which reference SiteTree or File items.
Attaching this to any DataObject will a relation which links to File items referenced in any HTMLText fields, and a boolean to indicate if there are any broken file links. Call augmentSyncFileLinkTracking 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.
Config options
| dependencies | array | Inject parser for each page | |
| show_file_link_tracking | boolean | Controls visibility of the File Tracking tab |
Properties
| DataObject|FileLinkTracking | $owner |
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']
FileParser 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
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
in Extension at line 60
setOwner(object $owner)
Set the owner of this extension.
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
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.
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()}.
in Extension at line 128
mixed
invokeExtension(object $owner, string $method, array $arguments)
Invoke extension point. This will prefer explicit extend prefixed
methods.
in DataExtension at line 19
static
unload_extra_statics($class, $extension)
in DataExtension at line 30
validate(ValidationResult $validationResult)
Hook for extension-specific validation.
in DataExtension at line 40
augmentSQL(SQLSelect $query, DataQuery $dataQuery = null)
Edit the given query object to support queries for this extension
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.
at line 98
onBeforeWrite()
in DataExtension at line 67
onAfterWrite()
in DataExtension at line 71
onBeforeDelete()
at line 152
onAfterDelete()
in DataExtension at line 79
requireDefaultRecords()
in DataExtension at line 83
populateDefaults()
in DataExtension at line 87
can($member)
in DataExtension at line 91
canEdit($member)
in DataExtension at line 95
canDelete($member)
in DataExtension at line 99
canCreate($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.
at line 230
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.
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.
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()}.
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']
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']
at line 72
File[]|ManyManyList
ImageTracking()
deprecated
deprecated 4.2..5.0 Use FileTracking() instead
at line 83
FileLinkTrackingParser
getFileParser()
FileParser for link tracking
at line 92
$this
setFileParser(FileLinkTrackingParser $parser = null)
at line 112
syncLinkTracking()
Public method to call when triggering symlink extension. Can be called externally, or overridden by class implementations.
{see FileLinkTracking::augmentSyncLinkTracking}
at line 120
augmentSyncLinkTracking()
Find HTMLText fields on {@link owner} to scrape for links that need tracking
at line 172
int[]
trackLinksInField(string $fieldName, bool $anyBroken = false)
Scrape the content of a field to detect anly links to local SiteTree pages or files