ISimpleFolder

interface OCP\Files\SimpleFS\ISimpleFolder
Interface ISimpleFolder
Implemented by:OC\Files\SimpleFS\SimpleFolder
Source:lib/public/Files/SimpleFS/ISimpleFolder.php#35

Methods

public OCP\Files\SimpleFS\ISimpleFolder::getDirectoryListing()
Get all the files in a folder
Source:lib/public/Files/SimpleFS/ISimpleFolder.php#42
Returns:\OCP\Files\SimpleFS\ISimpleFile[]
Since:11.0.0
public OCP\Files\SimpleFS\ISimpleFolder::fileExists($name)
Check if a file with $name exists
Source:

lib/public/Files/SimpleFS/ISimpleFolder.php#51

Parameters:
  • $name (string)
Returns:

bool

Since:

11.0.0

public OCP\Files\SimpleFS\ISimpleFolder::getFile($name)
Get the file named $name from the folder
Source:

lib/public/Files/SimpleFS/ISimpleFolder.php#61

Parameters:
  • $name (string)
Returns:

\OCP\Files\SimpleFS\ISimpleFile

Throws:

\OCP\Files\NotFoundException

Since:

11.0.0

public OCP\Files\SimpleFS\ISimpleFolder::newFile($name, $content=null)
Creates a new file with $name in the folder
Source:

lib/public/Files/SimpleFS/ISimpleFolder.php#72

Parameters:
  • $name (string)
  • $content (string | resource | null) @since 19.0.0
Returns:

\OCP\Files\SimpleFS\ISimpleFile

Throws:

\OCP\Files\NotPermittedException

Since:

11.0.0

public OCP\Files\SimpleFS\ISimpleFolder::delete()
Remove the folder and all the files in it
Source:lib/public/Files/SimpleFS/ISimpleFolder.php#80
Throws:\OCP\Files\NotPermittedException
Since:11.0.0
public OCP\Files\SimpleFS\ISimpleFolder::getName()
Get the folder name
Source:lib/public/Files/SimpleFS/ISimpleFolder.php#88
Returns:string
Since:11.0.0