class DeleteRecordPolicy implements DeletePolicy (View source)

A policy that deletes the root record

Traits

A class that can be instantiated or replaced via DI

Properties

protected DeletePolicy[] $dependantPolicies

List of dependant policies

Methods

public static 
create(mixed ...$args)

An implementation of the factory method, allows you to create an instance of a class

public static 
singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

public
getDependantPolicies()

No description

public
$this
setDependantPolicies(DeletePolicy[] $dependantPolicies)

No description

public
bool
delete(DataObject $record)

No description

protected
deleteBaseRecord(DataObject $record)

Do base record deletion

protected
mixed
getTargetTables(DataObject $record)

Generate table list to delete base record

Details

static Injectable create(mixed ...$args)

An implementation of the factory method, allows you to create an instance of a class

This method will defer class substitution to the Injector API, which can be customised via the Config API to declare substitution classes.

This can be called in one of two ways - either calling via the class directly, or calling on Object and passing the class name as the first parameter. The following are equivalent: $list = DataList::create(SiteTree::class); $list = SiteTree::get();

Parameters

mixed ...$args

Return Value

Injectable

static Injectable singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

It will always return the same instance for this class, which can be used for performance reasons and as a simple way to access instance methods which don't rely on instance data (e.g. the custom SilverStripe static handling).

Parameters

string $class

Optional classname to create, if the called class should not be used

Return Value

Injectable

The singleton instance

DeletePolicy[] getDependantPolicies()

No description

Return Value

DeletePolicy[]

$this setDependantPolicies(DeletePolicy[] $dependantPolicies)

No description

Parameters

DeletePolicy[] $dependantPolicies

Return Value

$this

bool delete(DataObject $record)

No description

Parameters

DataObject $record

Return Value

bool

Determines if any dependent objects block upstream deletion (e.g. db / model constraints) If this returns true, then there are additional conditions that must be satisfied before upstream relational constraints are safe to delete. If this returns true, then all downstream entities are reported purged, and upstream relational constraints can be deleted.

protected deleteBaseRecord(DataObject $record)

Do base record deletion

Parameters

DataObject $record

protected mixed getTargetTables(DataObject $record)

Generate table list to delete base record

Parameters

DataObject $record

Return Value

mixed