class FieldAccessor (View source)

A utility class that handles an assortment of issues related to field access on DataObjects, particularly with case insensitivity.

It can get all fields on DataObjects, parse dot syntax to traverse relationships, and format fields to their desired casing.

Traits

A class that can be instantiated or replaced via DI

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

Config options

allowed_aggregates array
field_formatter callable

A function that makes an object property a field name

__mappingCache array

Properties

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

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

public
mixed
stat(string $name) deprecated

Get inherited config value

public
mixed
uninherited(string $name)

Gets the uninherited value for the given config option

public
$this
set_stat(string $name, mixed $value) deprecated

Update the config value for a given property

public
string|null
normaliseField(DataObject $dataObject, string $field)

Get the field as it is defined on the DataObject for case-sensitive access

public
bool
hasField(DataObject $dataObject, string $field)

No description

public
bool
hasNativeField(DataObject $dataObject, string $field, bool $includeUnary = true, bool $includeList = true)

Returns true if the field is part of the ORM data structure

public
accessField(DataObject $dataObject, string $field)

Resolves complex dot syntax references.

public static 
string
formatField(string $field)

No description

public
array
getAllFields(DataObject $dataObject, bool $includeRelations = true, bool $includeInherited = true)

No description

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

static Config_ForClass config()

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

Return Value

Config_ForClass

mixed stat(string $name) deprecated

deprecated 5.0 Use ->config()->get() instead

Get inherited config value

Parameters

string $name

Return Value

mixed

mixed uninherited(string $name)

Gets the uninherited value for the given config option

Parameters

string $name

Return Value

mixed

$this set_stat(string $name, mixed $value) deprecated

deprecated 5.0 Use ->config()->set() instead

Update the config value for a given property

Parameters

string $name
mixed $value

Return Value

$this

string|null normaliseField(DataObject $dataObject, string $field)

Get the field as it is defined on the DataObject for case-sensitive access

Parameters

DataObject $dataObject
string $field

Return Value

string|null

bool hasField(DataObject $dataObject, string $field)

No description

Parameters

DataObject $dataObject
string $field

Return Value

bool

bool hasNativeField(DataObject $dataObject, string $field, bool $includeUnary = true, bool $includeList = true)

Returns true if the field is part of the ORM data structure

Parameters

DataObject $dataObject
string $field
bool $includeUnary
bool $includeList

Return Value

bool

DBField|SS_List|DataObject|null accessField(DataObject $dataObject, string $field)

Resolves complex dot syntax references.

Image.URL (String) FeaturedProduct.Categories.Title ([String] ->column('Title')) FeaturedProduct.Categories.Count() (Int) FeaturedProduct.Categories.Products.Max(Price) Category.Products.Reviews ([Review])

Parameters

DataObject $dataObject
string $field

Return Value

DBField|SS_List|DataObject|null

static string formatField(string $field)

No description

Parameters

string $field

Return Value

string

array getAllFields(DataObject $dataObject, bool $includeRelations = true, bool $includeInherited = true)

No description

Parameters

DataObject $dataObject
bool $includeRelations
bool $includeInherited

Return Value

array