FileInterface.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 for objects containing a file.
 *
 * This is to be kept compatible with the SonataMediaBundle MediaInterface to
 * allow integration with sonata.
 */
interface FileInterface extends HierarchyInterface, MetadataInterface
{
    /**
     * Returns the content
     *
     * @return string
     */
    public function getContentAsString();

    /**
     * Set the content
     *
     * @param string $content
     */
    public function setContentFromString($content);

    /**
     * Copy the content from a file, this allows to optimize copying the data
     * of a file. It is preferred to use the dedicated content setters if
     * possible.
     *
     * @param FileInterface|\SplFileInfo $file
     *
     * @throws \InvalidArgumentException if file is no FileInterface|\SplFileInfo
     */
    public function copyContentFromFile($file);

    /**
     * The mime type of this media element
     *
     * @return string
     */
    public function getContentType();

    /**
     * Returns the extension of the file
     *
     * @return string
     */
    public function getExtension();

    /**
     * Get the file size in bytes
     *
     * @return integer
     */
    public function getSize();

}