League\Flysystem\AdapterInterface Interface Reference

Inheritance diagram for League\Flysystem\AdapterInterface:

Collaboration diagram for League\Flysystem\AdapterInterface:

Public Member Functions
	write ($path, $contents, Config $config)
	Write a new file. More...
	writeStream ($path, $resource, Config $config)
	Write a new file using a stream. More...
	update ($path, $contents, Config $config)
	Update a file. More...
	updateStream ($path, $resource, Config $config)
	Update a file using a stream. More...
	rename ($path, $newpath)
	Rename a file. More...
	copy ($path, $newpath)
	Copy a file. More...
	delete ($path)
	Delete a file. More...
	deleteDir ($dirname)
	Delete a directory. More...
	createDir ($dirname, Config $config)
	Create a directory. More...
	setVisibility ($path, $visibility)
	Set the visibility for a file. More...
Public Member Functions inherited from League\Flysystem\ReadInterface
	has ($path)
	Check whether a file exists. More...
	read ($path)
	Read a file. More...
	readStream ($path)
	Read a file as a stream. More...
	listContents ($directory='', $recursive=false)
	List contents of a directory. More...
	getMetadata ($path)
	Get all the meta data of a file or directory. More...
	getSize ($path)
	Get the size of a file. More...
	getMimetype ($path)
	Get the mimetype of a file. More...
	getTimestamp ($path)
	Get the timestamp of a file. More...
	getVisibility ($path)
	Get the visibility of a file. More...

Data Fields
const	VISIBILITY_PUBLIC = 'public'
	VISIBILITY_PUBLIC public visibility More...
const	VISIBILITY_PRIVATE = 'private'
	VISIBILITY_PRIVATE private visibility More...

Detailed Description

Definition at line 5 of file AdapterInterface.php.

Member Function Documentation

copy()

League\Flysystem\AdapterInterface::copy	(		$path,
			$newpath
	)

Copy a file.

Parameters

string	$path
string	$newpath

Returns

bool

Implemented in League\Flysystem\Adapter\Local.

createDir()

League\Flysystem\AdapterInterface::createDir	(		$dirname,
		Config	$config
	)

Create a directory.

Parameters

string	$dirname	directory name
Config	$config

Returns

array|false

Implemented in League\Flysystem\Adapter\Local, League\Flysystem\Adapter\Ftp, and League\Flysystem\Adapter\NullAdapter.

Referenced by League\Flysystem\Adapter\AbstractFtpAdapter\ensureDirectory().

Here is the caller graph for this function:

delete()

League\Flysystem\AdapterInterface::delete

(

$path

)

Delete a file.

Parameters

string

$path

Returns

bool

Implemented in League\Flysystem\Adapter\Ftp, League\Flysystem\Adapter\Local, and League\Flysystem\Adapter\NullAdapter.

deleteDir()

League\Flysystem\AdapterInterface::deleteDir

(

$dirname

)

Delete a directory.

Parameters

string

$dirname

Returns

bool

Implemented in League\Flysystem\Adapter\Ftp, and League\Flysystem\Adapter\NullAdapter.

Referenced by League\Flysystem\Adapter\Local\createDir().

Here is the caller graph for this function:

rename()

League\Flysystem\AdapterInterface::rename	(		$path,
			$newpath
	)

Rename a file.

Parameters

string	$path
string	$newpath

Returns

bool

Implemented in League\Flysystem\Adapter\Ftp, League\Flysystem\Adapter\Local, and League\Flysystem\Adapter\NullAdapter.

setVisibility()

League\Flysystem\AdapterInterface::setVisibility	(		$path,
			$visibility
	)

Set the visibility for a file.

Parameters

string	$path
string	$visibility

Returns

array|false file meta data

Implemented in League\Flysystem\Adapter\Ftp, League\Flysystem\Adapter\Local, and League\Flysystem\Adapter\NullAdapter.

update()

League\Flysystem\AdapterInterface::update	(		$path,
			$contents,
		Config	$config
	)

Update a file.

Parameters

string	$path
string	$contents
Config	$config	Config object

Returns

array|false false on failure file meta data on success

Implemented in League\Flysystem\Adapter\Ftp, League\Flysystem\Adapter\Local, and League\Flysystem\Adapter\NullAdapter.

updateStream()

League\Flysystem\AdapterInterface::updateStream	(		$path,
			$resource,
		Config	$config
	)

Update a file using a stream.

Parameters

string	$path
resource	$resource
Config	$config	Config object

Returns

array|false false on failure file meta data on success

Implemented in League\Flysystem\Adapter\Ftp, and League\Flysystem\Adapter\Local.

write()

League\Flysystem\AdapterInterface::write	(		$path,
			$contents,
		Config	$config
	)

Write a new file.

Parameters

string	$path
string	$contents
Config	$config	Config object

Returns

array|false false on failure file meta data on success

Implemented in League\Flysystem\Adapter\Ftp, League\Flysystem\Adapter\Local, and League\Flysystem\Adapter\NullAdapter.

writeStream()

League\Flysystem\AdapterInterface::writeStream	(		$path,
			$resource,
		Config	$config
	)

Write a new file using a stream.

Parameters

string	$path
resource	$resource
Config	$config	Config object

Returns

array|false false on failure file meta data on success

Implemented in League\Flysystem\Adapter\Ftp, and League\Flysystem\Adapter\Local.

Field Documentation

VISIBILITY_PRIVATE

const League\Flysystem\AdapterInterface::VISIBILITY_PRIVATE = 'private'

VISIBILITY_PRIVATE private visibility

Definition at line 15 of file AdapterInterface.php.

Referenced by League\Flysystem\Adapter\Local\getVisibility(), and League\Flysystem\Adapter\AbstractFtpAdapter\normalizeUnixObject().

VISIBILITY_PUBLIC

const League\Flysystem\AdapterInterface::VISIBILITY_PUBLIC = 'public'

VISIBILITY_PUBLIC public visibility

Definition at line 10 of file AdapterInterface.php.

Referenced by League\Flysystem\Adapter\Local\getVisibility(), League\Flysystem\Adapter\AbstractFtpAdapter\normalizeUnixObject(), League\Flysystem\Adapter\AbstractFtpAdapter\normalizeWindowsObject(), and League\Flysystem\Adapter\Ftp\setVisibility().

---

The documentation for this interface was generated from the following file:

• libs/composer/vendor/league/flysystem/src/AdapterInterface.php