FieldAccessor
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
An implementation of the factory method, allows you to create an instance of a class
Creates a class instance by the "singleton" design pattern.
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).
Gets the uninherited value for the given config option
Get the field as it is defined on the DataObject for case-sensitive access
Returns true if the field is part of the ORM data structure
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();
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).
static Config_ForClass
config()
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).
mixed
stat(string $name)
deprecated
deprecated
Get inherited config value
mixed
uninherited(string $name)
Gets the uninherited value for the given config option
$this
set_stat(string $name, mixed $value)
deprecated
deprecated
Update the config value for a given property
string|null
normaliseField(DataObject $dataObject, string $field)
Get the field as it is defined on the DataObject for case-sensitive access
bool
hasField(DataObject $dataObject, string $field)
No description
bool
hasNativeField(DataObject $dataObject, string $field, bool $includeUnary = true, bool $includeList = true)
Returns true if the field is part of the ORM data structure
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])
static string
formatField(string $field)
No description
array
getAllFields(DataObject $dataObject, bool $includeRelations = true, bool $includeInherited = true)
No description