Chris@0: <?php
Chris@0: /**
Chris@0:  * Provide general element functions.
Chris@0:  */
Chris@0: namespace Masterminds\HTML5;
Chris@0: 
Chris@0: /**
Chris@0:  * This class provides general information about HTML5 elements,
Chris@0:  * including syntactic and semantic issues.
Chris@0:  * Parsers and serializers can
Chris@0:  * use this class as a reference point for information about the rules
Chris@0:  * of various HTML5 elements.
Chris@0:  *
Chris@0:  * @todo consider using a bitmask table lookup. There is enough overlap in
Chris@0:  *       naming that this could significantly shrink the size and maybe make it
Chris@0:  *       faster. See the Go teams implementation at https://code.google.com/p/go/source/browse/html/atom.
Chris@0:  */
Chris@0: class Elements
Chris@0: {
Chris@0: 
Chris@0:     /**
Chris@0:      * Indicates an element is described in the specification.
Chris@0:      */
Chris@0:     const KNOWN_ELEMENT = 1;
Chris@0: 
Chris@0:     // From section 8.1.2: "script", "style"
Chris@0:     // From 8.2.5.4.7 ("in body" insertion mode): "noembed"
Chris@0:     // From 8.4 "style", "xmp", "iframe", "noembed", "noframes"
Chris@0:     /**
Chris@0:      * Indicates the contained text should be processed as raw text.
Chris@0:      */
Chris@0:     const TEXT_RAW = 2;
Chris@0: 
Chris@0:     // From section 8.1.2: "textarea", "title"
Chris@0:     /**
Chris@0:      * Indicates the contained text should be processed as RCDATA.
Chris@0:      */
Chris@0:     const TEXT_RCDATA = 4;
Chris@0: 
Chris@0:     /**
Chris@0:      * Indicates the tag cannot have content.
Chris@0:      */
Chris@0:     const VOID_TAG = 8;
Chris@0: 
Chris@0:     // "address", "article", "aside", "blockquote", "center", "details", "dialog", "dir", "div", "dl",
Chris@0:     // "fieldset", "figcaption", "figure", "footer", "header", "hgroup", "menu",
Chris@0:     // "nav", "ol", "p", "section", "summary", "ul"
Chris@0:     // "h1", "h2", "h3", "h4", "h5", "h6"
Chris@0:     // "pre", "listing"
Chris@0:     // "form"
Chris@0:     // "plaintext"
Chris@0:     /**
Chris@0:      * Indicates that if a previous event is for a P tag, that element
Chris@0:      * should be considered closed.
Chris@0:      */
Chris@0:     const AUTOCLOSE_P = 16;
Chris@0: 
Chris@0:     /**
Chris@0:      * Indicates that the text inside is plaintext (pre).
Chris@0:      */
Chris@0:     const TEXT_PLAINTEXT = 32;
Chris@0: 
Chris@0:     // See https://developer.mozilla.org/en-US/docs/HTML/Block-level_elements
Chris@0:     /**
Chris@0:      * Indicates that the tag is a block.
Chris@0:      */
Chris@0:     const BLOCK_TAG = 64;
Chris@0: 
Chris@0:     /**
Chris@0:      * Indicates that the tag allows only inline elements as child nodes.
Chris@0:      */
Chris@0:     const BLOCK_ONLY_INLINE = 128;
Chris@0: 
Chris@0:     /**
Chris@0:      * The HTML5 elements as defined in http://dev.w3.org/html5/markup/elements.html.
Chris@0:      *
Chris@0:      * @var array
Chris@0:      */
Chris@0:     public static $html5 = array(
Chris@0:         "a" => 1,
Chris@0:         "abbr" => 1,
Chris@0:         "address" => 65, // NORMAL | BLOCK_TAG
Chris@0:         "area" => 9, // NORMAL | VOID_TAG
Chris@0:         "article" => 81, // NORMAL | AUTOCLOSE_P | BLOCK_TAG
Chris@0:         "aside" => 81, // NORMAL | AUTOCLOSE_P | BLOCK_TAG
Chris@0:         "audio" => 65, // NORMAL | BLOCK_TAG
Chris@0:         "b" => 1,
Chris@0:         "base" => 9, // NORMAL | VOID_TAG
Chris@0:         "bdi" => 1,
Chris@0:         "bdo" => 1,
Chris@0:         "blockquote" => 81, // NORMAL | AUTOCLOSE_P | BLOCK_TAG
Chris@0:         "body" => 1,
Chris@0:         "br" => 9, // NORMAL | VOID_TAG
Chris@0:         "button" => 1,
Chris@0:         "canvas" => 65, // NORMAL | BLOCK_TAG
Chris@0:         "caption" => 1,
Chris@0:         "cite" => 1,
Chris@0:         "code" => 1,
Chris@0:         "col" => 9, // NORMAL | VOID_TAG
Chris@0:         "colgroup" => 1,
Chris@0:         "command" => 9, // NORMAL | VOID_TAG
Chris@0:                         // "data" => 1, // This is highly experimental and only part of the whatwg spec (not w3c). See https://developer.mozilla.org/en-US/docs/HTML/Element/data
Chris@0:         "datalist" => 1,
Chris@0:         "dd" => 65, // NORMAL | BLOCK_TAG
Chris@0:         "del" => 1,
Chris@0:         "details" => 17, // NORMAL | AUTOCLOSE_P,
Chris@0:         "dfn" => 1,
Chris@0:         "dialog" => 17, // NORMAL | AUTOCLOSE_P,
Chris@0:         "div" => 81, // NORMAL | AUTOCLOSE_P | BLOCK_TAG
Chris@0:         "dl" => 81, // NORMAL | AUTOCLOSE_P | BLOCK_TAG
Chris@0:         "dt" => 1,
Chris@0:         "em" => 1,
Chris@0:         "embed" => 9, // NORMAL | VOID_TAG
Chris@0:         "fieldset" => 81, // NORMAL | AUTOCLOSE_P | BLOCK_TAG
Chris@0:         "figcaption" => 81, // NORMAL | AUTOCLOSE_P | BLOCK_TAG
Chris@0:         "figure" => 81, // NORMAL | AUTOCLOSE_P | BLOCK_TAG
Chris@0:         "footer" => 81, // NORMAL | AUTOCLOSE_P | BLOCK_TAG
Chris@0:         "form" => 81, // NORMAL | AUTOCLOSE_P | BLOCK_TAG
Chris@0:         "h1" => 81, // NORMAL | AUTOCLOSE_P | BLOCK_TAG
Chris@0:         "h2" => 81, // NORMAL | AUTOCLOSE_P | BLOCK_TAG
Chris@0:         "h3" => 81, // NORMAL | AUTOCLOSE_P | BLOCK_TAG
Chris@0:         "h4" => 81, // NORMAL | AUTOCLOSE_P | BLOCK_TAG
Chris@0:         "h5" => 81, // NORMAL | AUTOCLOSE_P | BLOCK_TAG
Chris@0:         "h6" => 81, // NORMAL | AUTOCLOSE_P | BLOCK_TAG
Chris@0:         "head" => 1,
Chris@0:         "header" => 81, // NORMAL | AUTOCLOSE_P | BLOCK_TAG
Chris@0:         "hgroup" => 81, // NORMAL | AUTOCLOSE_P | BLOCK_TAG
Chris@0:         "hr" => 73, // NORMAL | VOID_TAG
Chris@0:         "html" => 1,
Chris@0:         "i" => 1,
Chris@0:         "iframe" => 3, // NORMAL | TEXT_RAW
Chris@0:         "img" => 9, // NORMAL | VOID_TAG
Chris@0:         "input" => 9, // NORMAL | VOID_TAG
Chris@0:         "kbd" => 1,
Chris@0:         "ins" => 1,
Chris@0:         "keygen" => 9, // NORMAL | VOID_TAG
Chris@0:         "label" => 1,
Chris@0:         "legend" => 1,
Chris@0:         "li" => 1,
Chris@0:         "link" => 9, // NORMAL | VOID_TAG
Chris@0:         "map" => 1,
Chris@0:         "mark" => 1,
Chris@0:         "menu" => 17, // NORMAL | AUTOCLOSE_P,
Chris@0:         "meta" => 9, // NORMAL | VOID_TAG
Chris@0:         "meter" => 1,
Chris@0:         "nav" => 17, // NORMAL | AUTOCLOSE_P,
Chris@0:         "noscript" => 65, // NORMAL | BLOCK_TAG
Chris@0:         "object" => 1,
Chris@0:         "ol" => 81, // NORMAL | AUTOCLOSE_P | BLOCK_TAG
Chris@0:         "optgroup" => 1,
Chris@0:         "option" => 1,
Chris@0:         "output" => 65, // NORMAL | BLOCK_TAG
Chris@0:         "p" => 209, // NORMAL | AUTOCLOSE_P | BLOCK_TAG | BLOCK_ONLY_INLINE
Chris@0:         "param" => 9, // NORMAL | VOID_TAG
Chris@0:         "pre" => 81, // NORMAL | AUTOCLOSE_P | BLOCK_TAG
Chris@0:         "progress" => 1,
Chris@0:         "q" => 1,
Chris@0:         "rp" => 1,
Chris@0:         "rt" => 1,
Chris@0:         "ruby" => 1,
Chris@0:         "s" => 1,
Chris@0:         "samp" => 1,
Chris@0:         "script" => 3, // NORMAL | TEXT_RAW
Chris@0:         "section" => 81, // NORMAL | AUTOCLOSE_P | BLOCK_TAG
Chris@0:         "select" => 1,
Chris@0:         "small" => 1,
Chris@0:         "source" => 9, // NORMAL | VOID_TAG
Chris@0:         "span" => 1,
Chris@0:         "strong" => 1,
Chris@0:         "style" => 3, // NORMAL | TEXT_RAW
Chris@0:         "sub" => 1,
Chris@0:         "summary" => 17, // NORMAL | AUTOCLOSE_P,
Chris@0:         "sup" => 1,
Chris@0:         "table" => 65, // NORMAL | BLOCK_TAG
Chris@0:         "tbody" => 1,
Chris@0:         "td" => 1,
Chris@0:         "textarea" => 5, // NORMAL | TEXT_RCDATA
Chris@0:         "tfoot" => 65, // NORMAL | BLOCK_TAG
Chris@0:         "th" => 1,
Chris@0:         "thead" => 1,
Chris@0:         "time" => 1,
Chris@0:         "title" => 5, // NORMAL | TEXT_RCDATA
Chris@0:         "tr" => 1,
Chris@0:         "track" => 9, // NORMAL | VOID_TAG
Chris@0:         "u" => 1,
Chris@0:         "ul" => 81, // NORMAL | AUTOCLOSE_P | BLOCK_TAG
Chris@0:         "var" => 1,
Chris@0:         "video" => 65, // NORMAL | BLOCK_TAG
Chris@0:         "wbr" => 9, // NORMAL | VOID_TAG
Chris@0: 
Chris@0:         // Legacy?
Chris@0:         'basefont' => 8, // VOID_TAG
Chris@0:         'bgsound' => 8, // VOID_TAG
Chris@0:         'noframes' => 2, // RAW_TEXT
Chris@0:         'frame' => 9, // NORMAL | VOID_TAG
Chris@0:         'frameset' => 1,
Chris@0:         'center' => 16,
Chris@0:         'dir' => 16,
Chris@0:         'listing' => 16, // AUTOCLOSE_P
Chris@0:         'plaintext' => 48, // AUTOCLOSE_P | TEXT_PLAINTEXT
Chris@0:         'applet' => 0,
Chris@0:         'marquee' => 0,
Chris@0:         'isindex' => 8, // VOID_TAG
Chris@0:         'xmp' => 20, // AUTOCLOSE_P | VOID_TAG | RAW_TEXT
Chris@0:         'noembed' => 2 // RAW_TEXT
Chris@0:         );
Chris@0: 
Chris@0:     /**
Chris@0:      * The MathML elements.
Chris@0:      * See http://www.w3.org/wiki/MathML/Elements.
Chris@0:      *
Chris@0:      * In our case we are only concerned with presentation MathML and not content
Chris@0:      * MathML. There is a nice list of this subset at https://developer.mozilla.org/en-US/docs/MathML/Element.
Chris@0:      *
Chris@0:      * @var array
Chris@0:      */
Chris@0:     public static $mathml = array(
Chris@0:         "maction" => 1,
Chris@0:         "maligngroup" => 1,
Chris@0:         "malignmark" => 1,
Chris@0:         "math" => 1,
Chris@0:         "menclose" => 1,
Chris@0:         "merror" => 1,
Chris@0:         "mfenced" => 1,
Chris@0:         "mfrac" => 1,
Chris@0:         "mglyph" => 1,
Chris@0:         "mi" => 1,
Chris@0:         "mlabeledtr" => 1,
Chris@0:         "mlongdiv" => 1,
Chris@0:         "mmultiscripts" => 1,
Chris@0:         "mn" => 1,
Chris@0:         "mo" => 1,
Chris@0:         "mover" => 1,
Chris@0:         "mpadded" => 1,
Chris@0:         "mphantom" => 1,
Chris@0:         "mroot" => 1,
Chris@0:         "mrow" => 1,
Chris@0:         "ms" => 1,
Chris@0:         "mscarries" => 1,
Chris@0:         "mscarry" => 1,
Chris@0:         "msgroup" => 1,
Chris@0:         "msline" => 1,
Chris@0:         "mspace" => 1,
Chris@0:         "msqrt" => 1,
Chris@0:         "msrow" => 1,
Chris@0:         "mstack" => 1,
Chris@0:         "mstyle" => 1,
Chris@0:         "msub" => 1,
Chris@0:         "msup" => 1,
Chris@0:         "msubsup" => 1,
Chris@0:         "mtable" => 1,
Chris@0:         "mtd" => 1,
Chris@0:         "mtext" => 1,
Chris@0:         "mtr" => 1,
Chris@0:         "munder" => 1,
Chris@0:         "munderover" => 1
Chris@0:     );
Chris@0: 
Chris@0:     /**
Chris@0:      * The svg elements.
Chris@0:      *
Chris@0:      * The Mozilla documentation has a good list at https://developer.mozilla.org/en-US/docs/SVG/Element.
Chris@0:      * The w3c list appears to be lacking in some areas like filter effect elements.
Chris@0:      * That list can be found at http://www.w3.org/wiki/SVG/Elements.
Chris@0:      *
Chris@0:      * Note, FireFox appears to do a better job rendering filter effects than chrome.
Chris@0:      * While they are in the spec I'm not sure how widely implemented they are.
Chris@0:      *
Chris@0:      * @var array
Chris@0:      */
Chris@0:     public static $svg = array(
Chris@0:         "a" => 1,
Chris@0:         "altGlyph" => 1,
Chris@0:         "altGlyphDef" => 1,
Chris@0:         "altGlyphItem" => 1,
Chris@0:         "animate" => 1,
Chris@0:         "animateColor" => 1,
Chris@0:         "animateMotion" => 1,
Chris@0:         "animateTransform" => 1,
Chris@0:         "circle" => 1,
Chris@0:         "clipPath" => 1,
Chris@0:         "color-profile" => 1,
Chris@0:         "cursor" => 1,
Chris@0:         "defs" => 1,
Chris@0:         "desc" => 1,
Chris@0:         "ellipse" => 1,
Chris@0:         "feBlend" => 1,
Chris@0:         "feColorMatrix" => 1,
Chris@0:         "feComponentTransfer" => 1,
Chris@0:         "feComposite" => 1,
Chris@0:         "feConvolveMatrix" => 1,
Chris@0:         "feDiffuseLighting" => 1,
Chris@0:         "feDisplacementMap" => 1,
Chris@0:         "feDistantLight" => 1,
Chris@0:         "feFlood" => 1,
Chris@0:         "feFuncA" => 1,
Chris@0:         "feFuncB" => 1,
Chris@0:         "feFuncG" => 1,
Chris@0:         "feFuncR" => 1,
Chris@0:         "feGaussianBlur" => 1,
Chris@0:         "feImage" => 1,
Chris@0:         "feMerge" => 1,
Chris@0:         "feMergeNode" => 1,
Chris@0:         "feMorphology" => 1,
Chris@0:         "feOffset" => 1,
Chris@0:         "fePointLight" => 1,
Chris@0:         "feSpecularLighting" => 1,
Chris@0:         "feSpotLight" => 1,
Chris@0:         "feTile" => 1,
Chris@0:         "feTurbulence" => 1,
Chris@0:         "filter" => 1,
Chris@0:         "font" => 1,
Chris@0:         "font-face" => 1,
Chris@0:         "font-face-format" => 1,
Chris@0:         "font-face-name" => 1,
Chris@0:         "font-face-src" => 1,
Chris@0:         "font-face-uri" => 1,
Chris@0:         "foreignObject" => 1,
Chris@0:         "g" => 1,
Chris@0:         "glyph" => 1,
Chris@0:         "glyphRef" => 1,
Chris@0:         "hkern" => 1,
Chris@0:         "image" => 1,
Chris@0:         "line" => 1,
Chris@0:         "linearGradient" => 1,
Chris@0:         "marker" => 1,
Chris@0:         "mask" => 1,
Chris@0:         "metadata" => 1,
Chris@0:         "missing-glyph" => 1,
Chris@0:         "mpath" => 1,
Chris@0:         "path" => 1,
Chris@0:         "pattern" => 1,
Chris@0:         "polygon" => 1,
Chris@0:         "polyline" => 1,
Chris@0:         "radialGradient" => 1,
Chris@0:         "rect" => 1,
Chris@0:         "script" => 3, // NORMAL | RAW_TEXT
Chris@0:         "set" => 1,
Chris@0:         "stop" => 1,
Chris@0:         "style" => 3, // NORMAL | RAW_TEXT
Chris@0:         "svg" => 1,
Chris@0:         "switch" => 1,
Chris@0:         "symbol" => 1,
Chris@0:         "text" => 1,
Chris@0:         "textPath" => 1,
Chris@0:         "title" => 1,
Chris@0:         "tref" => 1,
Chris@0:         "tspan" => 1,
Chris@0:         "use" => 1,
Chris@0:         "view" => 1,
Chris@0:         "vkern" => 1
Chris@0:     );
Chris@0: 
Chris@0:     /**
Chris@0:      * Some attributes in SVG are case sensetitive.
Chris@0:      *
Chris@0:      * This map contains key/value pairs with the key as the lowercase attribute
Chris@0:      * name and the value with the correct casing.
Chris@0:      */
Chris@0:     public static $svgCaseSensitiveAttributeMap = array(
Chris@0:         'attributename' => 'attributeName',
Chris@0:         'attributetype' => 'attributeType',
Chris@0:         'basefrequency' => 'baseFrequency',
Chris@0:         'baseprofile' => 'baseProfile',
Chris@0:         'calcmode' => 'calcMode',
Chris@0:         'clippathunits' => 'clipPathUnits',
Chris@0:         'contentscripttype' => 'contentScriptType',
Chris@0:         'contentstyletype' => 'contentStyleType',
Chris@0:         'diffuseconstant' => 'diffuseConstant',
Chris@0:         'edgemode' => 'edgeMode',
Chris@0:         'externalresourcesrequired' => 'externalResourcesRequired',
Chris@0:         'filterres' => 'filterRes',
Chris@0:         'filterunits' => 'filterUnits',
Chris@0:         'glyphref' => 'glyphRef',
Chris@0:         'gradienttransform' => 'gradientTransform',
Chris@0:         'gradientunits' => 'gradientUnits',
Chris@0:         'kernelmatrix' => 'kernelMatrix',
Chris@0:         'kernelunitlength' => 'kernelUnitLength',
Chris@0:         'keypoints' => 'keyPoints',
Chris@0:         'keysplines' => 'keySplines',
Chris@0:         'keytimes' => 'keyTimes',
Chris@0:         'lengthadjust' => 'lengthAdjust',
Chris@0:         'limitingconeangle' => 'limitingConeAngle',
Chris@0:         'markerheight' => 'markerHeight',
Chris@0:         'markerunits' => 'markerUnits',
Chris@0:         'markerwidth' => 'markerWidth',
Chris@0:         'maskcontentunits' => 'maskContentUnits',
Chris@0:         'maskunits' => 'maskUnits',
Chris@0:         'numoctaves' => 'numOctaves',
Chris@0:         'pathlength' => 'pathLength',
Chris@0:         'patterncontentunits' => 'patternContentUnits',
Chris@0:         'patterntransform' => 'patternTransform',
Chris@0:         'patternunits' => 'patternUnits',
Chris@0:         'pointsatx' => 'pointsAtX',
Chris@0:         'pointsaty' => 'pointsAtY',
Chris@0:         'pointsatz' => 'pointsAtZ',
Chris@0:         'preservealpha' => 'preserveAlpha',
Chris@0:         'preserveaspectratio' => 'preserveAspectRatio',
Chris@0:         'primitiveunits' => 'primitiveUnits',
Chris@0:         'refx' => 'refX',
Chris@0:         'refy' => 'refY',
Chris@0:         'repeatcount' => 'repeatCount',
Chris@0:         'repeatdur' => 'repeatDur',
Chris@0:         'requiredextensions' => 'requiredExtensions',
Chris@0:         'requiredfeatures' => 'requiredFeatures',
Chris@0:         'specularconstant' => 'specularConstant',
Chris@0:         'specularexponent' => 'specularExponent',
Chris@0:         'spreadmethod' => 'spreadMethod',
Chris@0:         'startoffset' => 'startOffset',
Chris@0:         'stddeviation' => 'stdDeviation',
Chris@0:         'stitchtiles' => 'stitchTiles',
Chris@0:         'surfacescale' => 'surfaceScale',
Chris@0:         'systemlanguage' => 'systemLanguage',
Chris@0:         'tablevalues' => 'tableValues',
Chris@0:         'targetx' => 'targetX',
Chris@0:         'targety' => 'targetY',
Chris@0:         'textlength' => 'textLength',
Chris@0:         'viewbox' => 'viewBox',
Chris@0:         'viewtarget' => 'viewTarget',
Chris@0:         'xchannelselector' => 'xChannelSelector',
Chris@0:         'ychannelselector' => 'yChannelSelector',
Chris@0:         'zoomandpan' => 'zoomAndPan'
Chris@0:     );
Chris@0: 
Chris@0:     /**
Chris@0:      * Some SVG elements are case sensetitive.
Chris@0:      * This map contains these.
Chris@0:      *
Chris@0:      * The map contains key/value store of the name is lowercase as the keys and
Chris@0:      * the correct casing as the value.
Chris@0:      */
Chris@0:     public static $svgCaseSensitiveElementMap = array(
Chris@0:         'altglyph' => 'altGlyph',
Chris@0:         'altglyphdef' => 'altGlyphDef',
Chris@0:         'altglyphitem' => 'altGlyphItem',
Chris@0:         'animatecolor' => 'animateColor',
Chris@0:         'animatemotion' => 'animateMotion',
Chris@0:         'animatetransform' => 'animateTransform',
Chris@0:         'clippath' => 'clipPath',
Chris@0:         'feblend' => 'feBlend',
Chris@0:         'fecolormatrix' => 'feColorMatrix',
Chris@0:         'fecomponenttransfer' => 'feComponentTransfer',
Chris@0:         'fecomposite' => 'feComposite',
Chris@0:         'feconvolvematrix' => 'feConvolveMatrix',
Chris@0:         'fediffuselighting' => 'feDiffuseLighting',
Chris@0:         'fedisplacementmap' => 'feDisplacementMap',
Chris@0:         'fedistantlight' => 'feDistantLight',
Chris@0:         'feflood' => 'feFlood',
Chris@0:         'fefunca' => 'feFuncA',
Chris@0:         'fefuncb' => 'feFuncB',
Chris@0:         'fefuncg' => 'feFuncG',
Chris@0:         'fefuncr' => 'feFuncR',
Chris@0:         'fegaussianblur' => 'feGaussianBlur',
Chris@0:         'feimage' => 'feImage',
Chris@0:         'femerge' => 'feMerge',
Chris@0:         'femergenode' => 'feMergeNode',
Chris@0:         'femorphology' => 'feMorphology',
Chris@0:         'feoffset' => 'feOffset',
Chris@0:         'fepointlight' => 'fePointLight',
Chris@0:         'fespecularlighting' => 'feSpecularLighting',
Chris@0:         'fespotlight' => 'feSpotLight',
Chris@0:         'fetile' => 'feTile',
Chris@0:         'feturbulence' => 'feTurbulence',
Chris@0:         'foreignobject' => 'foreignObject',
Chris@0:         'glyphref' => 'glyphRef',
Chris@0:         'lineargradient' => 'linearGradient',
Chris@0:         'radialgradient' => 'radialGradient',
Chris@0:         'textpath' => 'textPath'
Chris@0:     );
Chris@0: 
Chris@0:     /**
Chris@0:      * Check whether the given element meets the given criterion.
Chris@0:      *
Chris@0:      * Example:
Chris@0:      *
Chris@0:      * Elements::isA('script', Elements::TEXT_RAW); // Returns true.
Chris@0:      *
Chris@0:      * Elements::isA('script', Elements::TEXT_RCDATA); // Returns false.
Chris@0:      *
Chris@0:      * @param string $name
Chris@0:      *            The element name.
Chris@0:      * @param int $mask
Chris@0:      *            One of the constants on this class.
Chris@0:      * @return boolean true if the element matches the mask, false otherwise.
Chris@0:      */
Chris@0:     public static function isA($name, $mask)
Chris@0:     {
Chris@0:         if (! static::isElement($name)) {
Chris@0:             return false;
Chris@0:         }
Chris@0: 
Chris@0:         return (static::element($name) & $mask) == $mask;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Test if an element is a valid html5 element.
Chris@0:      *
Chris@0:      * @param string $name
Chris@0:      *            The name of the element.
Chris@0:      *
Chris@0:      * @return bool True if a html5 element and false otherwise.
Chris@0:      */
Chris@0:     public static function isHtml5Element($name)
Chris@0:     {
Chris@0:         // html5 element names are case insensetitive. Forcing lowercase for the check.
Chris@0:         // Do we need this check or will all data passed here already be lowercase?
Chris@0:         return isset(static::$html5[strtolower($name)]);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Test if an element name is a valid MathML presentation element.
Chris@0:      *
Chris@0:      * @param string $name
Chris@0:      *            The name of the element.
Chris@0:      *
Chris@0:      * @return bool True if a MathML name and false otherwise.
Chris@0:      */
Chris@0:     public static function isMathMLElement($name)
Chris@0:     {
Chris@0:         // MathML is case-sensetitive unlike html5 elements.
Chris@0:         return isset(static::$mathml[$name]);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Test if an element is a valid SVG element.
Chris@0:      *
Chris@0:      * @param string $name
Chris@0:      *            The name of the element.
Chris@0:      *
Chris@0:      * @return boolean True if a SVG element and false otherise.
Chris@0:      */
Chris@0:     public static function isSvgElement($name)
Chris@0:     {
Chris@0:         // SVG is case-sensetitive unlike html5 elements.
Chris@0:         return isset(static::$svg[$name]);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Is an element name valid in an html5 document.
Chris@0:      *
Chris@0:      * This includes html5 elements along with other allowed embedded content
Chris@0:      * such as svg and mathml.
Chris@0:      *
Chris@0:      * @param string $name
Chris@0:      *            The name of the element.
Chris@0:      *
Chris@0:      * @return bool True if valid and false otherwise.
Chris@0:      */
Chris@0:     public static function isElement($name)
Chris@0:     {
Chris@0:         return static::isHtml5Element($name) || static::isMathMLElement($name) || static::isSvgElement($name);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Get the element mask for the given element name.
Chris@0:      *
Chris@0:      * @param string $name
Chris@0:      *            The name of the element.
Chris@0:      *
Chris@0:      * @return int|bool The element mask or false if element does not exist.
Chris@0:      */
Chris@0:     public static function element($name)
Chris@0:     {
Chris@0:         if (isset(static::$html5[$name])) {
Chris@0:             return static::$html5[$name];
Chris@0:         }
Chris@0:         if (isset(static::$svg[$name])) {
Chris@0:             return static::$svg[$name];
Chris@0:         }
Chris@0:         if (isset(static::$mathml[$name])) {
Chris@0:             return static::$mathml[$name];
Chris@0:         }
Chris@0: 
Chris@0:         return false;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Normalize a SVG element name to its proper case and form.
Chris@0:      *
Chris@0:      * @param string $name
Chris@0:      *            The name of the element.
Chris@0:      *
Chris@0:      * @return string The normalized form of the element name.
Chris@0:      */
Chris@0:     public static function normalizeSvgElement($name)
Chris@0:     {
Chris@0:         $name = strtolower($name);
Chris@0:         if (isset(static::$svgCaseSensitiveElementMap[$name])) {
Chris@0:             $name = static::$svgCaseSensitiveElementMap[$name];
Chris@0:         }
Chris@0: 
Chris@0:         return $name;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Normalize a SVG attribute name to its proper case and form.
Chris@0:      *
Chris@0:      * @param string $name
Chris@0:      *            The name of the attribute.
Chris@0:      *
Chris@0:      * @return string The normalized form of the attribute name.
Chris@0:      */
Chris@0:     public static function normalizeSvgAttribute($name)
Chris@0:     {
Chris@0:         $name = strtolower($name);
Chris@0:         if (isset(static::$svgCaseSensitiveAttributeMap[$name])) {
Chris@0:             $name = static::$svgCaseSensitiveAttributeMap[$name];
Chris@0:         }
Chris@0: 
Chris@0:         return $name;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Normalize a MathML attribute name to its proper case and form.
Chris@0:      *
Chris@0:      * Note, all MathML element names are lowercase.
Chris@0:      *
Chris@0:      * @param string $name
Chris@0:      *            The name of the attribute.
Chris@0:      *
Chris@0:      * @return string The normalized form of the attribute name.
Chris@0:      */
Chris@0:     public static function normalizeMathMlAttribute($name)
Chris@0:     {
Chris@0:         $name = strtolower($name);
Chris@0: 
Chris@0:         // Only one attribute has a mixed case form for MathML.
Chris@0:         if ($name == 'definitionurl') {
Chris@0:             $name = 'definitionURL';
Chris@0:         }
Chris@0: 
Chris@0:         return $name;
Chris@0:     }
Chris@0: }