class RelationValidationService implements Resettable (View source)

Basic validation of relationship setup, this tool makes sure your relationships are set up correctly in both directions The validation is configurable and inspection can be narrowed down by namespace, class and relation name

This tool is opt-in and runs via flush and outputs notices For strict validation it is recommended to hook this up to your unit test suite

Traits

Provides extensions to this object to integrate it with standard config API methods.

A class that can be instantiated or replaced via DI

Config options

output_enabled bool

Enable / disable validation output during flush This is disabled by default (opt-in)

allow_rules array

Only inspect classes with the following namespaces/class prefixes Empty string is a special value which represents classes without namespaces Set the value to null to disable the rule (useful when overriding configuration)

deny_rules array

Any classes with the following namespaces/class prefixes will not be inspected This config is intended to be used together with $allow_rules to narrow down the inspected classes Empty string is a special value which represents classes without namespaces Set the value to null to disable the rule (useful when overriding configuration)

deny_relations array

Relations listed here will not be inspected Format is . for example: Page::class.'.LinkTracking'

Properties

protected bool $ignoreConfig

Ignore any configuration, useful for debugging specific classes

protected array $errors

Methods

public static 
config()

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).

public
mixed
uninherited(string $name)

Gets the uninherited value for the given config option

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

No description

public static 
reset()

Reset the local cache of this object

public
array
validateRelations()

Hook this into your unit tests and assert for empty array like this

public
void
executeValidation()

No description

public
array
inspectClasses(array $classes)

Inspect specified classes - this ignores any configuration Useful for checking specific classes when trying to fix relation configuration

public
bool
isIgnored(string $class, string|null $relation = null)

Check if class is ignored during inspection or not Useful checking if your configuration works as expected Check goes through rules in this order (from generic to more specific): 1 - Allow rules 2 - Deny rules 3 - Deny relations

protected
bool
matchRules(string $class, string $rule)

Match class against specified rules

protected
array
validateClasses(array $classes)

Execute validation for specified classes

protected
void
validateClass(string $class)

No description

protected
void
validateHasOne(string $class)

No description

protected
void
validateBelongsTo(string $class)

No description

protected
void
validateHasMany(string $class)

No description

protected
void
validateManyMany(string $class)

No description

protected
void
validateBelongsManyMany(string $class)

No description

protected
array|null
parsePlainRelation(string $relationData)

No description

protected
string|null
parseManyManyRelation(array|string $relationData)

No description

protected
logError(string $class, string $relation, string $message)

No description

Details

static Config_ForClass config()

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).

Return Value

Config_ForClass

mixed uninherited(string $name)

Gets the uninherited value for the given config option

Parameters

string $name

Return Value

mixed

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

void clearErrors()

No description

Return Value

void

static reset()

Reset the local cache of this object

array validateRelations()

Hook this into your unit tests and assert for empty array like this

$messages = RelationValidationService::singleton()->validateRelations(); $this->assertEmpty($messages, print_r($messages, true));

Return Value

array

Exceptions

ReflectionException

void executeValidation()

No description

Return Value

void

Exceptions

ReflectionException

array inspectClasses(array $classes)

Inspect specified classes - this ignores any configuration Useful for checking specific classes when trying to fix relation configuration

Parameters

array $classes

Return Value

array

bool isIgnored(string $class, string|null $relation = null)

Check if class is ignored during inspection or not Useful checking if your configuration works as expected Check goes through rules in this order (from generic to more specific): 1 - Allow rules 2 - Deny rules 3 - Deny relations

Parameters

string $class
string|null $relation

Return Value

bool

protected bool matchRules(string $class, string $rule)

Match class against specified rules

Parameters

string $class
string $rule

Return Value

bool

protected array validateClasses(array $classes)

Execute validation for specified classes

Parameters

array $classes

Return Value

array

protected void validateClass(string $class)

No description

Parameters

string $class

Return Value

void

protected void validateHasOne(string $class)

No description

Parameters

string $class

Return Value

void

protected void validateBelongsTo(string $class)

No description

Parameters

string $class

Return Value

void

protected void validateHasMany(string $class)

No description

Parameters

string $class

Return Value

void

protected void validateManyMany(string $class)

No description

Parameters

string $class

Return Value

void

protected void validateBelongsManyMany(string $class)

No description

Parameters

string $class

Return Value

void

protected array|null parsePlainRelation(string $relationData)

No description

Parameters

string $relationData

Return Value

array|null

protected string|null parseManyManyRelation(array|string $relationData)

No description

Parameters

array|string $relationData

Return Value

string|null

protected logError(string $class, string $relation, string $message)

No description

Parameters

string $class
string $relation
string $message