PEAR
[ class tree: PEAR ] [ index: PEAR ] [ all elements ]

Class: PEAR_PackageFile_v1

Source Location: /PEAR-1.10.0dev2/PEAR/PackageFile/v1.php

Class Overview


package.xml encapsulator


Author(s):

Version:

  • Release: 1.10.0dev2

Copyright:

  • 1997-2009 The Authors

Methods


Inherited Variables

Inherited Methods


Class Details

[line 281]
package.xml encapsulator


[ Top ]


Method Detail

__construct (Constructor)   [line 348]

PEAR_PackageFile_v1 __construct( bool 0, string 1)


Parameters:

bool   0   —  determines whether to return a PEAR_Error object, or use the PEAR_ErrorStack
string   1   —  Name of Error Stack class to use.

[ Top ]

addConfigureOption   [line 832]

void addConfigureOption( $name, $prompt, [ $default = false])


Parameters:

   $name   — 
   $prompt   — 
   $default   — 

[ Top ]

addExtensionDep   [line 754]

void addExtensionDep( $name, $version, $rel, [ $optional = 'no'])


Parameters:

   $name   — 
   $version   — 
   $rel   — 
   $optional   — 

[ Top ]

addFile   [line 862]

void addFile( $dir, $file, $attrs)


Parameters:

   $dir   — 
   $file   — 
   $attrs   — 

[ Top ]

addMaintainer   [line 580]

void addMaintainer( $role, $handle, $name, $email)

Adds a new maintainer - no checking of duplicates is performed, use updatemaintainer for that purpose.

Parameters:

   $role   — 
   $handle   — 
   $name   — 
   $email   — 

[ Top ]

addPackageDep   [line 740]

void addPackageDep( $name, $version, $rel, [ $optional = 'no'])


Parameters:

   $name   — 
   $version   — 
   $rel   — 
   $optional   — 

[ Top ]

addPhpDep   [line 731]

void addPhpDep( $version, $rel)


Parameters:

   $version   — 
   $rel   — 

[ Top ]

clearConfigureOptions   [line 844]

void clearConfigureOptions( )


[ Top ]

clearDeps   [line 726]

void clearDeps( )

Reset dependencies prior to adding new ones

[ Top ]

clearMaintainers   [line 563]

void clearMaintainers( )


[ Top ]

deleteMaintainer   [line 608]

void deleteMaintainer( $handle)


Parameters:

   $handle   — 

[ Top ]

dependsOn   [line 799]

void dependsOn( $package, $channel)


Parameters:

   $package   — 
   $channel   — 

[ Top ]

fromArray   [line 472]

void fromArray( $pinfo)


Parameters:

   $pinfo   — 

[ Top ]

getArchiveFile   [line 437]

void getArchiveFile( )


[ Top ]

getArray   [line 517]

void getArray( )


[ Top ]

getChangelog   [line 916]

void getChangelog( )


[ Top ]

getChannel   [line 483]

void getChannel( )


[ Top ]

getConfigureOptions   [line 818]

void getConfigureOptions( )


[ Top ]

getDate   [line 645]

void getDate( )


[ Top ]

getDefaultGenerator   [line 1305]

PEAR_PackageFile_Generator_v1 &getDefaultGenerator( )

Get the default xml generator object

[ Top ]

getDependencyGroup   [line 779]

void getDependencyGroup( $group)


Parameters:

   $group   — 

[ Top ]

getDeps   [line 715]

void getDeps( )


[ Top ]

getDescription   [line 687]

void getDescription( )


[ Top ]

getDirtree   [line 459]

void getDirtree( )


[ Top ]

getExtends   [line 498]

void getExtends( )


[ Top ]

getFileContents   [line 1319]

string getFileContents( string $file)

Get the contents of a file listed within the package.xml

Parameters:

string   $file   — 

[ Top ]

getFilelist   [line 880]

void getFilelist( )


[ Top ]

getInstallationFilelist   [line 875]

void getInstallationFilelist( )


[ Top ]

getInstalledBinary   [line 398]

void getInstalledBinary( )


[ Top ]

getLastInstalledVersion   [line 390]

string|false getLastInstalledVersion( )


[ Top ]

getLicense   [line 659]

void getLicense( )


[ Top ]

getMaintainers   [line 568]

void getMaintainers( )


[ Top ]

getName   [line 522]

void getName( )


[ Top ]

getNotes   [line 701]

void getNotes( )


[ Top ]

getPackage   [line 527]

void getPackage( )


[ Top ]

getPackageFile   [line 427]

void getPackageFile( )


[ Top ]

getPackageType   [line 432]

void getPackageType( )


[ Top ]

getPackagexmlVersion   [line 924]

void getPackagexmlVersion( )


[ Top ]

getProvides   [line 849]

void getProvides( )


[ Top ]

getProvidesExtension   [line 857]

void getProvidesExtension( )


[ Top ]

getState   [line 626]

void getState( )


[ Top ]

