lechimp-p / flightcontrol

src/Directory.php

<?php
/******************************************************************************
 * An iterator interface over the Leagues flysystem.
 * Copyright (c) 2021, 2015 Richard Klees <richard.klees@rwth-aachen.de>
 *
 * This software is licensed under GPLv3. You should have received
 * a copy of the along with the code.
 */

namespace Lechimp\Flightcontrol;

/**
 * This class represents a directory in the FS.
 */
class Directory extends FixedFDirectory
{
    /**
     * Get the objects inside the directory.
     *
     * @return FSObject[]
     */
    public function contents() : array
    {
        $contents = $this->filesystem()->listContents($this->path());
        $returns = array();
        foreach ($contents as $content) {
            $returns[] = $this->flightcontrol->get($content["path"]);
        }
        return $returns;
    }

    /**
     * @inheritdoc
     */
    public function mimetype() : ?string
    {
        return "directory";
    }

    /**
     * @inheritdoc
     */
    public function toDirectory()
    {
        return $this;
    }

    /**
     * See documentation of FDirectory.
     *
     * @return FDirectory<File>

The doc-type FDirectory<File> could not be parsed: Expected "|" or "end of type", but got "<" at position 10. (view supported doc-types)

     */
    public function unfix() : FDirectory
    {
        return $this->flightcontrol()->newFDirectory($this, function () {
            return $this->contents();
        });
    }

    /**
     * Create a directory structure with an anamorphism an insert it in place of
     * this directory.
     *
     * This is for INTERNAL use, use unfold($start_value)->with($unfolder) instead.
     *
     * @param   mixed     $start_value
     * @throws  \LogicException         When generated root node is a file.
     */
    public function insertByAna(\Closure $unfolder, $start_value) : void
    {
        $insert = FixedFDirectory::ana($unfolder, $start_value);

        if ($insert->isFile()) {
            throw new \LogicException("Expected generated root node to be a directory, not a file.");
        }

        $inserter = array();
        $inserter[0] = function ($path, FixedFDirectory $directory) use (&$inserter) {
            foreach ($directory->contents() as $content) {
                $new_path = $path . "/" . $content->name();
                if ($content->isFile()) {
                    $this->filesystem()->write($new_path, $content->content());
                } else {
                    $this->filesystem()->createDirectory($new_path);
                    $inserter[0]($new_path, $content);
                }
            }
        };
        $inserter[0]($this->path(), $insert);
    }

    /**
     * Make a directory when unfolding a directory structure via Directory::unfold.
     *
     * @param   Flightcontrol   $flightcontrol
     * @param   string          $name
     * @param   array           $content
     * @return  FDirectory<a>

The doc-type FDirectory<a> could not be parsed: Expected "|" or "end of type", but got "<" at position 10. (view supported doc-types)

     */
    public static function makeFDirectory(Flightcontrol $flightcontrol, string $name, array $content) : FDirectory
    {
        return new FDirectory(
            new VirtualFSObject($flightcontrol, $name),
            function () use ($content) {
                return $content;
            }
        );
    }

    /**
     * Make a file when unfolding a directory structure via Directory::unfold.
     *
     * @param   Flightcontrol   $flightcontrol
     * @param   string  $name
     * @param   string  $content
     * @return  File
     */
    public static function makeFile(Flightcontrol $flightcontrol, string $name, string $content) : VirtualFile
    {
        return new VirtualFile($flightcontrol, $name, $content);
    }
}