HTMLPurifier_AttrTypes Class Reference

Provides lookup array of attribute types to HTMLPurifier_AttrDef objects. More...

Collaboration diagram for HTMLPurifier_AttrTypes:

Public Member Functions
	__construct ()
	Constructs the info array, supplying default implementations for attribute types. More...
	get ($type)
	Retrieves a type. More...
	set ($type, $impl)
	Sets a new implementation for a type. More...

Protected Attributes
	$info = array()
	Lookup array of attribute string identifiers to concrete implementations. More...

Static Private Member Functions
static	makeEnum ($in)

Detailed Description

Provides lookup array of attribute types to HTMLPurifier_AttrDef objects.

Definition at line 6 of file AttrTypes.php.

Constructor & Destructor Documentation

__construct()

HTMLPurifier_AttrTypes::__construct

(

)

Constructs the info array, supplying default implementations for attribute types.

Definition at line 17 of file AttrTypes.php.

                                  {
        // XXX This is kind of poor, since we don't actually /clone/
        // instances; instead, we use the supplied make() attribute. So,
        // the underlying class must know how to deal with arguments.
        // With the old implementation of Enum, that ignored its
        // arguments when handling a make dispatch, the IAlign
        // definition wouldn't work.

        // pseudo-types, must be instantiated via shorthand
        $this->info['Enum']    = new HTMLPurifier_AttrDef_Enum();
        $this->info['Bool']    = new HTMLPurifier_AttrDef_HTML_Bool();

        $this->info['CDATA']    = new HTMLPurifier_AttrDef_Text();
        $this->info['ID']       = new HTMLPurifier_AttrDef_HTML_ID();
        $this->info['Length']   = new HTMLPurifier_AttrDef_HTML_Length();
        $this->info['MultiLength'] = new HTMLPurifier_AttrDef_HTML_MultiLength();
        $this->info['NMTOKENS'] = new HTMLPurifier_AttrDef_HTML_Nmtokens();
        $this->info['Pixels']   = new HTMLPurifier_AttrDef_HTML_Pixels();
        $this->info['Text']     = new HTMLPurifier_AttrDef_Text();
        $this->info['URI']      = new HTMLPurifier_AttrDef_URI();
        $this->info['LanguageCode'] = new HTMLPurifier_AttrDef_Lang();
        $this->info['Color']    = new HTMLPurifier_AttrDef_HTML_Color();
        $this->info['IAlign']   = self::makeEnum('top,middle,bottom,left,right');
        $this->info['LAlign']   = self::makeEnum('top,bottom,left,right');
        $this->info['FrameTarget'] = new HTMLPurifier_AttrDef_HTML_FrameTarget();

        // unimplemented aliases
        $this->info['ContentType'] = new HTMLPurifier_AttrDef_Text();
        $this->info['ContentTypes'] = new HTMLPurifier_AttrDef_Text();
        $this->info['Charsets'] = new HTMLPurifier_AttrDef_Text();
        $this->info['Character'] = new HTMLPurifier_AttrDef_Text();

        // "proprietary" types
        $this->info['Class'] = new HTMLPurifier_AttrDef_HTML_Class();

        // number is really a positive integer (one or more digits)
        // FIXME: ^^ not always, see start and value of list items
        $this->info['Number']   = new HTMLPurifier_AttrDef_Integer(false, false, true);
    }

Member Function Documentation

get()

HTMLPurifier_AttrTypes::get

(

$type

)

Retrieves a type.

Parameters

$type

String type name

Returns

Object AttrDef for type

Definition at line 66 of file AttrTypes.php.

                               {

        // determine if there is any extra info tacked on
        if (strpos($type, '#') !== false) list($type, $string) = explode('#', $type, 2);
        else $string = '';

        if (!isset($this->info[$type])) {
            trigger_error('Cannot retrieve undefined attribute type ' . $type, E_USER_ERROR);
            return;
        }

        return $this->info[$type]->make($string);

    }

makeEnum()

static HTMLPurifier_AttrTypes::makeEnum (   $in )

staticprivate

Definition at line 57 of file AttrTypes.php.

References $in.

                                          {
        return new HTMLPurifier_AttrDef_Clone(new HTMLPurifier_AttrDef_Enum(explode(',', $in)));
    }

set()

HTMLPurifier_AttrTypes::set	(		$type,
			$impl
	)

Sets a new implementation for a type.

Parameters

$type	String type name
$impl	Object AttrDef for type

Definition at line 86 of file AttrTypes.php.

                                      {
        $this->info[$type] = $impl;
    }

Field Documentation

$info

HTMLPurifier_AttrTypes::$info = array()

protected

Lookup array of attribute string identifiers to concrete implementations.

Definition at line 11 of file AttrTypes.php.

---

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

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