getSummary   [line 673]

void getSummary( )


[ Top ]

getTime   [line 493]

void getTime( )


[ Top ]

getUri   [line 488]

void getUri( )


[ Top ]

getValidationWarnings   [line 934]

array getValidationWarnings( [boolean $purge = true])

Wrapper to PEAR_ErrorStack::getErrors()

Parameters:

boolean   $purge   —  determines whether to purge the error stack after retrieving

[ Top ]

getVersion   [line 549]

void getVersion( )


[ Top ]

hasConfigureOptions   [line 826]

void hasConfigureOptions( )


[ Top ]

hasDeps   [line 773]

void hasDeps( )


[ Top ]

initPostinstallScripts   [line 408]

void initPostinstallScripts( )


[ Top ]

installBinary   [line 355]

void installBinary( $installer)


Parameters:

   $installer   — 

[ Top ]

installedFile   [line 906]

void installedFile( $file, $atts)


Parameters:

   $file   — 
   $atts   — 

[ Top ]

isCompatible   [line 784]

void isCompatible( $pf)


Parameters:

   $pf   — 

[ Top ]

isExtension   [line 360]

void isExtension( $name)


Parameters:

   $name   — 

[ Top ]

isIncomplete   [line 478]

void isIncomplete( )


[ Top ]

isSubpackage   [line 794]

void isSubpackage( $p)


Parameters:

   $p   — 

[ Top ]

isSubpackageOf   [line 789]

void isSubpackageOf( $p)


Parameters:

   $p   — 

[ Top ]

listPostinstallScripts   [line 403]

void listPostinstallScripts( )


[ Top ]

packageInfo   [line 442]

void packageInfo( $field)


Parameters:

   $field   — 

[ Top ]

resetDirtree   [line 467]

void resetDirtree( )


[ Top ]

resetFilelist   [line 893]

void resetFilelist( )


[ Top ]

setConfig   [line 365]

void setConfig( &$config)


Parameters:

   &$config   — 

[ Top ]

setDate   [line 653]

void setDate( $date)


Parameters:

   $date   — 

[ Top ]

setDeps   [line 768]

void setDeps( $deps)

WARNING - do not use this function directly unless you know what you're doing

Parameters:

   $deps   — 

[ Top ]

setDescription   [line 695]

void setDescription( $desc)


Parameters:

   $desc   — 

[ Top ]

setDirtree   [line 451]

void setDirtree( $path)


Parameters:

   $path   — 

[ Top ]

setFileAttribute   [line 888]

void setFileAttribute( $file, $attr, $value)


Parameters:

   $file   — 
   $attr   — 
   $value   — 

[ Top ]

setInstalledAs   [line 898]

void setInstalledAs( $file, $path)


Parameters:

   $file   — 
   $path   — 

[ Top ]

setLastInstalledVersion   [line 382]

void setLastInstalledVersion( string $version)

For saving in the registry.

Set the last version that was installed


Parameters:

string   $version   — 

[ Top ]

setLicense   [line 667]

void setLicense( $date)


Parameters:

   $date   — 

[ Top ]

setLogger   [line 413]

void setLogger( &$logger)


Parameters:

   &$logger   — 

[ Top ]

setNotes   [line 709]

void setNotes( $notes)


Parameters:

   $notes   — 

[ Top ]

setPackage   [line 543]

void setPackage( $package)


Parameters:

   $package   — 

[ Top ]

setPackagefile   [line 421]

void setPackagefile( $file, [ $archive = false])


Parameters:

   $file   — 
   $archive   — 

[ Top ]

setRawPackage   [line 538]

void setRawPackage( $package)

WARNING - don't use this unless you know what you are doing

Parameters:

   $package   — 

[ Top ]

setRawState   [line 634]

void setRawState( $state)


Parameters:

   $state   — 

[ Top ]

setRequestedGroup   [line 371]

void setRequestedGroup( )


[ Top ]

setState   [line 639]

void setState( $state)


Parameters:

   $state   — 

[ Top ]

setSummary   [line 681]

void setSummary( $summary)


Parameters:

   $summary   — 

[ Top ]

setVersion   [line 557]

void setVersion( $version)


Parameters:

   $version   — 

[ Top ]

toArray   [line 509]

array toArray( )


[ Top ]

updateMaintainer   [line 587]

void updateMaintainer( $role, $handle, $name, $email)


Parameters:

   $role   — 
   $handle   — 
   $name   — 
   $email   — 

[ Top ]

validate   [line 1057]

boolean validate( [ $state = PEAR_VALIDATE_NORMAL], [ $nofilechecking = false])

Validate XML package definition file.
  • Access: public

Parameters:

   $state   — 
   $nofilechecking   — 

[ Top ]

_getErrorMessage   [line 967]

void _getErrorMessage( integer 0)

  • Access: protected

Parameters:

integer   0   —  error code

[ Top ]


Documentation generated on Fri, 31 Jul 2015 09:30:26 +0000 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.