Versioned

Construct a new Versioned object.

Called when this extension is added to a particular class

Set the owner of this extension.

Returns the owner of this extension.

Helper method to strip eval'ed arguments from a string thats passed to {@link DataObject::$extensions} or {@link Object::add_extension()}.

Hook for extension-specific validation.

Augment the the SQLQuery that is created by the DataQuery.

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.

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.

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.

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']

Reset static configuration variables to their default values.

Amend freshly created DataQuery objects with versioned-specific information.

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

Called by {@link SapphireTest} when the database is reset.

Perform a write without affecting the version table.

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

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 {@link 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 table supports the Versioned extensions (e.g. $table_versions does exists).

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

Is the latest version of the object published?

Move a database record from one stage to the other.

Set the migrating version.

Compare two stages to see if they're different. Only checks the version numbers, not the actual content.

Get a list of versions for this object, optionally with additional SQL parameters

Get a list of versions for this object, optionally with additional SQL parameters

Compare two version, and return the differences between them.

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

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 name of the 'live' stage.

Get the current reading stage.

Get the current archive date.

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.

Prepopulate 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 object will be pre-cached.

Get a set of class instances by the given stage.

Delete this item from the specified stage.

Write this item to the specified stage.

Roll the draft version of this object to match the published one.

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

Return the latest version of the given object.

Returns whether the current record is the latest one.

Return the equivalent of a DataList::create() call, querying the latest version of each object 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

Clear the cached version numbers from previous queries.

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

Returns an array of possible stages.