class CSSContentParser (View source)

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

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

Traits

A class that can be instantiated or replaced via DI

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

Methods

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.

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

__construct($content)

No description

getBySelector(string $selector)

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

getByXpath(string $xpath)

Allows querying the content through XPATH selectors.

string
selector2xpath(string $selector)

Converts a CSS selector into an equivalent xpath expression.

Details

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

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

__construct($content)

Parameters

$content

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[]

SimpleXMLElement[] getByXpath(string $xpath)

Allows querying the content through XPATH selectors.

Parameters

string $xpath

SimpleXML compatible XPATH statement

Return Value

SimpleXMLElement[]

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