ProtectedDirectory.php

<?php

namespace Drupal\Core\File;


/**
 * A value object representing a protected directory.
 */
class ProtectedDirectory {
    
    /**
     * The directory title.
     *
     * @var string
     */
    protected $title;
    
    /**
     * The directory path.
     *
     * @var string
     */
    protected $path;
    
    /**
     * If the directory is private (or public).
     *
     * @var bool
     */
    protected $private;
    
    /**
     * ProtectedDirectory constructor.
     *
     * @param string $title
     *   The directory title.
     * @param string $path
     *   The path to the directory.
     * @param bool $private
     *   (optional) Whether the directory is private or public (default).
     */
    public function __construct($title, $path, $private = FALSE) {
        $this->title = $title;
        $this->path = $path;
        $this->private = $private;
    }
    
    /**
     * Gets the title.
     *
     * @return string
     *   The Title.
     */
    public function getTitle() {
        return $this->title;
    }
    
    /**
     * Gets the directory path.
     *
     * @return string
     *   The directory path.
     */
    public function getPath() {
        return $this->path;
    }
    
    /**
     * Is the directory private (or public).
     *
     * @return bool
     *   TRUE if the directory is private, FALSE if it is public.
     */
    public function isPrivate() {
        return $this->private;
    }

}