CodeGen
[ class tree: CodeGen ] [ index: CodeGen ] [ all elements ]
Packages:
CodeGen


Classes:
CodeGen_PECL_Command
CodeGen_PECL_Dependency_Extension
CodeGen_PECL_Dependency_Header
CodeGen_PECL_Dependency_Lib
CodeGen_PECL_Dependency_Platform
CodeGen_PECL_Dependency_With
CodeGen_PECL_Element
CodeGen_PECL_Element_Class
CodeGen_PECL_Element_ClassConstant
CodeGen_PECL_Element_Constant
CodeGen_PECL_Element_Function
CodeGen_PECL_Element_Global
CodeGen_PECL_Element_Ini
CodeGen_PECL_Element_Logo
CodeGen_PECL_Element_Method
CodeGen_PECL_Element_Property
CodeGen_PECL_Element_Resource
CodeGen_PECL_Element_Stream
CodeGen_PECL_Element_Test
CodeGen_PECL_Extension
CodeGen_PECL_ExtensionParser
CodeGen_PECL_Maintainer
CodeGen_PECL_Release
Files:
Class.php
ClassConstant.php
Command.php
Constant.php
Element.php
Extension.php
Extension.php
ExtensionParser.php
Function.php
Global.php
Header.php
Ini.php
Lib.php
Logo.php
Maintainer.php
Method.php
Platform.php
Property.php
Release.php
Resource.php
Stream.php
Test.php
With.php

Class: CodeGen_PECL_Extension

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

Class Overview

CodeGen_Extension
   |
   --CodeGen_PECL_Extension

A class that generates PECL extension soure and documenation files


Author(s):

Version:

  • Release: @package_version@

Copyright:

  • 2005 Hartmut Holzgraefe

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

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


[ Top ]

Class Variables

$classes = array()

[line 152]

The PHP classes defined by this extension
  • Access: protected

Type:   array


[ Top ]

$code = array()

[line 187]

Code snippets
  • Access: protected

Type:   array


[ Top ]

$configfragments = array("top"=>array(),"bottom"=>array())

[line 230]

config.m4 fragments
  • Access: protected

Type:   array


[ Top ]

$constants = array()

[line 145]

The constants defined by this extension
  • Access: protected

Type:   array


[ Top ]

$functions = array()

[line 131]

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

Type:   array


[ Top ]

$globals = array()

[line 166]

The extensions internal global variables
  • Access: protected

Type:   array


[ Top ]

$headers = array()

[line 262]

External header files
  • Access: protected

Type:   array


[ Top ]

$internalFunctions = array()

[line 138]

The extensions internal functions like MINIT
  • Access: protected

Type:   array


[ Top ]

$libs = array()

[line 254]

External libraries
  • Access: protected

Type:   array


[ Top ]

$linespecs =  true

[line 238]

generate #line specs?
  • Access: protected

Type:   bool


[ Top ]

$logos = array()

[line 204]

phpinfo logos
  • Access: protected

Type:   string


[ Top ]

$makefragments = array()

[line 221]

Makefile fragments
  • Access: protected

Type:   array


[ Top ]

$otherExtensions = array()

[line 212]

cross extension dependencies
  • Access: protected

Type:   array


[ Top ]

$packageFiles = array()

[line 180]

The package files created by this extension
  • Access: protected

Type:   array


[ Top ]

$phpini = array()

[line 159]

The extensions php.ini parameters
  • Access: protected

Type:   array


[ Top ]

$resources = array()

[line 173]

The PHP resources defined by this extension
  • Access: protected

Type:   array


[ Top ]

$streams = array()

[line 246]

PHP Streams
  • Access: protected

Type:   array


[ Top ]

$testcases = array()

[line 195]

Custom test cases
  • Access: protected

Type:   array


[ Top ]

$version =  ""

[line 90]

Version requested by input if any
  • Access: protected

Type:   string


[ Top ]

$with = array()

[line 270]

--with configure options
  • Access: protected

Type:   array


[ Top ]


Method Detail

__construct (Constructor)   [line 283]

CodeGen_PECL_Extension __construct( )

The constructor
  • Access: public

[ Top ]

addClass   [line 506]

void addClass( CodeGen_PECL_Element_Class $class)

Add a PHP class to the extension
  • Access: public

Parameters:

object a   $class   —  class object

[ Top ]

addCode   [line 301]

void addCode( string $role, string $position, string $code)

Add verbatim code snippet to extension
  • Access: public

Parameters:

string   $role   —  which file to put the code to
string   $position   —  where in the file the code should be put
string   $code   —  the actual code

[ Top ]

addConfigFragment   [line 683]

void addConfigFragment( string $text, [ $position = "top"])

Add config.m4 fragment
  • Access: public

Parameters:

string   $text   — 
   $position   — 

[ Top ]

addConstant   [line 409]

void addConstant( CodeGen_PECL_Element_Constant $constant)

Add a PHP constant to the extension
  • Access: public

