Class: PEAR_Command_Pickle

Source Location: /PEAR-1.9.4/PEAR/Command/Pickle.php

Class Overview

PEAR
   |
   --PEAR_Command_Common
      |
      --PEAR_Command_Pickle

PEAR commands for login/logout

Author(s):

Greg Beaver <cellog at php.net>

Version:

Release: 1.9.4

Copyright:

2005-2009 The Authors

Variables

$commands

Methods

Inherited Variables

Class: PEAR_Command_Common

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

Inherited Methods

Class: PEAR_Command_Common

PEAR_Command_Common::PEAR_Command_Common(): 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::PEAR(): Constructor. Registers this object in $_PEAR_destructor_object_list for destructor emulation if a destructor object exists.
PEAR::delExpect(): This method deletes all occurences 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::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 independant PHP extension load. Remember to take care on the correct extension name for case sensitive OSes.
PEAR::popErrorHandling(): Pop the last error handler used
PEAR::popExpect(): This method pops one element off the expected error codes stack.
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::registerShutdownFunc(): Use this function to register a shutdown method for static classes.
PEAR::setErrorHandling(): Sets how errors generated by this object should be handled.
PEAR::staticPopErrorHandling()
PEAR::staticPushErrorHandling()
PEAR::throwError(): Simpler form of raiseError with fewer options. In most cases message, code and userinfo are enough.
PEAR::_PEAR(): Destructor (the emulated type of...). Does nothing right now, but is included for forward compatibility, so subclass destructors should always call it.

Class Details

[line 35]
PEAR commands for login/logout

Author: Greg Beaver <cellog@php.net>
Version: Release: 1.9.4
Copyright: 2005-2009 The Authors
Link: http://pear.php.net/package/PEAR
Since: Class available since Release 1.4.1
License: New BSD License

[ Top ]

Class Variables

$commands = array(
        'pickle' => array(
            'summary' => 'Build PECL Package',
            'function' => 'doPackage',
            'shortcut' => 'pi',
            'options' => array(
                'nocompress' => array(
                    'shortopt' => 'Z',
                    'doc' => 'Do not gzip the package file'
                    ),'showname'=>array('shortopt'=>'n','doc'=>'Print the name of the packaged file.',),),'doc'=>'[descfile]
Creates a PECL package from its package2.xml file.

An automatic conversion will be made to a package.xml 1.0 and written out to
disk in the current directory as "package.xml".  Note that
only simple package.xml 2.0 will be converted.  package.xml 2.0 with:

- dependency types other than required/optional PECL package/ext/php/pearinstaller
- more than one extsrcrelease or zendextsrcrelease
- zendextbinrelease, extbinrelease, phprelease, or bundle release type
- dependency groups
- ignore tags in release filelist
- tasks other than replace
- custom roles

will cause pickle to fail, and output an error message.  If your package2.xml
uses any of these features, you are best off using PEAR_PackageFileManager to
generate both package.xml.
'),)

[line 37]

Type:

mixed

[ Top ]

Method Detail

PEAR_Command_Pickle (Constructor) [line 79]

PEAR_Command_Pickle PEAR_Command_Pickle(

&$ui, 
&$config)

PEAR_Command_Package constructor.

Access: public

Parameters:

	`&$ui`	—
	`&$config`	—

[ Top ]

doPackage [line 124]

void doPackage(

$command, 
$options, 
$params)

Parameters:

	`$command`	—
	`$options`	—
	`$params`	—

[ Top ]

getPackageFile [line 107]

PEAR_PackageFile &getPackageFile(
PEAR_Config
$config, [bool
$debug = false], string|null
$tmpdir)

For unit-testing ease

Parameters:

PEAR_Config	`$config`	—
bool	`$debug`	—
string\|null	`$tmpdir`	—

[ Top ]

getPackager [line 89]

PEAR_Packager &getPackager(
)

For unit-testing ease

[ Top ]