SSViewer
class SSViewer implements Flushable (View source)
Parses a template file with an *.ss file extension.
In addition to a full template in the templates/ folder, a template in templates/Content or templates/Layout will be rendered into $Content and $Layout, respectively.
A single template can be parsed by multiple nested SSViewer instances through $Layout/$Content placeholders, as well as <% include MyTemplateFile %> template commands.
Themes
See http://doc.silverstripe.org/themes and http://doc.silverstripe.org/themes:developing
Caching
Compiled templates are cached via Cache, usually on the filesystem. If you put ?flush=1 on your URL, it will force the template to be recompiled.
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 |
Config options
| themes | string | A list (highest priority first) of themes to use Only used when $theme_enabled is set to TRUE. |
|
| theme_enabled | bool | 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. |
|
| global_key | string | Default prepended cache key for partial caching |
|
| source_file_comments | bool | ||
| rewrite_hash_links | bool | Set if hash links should be rewritten |
Properties
| protected static | array | $current_themes | Overridden value of $themes config |
|
| protected static | bool | $current_rewrite_hash_links | Overridden value of rewrite_hash_links config |
|
| protected | bool|null | $rewriteHashlinks | Instance variable to disable rewrite_hash_links (overrides global default) Leave null to use global state. |
|
| protected static deprecated | array | $topLevel | List of items being processed |
|
| protected deprecated | array | $templates | List of templates to select from |
|
| protected deprecated | string | $chosen | Absolute path to chosen template file |
|
| protected deprecated | array | $subTemplates | Templates to use when looking up 'Layout' or 'Content' |
|
| protected | bool | $includeRequirements | ||
| protected deprecated | TemplateParser | $parser | ||
| protected deprecated | CacheInterface | $partialCacheStore |
Methods
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).
Gets the uninherited value for the given config option
An implementation of the factory method, allows you to create an instance of a class
Creates a class instance by the "singleton" design pattern.
Create a template from a string instead of a .ss file
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 {SSViewer::chooseTemplate} on any list to determine the best candidate based on the current themes.
Get default value for rewrite hash links for all modules
Set the template parser that will be used in template generation
Returns true if at least one of the listed templates exists.
Call this to disable rewriting of links. This is useful in Ajax applications.
Clears all parsed template files in the cache folder.
Set the cache object to use when storing / retrieving partial cache blocks.
Get the cache object to use when storing / retrieving partial cache blocks.
Flag whether to include the requirements in this response.
An internal utility function to set up variables in preparation for including a compiled template, then do the include
The process() method handles the "meat" of the template processing.
Get the appropriate template to use for the named sub-template, or null if none are appropriate
Execute the given template, passing it the given data.
Execute the evaluated string, passing it the given data.
Parse given template contents
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 an appropriate base tag for the given template.
Return an appropriate base tag for the given template.
Details
static Config_ForClass
config()
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).
mixed
uninherited(string $name)
Gets the uninherited value for the given config option
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).
__construct(string|array $templates, TemplateParser $parser = null)
No description
static
flush()
deprecated
deprecated
Triggered early in the request when someone requests a flush.
static SSViewer
fromString(string $content, bool|void $cacheTemplate = null)
deprecated
deprecated
Create a template from a string instead of a .ss file
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.
static
add_themes(array $themes = [])
Add to the list of active themes to apply
static array
get_themes()
Get the list of active themes
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 {SSViewer::chooseTemplate} on any list to determine the best candidate based on the current themes.
static ViewableData
topLevel()
deprecated
deprecated
Get the current item being processed
bool
getRewriteHashLinks()
Check if rewrite hash links are enabled on this instance
$this
setRewriteHashLinks(bool $rewrite)
Set if hash links are rewritten for this instance
static bool
getRewriteHashLinksDefault()
Get default value for rewrite hash links for all modules
static
setRewriteHashLinksDefault(bool $rewrite)
Set default rewrite hash links
setTemplate(string|array $templates)
deprecated
deprecated
No description
static string
chooseTemplate(array|string $templates)
deprecated
deprecated
Find the template to use for a given list
setParser(TemplateParser $parser)
deprecated
deprecated
Set the template parser that will be used in template generation
TemplateParser
getParser()
deprecated
deprecated
Returns the parser that is set for template generation
static bool
hasTemplate(array|string $templates)
deprecated
deprecated
Returns true if at least one of the listed templates exists.
$this
dontRewriteHashlinks()
Call this to disable rewriting of links. This is useful in Ajax applications.
It returns the SSViewer objects, so that you can call new SSViewer("X")->dontRewriteHashlinks()->process();
string
exists()
deprecated
deprecated
No description
static string
getTemplateFileByType(string $identifier, string $type = null)
deprecated
deprecated
No description
static
flush_template_cache(bool $force = false)
deprecated
deprecated
Clears all parsed template files in the cache folder.
Can only be called once per request (there may be multiple SSViewer instances).
static
flush_cacheblock_cache(bool $force = false)
deprecated
deprecated
Clears all partial cache blocks.
Can only be called once per request (there may be multiple SSViewer instances).
setPartialCacheStore(CacheInterface $cache)
deprecated
deprecated
Set the cache object to use when storing / retrieving partial cache blocks.
CacheInterface
getPartialCacheStore()
deprecated
deprecated
Get the cache object to use when storing / retrieving partial cache blocks.
includeRequirements(bool $incl = true)
Flag whether to include the requirements in this response.
protected string
includeGeneratedTemplate(string $cacheFile, ViewableData $item, array $overlay, array $underlay, SSViewer_Scope|null $inheritedScope = null)
deprecated
deprecated
An internal utility function to set up variables in preparation for including a compiled template, then do the include
Effectively this is the common code that both SSViewer#process and SSViewer_FromString#process call
DBHTMLText
process(ViewableData $item, array|null $arguments = null, ViewableData $inheritedScope = null)
The process() method handles the "meat" of the template processing.
It takes care of caching the output (via Cache), as well as replacing the special "$Content" and "$Layout" placeholders with their respective subtemplates.
The method injects extra HTML in the header via Requirements::includeInHTML().
Note: You can call this method indirectly by ViewableData->renderWith().
protected array|null
getSubtemplateFor(string $subtemplate)
deprecated
deprecated
Get the appropriate template to use for the named sub-template, or null if none are appropriate
static string
execute_template(string $template, mixed $data, array $arguments = null, object $scope = null, bool $globalRequirements = false)
deprecated
deprecated
Execute the given template, passing it the given data.
Used by the <% include %> template tag to process templates.
static string
execute_string(string $content, mixed $data, array $arguments = null, bool $globalRequirements = false)
deprecated
deprecated
Execute the evaluated string, passing it the given data.
Used by partial caching to evaluate custom cache keys expressed using template expressions
string
parseTemplateContent(string $content, string $template = "")
deprecated
deprecated
Parse given template contents
array
templates()
deprecated
deprecated
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'
setTemplateFile(string $type, string $file)
deprecated
deprecated
No description
static string
get_base_tag(string $contentGeneratedSoFar)
deprecated
deprecated
Return an appropriate base tag for the given template.
It will be closed on an XHTML document, and unclosed on an HTML document.
static string
getBaseTag(bool $isXhtml = false)
Return an appropriate base tag for the given template.
It will be closed on an XHTML document, and unclosed on an HTML document.