1. class
  2. SilverStripe
  3. \
  4. Dev
  5. \
  6. CSSContentParser

CSSContentParser

class CSSContentParser

CSSContentParser enables parsing & assertion running of HTML content via CSS selectors.

It works by converting the content to XHTML using tidy, rewriting the CSS selectors as XPath queries, and executing those using SimpeXML.

It was built to facilitate testing using PHPUnit and contains a number of assert methods that will throw PHPUnit assertion exception when applicable.

Tries to use the PHP tidy extension (http://php.net/tidy), and falls back to the "tidy" CLI tool. If none of those exists, the string is parsed directly without sanitization.

Caution: Doesn't fully support HTML elements like

<

header> due to them being declared illegal by the "tidy" preprocessing step.

Traits

Injectable
A class that can be instantiated or replaced via DI

Methods

static Injectable
create(array $args)

An implementation of the factory method, allows you to create an instance of a class

from Injectable
static Injectable
singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

from Injectable
__construct($content)

No description

SimpleXMLElement[]
getBySelector(String $selector)

Returns a number of SimpleXML elements that match the given CSS selector.

SimpleXMLElement[]
getByXpath(String $xpath)

Allows querying the content through XPATH selectors.

String
selector2xpath(String $selector)

Converts a CSS selector into an equivalent xpath expression.

Details

in Injectable at line 26
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

in Injectable at line 43
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

at line 31
__construct($content)

Parameters

$content

at line 74
SimpleXMLElement[] getBySelector(String $selector)

Returns a number of SimpleXML elements that match the given CSS selector.

Currently the selector engine only supports querying by tag, id, and class. See {@link getByXpath()} for a more direct selector syntax.

Parameters

String $selector

Return Value

SimpleXMLElement[]

at line 86
SimpleXMLElement[] getByXpath(String $xpath)

Allows querying the content through XPATH selectors.

Parameters

String $xpath SimpleXML compatible XPATH statement

Return Value

SimpleXMLElement[]

at line 98
String selector2xpath(String $selector)

Converts a CSS selector into an equivalent xpath expression.

Currently the selector engine only supports querying by tag, id, and class.

Parameters

String $selector See {@link getBySelector()}

Return Value

String XPath expression