Root¶

class OC\Files\Node\Root¶

Class Root

Hooks available in scope \OC\Files
- preWrite(\OCP\Files\Node $node)
- postWrite(\OCP\Files\Node $node)
- preCreate(\OCP\Files\Node $node)
- postCreate(\OCP\Files\Node $node)
- preDelete(\OCP\Files\Node $node)
- postDelete(\OCP\Files\Node $node)
- preTouch(\OC\FilesP\Node $node, int $mtime)
- postTouch(\OCP\Files\Node $node)
- preCopy(\OCP\Files\Node $source, \OCP\Files\Node $target)
- postCopy(\OCP\Files\Node $source, \OCP\Files\Node $target)
- preRename(\OCP\Files\Node $source, \OCP\Files\Node $target)
- postRename(\OCP\Files\Node $source, \OCP\Files\Node $target)

Source:	lib/private/Files/Node/Root.php#66
Parent:	`OC\Files\Node\Folder`
Implements:	`OCP\Files\IRootFolder`

Properties¶

Methods¶

public OC\Files\Node\Root::__construct($manager, $view, $user, $userMountCache, $logger, $userManager)¶

Source:	lib/private/Files/Node/Root.php#90
Parameters:	$manager (`OC\Files\Mount\Manager`) $view (`OC\Files\View`) $user (`OC\User\User` \| null) $userMountCache (`OCP\Files\Config\IUserMountCache`) $logger (`OCP\ILogger`) $userManager (`OCP\IUserManager`)

public OC\Files\Node\Root::getUser()¶

Get the user for which the filesystem is setup

Source:	lib/private/Files/Node/Root.php#111
Returns:	`\OC\User\User`

public OC\Files\Node\Root::listen($scope, $method, $callback)¶

Source:	lib/private/Files/Node/Root.php#120
Parameters:	$scope (string) $method (string) $callback (callable)

public OC\Files\Node\Root::removeListener($scope=null, $method=null, $callback=null)¶

Source:	lib/private/Files/Node/Root.php#129
Parameters:	$scope (string) optional $method (string) optional $callback (callable) optional

public OC\Files\Node\Root::emit($scope, $method, $arguments=[])¶

Source:	lib/private/Files/Node/Root.php#138
Parameters:	$scope (string) $method (string) $arguments (`OC\Files\Node\Node[]`)

public OC\Files\Node\Root::mount($storage, $mountPoint, $arguments=[])¶

Source:	lib/private/Files/Node/Root.php#147
Parameters:	$storage (`OC\Files\Storage\Storage`) $mountPoint (string) $arguments (array)

public OC\Files\Node\Root::getMount($mountPoint)¶

Source:	lib/private/Files/Node/Root.php#156
Parameters:	$mountPoint (string)
Returns:	`\OC\Files\Mount\MountPoint`

public OC\Files\Node\Root::getMountsIn($mountPoint)¶

Source:	lib/private/Files/Node/Root.php#164
Parameters:	$mountPoint (string)
Returns:	`\OC\Files\Mount\MountPoint[]`

public OC\Files\Node\Root::getMountByStorageId($storageId)¶

Source:	lib/private/Files/Node/Root.php#172
Parameters:	$storageId (string)
Returns:	`\OC\Files\Mount\MountPoint[]`

public OC\Files\Node\Root::getMountByNumericStorageId($numericId)¶

Source:	lib/private/Files/Node/Root.php#180
Parameters:	$numericId (int)
Returns:	`\OC\Files\Mount\MountPoint[]`

public OC\Files\Node\Root::unMount($mount)¶

Source:	lib/private/Files/Node/Root.php#187
Parameters:	$mount (`OC\Files\Mount\MountPoint`)

public OC\Files\Node\Root::get($path)¶

