FilesystemPublisher
class FilesystemPublisher extends Publisher (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 | from Publisher | |
| lazy_form_recognition | bool | avoid caching any pages with name"SecurityID" - an indication that a form my be present that requires a fresh SecurityID |
from Publisher |
| domain_based_caching | bool | from Publisher | |
| add_timestamp | bool | from Publisher |
Properties
| protected | string | $destFolder | ||
| protected | string | $fileExtension |
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
Generate the templated content for a PHP script that can serve up the given piece of content with the given age and expiry.
returns true on success and false on failure
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
HTTPResponse
generatePageResponse(string $url)
No description
protected HTTPApplication
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
string
getDestPath()
No description
setDestFolder($destFolder)
No description
getDestFolder()
No description
setFileExtension($fileExtension)
No description
getFileExtension()
No description
array
purgeURL(string $url)
No description
bool
purgeAll()
return true on success
array
publishURL(string $url, bool $forcePublish = false)
No description
protected bool
publishRedirect(HTTPResponse $response, string $url)
No description
protected bool
publishPage(HTTPResponse $response, string $url)
No description
protected bool
saveToPath(string $content, string $filePath)
returns true on success and false on failure
protected
deleteFromPath($filePath)
No description
protected
URLtoPath($url)
No description
protected
pathToURL($path)
No description
array
getPublishedURLs($dir = null, $result = [])
No description