SiteTreeLinkTracking
class SiteTreeLinkTracking extends Extension (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 | |||
| protected | SiteTreeLinkTracking_Parser | $parser |
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 DataObject::$extensions or Object::add_extension().
Invoke extension point. This will prefer explicit extend prefixed
methods.
Public method to call when triggering symlink extension. Can be called externally, or overridden by class implementations.
Find HTMLText fields on owner to scrape for links that need tracking
Scrape the content of a field to detect anly links to local SiteTree pages or files
Add the given css class to the DOM element.
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
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()
T
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 DataObject::$extensions or Object::add_extension().
mixed
invokeExtension(object $owner, string $method, array ...$arguments)
Invoke extension point. This will prefer explicit extend prefixed
methods.
SiteTreeLinkTracking_Parser
getParser()
Parser for link tracking
$this
setParser(SiteTreeLinkTracking_Parser|null $parser = null)
No description
protected
onBeforeWrite()
No description
syncLinkTracking()
Public method to call when triggering symlink extension. Can be called externally, or overridden by class implementations.
{\SilverStripe\CMS\Model\SiteTreeLinkTracking::augmentSyncLinkTracking}
protected
augmentSyncLinkTracking()
Find HTMLText fields on owner to scrape for links that need tracking
protected
onAfterDelete()
No description
int[]
trackLinksInField(string $fieldName, bool $anyBroken = false)
Scrape the content of a field to detect anly links to local SiteTree pages or files
protected
toggleElementClass(DOMElement $domReference, string $class, bool $toggle)
Add the given css class to the DOM element.
protected
updateCMSFields(FieldList $fields)
No description
void
ManyManyThroughList() $SiteTree> LinkTracking()
No description