naneau / filegen

src/Naneau/FileGen/Structure.php

<?php
namespace Naneau\FileGen;

use Naneau\FileGen\Directory;
use Naneau\FileGen\File;
use Naneau\FileGen\SymLink;

use Naneau\FileGen\Parameter\Set as ParameterSet;

use Naneau\FileGen\Structure\Exception as StructureException;

/**
 * A structure
 */
class Structure extends Directory
{
    /**
     * The parameter definition
     *
     * @var ParameterSet
     **/
    private $parameterDefinition;

    /**
     * Constructor
     *
     * @return void

Adding a @return annotation to constructors is generally not recommended as a constructor does not have a meaningful return value.

     **/
    public function __construct()
    {
        // Although the root node (Structure) is a directory, it does not  have
        // a "name", relative to the root
        parent::__construct('');

        // Initialize the parameter definition
        $this->setParameterDefinition(new ParameterSet);
    }

    /**
     * Add a file
     *
     * @param  string              $name
     * @param  FileContents|string $contents
     * @param  int                 $mode     mode in octal 0XXX
     * @return Structure
     **/
    public function file($name, $contents = '', $mode = null)
    {
        // Create the file itself
        $file = new File(basename($name), $contents, $mode);

        $parent = $this->parentDirectory($name);
        $parent->addChild($file);

        return $this;
    }

    /**
     * Add a directory
     *
     * @param  string    $name
     * @param  int       $mode mode in octal 0XXX
     * @return Structure
     **/
    public function directory($name, $mode = null)
    {
        // Create the file itself
        $directory = new Directory(basename($name), $mode);

        $parent = $this->parentDirectory($name);
        $parent->addChild($directory);

        return $this;
    }

    /**
     * Create a symlink
     *
     * @param  string    $from
     * @param  string    $to
     * @return Structure
     **/
    public function link($from, $to)
    {
        // Create the file itself
        $link = new SymLink($from, basename($to));

        $parent = $this->parentDirectory($to);
        $parent->addChild($link);

        return $this;
    }

    /**
     * Add a parameter
     *
     * @param  string    $name        name of the parameter
     * @param  string    $description (optional) human readable description
     * @return Structure
     **/
    public function parameter($name, $description = null)
    {
        $this->getParameterDefinition()->add($name, $description);

        return $this;
    }

    /**
     * Get the parameter definition
     *
     * @return ParameterSet
     */
    public function getParameterDefinition()
    {
        return $this->parameterDefinition;
    }

    /**
     * Set the parameter definition
     *
     * @param  ParameterSet $parameterDefinition
     * @return Structure
     */
    public function setParameterDefinition(ParameterSet $parameterDefinition)
    {
        $this->parameterDefinition = $parameterDefinition;

        return $this;
    }

    /**
     * Create (and add) a parent directory for a path
     *
     * @param  string $name
     * @return void
     **/
    private function parentDirectory($name)
    {
        // Parent path
        $parentPath = dirname(trim($name, DIRECTORY_SEPARATOR));

        // There is no parent path (parent directory is the root)
        if ($parentPath === '.') {
            return $this;
        }

        // Directories to add
        $directories = explode(DIRECTORY_SEPARATOR, $parentPath);

        $parent = $this;
        $dirCount = count($directories);
        for ($x = 0; $x < $dirCount; $x++) {

            // Going through directories, highest level first
            $directory = $directories[$x];

            if ($parent->hasChild($directory)) {
                // If the parent already has a child by the name of $directory

                // Fetch the current child by that name
                $childDir = $parent->getChild($directory);

                // Make sure we get a directory back (it may be a file)
                if (!($childDir instanceof Directory)) {
                    throw new StructureException(sprintf(
                        'Trying to add directory where there is a file already: "%s"',
                        $parent->getFullName() . DIRECTORY_SEPARATOR . $directory
                    ));
                }
            } else {
                // Child directory does not exist yet, create a new one
                $childDir = new Directory($directory);

                // Add the child to the old parent
                $parent->addChild($childDir);
            }

            // Next directory with the new parent
            $parent = $childDir;
        }

        return $parent;
    }
}