Permalink
Cannot retrieve contributors at this time
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
198 lines (175 sloc)
4.22 KB
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
<?php | |
namespace Illuminate\Contracts\Filesystem; | |
interface Filesystem | |
{ | |
/** | |
* The public visibility setting. | |
* | |
* @var string | |
*/ | |
const VISIBILITY_PUBLIC = 'public'; | |
/** | |
* The private visibility setting. | |
* | |
* @var string | |
*/ | |
const VISIBILITY_PRIVATE = 'private'; | |
/** | |
* Determine if a file exists. | |
* | |
* @param string $path | |
* @return bool | |
*/ | |
public function exists($path); | |
/** | |
* Get the contents of a file. | |
* | |
* @param string $path | |
* @return string | |
* | |
* @throws \Illuminate\Contracts\Filesystem\FileNotFoundException | |
*/ | |
public function get($path); | |
/** | |
* Get a resource to read the file. | |
* | |
* @param string $path | |
* @return resource|null The path resource or null on failure. | |
* | |
* @throws \Illuminate\Contracts\Filesystem\FileNotFoundException | |
*/ | |
public function readStream($path); | |
/** | |
* Write the contents of a file. | |
* | |
* @param string $path | |
* @param string|resource $contents | |
* @param mixed $options | |
* @return bool | |
*/ | |
public function put($path, $contents, $options = []); | |
/** | |
* Write a new file using a stream. | |
* | |
* @param string $path | |
* @param resource $resource | |
* @param array $options | |
* @return bool | |
* | |
* @throws \InvalidArgumentException If $resource is not a file handle. | |
* @throws \Illuminate\Contracts\Filesystem\FileExistsException | |
*/ | |
public function writeStream($path, $resource, array $options = []); | |
/** | |
* Get the visibility for the given path. | |
* | |
* @param string $path | |
* @return string | |
*/ | |
public function getVisibility($path); | |
/** | |
* Set the visibility for the given path. | |
* | |
* @param string $path | |
* @param string $visibility | |
* @return bool | |
*/ | |
public function setVisibility($path, $visibility); | |
/** | |
* Prepend to a file. | |
* | |
* @param string $path | |
* @param string $data | |
* @return bool | |
*/ | |
public function prepend($path, $data); | |
/** | |
* Append to a file. | |
* | |
* @param string $path | |
* @param string $data | |
* @return bool | |
*/ | |
public function append($path, $data); | |
/** | |
* Delete the file at a given path. | |
* | |
* @param string|array $paths | |
* @return bool | |
*/ | |
public function delete($paths); | |
/** | |
* Copy a file to a new location. | |
* | |
* @param string $from | |
* @param string $to | |
* @return bool | |
*/ | |
public function copy($from, $to); | |
/** | |
* Move a file to a new location. | |
* | |
* @param string $from | |
* @param string $to | |
* @return bool | |
*/ | |
public function move($from, $to); | |
/** | |
* Get the file size of a given file. | |
* | |
* @param string $path | |
* @return int | |
*/ | |
public function size($path); | |
/** | |
* Get the file's last modification time. | |
* | |
* @param string $path | |
* @return int | |
*/ | |
public function lastModified($path); | |
/** | |
* Get an array of all files in a directory. | |
* | |
* @param string|null $directory | |
* @param bool $recursive | |
* @return array | |
*/ | |
public function files($directory = null, $recursive = false); | |
/** | |
* Get all of the files from the given directory (recursive). | |
* | |
* @param string|null $directory | |
* @return array | |
*/ | |
public function allFiles($directory = null); | |
/** | |
* Get all of the directories within a given directory. | |
* | |
* @param string|null $directory | |
* @param bool $recursive | |
* @return array | |
*/ | |
public function directories($directory = null, $recursive = false); | |
/** | |
* Get all (recursive) of the directories within a given directory. | |
* | |
* @param string|null $directory | |
* @return array | |
*/ | |
public function allDirectories($directory = null); | |
/** | |
* Create a directory. | |
* | |
* @param string $path | |
* @return bool | |
*/ | |
public function makeDirectory($path); | |
/** | |
* Recursively delete a directory. | |
* | |
* @param string $directory | |
* @return bool | |
*/ | |
public function deleteDirectory($directory); | |
} |