class CodeGenerationStore implements SchemaStorageInterface (View source)

Traits

A class that can be instantiated or replaced via DI

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

Constants

TYPE_CLASS_NAME

Properties

static private $schemaFilename
static private $configFilename
static private $namespacePrefix
static private $dirName

Methods

static Injectable
create(mixed ...$args)

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

static Injectable
singleton(string $class = null)

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

static Config_ForClass
config()

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

mixed
stat(string $name) 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

Update the config value for a given property

__construct(string $name, CacheInterface $cache)

No description

void
persistSchema(StorableSchema $schema)

No description

Schema
getSchema(bool $useCache = true)

No description

getConfig()

No description

void
clear()

No description

bool
exists()

No description

CacheInterface
getCache()

No description

setCache(CacheInterface $cache)

No description

string
getRootDir()

No description

setRootDir(string $rootDir)

No description

getObfuscator()

No description

setObfuscator(NameObfuscator $obfuscator)

No description

setVerbose(bool $bool)

No description

static string
getTemplateDir()

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

__construct(string $name, CacheInterface $cache)

Parameters

string $name
CacheInterface $cache

void persistSchema(StorableSchema $schema)

Parameters

StorableSchema $schema

Return Value

void

Exceptions

Exception
InvalidArgumentException
RuntimeException
EmptySchemaException

Schema getSchema(bool $useCache = true)

Parameters

bool $useCache

Return Value

Schema

Exceptions

SchemaNotFoundException

SchemaConfig getConfig()

Return Value

SchemaConfig

void clear()

Return Value

void

bool exists()

Return Value

bool

CacheInterface getCache()

Return Value

CacheInterface

CodeGenerationStore setCache(CacheInterface $cache)

Parameters

CacheInterface $cache

Return Value

CodeGenerationStore

string getRootDir()

Return Value

string

CodeGenerationStore setRootDir(string $rootDir)

Parameters

string $rootDir

Return Value

CodeGenerationStore

NameObfuscator getObfuscator()

Return Value

NameObfuscator

CodeGenerationStore setObfuscator(NameObfuscator $obfuscator)

Parameters

NameObfuscator $obfuscator

Return Value

CodeGenerationStore

CodeGenerationStore setVerbose(bool $bool)

Parameters

bool $bool

Return Value

CodeGenerationStore

static string getTemplateDir()

Return Value

string