abstract class Publisher implements StaticPublisher (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.

Config options

static_publisher_themes array
lazy_form_recognition bool

avoid caching any pages with name"SecurityID" - an indication that a form my be present that requires a fresh SecurityID

domain_based_caching bool
add_timestamp bool

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
generatePageResponse(string $url)

No description

protected
getHTTPApplication()

No description

protected
string
generatePHPCacheFile(HTTPResponse $response)

Generate the templated content for a PHP script that can serve up the given piece of content with the given age and expiry.

protected
string
generateHTMLCacheRedirection(string $destination)

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

HTTPResponse generatePageResponse(string $url)

No description

Parameters

string $url

Return Value

HTTPResponse

protected HTTPApplication getHTTPApplication()

No description

Return Value

HTTPApplication

protected string generatePHPCacheFile(HTTPResponse $response)

Generate the templated content for a PHP script that can serve up the given piece of content with the given age and expiry.

Parameters

HTTPResponse $response

Return Value

string

protected string generateHTMLCacheRedirection(string $destination)

No description

Parameters

string $destination

Return Value

string