Docs For Class PEAR_PackageFile_Generator

Class: PEAR_PackageFile_Generator_v1

Inherited Variables

Inherited Methods

Class Details

[line 35]
This class converts a PEAR_PackageFile_v1 object into any output format.

Supported output formats include array, XML string, and a PEAR_PackageFile_v2 object, for converting package.xml 1.0 into package.xml 2.0 with no sweat.

Author: Greg Beaver <cellog@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.4.0a1
License: New BSD License

Method Detail

__construct (Constructor) [line 41]

PEAR_PackageFile_Generator_v1 __construct(

&$packagefile)

Parameters:

&$packagefile —

[ Top ]

dependenciesToV2 [line 486]

array dependenciesToV2(
)

[ Top ]

getPackagerVersion [line 46]

void getPackagerVersion(
)

[ Top ]

recursiveXmlFilelist [line 358]

void recursiveXmlFilelist(
array
$list)

Access: protected

Parameters:

array $list —

[ Top ]

toPackageFile [line 135]

string|PEAR_Error toPackageFile(
[string|null
$where = null], [int
$state = PEAR_VALIDATE_NORMAL], [string
$name = 'package.xml'], [bool
$nofilechecking = false])

Return: path to the created file on success

Parameters:

string\|null	`$where`	—	directory to place the package.xml in, or null for a temporary dir
int	`$state`	—	one of the PEAR_VALIDATE_* constants
string	`$name`	—	name of the generated file
bool	`$nofilechecking`	—	if true, then no analysis will be performed on role="php" files

[ Top ]

toTgz [line 57]

string|PEAR_Error toTgz(
PEAR_Packager
&$packager, [bool
$compress = true], [string|null
$where = null])

Return: location of package or error object

Parameters:

PEAR_Packager	`&$packager`	—
bool	`$compress`	—	if true, a .tgz is written, otherwise a .tar is written
string\|null	`$where`	—	directory in which to save the .tgz

[ Top ]

toV2 [line 504]

PEAR_PackageFile_v2|PEAR_Error &toV2(
[string
$class = 'PEAR_PackageFile_v2'], [boolean
$strict = false])

Convert a package.xml version 1.0 into version 2.0

Note that this does a basic conversion, to allow more advanced features like bundles and multiple releases

Parameters:

string	`$class`	—	the classname to instantiate and return. This must be PEAR_PackageFile_v2 or a descendant
boolean	`$strict`	—	if true, only valid, deterministic package.xml 1.0 as defined by the strictest parameters will be converted

[ Top ]

toXml [line 184]

string toXml(
[
$state = PEAR_VALIDATE_NORMAL], [
$nofilevalidation = false])

Return an XML document based on the package info (as returned by the PEAR_Common::infoFrom* methods).

Return: XML data

Parameters:

	`$state`	—
	`$nofilevalidation`	—

[ Top ]

Class: PEAR_PackageFile_Generator_v1

Class Overview

Author(s):

Version:

Copyright:

Methods

Inherited Variables

Inherited Methods

Class Details

Method Detail

__construct (Constructor) [line 41]

Parameters:

dependenciesToV2 [line 486]

getPackagerVersion [line 46]

recursiveXmlFilelist [line 358]

Parameters:

toPackageFile [line 135]

Parameters:

toTgz [line 57]

Parameters:

toV2 [line 504]

Parameters:

toXml [line 184]

Parameters: