MediaManagerInterface.php

<?php

/*
 * This file is part of the Symfony CMF package.
 *
 * (c) 2011-2014 Symfony CMF
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Symfony\Cmf\Bundle\MediaBundle;

/**
 * Interface containing media helper methods, these are probably persistence
 * layer specific.
 */
interface MediaManagerInterface
{
    /**
     * Get path, like:
     * - /path/to/file/filename.ext
     * - /fileId
     *
     * It is similar to a filesystem path only always uses "/" to separate
     * parents, and therefore allows to get the parent from the path.
     *
     * @param MediaInterface $media
     *
     * @return string
     */
    public function getPath(MediaInterface $media);

    /**
     * Get an url safe path
     *
     * @param MediaInterface $media
     *
     * @return string
     */
    public function getUrlSafePath(MediaInterface $media);

    /**
     * Set defaults for a media object;
     * this is used fe. by Doctrine Phpcr to ensure a unique id and add the
     * parent object.
     *
     * @param MediaInterface $media
     * @param string         $parentPath optionally add the parent path
     *
     * @return void
     *
     * @throws \RuntimeException if the defaults could not be set
     */
    public function setDefaults(MediaInterface $media, $parentPath = null);

    /**
     * Map the path to an id that can be used to lookup the file in the
     * Doctrine store.
     *
     * @param string $path
     * @param string $rootPath
     *
     * @return string
     *
     * @throws \OutOfBoundsException if the path is out of the root path where
     *                               the filesystem is located
     */
    public function mapPathToId($path, $rootPath = null);

    /**
     * Map the requested path (ie. subpath in the URL) to an id that can
     * be used to lookup the file in the Doctrine store.
     *
     * @param string $path
     * @param string $rootPath
     *
     * @return string
     *
     * @throws \OutOfBoundsException if the path is out of the root path where
     *                               the filesystem is located
     */
    public function mapUrlSafePathToId($path, $rootPath = null);
}