FileInterface.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Core\Resource;

/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */

interface FileInterface extends ResourceInterface
{
    /*******************************
     * VARIOUS FILE PROPERTY GETTERS
     *******************************/
    public function hasProperty($key);

    public function getProperty($key);

    public function getSize();

    public function getSha1();

    public function getNameWithoutExtension();

    public function getExtension();

    public function getMimeType();

    public function getModificationTime();

    public function getCreationTime();

    /******************
     * CONTENTS RELATED
     ******************/
    public function getContents();

    public function setContents($contents);

    /****************************************
     * STORAGE AND MANAGEMENT RELATED METHODS
     ****************************************/
    public function delete();

    public function rename($newName, $conflictMode = DuplicationBehavior::RENAME);

    /*****************
     * SPECIAL METHODS
     *****************/
    public function getPublicUrl($relativeToCurrentScript = false);

    public function isIndexed();

    public function getForLocalProcessing($writable = true);

    public function toArray();
}