HTMLPurifier_IDAccumulator Class Reference

Component of HTMLPurifier_AttrContext that accumulates IDs to prevent dupes. More...

Collaboration diagram for HTMLPurifier_IDAccumulator:

Public Member Functions
	add ($id)
	Add an ID to the lookup table.
	load ($array_of_ids)
	Load a list of IDs into the lookup table.

Static Public Member Functions
static	build ($config, $context)
	Builds an IDAccumulator, also initializing the default blacklist.

Data Fields
	$ids = array()
	Lookup table of IDs we've accumulated.

Detailed Description

Component of HTMLPurifier_AttrContext that accumulates IDs to prevent dupes.

Note

In Slashdot-speak, dupe means duplicate.

The default constructor does not accept $config or $context objects: use must use the static build() factory method to perform initialization.

Definition at line 9 of file IDAccumulator.php.

Member Function Documentation

HTMLPurifier_IDAccumulator::add

(

$id

)

Add an ID to the lookup table.

Parameters

$id	ID to be added.

Returns

Bool status, true if success, false if there's a dupe

Definition at line 35 of file IDAccumulator.php.

                             {
        if (isset($this->ids[$id])) return false;
        return $this->ids[$id] = true;
    }

static HTMLPurifier_IDAccumulator::build (   $config,   $context  )

static

Builds an IDAccumulator, also initializing the default blacklist.

Parameters

$config	Instance of HTMLPurifier_Config
$context	Instance of HTMLPurifier_Context

Returns

Fully initialized HTMLPurifier_IDAccumulator

Definition at line 24 of file IDAccumulator.php.

References $config.

Referenced by HTMLPurifier\purify(), and HTMLPurifier_AttrValidator\validateToken().

                                                    {
        $id_accumulator = new HTMLPurifier_IDAccumulator();
        $id_accumulator->load($config->get('Attr.IDBlacklist'));
        return $id_accumulator;
    }

Here is the caller graph for this function:

HTMLPurifier_IDAccumulator::load

(

$array_of_ids

)

Load a list of IDs into the lookup table.

Parameters

$array_of_ids

Array of IDs to load

Note

This function doesn't care about duplicates

Definition at line 45 of file IDAccumulator.php.

                                        {
        foreach ($array_of_ids as $id) {
            $this->ids[$id] = true;
        }
    }

Field Documentation

HTMLPurifier_IDAccumulator::$ids = array()

Lookup table of IDs we've accumulated.

Definition at line 16 of file IDAccumulator.php.

---

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

• Services/Html/HtmlPurifier/library/HTMLPurifier/IDAccumulator.php