Versioned

Construct a new Versioned object.

Called when this extension is added to a particular class

Set the owner of this extension.

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()

Returns the owner of this extension.

Helper method to strip eval'ed arguments from a string that's passed to DataObject::$extensions or Object::add_extension().

No description

Hook for extension-specific validation.

Augment the the SQLSelect that is created by the DataQuery

See {\SilverStripe\Versioned\augmentLazyLoadFields} for lazy-loading applied prior to this.

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.

Augment a write-record request.

Extend the owner's onBeforeWrite() logic

See DataObject::onBeforeWrite() for context.

No description

Extend the owner's onBeforeDelete() logic

See DataObject::onBeforeDelete() for context.

Extend the owner's onAfterDelete() logic

See DataObject::onAfterDelete() for context.

Extend the owner's requireDefaultRecords() logic

See DataObject::requireDefaultRecords() for context.

Extend the owner's populateDefaults() logic

See DataObject::populateDefaults() for context.

Extend the owner's onAfterBuild() logic

See DataObject::onAfterBuild() for context.

Influence the owner's can() permission check value to be disallowed (false), allowed (true) if no other processed results are to disallow, or open (null) to not affect the outcome.

See DataObject::can()} and {@link DataObject::extendedCan() for context.

Influence the owner's canEdit() permission check value to be disallowed (false), allowed (true) if no other processed results are to disallow, or open (null) to not affect the outcome.

See DataObject::canEdit()} and {@link DataObject::extendedCan() for context.

Influence the owner's canDelete() permission check value to be disallowed (false), allowed (true) if no other processed results are to disallow, or open (null) to not affect the outcome.

See DataObject::canDelete()} and {@link DataObject::extendedCan() for context.

Influence the owner's canCreate() permission check value to be disallowed (false), allowed (true) if no other processed results are to disallow, or open (null) to not affect the outcome.

See DataObject::canCreate()} and {@link DataObject::extendedCan() for context.

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.

No description

This function is used to provide modifications to the Validators used on a DataObject.

Caution: Use CompositeValidator->addValidator() to add Validators.

This function is used to provide modifications to the form used for front end forms. DataObject->getFrontEndFields()

Caution: Use FieldList->push() to add fields.

This is used to provide modifications to the form actions used in the CMS. 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']

No description

Reset static configuration variables to their default values.

Amend freshly created DataQuery objects with versioned-specific information.

Get this record at a specific version

Get modified date for the given version

Get modified date and stage for the given version

Updates query parameters of relations attached to versioned dataobjects

Reading a specific stage (Stage or Live)

Reading a specific stage, but only return items that aren't in any other stage

Augment SQL to select from _Versions table instead.

Prepare a sub-select for determining latest versions of records on the base table. This is used as either an inner join or sub-select on the base query

Indicates if a subquery filtering versioned records should apply as a condition instead of an inner join

Filter the versioned history by a specific date and archive stage

Return latest version instance, regardless of whether it is on a particular stage.

This is similar to augmentSQLVersionedLatest() below, except it only returns a single value selected by Versioned.id

Return latest version instances, regardless of whether they are on a particular stage.

This provides "show all, including deleted" functionality.

Note: latest_version ignores deleted versions, and will select the latest non-deleted version.

If selecting a specific version, filter it here

If all versions are requested, ensure that records are sorted by this field

Determine if the given versioned table is a part of the sub-tree of the current dataobject This helps prevent rewriting of other tables that get joined in, in particular, many_many tables

For lazy loaded fields requiring extra sql manipulation, ie versioning.

Cleanup orphaned records in the _Versions table

Generates a ($table)_version DB manipulation and injects it into the current $manipulation

Rewrite the given manipulation to update the selected (non-default) stage

Adds a WasDeleted=1 version entry for this record, and records any stages the deletion applies to

Perform a write without affecting the version table.

Check if next write is without version

Set if next write should be without version or not

Check if delete() should write _Version rows or not

Set if delete() should write _Version rows

Helper method to safely suppress delete callback

If a write was skipped, then we need to ensure that we don't leave a migrateVersion() value lying around for the next write.

This function should return true if the current user can publish this record.

It can be overloaded to customise the security model for an application.

Denies permission if any of the following conditions is true:

• canPublish() on any extension returns false
• canEdit() returns false

Check if the current user can delete this record from live

Check if the current user is allowed to archive this record.

If extended, ensure that both canDelete and canUnpublish are extended also

Check if the user can revert this record to live

Check if the user can restore this record to draft

Extend permissions to include additional security for objects that are not published to live.

Determine if there are any additional restrictions on this object for the given reading version.

Override this in a subclass to customise any additional effect that Versioned applies to canView.

This is expected to be called by canView, and thus is only responsible for denying access if the default canView would otherwise ALLOW access. Thus it should not be called in isolation as an authoritative permission check.

This has the following extension points:

• canViewDraft is invoked if Mode = stage and Stage = stage
• canViewArchived is invoked if Mode = archive

Determines canView permissions for the latest version of this object on a specific stage.

Usually the stage is read from Versioned::current_stage().

This method should be invoked by user code to check if a record is visible in the given stage.

This method should not be called via ->extend('canViewStage'), but rather should be overridden in the extended class.

Determine if a class is supporting the Versioned extensions (e.g.

$table_Versions does exists).

Check if a certain table has the 'Version' field.

No description

Determines if the current draft version is the same as live or rather, that there are no outstanding draft changes

No description

Publishes this object to Live, but doesn't publish owned objects.

User code should call {\SilverStripe\Versioned\canPublish()} prior to invoking this method.

Removes the record from both live and stage

User code should call {\SilverStripe\Versioned\canArchive()} prior to invoking this method.

Removes this record from the live site

User code should call {\SilverStripe\Versioned\canUnpublish()} prior to invoking this method.

Determine if this object is published, and has any published owners.

If this is true, a warning should be shown before this is published.

Note: This method returns false if the object itself is unpublished, since owners are only considered on the same stage as the record itself.

Revert the draft changes: replace the draft content with the content on live

User code should call {\SilverStripe\Versioned\canRevertToLive()} prior to invoking this method.

No description

No description

Move a database record from one stage to the other.

Get version migrated to

No description

Set the migrating version.

Compare two stages to see if they're different.

Only checks the version numbers, not the actual content.

No description

Return a list of all the versions available.

Compare two version, and return the diff between them.

Return the base table - the class that directly extends DataObject.

Protected so it doesn't conflict with DataObject::baseTable()

Given a table and stage determine the table name.

Note: Stages this asset does not exist in will default to the draft table.

Determine if the current user is able to set the given site stage / archive

Choose the stage the site is currently on.

If $_GET['stage'] is set, then it will use that stage, and store it in the session.

if $_GET['archiveDate'] is set, it will use that date, and store it in the session.

If neither of these are set, it checks the session, otherwise the stage is set to 'Live'.

Set the current reading mode.

Get the current reading mode.

Get the current reading stage.

Get the current archive date.

Get the current archive stage.

Set the reading stage.

Replace default mode.

An non-default mode should be specified via querystring arguments.

Get default reading mode

Check if draft site should be secured.

Can be turned off if draft site unauthenticated

Set if the draft site should be secured or not

Set the reading archive date.

Get a singleton instance of a class in the given stage.

Gets the current version number of a specific record.

Hook into Hierarchy::prepopulateTreeDataCache.

Pre-populate the cache for Versioned::get_versionnumber_by_stage() for a list of record IDs, for more efficient database querying. If $idList is null, then every record will be pre-cached.

Get a set of class instances by the given stage.

Delete this record from the given stage

Write the given record to the given stage.

Note: If writing to live, this will write to stage as well.

Roll the draft version of this record to match the published record.

Caution: Doesn't overwrite the object properties with the rolled back version.

{\SilverStripe\Versioned\doRevertToLive()} to reollback to live

No description

Recursively rollback draft to the given version. This will also rollback any owned objects at that point in time to the same date. Objects which didn't exist (or weren't attached) to the record at the target point in time will be "unlinked", which dis-associates the record without requiring a hard deletion.

