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

Class: CodeGen_PECL_Extension

Source Location: /CodeGen_PECL-1.1.3/PECL/Extension.php

Class Overview

CodeGen_Extension
   |
   --CodeGen_PECL_Extension

A class that generates PECL extension soure and documenation files


Author(s):

Version:

  • Release: 1.1.3

Copyright:

  • 2005-2008 Hartmut Holzgraefe

Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 61]
A class that generates PECL extension soure and documenation files


[ Top ]


Class Variables

$channel =  "pecl.php.net"

[line 199]

pear installer channel name
  • Access: protected

Type:   string


[ Top ]

$classes = array()

[line 114]

The PHP classes defined by this extension
  • Access: protected

Type:   array


[ Top ]

$constants = array()

[line 107]

The constants defined by this extension
  • Access: protected

Type:   array


[ Top ]

$docPurpose =  "utilspec"

[line 209]

phpdoc reference purpose

See http://doc.php.net/php/en/dochowto/x1257.php for details

  • Access: protected

Type:   string


[ Top ]

$functions = array()

[line 93]

The public PHP functions defined by this extension
  • Access: protected

Type:   array


[ Top ]

$globals = array()

[line 135]

The extensions internal global variables
  • Access: protected

Type:   array


[ Top ]

$interfaces = array()

[line 121]

The PHP interfaces defined by this extension
  • Access: protected

Type:   array


[ Top ]

$internalFunctions = array()

[line 100]

The extensions internal functions like MINIT
  • Access: protected

Type:   array


[ Top ]

$linespecs =  false

[line 175]

generate #line specs?
  • Access: protected

Type:   bool


[ Top ]

$logos = array()

[line 158]

phpinfo logos
  • Access: protected

Type:   string


[ Top ]

$otherExtensions = array()

[line 166]

cross extension dependencies
  • Access: protected

Type:   array


[ Top ]

$phpini = array()

[line 128]

The extensions php.ini parameters
  • Access: protected

Type:   array


[ Top ]

$resources = array()

[line 142]

The PHP resources defined by this extension
  • Access: protected

Type:   array


[ Top ]

$streams = array()

[line 183]

PHP Streams
  • Access: protected

Type:   array


[ Top ]

$testcases = array()

[line 149]

Custom test cases
  • Access: protected

Type:   array


[ Top ]

$with = array()

[line 191]

--with configure options
  • Access: protected

Type:   array


[ Top ]



Method Detail

__construct (Constructor)   [line 222]

CodeGen_PECL_Extension __construct( )

The constructor
  • Access: public

[ Top ]

addClass   [line 440]

void addClass( $class)

Add a PHP class to the extension
  • Access: public

Parameters:

object a   $class     class object

[ Top ]

addConstant   [line 294]

void addConstant( $constant)

Add a PHP constant to the extension
  • Access: public

Parameters:

object a   $constant     constant object

[ Top ]

addFunction   [line 243]

void addFunction( CodeGen_PECL_Element_Function $function)

Add a function to the extension
  • Access: public

Parameters:

object a   $function     function object

[ Top ]

addGlobal   [line 333]

void addGlobal( $global)

Add a internal global variable
  • Access: public

Parameters:

object a   $global     global object

[ Top ]

addInterface   [line 457]

void addInterface( $interface)

Add a PHP interface to the extension
  • Access: public

Parameters:

object an   $interface     interface object

[ Top ]

addLogo   [line 512]

void addLogo( $logo)

Add phpinfo logo
  • Access: public

Parameters:

object the   $logo     logo

[ Top ]

addOtherExtension   [line 531]

void addOtherExtension( $ext)

Add cross-module dependency

Parameters:

object extension   $ext     dependency object

[ Top ]

addPhpIni   [line 314]

void addPhpIni( $phpini)

Add a PHP ini directive
  • Access: public

Parameters:

object a   $phpini     phpini object

[ Top ]

addResource   [line 351]

void addResource( $resource)

Add a PHP resource type
  • Access: public

