File/VFS/scripts/VFS/vfs.php

Description

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

Functions
cp (line 142)

Copies one or several files to a different location.

void cp (string $source, string $target, array $argv, string $filter)
  • string $source: The source file(s) or directory.
  • string $target: The target file or directory.
  • array $argv: Additional options
  • string $filter: Additional parameters
ls (line 86)

Lists the contents of the specified directory.

void ls (string $url, array $argv, string $filter)
  • string $url: The URL of the VFS backend
  • array $argv: Additional options
  • string $filter: Additional parameters
mergeOptions (line 308)

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

  • return: A flat array with the options.
array mergeOptions (array $options)
  • array $options: A two dimensional array with the options.
url2params (line 327)

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.
array url2params (string $url)
  • string $url: A URL with all necessary information for a VFS driver.
usage (line 249)

Shows some error and usage information.

void usage ([PEAR_Error $error = null])
  • PEAR_Error $error: If specified its error messages will be displayed.
vfs (line 295)

Returns a VFS instance.

  • return: An instance of the requested VFS backend.
VFS &vfs (array $params)
  • array $params: A complete parameter set including the driver name for the requested VFS instance.
_cp (line 172)

Copies one or several files to a different location.

void _cp ( &$source_vfs,  &$target_vfs, string $source_path, string $target_path, array $argv, string $filter, VFS $source_vfs, VFS $target_vfs)
  • 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

Documentation generated on Sun, 30 Jan 2011 05:23:17 +0000 by phpDocumentor 1.4.3