Rollback draft to a given version

Return the latest version of the given record.

Returns whether the current record is the latest one.

Performance - could do this directly via SQL.

Returns whether the current record's version is the current live/published version

Returns whether the current record's version is the current draft/modified version

Check if this record exists on live On objects with only 1 stage, check if the record exists on that stage.

Check if page doesn't exist on any stage, but used to be

Check if this record exists on the draft stage.

On objects with only 1 stage, check if the record exists on that stage.

Compares current draft with live version, and returns true if no draft version of this page exists but the page is still published (eg, after triggering "Delete from draft site" in the CMS).

Compares current draft with live version, and returns true if no live version exists, meaning the page was never published.

Compares current draft with live version, and returns true if these versions differ, meaning there have been unpublished changes to the draft site.

Return the equivalent of a DataList::create() call, querying the latest version of each record stored in the (class)_Versions tables.

In particular, this will query deleted records as well as active ones.

Return the specific version of the given id.

Caution: The record is retrieved as a DataObject, but saving back modifications via write() will create a new version, rather than modifying the existing one.

Return a list of all versions for a given id.

Ensure version ID is reset to 0 on duplicate

No description

Return a piece of text to keep DataObject cache keys appropriately specific.

Returns an array of possible stages.

Called by SSViewer to get a list of global variables to expose to the template, the static method to call on this class to get the value for those variables, and the class to use for casting the returned value for use in a template

If the method to call is not included for a particular template variable, a method named the same as the template variable will be called

If the casting class is not specified for a particular template variable, ViewableData::$default_cast is used

The first letter of the template variable is case-insensitive. However the method name is always case sensitive.

Check if this object has stages

Invoke a callback which may modify reading mode, but ensures this mode is restored after completion, without modifying global state.

The desired reading mode should be set by the callback directly

Get author of this record.

Note: Only works on records selected via Versions()

Get publisher of this record.

Note: Only works on records selected via Versions()