Jkphl\RdfaLiteMicrodata\Infrastructure\Factories\HtmlDocumentFactory

Complexity

Total Complexity

11

Size/Duplication

Total Lines	221
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	createDocumentFromSource()	0	10	1
A	processParsingErrors()	0	9	4
A	isNotInvalidHtml5TagError()	0	8	3
A	isNotAllowedError()	0	4	2

<?php

/**
 * rdfa-lite-microdata
 *
 * @category Jkphl
 * @package Jkphl\RdfaLiteMicrodata
 * @subpackage Jkphl\RdfaLiteMicrodata\Infrastructure
 * @author Joschi Kuphal <joschi@tollwerk.de> / @jkphl
 * @copyright Copyright © 2017 Joschi Kuphal <joschi@tollwerk.de> / @jkphl
 * @license http://opensource.org/licenses/MIT The MIT License (MIT)
 */

/***********************************************************************************
 *  The MIT License (MIT)
 *
 *  Copyright © 2017 Joschi Kuphal <joschi@kuphal.net> / @jkphl
 *
 *  Permission is hereby granted, free of charge, to any person obtaining a copy of
 *  this software and associated documentation files (the "Software"), to deal in
 *  the Software without restriction, including without limitation the rights to
 *  use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 *  the Software, and to permit persons to whom the Software is furnished to do so,
 *  subject to the following conditions:
 *
 *  The above copyright notice and this permission notice shall be included in all
 *  copies or substantial portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 *  FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 *  COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 *  IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 *  CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 ***********************************************************************************/

namespace Jkphl\RdfaLiteMicrodata\Infrastructure\Factories;

use Jkphl\RdfaLiteMicrodata\Application\Contract\DocumentFactoryInterface;
use Jkphl\RdfaLiteMicrodata\Infrastructure\Exceptions\HtmlParsingException;
use Jkphl\RdfaLiteMicrodata\Infrastructure\Exceptions\InvalidArgumentException;

/**
 * HTML document factory
 *
 * @package Jkphl\RdfaLiteMicrodata
 * @subpackage Jkphl\RdfaLiteMicrodata\Infrastructure
 */
class HtmlDocumentFactory implements DocumentFactoryInterface
{
    /**
     * HTML5 elements
     *
     * @var array
     */
    protected static $html5 = [
        'a',
        'abbr',
        'acronym',
        'address',
        'applet',
        'area',
        'article',
        'aside',
        'audio',
        'b',
        'base',
        'basefont',
        'bdi',
        'bdo',
        'bgsound',
        'big',
        'blink',
        'blockquote',
        'body',
        'br',
        'button',
        'canvas',
        'caption',
        'center',
        'cite',
        'code',
        'col',
        'colgroup',
        'content',
        'data',
        'datalist',
        'dd',
        'decorator',
        'del',
        'details',
        'dfn',
        'dir',
        'div',
        'dl',
        'dt',
        'element',
        'em',
        'embed',
        'fieldset',
        'figcaption',
        'figure',
        'font',
        'footer',
        'form',
        'frame',
        'frameset',
        'h1',
        'h2',
        'h3',
        'h4',
        'h5',
        'h6',
        'head',
        'header',
        'hgroup',
        'hr',
        'html',
        'i',
        'iframe',
        'img',
        'input',
        'ins',
        'isindex',
        'kbd',
        'keygen',
        'label',
        'legend',
        'li',
        'link',
        'listing',
        'main',
        'map',
        'mark',
        'marquee',
        'menu',
        'menuitem',
        'meta',
        'meter',
        'nav',
        'nobr',
        'noframes',
        'noscript',
        'object',
        'ol',
        'optgroup',
        'option',
        'output',
        'p',
        'param',
        'plaintext',
        'pre',
        'progress',
        'q',
        'rp',
        'rt',
        'ruby',
        's',
        'samp',
        'script',
        'section',
        'select',
        'shadow',
        'small',
        'source',
        'spacer',
        'span',
        'strike',
        'strong',
        'style',
        'sub',
        'summary',
        'sup',
        'table',
        'tbody',
        'td',
        'template',
        'textarea',
        'tfoot',
        'th',
        'thead',
        'time',
        'title',
        'tr',
        'track',
        'tt',
        'u',
        'ul',
        'var',
        'video',
        'wbr',
        'xmp'
    ];
    /**
     * Custom HTML parsing error handler
     *
     * @var callable|null
     */
    protected $errorHandler;

    /**
     * Constructor
     *
     * @param callable|null $errorHandler Custom HTML parsing error handler
     */
    public function __construct(callable $errorHandler = null)
    {
        $this->errorHandler = $errorHandler;
    }

    /**
     * Create a DOM document from a source
     *
     * @param mixed $source Source
     * @return \DOMDocument DOM document
     */
    public function createDocumentFromSource($source)
    {
        $dom = new \DOMDocument();
        libxml_use_internal_errors(true);
        $dom->loadHTML($source);
        $errors = libxml_get_errors();
        libxml_use_internal_errors(false);
        $this->processParsingErrors($errors);
        return $dom;
    }

    /**
     * Process parsing errors
     *
     * @param \LibXMLError[] $errors Parsing errors
     * @throws InvalidArgumentException If it's not a HTML5 error
     */
    protected function processParsingErrors(array $errors)
    {
        /** @var \LibXMLError $error */
        foreach ($errors as $error) {
            if ($this->isNotInvalidHtml5TagError($error) && $this->isNotAllowedError($error)) {
                throw new HtmlParsingException($error);
            }
        }
    }

    /**
     * Test whether a parsing error is not because of an "invalid" HTML5 tag
     *
     * @param \LibXMLError $error Parsing error
     * @return bool Error is not because of an "invalid" HTML5 tag
     */
    protected function isNotInvalidHtml5TagError(\LibXMLError $error)
    {
        return ($error->code != 801) ||
            (
                preg_match('/^tag\s+(\S+)\s+invalid$/', strtolower($error->message), $tag) &&
                !in_array($tag[1], self::$html5)
            );
    }

    /**
     * Test whether a parsing error is allowed per custom HTML parser error handler
     *
     * @param \LibXMLError $error Parsing error
     * @return bool Error is not allowed
     */
    protected function isNotAllowedError(\LibXMLError $error)
    {
        return !(is_callable($this->errorHandler) && call_user_func($this->errorHandler, $error));
    }
}