jkphl/micrometa

<?php

/**
 * micrometa
 *
 * @category   Jkphl
 * @package    Jkphl\Micrometa
 * @subpackage Jkphl\Micrometa\Infrastructure\Parser
 * @author     Joschi Kuphal <joschi@kuphal.net> / @jkphl
 * @copyright  Copyright © 2018 Joschi Kuphal <joschi@kuphal.net> / @jkphl
 * @license    http://opensource.org/licenses/MIT The MIT License (MIT)
 */

/***********************************************************************************
 *  The MIT License (MIT)
 *
 *  Copyright © 2018 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\Micrometa\Infrastructure\Parser;

use Jkphl\Micrometa\Application\Contract\ParsingResultInterface;
use Jkphl\Micrometa\Ports\Format;

/**
 * Link rel parser
 *
 * @package    Jkphl\Micrometa
 * @subpackage Jkphl\Micrometa\Infrastructure
 */
class LinkType extends AbstractParser
{
    /**
     * Format
     *
     * @var int
     */
    const FORMAT = Format::LINK_TYPE;

    /**
     * Parse a DOM document
     *
     * @param \DOMDocument $dom DOM Document
     *
     * @return ParsingResultInterface Micro information items
     */
    public function parseDom(\DOMDocument $dom)
    {
        $this->logger->info('Running parser: '.(new \ReflectionClass(__CLASS__))->getShortName());
        $items = [];

        $xpath = new \DOMXPath($dom);
        $xpath->registerNamespace('html', self::HTML_PROFILE_URI);

        // Run through all <link> elements with a `rel` attribute
        /** @var \DOMElement $linkType */
        foreach ($xpath->query('//*[local-name(.) = "link" or local-name(.) = "a"][@rel]') as $linkType) {
            $item    = [
                'type'       => $this->parseLinkType($linkType->getAttribute('rel')),
                'id'         => $linkType->getAttribute('id') ?: null,
                'properties' => $this->parseProperties($linkType),
            ];
            $items[] = (object)$item;
        }

        return new ParsingResult(self::FORMAT, $items);
    }

    /**
     * Process the item types
     *
     * @param string $relAttr rel attribute value
     *
     * @return array Item types
     */
    protected function parseLinkType($relAttr)
    {
        $type = [];
        foreach (preg_split('/\040+/', $relAttr) as $rel) {
            $type[] = (object)['name' => $rel, 'profile' => self::HTML_PROFILE_URI];
        }

        return $type;
    }

    /**
     * Parse the LinkType attributes
     *
     * @param \DOMElement $linkType LinkType element
     *
     * @return array Properties
     */
    protected function parseProperties(\DOMElement $linkType)
    {
        $properties = [];
        /**
         * @var string $attributeName Attribute name
         * @var \DOMAttr $attribute   Attribute
         */
        foreach ($linkType->attributes as $attributeName => $attribute) {
            if (!in_array($attributeName, ['rel', 'id'])) {
                $profile      = $attribute->lookupNamespaceUri($attribute->prefix ?: null);
                $property     = (object)[
                    'name'    => $attributeName,
                    'profile' => $profile,
                    'values'  => $this->parseAttributeValue($profile, $attributeName, $attribute->value),
                ];
                $properties[] = $property;
            }
        }

        return $properties;
    }

    /**
     * Parse an attribute value
     *
     * @param string $profile   Profile
     * @param string $attribute Attribute name
     * @param string $value     Attribute value
     *
     * @return array Attribute values
     */
    protected function parseAttributeValue($profile, $attribute, $value)
    {
        // If it's a HTML attribute
        if ($profile == LinkType::HTML_PROFILE_URI) {
            switch ($attribute) {
                // Space delimited lists
                case 'sizes':
                    return array_filter(preg_split('/\040+/', $value));
                // Space or comma delimited lists
                case 'charset':
                    return array_filter(preg_split('/[,\040]+/', $value));
            }
        }

        return [$value];
    }
}