Parameters:

object a   $resource     resource object

[ Top ]

addStream   [line 474]

void addStream( $stream)

Add a PHP stream wrapper to the extension
  • Access: public

Parameters:

object a   $stream     stream wrapper object

[ Top ]

addTest   [line 2432]

void addTest( CodeGen_PECL_Element_Test $test)

add a custom test case
  • Access: public

Parameters:

object a   $test     Test object

[ Top ]

addWith   [line 492]

bool addWith( $with)

Add a --with configure option
  • Access: public

Parameters:

object 'With'   $with     object

[ Top ]

copyright   [line 79]

string copyright( )

CodeGen_PECL Copyright message

[ Top ]

createExtension   [line 577]

void createExtension( [string $dirpath = false], [ $force = false])

Create the extensions including
  • Access: public

Parameters:

string   $dirpath     Directory to create (default is ./$this->name)
   $force     

[ Top ]

docEditorSettings   [line 2629]

string docEditorSettings( [int $level = 3])

Generate Editor settings block for documentation files
  • Return: Editor settings comment block
  • Access: public

Parameters:

int   $level     Directory nesting depth of target file (default: 3)

[ Top ]

generateDocumentation   [line 699]

void generateDocumentation( string $docdir)

Create the extension documentation DocBook XML files
  • Access: public

Parameters:

string   $docdir     Directory to write to

[ Top ]

generateSource   [line 645]

void generateSource( )

Create the extensions code soure and project files
  • Access: public

[ Top ]

getClass   [line 424]

object class getClass( string $name)

Get a specific class by name
  • Return: object or false if not found
  • Access: public

Parameters:

string   $name     class name

[ Top ]

getConstant   [line 407]

object constant getConstant( string $name)

Get a specific constant by name
  • Return: object or false if not found
  • Access: public

Parameters:

string   $name     constant name

[ Top ]

getConstants   [line 395]

array getConstants( )

Get PHP constants
  • Access: public

[ Top ]

getFunctions   [line 2682]

array getFunctions( )

Return array of defined functions

[ Top ]

getLinespecs   [line 561]

bool getLinespecs( )

linespec getter
  • Access: public

[ Top ]

getResource   [line 380]

object resource getResource( string $name)

Get a specific resource by name
  • Return: object or false if not found
  • Access: public

Parameters:

string   $name     resource name

[ Top ]

getResources   [line 368]

array getResources( )

Get PHP resource types
  • Access: public

[ Top ]

maxVersion   [line 2605]

void maxVersion( $v1, $v2)


Parameters:

   $v1     
   $v2     

[ Top ]

minPhpVersion   [line 2582]

string minPhpVersion( )

Return minimal PHP version required to support the requested features
  • Return: version string

[ Top ]

minPhpVersionId   [line 2615]

string minPhpVersionId( )

Return minimal PHP version required to support the requested features
  • Return: version string

[ Top ]

packageXmlFileList   [line 2225]

string packageXmlFileList( )

Write file list for package.xml (both version 1.0 and 2.0)
  • Access: protected

[ Top ]

setChannel   [line 1296]

void setChannel( string $channel)

Set pear installer channel
  • Access: public

Parameters:

string   $channel     

[ Top ]

setLicense   [line 1244]

void setLicense( object $license)

Set license
  • Access: public

Parameters:

object   $license     

[ Top ]

setLinespecs   [line 550]

void setLinespecs( bool $state)

Generate #line specs?
  • Access: public

Parameters:

bool   $state     

[ Top ]

setPlatform   [line 278]

void setPlatform( string $type)

Set target platform for generated code
  • Access: public

Parameters:

string   $type     platform name

[ Top ]

terminate   [line 2662]

void terminate( string $msg)

Show error message and bailout

Parameters:

string   $msg     error message

[ Top ]

version   [line 69]

string version( )

Current CodeGen_PECL version number

[ Top ]


Documentation generated on Mon, 27 Sep 2010 12:00:16 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.