PackageXmlParser.php

Go to the documentation of this file.

<?php
namespace MagentoHackathon\Composer\Magento;

class PackageXmlParser extends PathTranslationParser
{
    protected $_moduleDir = null;

    protected $_file = null;

    protected $_targets = array();

    public function __construct($moduleDir, $packageXmlFile, $translations = array(), $pathSuffix)
    {
        parent::__construct($translations, $pathSuffix);
        $this->setModuleDir($moduleDir);
        $this->setFile($this->getModuleDir() . '/' . $packageXmlFile);
    }

    public function setModuleDir($moduleDir)
    {
        // Remove trailing slash
        if (!is_null($moduleDir)) {
            $moduleDir = rtrim($moduleDir, '\\/');
        }

        $this->_moduleDir = $moduleDir;
        return $this;
    }

    public function getModuleDir()
    {
        return $this->_moduleDir;
    }

    public function setFile($file)
    {
        if (is_string($file)) {
            $file = new \SplFileObject($file);
        }
        $this->_file = $file;
        return $this;
    }

    public function getFile()
    {
        return $this->_file;
    }

    public function getMappings()
    {
        $file = $this->getFile();

        if (!$file->isReadable()) {
            throw new \ErrorException(sprintf('Package file "%s" not readable', $file->getPathname()));
        }

        $map = $this->_parseMappings();
        $map = $this->translatePathMappings($map);
        return $map;
    }

    protected function _parseMappings()
    {
        $map = array();

        $package = simplexml_load_file($this->getFile()->getPathname());
        if (isset($package)) {
            foreach ($package->xpath('//contents/target') as $target) {
                try {
                    $basePath = $this->getTargetPath($target);

                    foreach ($target->children() as $child) {
                        foreach ($this->getElementPaths($child) as $elementPath) {
                            $relativePath = $basePath . '/' . $elementPath;
                            $map[] = array($relativePath, $relativePath);
                        }
                    }

                }
                catch (RuntimeException $e) {
                    // Skip invalid targets
                    throw $e;
                    continue;
                }
            }
        }
        return $map;
    }

    protected function getTargetPath(\SimpleXMLElement $target)
    {
        $name = (string) $target->attributes()->name;
        $targets = $this->getTargetsDefinitions();
        if (! isset($targets[$name])) {
            throw new RuntimeException('Invalid target type ' . $name);
        }
        return $targets[$name];
    }

    protected function getTargetsDefinitions()
    {
        if (! $this->_targets) {

            $targets = simplexml_load_file(__DIR__ . '/../../../../res/target.xml');
            foreach ($targets as $target) {
                $attributes = $target->attributes();
                $this->_targets["{$attributes->name}"] = "{$attributes->uri}";
            }
        }
        return $this->_targets;
    }

    protected function getElementPaths(\SimpleXMLElement $element) {
        $type = $element->getName();
        $name = $element->attributes()->name;
        $elementPaths = array();

        switch ($type) {
            case 'dir':
                if ($element->children()) {
                    foreach ($element->children() as $child) {
                        foreach ($this->getElementPaths($child) as $elementPath) {
                            $elementPaths[] = $name == '.' ? $elementPath : $name . '/' . $elementPath;
                        }
                    }
                } else {
                    $elementPaths[] = $name;
                }
                break;

            case 'file':
                $elementPaths[] = $name;
                break;

            default:
                throw new RuntimeException('Unknown path type: ' . $type);
        }

        return $elementPaths;
    }

    protected function getFirstChild(\SimpleXMLElement$element)
    {
        foreach ($element->children() as $child) {
            return $child;
        }
    }
}