SsiProcessorEsi
extends SsiProcessor
in package
Representation of an ESI processor
Tags
Table of Contents
Properties
- $dirname : string
- $parseMode : string
Methods
- __construct() : mixed
- Sets the parseMode for ESI parsing
- getIncludeCode() : string
- Gets the ESI/SSI include code for an URL
- getRandomizedIncludeCode() : string
- Gets the ESI/SSI random include code for a set of URLs
- getTemplateFile() : HTML_Template_Sigma
- Loads a template file based on $this->parseMode and $this->dirname
- parseRandomizedIncludeCode() : mixed
- Parses randomized include code
Properties
$dirname
protected
string
$dirname
Library base dir (defaults to ../../ (relative to this file's path))
$parseMode
protected
string
$parseMode
SsiProcessor name (currently either 'esi' or 'ssi'), case insensitive
Methods
__construct()
Sets the parseMode for ESI parsing
public
__construct() : mixed
getIncludeCode()
Gets the ESI/SSI include code for an URL
public
getIncludeCode(string $url) : string
Parameters
- $url : string
-
URL to get include tag for
Return values
string —ESI/SSI include tag
getRandomizedIncludeCode()
Gets the ESI/SSI random include code for a set of URLs
public
getRandomizedIncludeCode(array<string|int, mixed> $urls[, int $count = 1 ]) : string
Parameters
- $urls : array<string|int, mixed>
-
List of URLs to get random include tag for
- $count : int = 1
-
(optional) Number of unique random entries to parse
Return values
string —ESI/SSI random include tag
getTemplateFile()
Loads a template file based on $this->parseMode and $this->dirname
protected
getTemplateFile(string $filename) : HTML_Template_Sigma
Parameters
- $filename : string
-
Template base filename
Return values
HTML_Template_Sigma —Requested template
parseRandomizedIncludeCode()
Parses randomized include code
protected
parseRandomizedIncludeCode(HTML_Template_Sigma $template, array<string|int, mixed> $urls[, int $count = 1 ]) : mixed
Parameters
- $template : HTML_Template_Sigma
-
Template to parse
- $urls : array<string|int, mixed>
-
List of URLs to get random include tag for
- $count : int = 1
-
(optional) Number of unique random entries to parse