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

Class: PEAR_PackageFile_v1

Source Location: /PEAR-1.9.5/PEAR/PackageFile/v1.php

Class Overview


package.xml encapsulator


Author(s):

Version:

  • Release: 1.9.5

Copyright:

  • 1997-2009 The Authors

Methods


Inherited Variables

Inherited Methods


Class Details

[line 282]
package.xml encapsulator


[ Top ]


Method Detail

PEAR_PackageFile_v1 (Constructor)   [line 349]

PEAR_PackageFile_v1 PEAR_PackageFile_v1( 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 833]

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


Parameters:

   $name     
   $prompt     
   $default     

[ Top ]

addExtensionDep   [line 755]

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


Parameters:

   $name     
   $version     
   $rel     
   $optional     

[ Top ]

addFile   [line 863]

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


Parameters:

   $dir     
   $file     
   $attrs     

[ Top ]

addMaintainer   [line 581]

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 741]

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


Parameters:

   $name     
   $version     
   $rel     
   $optional     

[ Top ]

addPhpDep   [line 732]

void addPhpDep( $version, $rel)


Parameters:

   $version     
   $rel     

[ Top ]

clearConfigureOptions   [line 845]

void clearConfigureOptions( )


[ Top ]

clearDeps   [line 727]

void clearDeps( )

Reset dependencies prior to adding new ones

[ Top ]

clearMaintainers   [line 564]

void clearMaintainers( )


[ Top ]

deleteMaintainer   [line 609]

void deleteMaintainer( $handle)


Parameters:

   $handle     

[ Top ]

dependsOn   [line 800]

void dependsOn( $package, $channel)


Parameters:

   $package     
   $channel     

[ Top ]

fromArray   [line 473]

void fromArray( $pinfo)


Parameters:

   $pinfo     

[ Top ]

getArchiveFile   [line 438]

void getArchiveFile( )


[ Top ]

getArray   [line 518]

void getArray( )


[ Top ]

getChangelog   [line 917]

void getChangelog( )


[ Top ]

getChannel   [line 484]

void getChannel( )


[ Top ]

getConfigureOptions   [line 819]

void getConfigureOptions( )


[ Top ]

getDate   [line 646]

void getDate( )


[ Top ]

getDefaultGenerator   [line 1306]

PEAR_PackageFile_Generator_v1 &getDefaultGenerator( )

Get the default xml generator object

[ Top ]

getDependencyGroup   [line 780]

void getDependencyGroup( $group)


Parameters:

   $group     

[ Top ]

getDeps   [line 716]

void getDeps( )


[ Top ]

getDescription   [line 688]

void getDescription( )


[ Top ]

getDirtree   [line 460]

void getDirtree( )


[ Top ]

getExtends   [line 499]

void getExtends( )


[ Top ]

getFileContents   [line 1320]

string getFileContents( string $file)

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

Parameters:

string   $file     

[ Top ]

getFilelist   [line 881]

void getFilelist( )


[ Top ]

getInstallationFilelist   [line 876]

void getInstallationFilelist( )


[ Top ]

getInstalledBinary   [line 399]

void getInstalledBinary( )


[ Top ]

getLastInstalledVersion   [line 391]

string|false getLastInstalledVersion( )


[ Top ]

getLicense   [line 660]

void getLicense( )


[ Top ]

getMaintainers   [line 569]

void getMaintainers( )


[ Top ]

getName   [line 523]

void getName( )


[ Top ]

getNotes   [line 702]

void getNotes( )


[ Top ]

getPackage   [line 528]

void getPackage( )


[ Top ]

getPackageFile   [line 428]

void getPackageFile( )


[ Top ]

getPackageType   [line 433]

void getPackageType( )


[ Top ]

getPackagexmlVersion   [line 925]

void getPackagexmlVersion( )


[ Top ]

getProvides   [line 850]

void getProvides( )


[ Top ]

getProvidesExtension   [line 858]

void getProvidesExtension( )


[ Top ]

getState   [line 627]

void getState( )


[ Top ]

getSummary   [line 674]

void getSummary( )


[ Top ]

getTime   [line 494]

