class SSViewer_FromString extends SSViewer (View source)

Special SSViewer that will process a template passed as a string, rather than a filename.

Traits

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

A class that can be instantiated or replaced via DI

Constants

DEFAULT_THEME

Identifier for the default theme

PUBLIC_THEME

Identifier for the public theme

Properties

static private string $themes

A list (highest priority first) of themes to use Only used when {@link $theme_enabled} is set to TRUE.

from  SSViewer
static private string $theme

The used "theme", which usually consists of templates, images and stylesheets.

from  SSViewer
static private bool $theme_enabled

Use the theme. Set to FALSE in order to disable themes, which can be useful for scenarios where theme overrides are temporarily undesired, such as an administrative interface separate from the website theme.

from  SSViewer
static private string $global_key

Default prepended cache key for partial caching

from  SSViewer
static private bool $source_file_comments from  SSViewer
$rewrite_hash_links

Set if hash links should be rewritten

from  SSViewer
static private bool $cache_template

The global template caching behaviour if no instance override is specified

Methods

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

static Injectable
create(array ...$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.

__construct(string $content, TemplateParser $parser = null)

No description

static 
flush()

Triggered early in the request when someone requests a flush.

from  SSViewer
static SSViewer
fromString(string $content, bool|void $cacheTemplate = null)

Create a template from a string instead of a .ss file

from  SSViewer
static 
set_themes(array $themes = [])

Assign the list of active themes to apply.

from  SSViewer
static 
add_themes(array $themes = [])

Add to the list of active themes to apply

from  SSViewer
static array
get_themes()

Get the list of active themes

from  SSViewer
static 
set_theme(string $theme) deprecated

No description

from  SSViewer
static array
get_templates_by_class(string|object $classOrObject, string $suffix = '', string $baseClass = null)

Traverses the given the given class context looking for candidate template names which match each item in the class hierarchy. The resulting list of template candidates may or may not exist, but you can invoke {see SSViewer::chooseTemplate} on any list to determine the best candidate based on the current themes.

from  SSViewer
static ViewableData
topLevel()

Get the current item being processed

from  SSViewer
bool
getRewriteHashLinks()

Check if rewrite hash links are enabled on this instance

from  SSViewer
$this
setRewriteHashLinks(bool $rewrite)

Set if hash links are rewritten for this instance

from  SSViewer
static bool
getRewriteHashLinksDefault()

Get default value for rewrite hash links for all modules

from  SSViewer
static 
setRewriteHashLinksDefault(bool $rewrite)

Set default rewrite hash links

from  SSViewer
setTemplate(string|array $templates)

No description

from  SSViewer
static string
chooseTemplate(array|string $templates)

Find the template to use for a given list

from  SSViewer
setParser(TemplateParser $parser)

Set the template parser that will be used in template generation

from  SSViewer
getParser()

Returns the parser that is set for template generation

from  SSViewer
static bool
hasTemplate(array|string $templates)

Returns true if at least one of the listed templates exists.

from  SSViewer
string
exists()

No description

from  SSViewer
static string
getTemplateFileByType(string $identifier, string $type = null)

No description

from  SSViewer
static 
flush_template_cache(bool $force = false)

Clears all parsed template files in the cache folder.

from  SSViewer
static 
flush_cacheblock_cache(bool $force = false)

Clears all partial cache blocks.

from  SSViewer
setPartialCacheStore(CacheInterface $cache)

Set the cache object to use when storing / retrieving partial cache blocks.

from  SSViewer
CacheInterface
getPartialCacheStore()

Get the cache object to use when storing / retrieving partial cache blocks.

from  SSViewer
includeRequirements(bool $incl = true)

Flag whether to include the requirements in this response.

from  SSViewer
process(ViewableData $item, array|null $arguments = null, $scope = null)

The process() method handles the "meat" of the template processing.

static string
execute_template(string $template, mixed $data, array $arguments = null, object $scope = null, bool $globalRequirements = false)

Execute the given template, passing it the given data.

from  SSViewer
static string
execute_string(string $content, mixed $data, array $arguments = null, bool $globalRequirements = false)

Execute the evaluated string, passing it the given data.

from  SSViewer
string
parseTemplateContent(string $content, string $template = "")

Parse given template contents

from  SSViewer
array
templates()

Returns the filenames of the template that will be rendered. It is a map that may contain 'Content' & 'Layout', and will have to contain 'main'

from  SSViewer
setTemplateFile(string $type, string $file)

No description

from  SSViewer
static string
get_base_tag(string $contentGeneratedSoFar)

Return an appropriate base tag for the given template.

from  SSViewer
setCacheTemplate(bool $cacheTemplate)

No description

bool
getCacheTemplate()

No description

Details

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

static Injectable create(array ...$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'); $list = SiteTree::get();

Parameters

array ...$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

__construct(string $content, TemplateParser $parser = null)

Parameters

string $content
TemplateParser $parser

static flush()

Triggered early in the request when someone requests a flush.

static SSViewer fromString(string $content, bool|void $cacheTemplate = null)

Create a template from a string instead of a .ss file

Parameters

string $content

The template content

bool|void $cacheTemplate

Whether or not to cache the template from string

Return Value

SSViewer

static set_themes(array $themes = [])

Assign the list of active themes to apply.

If default themes should be included add $default as the last entry.

Parameters

array $themes

static add_themes(array $themes = [])

Add to the list of active themes to apply

Parameters

array $themes

static array get_themes()

Get the list of active themes

Return Value

array

static set_theme(string $theme) deprecated

deprecated 4.0.0:5.0.0 Use the "SSViewer#set_themes" instead

Parameters

string $theme

The "base theme" name (without underscores).

static array get_templates_by_class(string|object $classOrObject, string $suffix = '', string $baseClass = null)

Traverses the given the given class context looking for candidate template names which match each item in the class hierarchy. The resulting list of template candidates may or may not exist, but you can invoke {see SSViewer::chooseTemplate} on any list to determine the best candidate based on the current themes.

Parameters

string|object $classOrObject

Valid class name, or object

string $suffix
string $baseClass

Class to halt ancestry search at

Return Value

array

static ViewableData topLevel()

Get the current item being processed

Return Value

ViewableData

Check if rewrite hash links are enabled on this instance

Return Value

bool

Set if hash links are rewritten for this instance

Parameters

bool $rewrite

Return Value

$this

static bool getRewriteHashLinksDefault()

Get default value for rewrite hash links for all modules

Return Value

bool

static setRewriteHashLinksDefault(bool $rewrite)

Set default rewrite hash links

Parameters

bool $rewrite

setTemplate(string|array $templates)

Parameters

string|array $templates

static string chooseTemplate(array|string $templates)

Find the template to use for a given list

Parameters

array|string $templates

Return Value

string

setParser(TemplateParser $parser)

Set the template parser that will be used in template generation

Parameters

TemplateParser $parser

TemplateParser getParser()

Returns the parser that is set for template generation

Return Value

TemplateParser

static bool hasTemplate(array|string $templates)

Returns true if at least one of the listed templates exists.

Parameters

array|string $templates

Return Value

bool

string exists()

Return Value

string

static string getTemplateFileByType(string $identifier, string $type = null)

Parameters

string $identifier

A template name without '.ss' extension or path

string $type

The template type, either "main", "Includes" or "Layout"

Return Value

string

Full system path to a template file

static flush_template_cache(bool $force = false)

Clears all parsed template files in the cache folder.

Can only be called once per request (there may be multiple SSViewer instances).

Parameters

bool $force

Set this to true to force a re-flush. If left to false, flushing may only be performed once a request.

static flush_cacheblock_cache(bool $force = false)

Clears all partial cache blocks.

Can only be called once per request (there may be multiple SSViewer instances).

Parameters

bool $force

Set this to true to force a re-flush. If left to false, flushing may only be performed once a request.

setPartialCacheStore(CacheInterface $cache)

Set the cache object to use when storing / retrieving partial cache blocks.

Parameters

CacheInterface $cache

CacheInterface getPartialCacheStore()

Get the cache object to use when storing / retrieving partial cache blocks.

Return Value

CacheInterface

includeRequirements(bool $incl = true)

Flag whether to include the requirements in this response.

Parameters

bool $incl

DBHTMLText process(ViewableData $item, array|null $arguments = null, $scope = null)

The process() method handles the "meat" of the template processing.

It takes care of caching the output (via {@link Cache}), as well as replacing the special "$Content" and "$Layout" placeholders with their respective subtemplates.

The method injects extra HTML in the header via {@link Requirements::includeInHTML()}.

Note: You can call this method indirectly by {@link ViewableData->renderWith()}.

Parameters

ViewableData $item
array|null $arguments

Arguments to an included template

$scope

Return Value

DBHTMLText

Parsed template output.

static string execute_template(string $template, mixed $data, array $arguments = null, object $scope = null, bool $globalRequirements = false)

Execute the given template, passing it the given data.

Used by the <% include %> template tag to process templates.

Parameters

string $template

Template name

mixed $data

Data context

array $arguments

Additional arguments

object $scope
bool $globalRequirements

Return Value

string

Evaluated result

static string execute_string(string $content, mixed $data, array $arguments = null, bool $globalRequirements = false)

Execute the evaluated string, passing it the given data.

Used by partial caching to evaluate custom cache keys expressed using template expressions

Parameters

string $content

Input string

mixed $data

Data context

array $arguments

Additional arguments

bool $globalRequirements

Return Value

string

Evaluated result

string parseTemplateContent(string $content, string $template = "")

Parse given template contents

Parameters

string $content

The template contents

string $template

The template file name

Return Value

string

array templates()

Returns the filenames of the template that will be rendered. It is a map that may contain 'Content' & 'Layout', and will have to contain 'main'

Return Value

array

setTemplateFile(string $type, string $file)

Parameters

string $type

"Layout" or "main"

string $file

Full system path to the template file

static string get_base_tag(string $contentGeneratedSoFar)

Return an appropriate base tag for the given template.

It will be closed on an XHTML document, and unclosed on an HTML document.

Parameters

string $contentGeneratedSoFar

The content of the template generated so far; it should contain the DOCTYPE declaration.

Return Value

string

setCacheTemplate(bool $cacheTemplate)

Parameters

bool $cacheTemplate

bool getCacheTemplate()

Return Value

bool