1. class
  2. SilverStripe
  3. \
  4. Versioned
  5. \
  6. VersionedStateExtension

VersionedStateExtension

class VersionedStateExtension extends Extension (View source)

Persists versioned state between requests via querystring arguments

Properties

RequestHandler|DataObject $owner

Methods

__construct()

No description

from  Extension
static 
add_to_class(string $class, string $extensionClass, mixed $args = null)

Called when this extension is added to a particular class

from  Extension
setOwner(object $owner)

Set the owner of this extension.

from  Extension
mixed
withOwner(mixed $owner, callable $callback, array $args = [])

Temporarily modify the owner. The original owner is ensured to be restored

from  Extension
clearOwner()

Clear the current owner, and restore extension to the state prior to the last setOwner()

from  Extension
object
getOwner()

Returns the owner of this extension.

from  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()}.

from  Extension
mixed
invokeExtension(object $owner, string $method, array ...$arguments)

Invoke extension point. This will prefer explicit extend prefixed methods.

from  Extension
updateLink(string $link)

Auto-append current stage if we're in draft, to avoid relying on session state for this, and the related potential of showing draft content without varying the URL itself.

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

Parameters

string $class
string $extensionClass
mixed $args

in Extension at line 60
setOwner(object $owner)

Set the owner of this extension.

Parameters

object $owner

The owner object

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

Parameters

mixed $owner

Owner to set
callable $callback

Callback to invoke
array $args

Args to pass to callback

Return Value

mixed

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.

Return Value

object

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

Parameters

string $extensionStr

E.g. "Versioned('Stage','Live')"

Return Value

string

Extension classname, e.g. "Versioned"

in Extension at line 128
mixed invokeExtension(object $owner, string $method, array ...$arguments)

Invoke extension point. This will prefer explicit extend prefixed methods.

Parameters

object $owner
string $method
array ...$arguments

Return Value

mixed

Auto-append current stage if we're in draft, to avoid relying on session state for this, and the related potential of showing draft content without varying the URL itself.

Assumes that if the user has access to view the current record in draft stage, they can also view other draft records. Does not concern itself with verifying permissions for performance reasons.

This should also pull through to form actions.

Parameters

string $link