Class: PEAR_Builder

Source Location: /PEAR-1.10.12/PEAR/Builder.php

Class Overview

PEAR
   |
   --PEAR_Common
      |
      --PEAR_Builder

Class to handle building (compiling) extensions.

Author(s):

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

Version:

Release: 1.10.12

Copyright:

1997-2009 The Authors

Variables

Methods

Inherited Variables

Class: PEAR_Common

PEAR_Common::$config
PEAR_Common::$current_attributes
PEAR_Common::$current_element
PEAR_Common::$current_path
PEAR_Common::$element_stack
PEAR_Common::$pkginfo
PEAR_Common::$ui

Class: PEAR

PEAR::$bivalentMethods

Inherited Methods

Class: PEAR_Common

PEAR_Common::__construct(): PEAR_Common constructor
PEAR_Common::addTempFile(): Register a temporary file or directory. When the destructor is executed, all registered temporary files and directories are removed.
PEAR_Common::analyzeSourceCode(): Analyze the source code of the given PHP file
PEAR_Common::betterStates(): Return an array containing all of the states that are more stable than or equal to the passed in state
PEAR_Common::buildProvidesArray(): Build a "provides" array from data returned by analyzeSourceCode(). The format of the built array is like this:
PEAR_Common::detectDependencies()
PEAR_Common::downloadHttp(): Download a file through HTTP. Considers suggested file name in
PEAR_Common::getDependencyRelations(): Get the implemented dependency relations (has, lt, ge etc.)
PEAR_Common::getDependencyTypes(): Get the implemented dependency types (php, ext, pkg etc.)
PEAR_Common::getFileRoles(): Get the implemented file roles
PEAR_Common::getProvideTypes(): Get the implemented file replacement types in
PEAR_Common::getReleaseStates(): Get the valid package release states of packages
PEAR_Common::getReplacementTypes(): Get the implemented file replacement types in
PEAR_Common::getScriptPhases(): Get the implemented file replacement types in
PEAR_Common::getUserRoles(): Get the valid roles for a PEAR package maintainer
PEAR_Common::infoFromAny(): Returns package information from different sources
PEAR_Common::infoFromDescriptionFile(): Returns information about a package file. Expects the name of a package xml file as input.
PEAR_Common::infoFromString(): Returns information about a package file. Expects the contents of a package xml file as input.
PEAR_Common::infoFromTgzFile(): Returns information about a package file. Expects the name of a gzipped tar file as input.
PEAR_Common::isIncludeable()
PEAR_Common::log(): Logging method.
PEAR_Common::mkDirHier(): Wrapper to System::mkDir(), creates a directory as well as any necessary parent directories.
PEAR_Common::mkTempDir(): Create and register a temporary directory.
PEAR_Common::setFrontendObject(): Set object that represents the frontend to be used.
PEAR_Common::validatePackageInfo(): Validate XML package definition file.
PEAR_Common::validPackageName(): Test whether a string contains a valid package name.
PEAR_Common::validPackageVersion(): Test whether a string contains a valid package version.
PEAR_Common::xmlFromInfo(): Return an XML document based on the package info (as returned by the PEAR_Common::infoFrom* methods).

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 41]
Class to handle building (compiling) extensions.

Author: Stig Bakken <ssb@php.net>
Author: Greg Beaver <cellog@php.net>
Version: Release: 1.10.12
Copyright: 1997-2009 The Authors
See: http://pear.php.net/manual/en/core.ppm.pear-builder.php
Link: http://pear.php.net/package/PEAR
Since: Class available since PHP 4.0.2
License: New BSD License

[ Top ]

Class Variables

$current_callback = null

[line 53]

Var: Used for reporting when it is not possible to pass function via extra parameter, e.g. log, msdevCallback

Type:

string

[ Top ]

$extensions_built = array()

[line 47]

Type:

mixed

[ Top ]

$php_api_version = 0

[line 43]

Type:

mixed

[ Top ]

$zend_extension_api_no = 0

[line 45]

Type:

mixed

[ Top ]

$zend_module_api_no = 0

[line 44]

Type:

mixed

[ Top ]

Method Detail

__construct (Constructor) [line 74]

PEAR_Builder __construct(
mixed[]
$configureoptions, 
&$ui, object
$ui)

PEAR_Builder constructor.

Access: public

Overrides PEAR_Common::__construct() (PEAR_Common constructor)

Parameters:

mixed[]	`$configureoptions`	—
object	`$ui`	—	user interface object (instance of PEAR_Frontend_*)
	`&$ui`	—

[ Top ]

build [line 298]

array build(
string|PEAR_PackageFile_v*
$descfile, [mixed
$callback = null])

Build an extension from source. Runs "phpize" in the source directory, but compiles in a temporary directory (TMPDIR/pear-build-USER/PACKAGE-VERSION).

Return: an array of associative arrays with built files, format: array( array( 'file' => '/path/to/ext.so', 'php_api' => YYYYMMDD, 'zend_mod_api' => YYYYMMDD, 'zend_ext_api' => YYYYMMDD ), ... )
See: PEAR_Builder::_runCommand
Access: public

Parameters:

string\|PEAR_PackageFile_v*	`$descfile`	—	path to XML package description file, or a PEAR_PackageFile object
mixed	`$callback`	—	callback function used to report output, see PEAR_Builder::_runCommand for details

[ Top ]

log [line 549]

void log(

$level, 
$msg, [
$append_crlf = true])

Overrides PEAR_Common::log() (Logging method.)

Parameters:

	`$level`	—
	`$msg`	—
	`$append_crlf`	—

[ Top ]

msdevCallback [line 227]

void msdevCallback(

$what, 
$data)

Parameters:

	`$what`	—
	`$data`	—

[ Top ]

phpizeCallback [line 485]

void phpizeCallback(
string
$what, mixed
$data)

Message callback function used when running the "phpize" program. Extracts the API numbers used. Ignores other message types than "cmdoutput".

Access: public

Parameters:

string	`$what`	—	the type of message
mixed	`$data`	—	the message

[ Top ]