DriverInterface.php

Go to the documentation of this file.

<?php
namespace Magento\Framework\Filesystem;

use Magento\Framework\Exception\FileSystemException;

interface DriverInterface
{
    const WRITEABLE_DIRECTORY_MODE = 0770;

    const WRITEABLE_FILE_MODE = 0660;

    public function isExists($path);

    public function stat($path);

    public function isReadable($path);

    public function isFile($path);

    public function isDirectory($path);

    public function fileGetContents($path, $flag = null, $context = null);

    public function isWritable($path);

    public function getParentDirectory($path);

    public function createDirectory($path, $permissions = 0777);

    public function readDirectory($path);

    public function readDirectoryRecursively($path = null);

    public function search($pattern, $path);

    public function rename($oldPath, $newPath, DriverInterface $targetDriver = null);

    public function copy($source, $destination, DriverInterface $targetDriver = null);

    public function symlink($source, $destination, DriverInterface $targetDriver = null);

    public function deleteFile($path);

    public function deleteDirectory($path);

    public function changePermissions($path, $permissions);

    public function changePermissionsRecursively($path, $dirPermissions, $filePermissions);

    public function touch($path, $modificationTime = null);

    public function filePutContents($path, $content, $mode = null);

    public function fileOpen($path, $mode);

    public function fileReadLine($resource, $length, $ending = null);

    public function fileRead($resource, $length);

    public function fileGetCsv($resource, $length = 0, $delimiter = ',', $enclosure = '"', $escape = '\\');

    public function fileTell($resource);

    public function fileSeek($resource, $offset, $whence = SEEK_SET);

    public function endOfFile($resource);

    public function fileClose($resource);

    public function fileWrite($resource, $data);

    public function filePutCsv($resource, array $data, $delimiter = ',', $enclosure = '"');

    public function fileFlush($resource);

    public function fileLock($resource, $lockMode = LOCK_EX);

    public function fileUnlock($resource);

    public function getAbsolutePath($basePath, $path, $scheme = null);

    public function getRealPath($path);

    public function getRealPathSafety($path);

    public function getRelativePath($basePath, $path = null);
}