To only return nodes containing a certain content, give
the $content to match as a string. Otherwise, setting
$content to TRUE will return all nodes matching $selector.
The $actual document may be a DOMDocument or a string
containing XML or HTML, identified by $isHtml.
/**
* Assert function to determine if tips rendered to the page
* have a corresponding page element.
*
* @param array $tips
* A list of tips which provide either a "data-id" or "data-class".
*
* @code
* // Basic example.
* $this->assertTourTips();
*
* // Advanced example. The following would be used for multipage or
* // targeting a specific subset of tips.
* $tips = array();
* $tips[] = array('data-id' => 'foo');
* $tips[] = array('data-id' => 'bar');
* $tips[] = array('data-class' => 'baz');
* $this->assertTourTips($tips);
* @endcode
*/
public function assertTourTips($tips = array())
{
// Get the rendered tips and their data-id and data-class attributes.
if (empty($tips)) {
// Tips are rendered as <li> elements inside <ol id="tour">.
$rendered_tips = $this->xpath('//ol[@id = "tour"]//li[starts-with(@class, "tip")]');
foreach ($rendered_tips as $rendered_tip) {
$attributes = (array) $rendered_tip->attributes();
$tips[] = $attributes['@attributes'];
}
}
// If the tips are still empty we need to fail.
if (empty($tips)) {
$this->fail('Could not find tour tips on the current page.');
} else {
// Check for corresponding page elements.
$total = 0;
$modals = 0;
foreach ($tips as $tip) {
if (!empty($tip['data-id'])) {
$elements = \PHPUnit_Util_XML::cssSelect('#' . $tip['data-id'], TRUE, $this->content, TRUE);
$this->assertTrue(!empty($elements) && count($elements) === 1, format_string('Found corresponding page element for tour tip with id #%data-id', array('%data-id' => $tip['data-id'])));
} elseif (!empty($tip['data-class'])) {
$elements = \PHPUnit_Util_XML::cssSelect('.' . $tip['data-class'], TRUE, $this->content, TRUE);
$this->assertFalse(empty($elements), format_string('Found corresponding page element for tour tip with class .%data-class', array('%data-class' => $tip['data-class'])));
} else {
// It's a modal.
$modals++;
}
$total++;
}
$this->pass(format_string('Total %total Tips tested of which %modals modal(s).', array('%total' => $total, '%modals' => $modals)));
}
}
/**
* assertSelectEquals("#binder .name", "Chuck", true, $xml); // any?
* assertSelectEquals("#binder .name", "Chuck", false, $xml); // none?
*
* @param array $selector
* @param string $content
* @param int|bool|array $count
* @param mixed $actual
* @param string $message
* @param bool $isHtml
* @since Method available since Release 3.3.0
* @author Mike Naberezny <*****@*****.**>
* @author Derek DeVries <*****@*****.**>
* @deprecated
*/
public static function assertSelectEquals($selector, $content, $count, $actual, $message = '', $isHtml = true)
{
trigger_error(__METHOD__ . ' is deprecated', E_USER_DEPRECATED);
$tags = PHPUnit_Util_XML::cssSelect($selector, $content, $actual, $isHtml);
// assert specific number of elements
if (is_numeric($count)) {
$counted = $tags ? count($tags) : 0;
self::assertEquals($count, $counted, $message);
} elseif (is_bool($count)) {
$any = count($tags) > 0 && $tags[0] instanceof DOMNode;
if ($count) {
self::assertTrue($any, $message);
} else {
self::assertFalse($any, $message);
}
} elseif (is_array($count) && (isset($count['>']) || isset($count['<']) || isset($count['>=']) || isset($count['<=']))) {
$counted = $tags ? count($tags) : 0;
if (isset($count['>'])) {
self::assertTrue($counted > $count['>'], $message);
}
if (isset($count['>='])) {
self::assertTrue($counted >= $count['>='], $message);
}
if (isset($count['<'])) {
self::assertTrue($counted < $count['<'], $message);
}
if (isset($count['<='])) {
self::assertTrue($counted <= $count['<='], $message);
}
} else {
throw new PHPUnit_Framework_Exception();
}
}
/**
* assertSelectEquals("#binder .name", "Chuck", true, $xml); // any?
* assertSelectEquals("#binder .name", "Chuck", false, $xml); // none?
*
* @param array $selector
* @param string $content
* @param integer $count
* @param mixed $actual
* @param string $message
* @param boolean $isHtml
* @since Method available since Release 3.3.0
* @author Mike Naberezny <*****@*****.**>
* @author Derek DeVries <*****@*****.**>
*/
public static function assertSelectEquals($selector, $content, $count, $actual, $message = '', $isHtml = TRUE)
{
$tags = PHPUnit_Util_XML::cssSelect($selector, $content, $actual, $isHtml);
// assert specific number of elements
if (is_numeric($count)) {
$counted = $tags ? count($tags) : 0;
self::assertEquals($count, $counted);
} else {
if (is_bool($count)) {
$any = count($tags) > 0 && $tags[0] instanceof DOMNode;
if ($count) {
self::assertTrue($any, $message);
} else {
self::assertFalse($any, $message);
}
} else {
if (is_array($count) && (isset($count['>']) || isset($count['<']) || isset($count['>=']) || isset($count['<=']))) {
$counted = $tags ? count($tags) : 0;
if (isset($count['>'])) {
self::assertTrue($counted > $count['>'], $message);
}
if (isset($count['>='])) {
self::assertTrue($counted >= $count['>='], $message);
}
if (isset($count['<'])) {
self::assertTrue($counted < $count['<'], $message);
}
if (isset($count['<='])) {
self::assertTrue($counted <= $count['<='], $message);
}
} else {
throw new InvalidArgumentException();
}
}
}
}
