Class: PEAR_Command_Package

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

Class Overview

PEAR
   |
   --PEAR_Command_Common
      |
      --PEAR_Command_Package

PEAR commands for login/logout

Author(s):

Greg Beaver <cellog at php.net>
Stig Bakken <ssb at php.net>
Martin Jansen <mj at php.net>

Version:

Release: @package_version@

Copyright:

1997-2009 The Authors

Variables

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 39]
PEAR commands for login/logout

Author: Greg Beaver <cellog@php.net>
Author: Stig Bakken <ssb@php.net>
Author: Martin Jansen <mj@php.net>
Version: Release: @package_version@
Copyright: 1997-2009 The Authors
Link: http://pear.php.net/package/PEAR
Since: Class available since Release 0.1
License: New BSD License

[ Top ]

Class Variables

$commands = array(
        'package' => array(
            'summary' => 'Build Package',
            'function' => 'doPackage',
            'shortcut' => 'p',
            '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] [descfile2]
Creates a PEAR package from its description file (usually called
package.xml).  If a second packagefile is passed in, then
the packager will check to make sure that one is a package.xml
version 1.0, and the other is a package.xml version 2.0.  The
package.xml version 1.0 will be saved as "package.xml" in the archive,
and the other as "package2.xml" in the archive"
'),'package-validate'=>array('summary'=>'Validate Package Consistency','function'=>'doPackageValidate','shortcut'=>'pv','options'=>array(),'doc'=>'
',),'cvsdiff'=>array('summary'=>'Run a "cvs diff" for all files in a package','function'=>'doCvsDiff','shortcut'=>'cd','options'=>array('quiet'=>array('shortopt'=>'q','doc'=>'Be quiet',),'reallyquiet'=>array('shortopt'=>'Q','doc'=>'Be really quiet',),'date'=>array('shortopt'=>'D','doc'=>'Diff against revision of DATE','arg'=>'DATE',),'release'=>array('shortopt'=>'R','doc'=>'Diff against tag for package release REL','arg'=>'REL',),'revision'=>array('shortopt'=>'r','doc'=>'Diff against revision REV','arg'=>'REV',),'context'=>array('shortopt'=>'c','doc'=>'Generate context diff',),'unified'=>array('shortopt'=>'u','doc'=>'Generate unified diff',),'ignore-case'=>array('shortopt'=>'i','doc'=>'Ignore case, consider upper- and lower-case letters equivalent',),'ignore-whitespace'=>array('shortopt'=>'b','doc'=>'Ignore changes in amount of white space',),'ignore-blank-lines'=>array('shortopt'=>'B','doc'=>'Ignore changes that insert or delete blank lines',),'brief'=>array('doc'=>'Report only whether the files differ, no details',),'dry-run'=>array('shortopt'=>'n','doc'=>'Don\'t do anything, just pretend',),),'doc'=>'<package.xml>
Compares all the files in a package.  Without any options, this
command will compare the current code with the last checked-in code.
Using the -r or -R option you may compare the current code with that
of a specific release.
',),'svntag'=>array('summary'=>'Set SVN Release Tag','function'=>'doSvnTag','shortcut'=>'sv','options'=>array('quiet'=>array('shortopt'=>'q','doc'=>'Be quiet',),'slide'=>array('shortopt'=>'F','doc'=>'Move (slide) tag if it exists',),'delete'=>array('shortopt'=>'d','doc'=>'Remove tag',),'dry-run'=>array('shortopt'=>'n','doc'=>'Don\'t do anything, just pretend',),),'doc'=>'<package.xml> [files...]
Sets a SVN tag on all files in a package.  Use this command after you have
packaged a distribution tarball with the "package" command to tag what
revisions of what files were in that release.  If need to fix something
after running svntag once, but before the tarball is released to the public,
use the "slide" option to move the release tag.

to include files (such as a second package.xml, or tests not included in the
release), pass them as additional parameters.
',),'cvstag'=>array('summary'=>'Set CVS Release Tag','function'=>'doCvsTag','shortcut'=>'ct','options'=>array('quiet'=>array('shortopt'=>'q','doc'=>'Be quiet',),'reallyquiet'=>array('shortopt'=>'Q','doc'=>'Be really quiet',),'slide'=>array('shortopt'=>'F','doc'=>'Move (slide) tag if it exists',),'delete'=>array('shortopt'=>'d','doc'=>'Remove tag',),'dry-run'=>array('shortopt'=>'n','doc'=>'Don\'t do anything, just pretend',),),'doc'=>'<package.xml> [files...]
Sets a CVS tag on all files in a package.  Use this command after you have
packaged a distribution tarball with the "package" command to tag what
revisions of what files were in that release.  If need to fix something
after running cvstag once, but before the tarball is released to the public,
use the "slide" option to move the release tag.

