Documentation.php

Go to the documentation of this file.

<?php
namespace TYPO3\Flow\Package;

/*                                                                        *
 * This script belongs to the TYPO3 Flow framework.                       *
 *                                                                        *
 * It is free software; you can redistribute it and/or modify it under    *
 * the terms of the GNU Lesser General Public License, either version 3   *
 * of the License, or (at your option) any later version.                 *
 *                                                                        *
 * The TYPO3 project - inspiring people to share!                         *
 *                                                                        */

class Documentation {

    protected $package;

    protected $documentationName;

    protected $documentationPath;

    public function __construct($package, $documentationName, $documentationPath) {
        $this->package = $package;
        $this->documentationName = $documentationName;
        $this->documentationPath = $documentationPath;
    }

    public function getPackage() {
        return $this->package;
    }

    public function getDocumentationName() {
        return $this->documentationName;
    }

    public function getDocumentationPath() {
        return $this->documentationPath;
    }

    public function getDocumentationFormats() {
        $documentationFormats = array();

        $documentationFormatsDirectoryIterator = new \DirectoryIterator($this->documentationPath);
        $documentationFormatsDirectoryIterator->rewind();
        while ($documentationFormatsDirectoryIterator->valid()) {
            $filename = $documentationFormatsDirectoryIterator->getFilename();
            if ($filename[0] != '.' && $documentationFormatsDirectoryIterator->isDir()) {
                $documentationFormat = new \TYPO3\Flow\Package\Documentation\Format($filename, $this->documentationPath . $filename . '/');
                $documentationFormats[$filename] = $documentationFormat;
            }
            $documentationFormatsDirectoryIterator->next();
        }

        return $documentationFormats;
    }
}
?>