\phpDocumentor\Plugin\Scrybe\Converter\RestructuredText\DirectivesFigure

<?php
/**
 * phpDocumentor
 *
 * PHP Version 5.3
 *
 * @copyright 2010-2014 Mike van Riel / Naenius (http://www.naenius.com)
 * @license   http://www.opensource.org/licenses/mit-license.php MIT
 * @link      http://phpdoc.org
 */

namespace phpDocumentor\Plugin\Scrybe\Converter\RestructuredText\Directives;

use phpDocumentor\Plugin\Scrybe\Converter\Metadata\Assets;
use \phpDocumentor\Plugin\Scrybe\Converter\RestructuredText\Visitors\Discover;

/**
 * Directive used to process `.. figure::` and collect images as assets to be copied.
 *
 * The filenames of the images are taken from the directive and added onto the assets collection during the
 * discovery phase. These assets may then be copied to the destination location by the invoker.
 *
 * @see \phpDocumentor\Plugin\Scrybe\Converter\Metadata\Assets
 */
class Figure extends \ezcDocumentRstFigureDirective
{
    /** @var Discover */
    protected $visitor;

    /**
     * Converts the Image directive to aDocBook image tag.
     *
     * This method takes an image directive and converts it into its DocBook representation and stores a reference in
     * the Asset manager of the Converter.
     *
     * @see ConverterInterface::getAssets() for the asset manager
     *
     * @param \DOMDocument $document
     * @param \DOMElement  $root
     *
     * @return void
     */
    public function toDocbook(\DOMDocument $document, \DOMElement $root)
    {
        $this->storeAsset();
        parent::toDocbook($document, $root);
    }

    /**
     * Converts the Image directive to an <img/> tag.
     *
     * This method takes an image directive and converts it into its HTML representation and stores a reference in the
     * Asset manager of the Converter.
     *
     * @see ConverterInterface::getAssets() for the asset manager
     *
     * @param \DOMDocument $document
     * @param \DOMElement $root
     *
     * @return void
     */
    public function toXhtml(\DOMDocument $document, \DOMElement $root)
    {
        $this->storeAsset();
        parent::toXhtml($document, $root);
    }

    /**
     * Stores the asset in the asset manager.
     *
     * This method takes an asset defined in the directive and stores that in the asset manager.
     *
     * The following rules apply:
     *
     * 1. The source of the asset is the relative path of the asset prefixed
     *    with a path based on the following rules:
     *
     *    1. If the asset starts with a slash then the path is calculated from the project's root or
     *    2. if the asset does not start with a slash then the path is calculated from the file's directory.
     *
     * 2. the destination of the asset is the path relative to the project root.
     *
     *    1. When the asset starts with a slash then this equals that path without the leading slash.
     *    2. If not, the destination must be calculated by subtracting the project root from the current file's path
     *       and prepending that to the asset path (resolving `../` patterns in the mean time).
     *
     * @return void
     */
    protected function storeAsset()
    {
        if (!$this->visitor instanceof Discover) {
            return;
        }

        $assets       = $this->getAssetManager();
        $project_root = $assets->getProjectRoot();
        $asset_path   = trim($this->node->parameters);
        $file_path    = $this->visitor->getDocument()->getFile()->getRealPath();

        // get source path
        $source = ($asset_path[0] !== '/')
            ? dirname($file_path) . '/' . $asset_path
            : $project_root . $asset_path;

        // get destination path
        $destination = ($asset_path[0] !== '/')
            ? substr(dirname($file_path).'/'.$asset_path, strlen($project_root))
            : substr($asset_path, 1);

        // set asset
        $assets->set($source, $destination);
    }

    /**
     * Returns the asset manager.
     *
     * @return Assets
     */
    protected function getAssetManager()
    {
        return $this->visitor->getDocument()->getConverter()->getAssets();
    }
}