void getTime( )


[ Top ]

getUri   [line 489]

void getUri( )


[ Top ]

getValidationWarnings   [line 935]

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 550]

void getVersion( )


[ Top ]

hasConfigureOptions   [line 827]

void hasConfigureOptions( )


[ Top ]

hasDeps   [line 774]

void hasDeps( )


[ Top ]

initPostinstallScripts   [line 409]

void initPostinstallScripts( )


[ Top ]

installBinary   [line 356]

void installBinary( $installer)


Parameters:

   $installer     

[ Top ]

installedFile   [line 907]

void installedFile( $file, $atts)


Parameters:

   $file     
   $atts     

[ Top ]

isCompatible   [line 785]

void isCompatible( $pf)


Parameters:

   $pf     

[ Top ]

isExtension   [line 361]

void isExtension( $name)


Parameters:

   $name     

[ Top ]

isIncomplete   [line 479]

void isIncomplete( )


[ Top ]

isSubpackage   [line 795]

void isSubpackage( $p)


Parameters:

   $p     

[ Top ]

isSubpackageOf   [line 790]

void isSubpackageOf( $p)


Parameters:

   $p     

[ Top ]

listPostinstallScripts   [line 404]

void listPostinstallScripts( )


[ Top ]

packageInfo   [line 443]

void packageInfo( $field)


Parameters:

   $field     

[ Top ]

resetDirtree   [line 468]

void resetDirtree( )


[ Top ]

resetFilelist   [line 894]

void resetFilelist( )


[ Top ]

setConfig   [line 366]

void setConfig( &$config)


Parameters:

   &$config     

[ Top ]

setDate   [line 654]

void setDate( $date)


Parameters:

   $date     

[ Top ]

setDeps   [line 769]

void setDeps( $deps)

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

Parameters:

   $deps     

[ Top ]

setDescription   [line 696]

void setDescription( $desc)


Parameters:

   $desc     

[ Top ]

setDirtree   [line 452]

void setDirtree( $path)


Parameters:

   $path     

[ Top ]

setFileAttribute   [line 889]

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


Parameters:

   $file     
   $attr     
   $value     

[ Top ]

setInstalledAs   [line 899]

void setInstalledAs( $file, $path)


Parameters:

   $file     
   $path     

[ Top ]

setLastInstalledVersion   [line 383]

void setLastInstalledVersion( string $version)

For saving in the registry.

Set the last version that was installed


Parameters:

string   $version     

[ Top ]

setLicense   [line 668]

void setLicense( $date)


Parameters:

   $date     

[ Top ]

setLogger   [line 414]

void setLogger( &$logger)


Parameters:

   &$logger     

[ Top ]

setNotes   [line 710]

void setNotes( $notes)


Parameters:

   $notes     

[ Top ]

setPackage   [line 544]

void setPackage( $package)


Parameters:

   $package     

[ Top ]

setPackagefile   [line 422]

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


Parameters:

   $file     
   $archive     

[ Top ]

setRawPackage   [line 539]

void setRawPackage( $package)

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

Parameters:

   $package     

[ Top ]

setRawState   [line 635]

void setRawState( $state)


Parameters:

   $state     

[ Top ]

setRequestedGroup   [line 372]

void setRequestedGroup( )


[ Top ]

setState   [line 640]

void setState( $state)


Parameters:

   $state     

[ Top ]

setSummary   [line 682]

void setSummary( $summary)


Parameters:

   $summary     

[ Top ]

setVersion   [line 558]

void setVersion( $version)


Parameters:

   $version     

[ Top ]

toArray   [line 510]

array toArray( )


[ Top ]

updateMaintainer   [line 588]

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


Parameters:

   $role     
   $handle     
   $name     
   $email     

[ Top ]

validate   [line 1058]

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

Validate XML package definition file.
  • Access: public

Parameters:

   $state     
   $nofilechecking     

[ Top ]

_getErrorMessage   [line 968]

void _getErrorMessage( integer 0)

  • Access: protected

Parameters:

integer   0     error code

[ Top ]


Documentation generated on Sat, 12 Jul 2014 14:01:25 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.