Methods summary
public static
|
#
setDir( string $dir )
Changes the current directory of the Gollem session to the supplied
value.
Changes the current directory of the Gollem session to the supplied
value.
Parameters
Throws
|
public static
|
#
changeDir( )
Changes the current directory of the Gollem session based on the
'dir' form field.
Changes the current directory of the Gollem session based on the
'dir' form field.
Throws
|
public static
|
#
sortDate( mixed $a, mixed $b )
Internal sorting function for 'date'.
Internal sorting function for 'date'.
|
public static
|
#
sortSize( mixed $a, mixed $b )
Internal sorting function for 'size'.
Internal sorting function for 'size'.
|
public static
|
#
sortType( mixed $a, mixed $b )
Internal sorting function for 'type'.
Internal sorting function for 'type'.
|
public static
|
#
sortName( mixed $a, mixed $b )
Internal sorting function for 'name'.
Internal sorting function for 'name'.
|
public static
array
|
#
listFolder( string $dir )
List the current folder.
Parameters
Returns
array
The sorted list of files.
Throws
|
public static
|
#
expireCache( string $dir )
Expire a folder cache entry.
Expire a folder cache entry.
Parameters
|
public static
string
|
#
subdirectory( string $base, string $dir )
Generate correct subdirectory links.
Generate correct subdirectory links.
Parameters
- $base
- The base directory.
- $dir
- The directory string.
Returns
string
The correct subdirectoy string.
|
public static
|
#
createFolder( string $dir, string $name, Horde_Vfs_Base $gollem_vfs = null )
Create a folder using the current Gollem session settings.
Create a folder using the current Gollem session settings.
Parameters
- $dir
- The directory path.
- $name
- The folder to create.
- $gollem_vfs
- A VFS instance to use.
Throws
|
public static
|
#
renameItem( string $oldDir, string $old, string $newDir, string $new )
Rename files using the current Gollem session settings.
Rename files using the current Gollem session settings.
Parameters
- $oldDir
- Old directory name.
- $old
- Old file name.
- $newDir
- New directory name.
- $new
- $old New file name.
Throws
Horde_Vfs_Exception
|
public static
|
#
deleteFolder( string $dir, string $name )
Delete a folder using the current Gollem session settings.
Delete a folder using the current Gollem session settings.
Parameters
- $dir
- The subdirectory name.
- $name
- The folder name to delete.
Throws
|
public static
|
#
deleteFile( string $dir, string $name )
Delete a file using the current Gollem session settings.
Delete a file using the current Gollem session settings.
Parameters
- $dir
- The directory name.
- $name
- The filename to delete.
Throws
|
public static
|
#
changePermissions( string $dir, string $name, string $permission )
Change permissions on files using the current Gollem session settings.
Change permissions on files using the current Gollem session settings.
Parameters
- $dir
- The directory name.
- $name
- The filename to change permissions on.
- $permission
- The permission mode to set.
Throws
|
public static
|
#
writeFile( string $dir, string $name, string $filename )
Write an uploaded file to the VFS backend.
Write an uploaded file to the VFS backend.
Parameters
- $dir
- The directory name.
- $name
- The filename to create.
- $filename
- The local file containing the file data.
Thows
Horde_Vfs_Exception
|
public static
|
#
moveFile( string $backend_f, string $dir, string $name, string $backend_t, string $newdir )
Moves a file using the current Gollem session settings.
Moves a file using the current Gollem session settings.
Parameters
- $backend_f
- The backend to move the file from.
- $dir
- The directory name of the original file.
- $name
- The original filename.
- $backend_t
- The backend to move the file to.
- $newdir
- The directory to move the file to.
Throws
Horde_Vfs_Exception
|
public static
|
#
copyFile( string $backend_f, string $dir, string $name, string $backend_t, string $newdir )
Copies a file using the current Gollem session settings.
Copies a file using the current Gollem session settings.
Parameters
- $backend_f
- The backend to copy the file from.
- $dir
- The directory name of the original file.
- $name
- The original filename.
- $backend_t
- The backend to copy the file to.
- $newdir
- The directory to copy the file to.
Throws
Horde_Vfs_Exception
|
public static
boolean
|
#
verifyDir( string $dir )
This function verifies whether a given directory is below the root.
This function verifies whether a given directory is below the root.
Parameters
- $dir
- The directory to check.
Returns
boolean
True if the directory is below the root.
|
public static
boolean
|
#
checkPermissions( string $filter, integer $permission = Horde_Perms::READ, string $backend = null )
Checks if a user has the specified permissions on the selected backend.
Checks if a user has the specified permissions on the selected backend.
Parameters
- $filter
- What are we checking for.
- $permission
- What permission to check for.
- $backend
- <p>The backend to check. If empty, check
the current backend.</p>
Returns
booleanReturns true if the user has permission, false if
they do not.
|
public static
string
|
#
directoryNavLink( string $currdir, string $url )
Produces a directory link used for navigation.
Produces a directory link used for navigation.
Parameters
- $currdir
- The current directory string.
- $url
- The URL to link to.
Returns
string
The directory navigation string.
|
public static
|
#
status( )
Outputs Gollem's status/notification bar.
Outputs Gollem's status/notification bar.
|
public static
string
|
#
backendSelect( )
Generate the backend selection list for use in the menu.
Generate the backend selection list for use in the menu.
Returns
string
The backend selection list.
|
public static
string
|
#
getDisplayPath( string $path )
Generate the display path (the path with any root information stripped
out).
Generate the display path (the path with any root information stripped
out).
Parameters
- $path
- The path to display.
Returns
string
The display path.
|
public static
string
|
#
stripAPIPath( string $path )
Cleans a path presented to Gollem's browse API call.
Cleans a path presented to Gollem's browse API call.
This will remove:
- leading '/'
- leading 'gollem'
- trailing '/'
The desired end result is the path including VFS backend.
Parameters
- $path
- Path as presented to Gollem API.
Returns
string
Cleaned path as described above.
|
public static
string
|
#
pathEncode( string $path )
Convert a Gollem path into a URL encoded string, but keep '/'.
This allows for proper PATH_INFO path parsing.
Special care is taken to handle "+" and " ".
Convert a Gollem path into a URL encoded string, but keep '/'.
This allows for proper PATH_INFO path parsing.
Special care is taken to handle "+" and " ".
Parameters
- $path
- Path to be urlencode()d.
Returns
string
URL-encoded string with '/' preserved.
|
public static
array
|
#
getVFSPath( string $fullpath )
Take a fully qualified and break off the file or directory name.
This pair is used for the input to many VFS library functions.
Take a fully qualified and break off the file or directory name.
This pair is used for the input to many VFS library functions.
Parameters
- $fullpath
- Path to be split.
Returns
array
Array of ($path, $name)
|