enshrined\svgSanitize\ElementReference\Resolver Class Reference

Collaboration diagram for enshrined\svgSanitize\ElementReference\Resolver:

Public Member Functions
	__construct (XPath $xPath, $useNestingLimit)
	collect ()
	findByElement (\DOMElement $element, $considerChildren=false)
	Resolves one subject by element. More...
	findByElementId ($elementId)
	Resolves subjects (plural!) by element id - in theory malformed DOM might have same ids assigned to different elements and leaving it to client/browser implementation which element to actually use. More...
	getElementsToRemove ()
	Get all the elements that caused a nesting exception. More...

Protected Member Functions
	determineInvalidSubjects ()
	Determines and tags infinite loops. More...
	markSubjectAsInvalid (Subject $subject)
	The Subject is invalid for some reason, therefore we should remove it and all it's child usages. More...

Protected Attributes
	$xPath
	$subjects = []
	$elementsToRemove = []
	$useNestingLimit

Detailed Description

Definition at line 8 of file Resolver.php.

Constructor & Destructor Documentation

__construct()

enshrined\svgSanitize\ElementReference\Resolver::__construct	(	XPath	$xPath,
			$useNestingLimit
	)

Definition at line 30 of file Resolver.php.

References enshrined\svgSanitize\ElementReference\Resolver\$useNestingLimit, and enshrined\svgSanitize\ElementReference\Resolver\$xPath.

    {
        $this->xPath = $xPath;
        $this->useNestingLimit = $useNestingLimit;
    }

Member Function Documentation

collect()

enshrined\svgSanitize\ElementReference\Resolver::collect

(

)

Definition at line 36 of file Resolver.php.

References enshrined\svgSanitize\ElementReference\Resolver\determineInvalidSubjects().

    {
        $this->collectIdentifiedElements();
        $this->processReferences();
        $this->determineInvalidSubjects();
    }

Here is the call graph for this function:

determineInvalidSubjects()

enshrined\svgSanitize\ElementReference\Resolver::determineInvalidSubjects ( )

protected

Determines and tags infinite loops.

Definition at line 123 of file Resolver.php.

References enshrined\svgSanitize\ElementReference\Resolver\$elementsToRemove, enshrined\svgSanitize\Helper\extractIdReferenceFromHref(), enshrined\svgSanitize\Exceptions\NestingException\getElement(), enshrined\svgSanitize\Helper\getElementHref(), and enshrined\svgSanitize\ElementReference\Resolver\markSubjectAsInvalid().

Referenced by enshrined\svgSanitize\ElementReference\Resolver\collect().

    {
        foreach ($this->subjects as $subject) {

            if (in_array($subject->getElement(), $this->elementsToRemove)) {
                continue;
            }

            $useId = Helper::extractIdReferenceFromHref(
                Helper::getElementHref($subject->getElement())
            );

            try {
                if ($useId === $subject->getElementId()) {
                    $this->markSubjectAsInvalid($subject);
                } elseif ($subject->hasInfiniteLoop()) {
                    $this->markSubjectAsInvalid($subject);
                }
            } catch (NestingException $e) {
                $this->elementsToRemove[] = $e->getElement();
                $this->markSubjectAsInvalid($subject);
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

findByElement()

enshrined\svgSanitize\ElementReference\Resolver::findByElement	(	\DOMElement	$element,
			$considerChildren = false
	)

Resolves one subject by element.

Parameters

\DOMElement	$element
bool	$considerChildren	Whether to search in Subject's children as well

Returns

Subject|null

Definition at line 50 of file Resolver.php.

References enshrined\svgSanitize\Helper\isElementContainedIn().

    {
        foreach ($this->subjects as $subject) {
            if (
                $element === $subject->getElement()
                || $considerChildren && Helper::isElementContainedIn($element, $subject->getElement())
            ) {
                return $subject;
            }
        }
        return null;
    }

Here is the call graph for this function:

findByElementId()

enshrined\svgSanitize\ElementReference\Resolver::findByElementId

(

$elementId

)

Resolves subjects (plural!) by element id - in theory malformed DOM might have same ids assigned to different elements and leaving it to client/browser implementation which element to actually use.

Parameters

string

$elementId

Returns

Subject[]

Definition at line 71 of file Resolver.php.

References enshrined\svgSanitize\Helper\extractIdReferenceFromHref(), enshrined\svgSanitize\Helper\getElementHref(), and enshrined\svgSanitize\ElementReference\Subject\getElementId().

    {
        return array_filter(
            $this->subjects,
            function (Subject $subject) use ($elementId) {
                return $elementId === $subject->getElementId();
            }
        );
    }

Here is the call graph for this function:

getElementsToRemove()

enshrined\svgSanitize\ElementReference\Resolver::getElementsToRemove

(

)

Get all the elements that caused a nesting exception.

Returns

array

Definition at line 153 of file Resolver.php.

References enshrined\svgSanitize\ElementReference\Resolver\$elementsToRemove.

                                          {
        return $this->elementsToRemove;
    }

markSubjectAsInvalid()

enshrined\svgSanitize\ElementReference\Resolver::markSubjectAsInvalid ( Subject  $subject )

protected

The Subject is invalid for some reason, therefore we should remove it and all it's child usages.

Parameters

Subject

$subject

Definition at line 163 of file Resolver.php.

References enshrined\svgSanitize\ElementReference\Subject\clearInternalAndGetAffectedElements().

Referenced by enshrined\svgSanitize\ElementReference\Resolver\determineInvalidSubjects().

                                                              {
        $this->elementsToRemove = array_merge(
            $this->elementsToRemove,
            $subject->clearInternalAndGetAffectedElements()
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$elementsToRemove

enshrined\svgSanitize\ElementReference\Resolver::$elementsToRemove = []

protected

Definition at line 23 of file Resolver.php.

Referenced by enshrined\svgSanitize\ElementReference\Resolver\determineInvalidSubjects(), and enshrined\svgSanitize\ElementReference\Resolver\getElementsToRemove().

$subjects

enshrined\svgSanitize\ElementReference\Resolver::$subjects = []

protected

Definition at line 18 of file Resolver.php.

$useNestingLimit

enshrined\svgSanitize\ElementReference\Resolver::$useNestingLimit

protected

Definition at line 28 of file Resolver.php.

Referenced by enshrined\svgSanitize\ElementReference\Resolver\__construct().

$xPath

enshrined\svgSanitize\ElementReference\Resolver::$xPath

protected

Definition at line 13 of file Resolver.php.

Referenced by enshrined\svgSanitize\ElementReference\Resolver\__construct().

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/enshrined/svg-sanitize/src/ElementReference/Resolver.php