Class: PEAR_Command_Mirror

Source Location: /PEAR-1.10.12/PEAR/Command/Mirror.php

Class Overview

PEAR
   |
   --PEAR_Command_Common
      |
      --PEAR_Command_Mirror

PEAR commands for providing file mirrors

Author(s):

Alexander Merz <alexmerz at php.net>

Version:

Release: 1.10.12

Copyright:

1997-2009 The Authors

Variables

$commands

Methods

Inherited Variables

Class: PEAR_Command_Common

PEAR_Command_Common::$config
PEAR_Command_Common::$ui
PEAR_Command_Common::$_registry

Class: PEAR

PEAR::$bivalentMethods

Inherited Methods

Class: PEAR_Command_Common

PEAR_Command_Common::__construct(): PEAR_Command_Common constructor.
PEAR_Command_Common::getCommands(): Return a list of all the commands defined by this class.
PEAR_Command_Common::getGetoptArgs()
PEAR_Command_Common::getHelp(): Returns the help message for the given command
PEAR_Command_Common::getHelpArgs(): Returns the help for the accepted arguments of a command
PEAR_Command_Common::getOptions()
PEAR_Command_Common::getShortcuts(): Return a list of all the command shortcuts defined by this class.
PEAR_Command_Common::run()

Class: PEAR

PEAR::__construct(): Constructor. Registers this object in $_PEAR_destructor_object_list for destructor emulation if a destructor object exists.
PEAR::PEAR(): Only here for backwards compatibility.
PEAR::delExpect(): This method deletes all occurrences of the specified element from the expected error codes stack.
PEAR::expectError(): This method is used to tell which errors you expect to get.
PEAR::getSourceDateEpoch(): Get SOURCE_DATE_EPOCH environment variable See https://reproducible-builds.org/specs/source-date-epoch/
PEAR::getStaticProperty(): If you have a class that's mostly/entirely static, and you need static
PEAR::isError(): Tell whether a value is a PEAR error.
PEAR::loadExtension(): OS independent PHP extension load. Remember to take care on the correct extension name for case sensitive OSes.
PEAR::popExpect(): This method pops one element off the expected error codes stack.
PEAR::registerShutdownFunc(): Use this function to register a shutdown method for static classes.
PEAR::staticPopErrorHandling()
PEAR::staticPushErrorHandling()
PEAR::_PEAR(): Destructor (the emulated type of...). Does nothing right now, but is included for forward compatibility, so subclass destructors should always call it.
PEAR::_popErrorHandling(): Pop the last error handler used
PEAR::_pushErrorHandling(): Push a new error handler on top of the error handler options stack. With this you can easily override the actual error handler for some code and restore it later with popErrorHandling.
PEAR::_raiseError(): This method is a wrapper that returns an instance of the configured error class with this object's default error handling applied. If the $mode and $options parameters are not specified, the object's defaults are used.
PEAR::_setErrorHandling(): Sets how errors generated by this object should be handled.
PEAR::_throwError(): Simpler form of raiseError with fewer options. In most cases message, code and userinfo are enough.
PEAR::__call()
PEAR::__callStatic()

Class Details

[line 33]
PEAR commands for providing file mirrors

Author: Alexander Merz <alexmerz@php.net>
Version: Release: 1.10.12
Copyright: 1997-2009 The Authors
Link: http://pear.php.net/package/PEAR
Since: Class available since Release 1.2.0
License: New BSD License

[ Top ]

Class Variables

$commands = array(
        'download-all' => array(
            'summary' => 'Downloads each available package from the default channel',
            'function' => 'doDownloadAll',
            'shortcut' => 'da',
            'options' => array(
                'channel' =>
                    array(
                    'shortopt' => 'c',
                    'doc' => 'specify a channel other than the default channel',
                    'arg' => 'CHAN',
                    ),),'doc'=>'
Requests a list of available packages from the default channel ({config default_channel})
and downloads them to current working directory.  Note: only
packages within preferred_state ({config preferred_state}) will be downloaded'),)

[line 35]

Type:

mixed

[ Top ]

Method Detail

__construct (Constructor) [line 62]

PEAR_Command_Mirror __construct(
object PEAR_Frontend
&$ui, object PEAR_Config
&$config)

PEAR_Command_Mirror constructor.

Access: public

Overrides PEAR_Command_Common::__construct() (PEAR_Command_Common constructor.)

Parameters:

object PEAR_Frontend	`&$ui`	—	a reference to an frontend
object PEAR_Config	`&$config`	—	a reference to the configuration data

[ Top ]

doDownloadAll [line 87]

bool doDownloadAll(
string
$command, array
$options, array
$params)

retrieves a list of avaible Packages from master server and downloads them

Return: true if successful
Access: public

Parameters:

string	`$command`	—	the command
array	`$options`	—	the command options before the command
array	`$params`	—	the stuff after the command name

[ Top ]

factory [line 70]

void &factory(

$a)

For unit-testing

Parameters:

$a —

[ Top ]