File: vfs.php

Source Location: /VFS-0.3.0/scripts/VFS/vfs.php

Classes:

Page Details:

This is a command line interface for the VFS package.

`vfs.php help' shows some usage instructions.

$Horde: framework/VFS/scripts/VFS/vfs.php,v 1.1.2.2 2008/02/16 15:30:33 jan Exp $

Includes:

require_once('DB.php') [line 20]
DB
require_once('Console/Getopt.php') [line 17]
Console_Getopt
require_once('PEAR.php') [line 14]
PEAR
require_once(VFS.php) [line 23]
VFS

cp [line 142]

void cp(
string $source, string $target, array $argv, string $filter)

Copies one or several files to a different location.

Parameters

string	$source	The source file(s) or directory.
string	$target	The target file or directory.
array	$argv	Additional options
string	$filter	Additional parameters

[ Top ]

ls [line 86]

void ls(
string $url, array $argv, string $filter)

Lists the contents of the specified directory.

Parameters

string	$url	The URL of the VFS backend
array	$argv	Additional options
string	$filter	Additional parameters

[ Top ]

mergeOptions [line 308]

array mergeOptions(
array $options)

Merges a set of options as returned by Console_Getopt::getopt2() into a single array.

Return: A flat array with the options.

Parameters

array

$options

A two dimensional array with the options.

[ Top ]

url2params [line 327]

array url2params(
string $url)

Parses a URL into a set of parameters that can be used to instantiate a VFS object.

Return: A hash with the parsed information.
Todo: Document the possible URL formats.

Parameters

string

$url

A URL with all necessary information for a VFS driver.

[ Top ]

usage [line 249]

void usage(
[PEAR_Error $error = null])

Shows some error and usage information.

Parameters

PEAR_Error

$error

If specified its error messages will be displayed.

[ Top ]

vfs [line 295]

VFS &vfs(
array $params)

Returns a VFS instance.

Return: An instance of the requested VFS backend.

Parameters

array

$params

A complete parameter set including the driver name for the requested VFS instance.

[ Top ]

_cp [line 172]

void _cp(
 &$source_vfs,  &$target_vfs, string $source_path, string $target_path, array $argv, string $filter, VFS $source_vfs, VFS $target_vfs)

Copies one or several files to a different location.

Parameters

VFS	$source_vfs	The source VFS object.
VFS	$target_vfs	The The target VFS object.
string	$source_path	The source file(s) or directory.
string	$target_path	The target file or directory.
array	$argv	Additional options
string	$filter	Additional parameters
	&$source_vfs
	&$target_vfs

[ Top ]