Source:	lib/private/Files/Node/Root.php#197
Parameters:	$path (string)
Throws:	`\OCP\Files\NotFoundException`
Throws:	`\OCP\Files\NotPermittedException`
Throws:	`\OCP\Files\NotFoundException`
Throws:	`\OCP\Files\NotPermittedException`
Returns:	`\OC\Files\Node\Node`

public OC\Files\Node\Root::rename($targetPath)¶

Source:	lib/private/Files/Node/Root.php#219
Parameters:	$targetPath (string)
Throws:	`\OCP\Files\NotPermittedException`
Returns:	`\OC\Files\Node\Node`

public OC\Files\Node\Root::delete()¶

Source:	lib/private/Files/Node/Root.php#223

public OC\Files\Node\Root::copy($targetPath)¶

Source:	lib/private/Files/Node/Root.php#232
Parameters:	$targetPath (string)
Throws:	`\OCP\Files\NotPermittedException`
Returns:	`\OC\Files\Node\Node`

public OC\Files\Node\Root::touch($mtime=null)¶

Source:	lib/private/Files/Node/Root.php#240
Parameters:	$mtime (int)
Throws:	`\OCP\Files\NotPermittedException`

public OC\Files\Node\Root::getStorage()¶

Source:	lib/private/Files/Node/Root.php#248
Returns:	`\OC\Files\Storage\Storage`
Throws:	`\OCP\Files\NotFoundException`

public OC\Files\Node\Root::getPath()¶

Source:	lib/private/Files/Node/Root.php#255
Returns:	string

public OC\Files\Node\Root::getInternalPath()¶

Source:	lib/private/Files/Node/Root.php#262
Returns:	string

public OC\Files\Node\Root::getId()¶

Source:	lib/private/Files/Node/Root.php#269
Returns:	int

public OC\Files\Node\Root::stat()¶

Source:	lib/private/Files/Node/Root.php#276
Returns:	array

public OC\Files\Node\Root::getMTime()¶

Source:	lib/private/Files/Node/Root.php#283
Returns:	int

public OC\Files\Node\Root::getSize($includeMounts=true)¶

Source:	lib/private/Files/Node/Root.php#291
Parameters:	$includeMounts (bool)
Returns:	int

public OC\Files\Node\Root::getEtag()¶

Source:	lib/private/Files/Node/Root.php#298
Returns:	string

public OC\Files\Node\Root::getPermissions()¶

Source:	lib/private/Files/Node/Root.php#305
Returns:	int

public OC\Files\Node\Root::isReadable()¶

Source:	lib/private/Files/Node/Root.php#312
Returns:	bool

public OC\Files\Node\Root::isUpdateable()¶

Source:	lib/private/Files/Node/Root.php#319
Returns:	bool

public OC\Files\Node\Root::isDeletable()¶

Source:	lib/private/Files/Node/Root.php#326
Returns:	bool

public OC\Files\Node\Root::isShareable()¶

Source:	lib/private/Files/Node/Root.php#333
Returns:	bool

public OC\Files\Node\Root::getParent()¶

Source:	lib/private/Files/Node/Root.php#341
Returns:	`\OC\Files\Node\Node`
Throws:	`\OCP\Files\NotFoundException`

public OC\Files\Node\Root::getName()¶

Source:	lib/private/Files/Node/Root.php#348
Returns:	string

public OC\Files\Node\Root::getUserFolder($userId)¶

Returns a view to user’s files folder

Source:	lib/private/Files/Node/Root.php#360
Parameters:	$userId (string) user ID
Returns:	`\OCP\Files\Folder`
Throws:	`\OC\User\NoUserException`
Throws:	`\OCP\Files\NotPermittedException`
Throws:	`\OC\User\NoUserException`
Throws:	`\OCP\Files\NotPermittedException`

public OC\Files\Node\Root::clearCache()¶

Source:	lib/private/Files/Node/Root.php#396

public OC\Files\Node\Root::getUserMountCache()¶

Source:	lib/private/Files/Node/Root.php#400