to include files (such as a second package.xml, or tests not included in the
release), pass them as additional parameters.
',),'package-dependencies'=>array('summary'=>'Show package dependencies','function'=>'doPackageDependencies','shortcut'=>'pd','options'=>array(),'doc'=>'<package-file> or <package.xml> or <install-package-name>
List all dependencies the package has.
Can take a tgz / tar file, package.xml or a package name of an installed package.'),'sign'=>array('summary'=>'Sign a package distribution file','function'=>'doSign','shortcut'=>'si','options'=>array('verbose'=>array('shortopt'=>'v','doc'=>'Display GnuPG output',),),'doc'=>'<package-file>
Signs a package distribution (.tar or .tgz) file with GnuPG.',),'makerpm'=>array('summary'=>'Builds an RPM spec file from a PEAR package','function'=>'doMakeRPM','shortcut'=>'rpm','options'=>array('spec-template'=>array('shortopt'=>'t','arg'=>'FILE','doc'=>'Use FILE as RPM spec file template'),'rpm-pkgname'=>array('shortopt'=>'p','arg'=>'FORMAT','doc'=>'Use FORMAT as format string for RPM package name, %s is replaced
by the PEAR package name, defaults to "PEAR::%s".',),),'doc'=>'<package-file>

Creates an RPM .spec file for wrapping a PEAR package inside an RPM
package.  Intended to be used from the SPECS directory, with the PEAR
package tarball in the SOURCES directory:

$ pear makerpm ../SOURCES/Net_Socket-1.0.tgz
Wrote RPM spec file PEAR::Net_Geo-1.0.spec
$ rpm -bb PEAR::Net_Socket-1.0.spec
...
Wrote: /usr/src/redhat/RPMS/i386/PEAR::Net_Socket-1.0-1.i386.rpm
',),'convert'=>array('summary'=>'Convert a package.xml 1.0 to package.xml 2.0 format','function'=>'doConvert','shortcut'=>'c2','options'=>array('flat'=>array('shortopt'=>'f','doc'=>'do not beautify the filelist.',),),'doc'=>'[descfile] [descfile2]
Converts a package.xml in 1.0 format into a package.xml
in 2.0 format.  The new file will be named package2.xml by default,
and package.xml will be used as the old file by default.
This is not the most intelligent conversion, and should only be
used for automated conversion or learning the format.
'),)

[line 41]

Type:

mixed

[ Top ]

$output =

[line 278]

Type:

mixed

[ Top ]

Method Detail

__construct (Constructor) [line 285]

PEAR_Command_Package __construct(

&$ui, 
&$config)

PEAR_Command_Package constructor.

Access: public

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

Parameters:

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

[ Top ]

doConvert [line 1077]

void doConvert(

$command, 
$options, 
$params)

Parameters:

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

[ Top ]

doCvsDiff [line 714]

void doCvsDiff(

$command, 
$options, 
$params)

Parameters:

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

[ Top ]

doCvsTag [line 627]

void doCvsTag(

$command, 
$options, 
$params)

Parameters:

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

[ Top ]

doMakeRPM [line 1057]

void doMakeRPM(

$command, 
$options, 
$params)

Parameters:

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

[ Top ]

doPackage [line 331]

void doPackage(

$command, 
$options, 
$params)

Parameters:

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

[ Top ]

doPackageDependencies [line 805]

void doPackageDependencies(

$command, 
$options, 
$params)

Parameters:

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

[ Top ]

doPackageValidate [line 359]

void doPackageValidate(

$command, 
$options, 
$params)

Parameters:

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

[ Top ]

doSign [line 951]

void doSign(

$command, 
$options, 
$params)

Parameters:

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

[ Top ]

doSvnTag [line 412]

void doSvnTag(

$command, 
$options, 
$params)

Parameters:

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

[ Top ]

getCommandPackaging [line 1039]

void &getCommandPackaging(

&$ui, 
&$config)

For unit testing purposes

Parameters:

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

[ Top ]

getInstaller [line 1027]

void &getInstaller(

&$ui)

For unit testing purposes

Parameters:

&$ui —

[ Top ]

getPackageFile [line 316]

void &getPackageFile(

$config, [
$debug = false])

Parameters:

	`$config`	—
	`$debug`	—

[ Top ]

getPackager [line 307]

void &getPackager(
)

[ Top ]