enshrined\svgSanitize\ElementReference\Subject Class Reference

Collaboration diagram for enshrined\svgSanitize\ElementReference\Subject:

Public Member Functions
	__construct (\DOMElement $element, $useNestingLimit)
	Subject constructor. More...
	getElement ()
	getElementId ()
	hasInfiniteLoop (array $subjects=[], $level=1)
	addUse (Subject $subject)
	addUsedIn (Subject $subject)
	countUse ($accumulated=false)
	countUsedIn ()
	clearInternalAndGetAffectedElements ()
	Clear the internal arrays (to free up memory as they can get big) and return all the child usages DOMElement's. More...

Protected Attributes
	$element
	$useCollection = []
	$usedInCollection = []
	$useNestingLimit

Detailed Description

Definition at line 4 of file Subject.php.

Constructor & Destructor Documentation

__construct()

enshrined\svgSanitize\ElementReference\Subject::__construct	(	\DOMElement	$element,
			$useNestingLimit
	)

Subject constructor.

Parameters

\DOMElement	$element
int	$useNestingLimit

Definition at line 32 of file Subject.php.

References enshrined\svgSanitize\ElementReference\Subject\$element, and enshrined\svgSanitize\ElementReference\Subject\$useNestingLimit.

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

Member Function Documentation

addUse()

enshrined\svgSanitize\ElementReference\Subject::addUse

(

Subject

$subject

)

Parameters

Subject

$subject

Definition at line 81 of file Subject.php.

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

    {
        if ($subject === $this) {
            throw new \LogicException('Cannot add self usage', 1570713416);
        }
        $identifier = $subject->getElementId();
        if (isset($this->useCollection[$identifier])) {
            $this->useCollection[$identifier]->increment();
            return;
        }
        $this->useCollection[$identifier] = new Usage($subject);
    }

Here is the call graph for this function:

addUsedIn()

enshrined\svgSanitize\ElementReference\Subject::addUsedIn

(

Subject

$subject

)

Parameters

Subject

$subject

Definition at line 97 of file Subject.php.

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

    {
        if ($subject === $this) {
            throw new \LogicException('Cannot add self as usage', 1570713417);
        }
        $identifier = $subject->getElementId();
        if (isset($this->usedInCollection[$identifier])) {
            $this->usedInCollection[$identifier]->increment();
            return;
        }
        $this->usedInCollection[$identifier] = new Usage($subject);
    }

Here is the call graph for this function:

clearInternalAndGetAffectedElements()

enshrined\svgSanitize\ElementReference\Subject::clearInternalAndGetAffectedElements

(

)

Clear the internal arrays (to free up memory as they can get big) and return all the child usages DOMElement's.

Returns

array

Definition at line 142 of file Subject.php.

References enshrined\svgSanitize\ElementReference\Subject\$useCollection, and enshrined\svgSanitize\ElementReference\Usage\getSubject().

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

    {
        $elements = array_map(function(Usage $usage) {
            return $usage->getSubject()->getElement();
        }, $this->useCollection);

        $this->usedInCollection = [];
        $this->useCollection = [];

        return $elements;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

countUse()

enshrined\svgSanitize\ElementReference\Subject::countUse

(

$accumulated = false

)

Parameters

bool

$accumulated

Returns

int

Definition at line 114 of file Subject.php.

    {
        $count = 0;
        foreach ($this->useCollection as $use) {
            $useCount = $use->getSubject()->countUse();
            $count += $use->getCount() * ($accumulated ? 1 + $useCount : max(1, $useCount));
        }
        return $count;
    }

countUsedIn()

enshrined\svgSanitize\ElementReference\Subject::countUsedIn

(

)

Returns

int

Definition at line 127 of file Subject.php.

    {
        $count = 0;
        foreach ($this->usedInCollection as $usedIn) {
            $count += $usedIn->getCount() * max(1, $usedIn->getSubject()->countUsedIn());
        }
        return $count;
    }

getElement()

enshrined\svgSanitize\ElementReference\Subject::getElement

(

)

Returns

Definition at line 41 of file Subject.php.

References enshrined\svgSanitize\ElementReference\Subject\$element.

Referenced by enshrined\svgSanitize\ElementReference\Subject\hasInfiniteLoop().

    {
        return $this->element;
    }

Here is the caller graph for this function:

getElementId()

enshrined\svgSanitize\ElementReference\Subject::getElementId

(

)

Returns

string

Definition at line 49 of file Subject.php.

Referenced by enshrined\svgSanitize\ElementReference\Subject\addUse(), enshrined\svgSanitize\ElementReference\Subject\addUsedIn(), and enshrined\svgSanitize\ElementReference\Resolver\findByElementId().

    {
        return $this->element->getAttribute('id');
    }

Here is the caller graph for this function:

hasInfiniteLoop()

enshrined\svgSanitize\ElementReference\Subject::hasInfiniteLoop	(	array	$subjects = [],
			$level = 1
	)

Parameters

array	$subjects	Previously processed subjects
int	$level	The current level of nesting.

Returns

bool

Exceptions

Definition at line 60 of file Subject.php.

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

    {
        if ($level > $this->useNestingLimit) {
            throw new \enshrined\svgSanitize\Exceptions\NestingException('Nesting level too high, aborting', 1570713498, null, $this->getElement());
        }

        if (in_array($this, $subjects, true)) {
            return true;
        }
        $subjects[] = $this;
        foreach ($this->useCollection as $usage) {
            if ($usage->getSubject()->hasInfiniteLoop($subjects, $level + 1)) {
                return true;
            }
        }
        return false;
    }

Here is the call graph for this function:

Field Documentation

$element

enshrined\svgSanitize\ElementReference\Subject::$element

protected

Definition at line 9 of file Subject.php.

Referenced by enshrined\svgSanitize\ElementReference\Subject\__construct(), and enshrined\svgSanitize\ElementReference\Subject\getElement().

$useCollection

enshrined\svgSanitize\ElementReference\Subject::$useCollection = []

protected

Definition at line 14 of file Subject.php.

Referenced by enshrined\svgSanitize\ElementReference\Subject\clearInternalAndGetAffectedElements().

$usedInCollection

enshrined\svgSanitize\ElementReference\Subject::$usedInCollection = []

protected

Definition at line 19 of file Subject.php.

$useNestingLimit

enshrined\svgSanitize\ElementReference\Subject::$useNestingLimit

protected

Definition at line 24 of file Subject.php.

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

---

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

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