Parameters:

object a   $constant   —  constant object

[ Top ]

addFunction   [line 358]

void addFunction( CodeGen_PECL_Element_Function $function)

Add a function to the extension
  • Access: public

Parameters:

object a   $function   —  function object

[ Top ]

addGlobal   [line 448]

void addGlobal( CodeGen_PECL_Element_Global $global)

Add a internal global variable
  • Access: public

Parameters:

object a   $global   —  global object

[ Top ]

addHeader   [line 336]

void addHeader( CodeGen_PECL_Dependency_Header $header)

Add toplevel header file dependancy
  • Var: header filename

Parameters:

CodeGen_PECL_Dependency_Header   $header   — 

[ Top ]

addLib   [line 318]

void addLib( CodeGen_PECL_Dependency_Lib $lib)

Add toplevel library dependancy
  • Var: library basename

Parameters:

CodeGen_PECL_Dependency_Lib   $lib   — 

[ Top ]

addLogo   [line 632]

void addLogo( CodeGen_PECL_Element_Logo $logo)

Add phpinfo logo
  • Access: public

Parameters:

object the   $logo   —  logo

[ Top ]

addMakeFragment   [line 670]

void addMakeFragment( string $text)

Add makefile fragment
  • Access: public

Parameters:

string   $text   — 

[ Top ]

addOtherExtension   [line 651]

void addOtherExtension( CodeGen_PECL_Dependency_Extension $ext)

Add cross-module dependency

Parameters:

object extension   $ext   —  dependency object

[ Top ]

addPackageFile   [line 542]

bool addPackageFile( string $type, string $path)

Add a package file by type and path
  • Return: success state
  • Access: public

Parameters:

string   $type   —  type
string   $path   —  path

[ Top ]

addPhpIni   [line 429]

void addPhpIni( CodeGen_PECL_Element_Ini $phpini)

Add a PHP ini directive
  • Access: public

Parameters:

object a   $phpini   —  phpini object

[ Top ]

addResource   [line 466]

void addResource( CodeGen_PECL_Element_Resource $resource)

Add a PHP resource type
  • Access: public

Parameters:

object a   $resource   —  resource object

[ Top ]

addSourceFile   [line 580]

void addSourceFile( string $name)

Add a source file to be copied to the extension dir
  • Access: public

Parameters:

string   $name   —  path

[ Top ]

addStream   [line 523]

void addStream( CodeGen_PECL_Element_Stream $stream)

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

Parameters:

object a   $stream   —  stream wrapper object

[ Top ]

addTest   [line 2283]

void addTest( CodeGen_PECL_Element_Test $test)

add a custom test case
  • Access: public

Parameters:

object a   $test   —  Test object

[ Top ]

addWith   [line 561]

bool addWith( CodeGen_PECL_Dependency_With $with)

Add a --with configure option
  • Access: public

Parameters:

object 'With'   $with   —  object

[ Top ]

copyright   [line 77]

string copyright( )

CodeGen_PECL Copyright message

[ Top ]

createExtension   [line 726]

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 ]

generateDocumentation   [line 828]

void generateDocumentation( string $docdir)

Create the extension documentation DocBook XML files
  • Access: public

Parameters:

string   $docdir   —  Directory to write to

[ Top ]

generateSource   [line 774]

void generateSource( )

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

[ Top ]

getConstants   [line 494]

array getConstants( )

Get PHP constants
  • Access: public

[ Top ]

getLinespecs   [line 710]

bool getLinespecs( )

linespec getter
  • Access: public

[ Top ]

getResources   [line 483]

array getResources( )

Get PHP resource types
  • Access: public

[ Top ]

getVersion   [line 97]

string getVersion( )

Get requested version

[ Top ]

haveVersion   [line 118]

bool haveVersion( string $version)

Check requested version

Parameters:

string   $version   —  version

[ Top ]

minPhpVersion   [line 2512]

string minPhpVersion( )

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

[ Top ]

packageXmlFileList   [line 2102]

string packageXmlFileList( )

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

[ Top ]

setLicense   [line 1150]

void setLicense( object $license)

Set license
  • Access: public

Parameters:

object   $license   — 

[ Top ]

setLinespecs   [line 699]

void setLinespecs( bool $state)

Generate #line specs?
  • Access: public

Parameters:

bool   $state   — 

[ Top ]

setPlatform   [line 393]

void setPlatform( string $type)

Set target platform for generated code
  • Access: public

Parameters:

string   $type   —  platform name

[ Top ]

setVersion   [line 107]

void setVersion( string $version)

Set requested version

Parameters:

string   $version   — 

[ Top ]

version   [line 67]

string version( )

Current CodeGen_PECL version number

[ Top ]

writeDotCvsignore   [line 2326]

void writeDotCvsignore( string 0)

Write .cvsignore entries
  • Access: public

Parameters:

string   0   —  directory to write to

[ Top ]
Documentation generated on Mon, 11 Mar 2019 14:16:02 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.