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


Classes:
CodeGen_PECL_Dependency_Header
CodeGen_PECL_Dependency_Lib
CodeGen_PECL_Dependency_Platform
CodeGen_PECL_Element_Test
CodeGen_PECL_Extension
Files:
Extension.php
Header.php
Lib.php
ObjectInterface.php
Platform.php
Test.php

Class: CodeGen_PECL_Extension

Source Location: /CodeGen_PECL-1.0.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: @package_version@

Copyright:

  • 2005 Hartmut Holzgraefe

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

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


[ Top ]

Class Variables

$channel =  "pecl.php.net"

[line 215]

pear installer channel name
  • Access: protected

Type:   string


[ Top ]

$classes = array()

[line 113]

The PHP classes defined by this extension
  • Access: protected

Type:   array


[ Top ]

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

[line 183]

config.m4 fragments
  • Access: protected

Type:   array


[ Top ]

$constants = array()

[line 106]

The constants defined by this extension
  • Access: protected

Type:   array


[ Top ]

$functions = array()

[line 92]

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

Type:   array


[ Top ]

$globals = array()

[line 134]

The extensions internal global variables
  • Access: protected

Type:   array


[ Top ]

$interfaces = array()

[line 120]

The PHP interfaces defined by this extension
  • Access: protected

Type:   array


[ Top ]

$internalFunctions = array()

[line 99]

The extensions internal functions like MINIT
  • Access: protected

Type:   array


[ Top ]

$linespecs =  false

[line 191]

generate #line specs?
  • Access: protected

Type:   bool


[ Top ]

$logos = array()

[line 157]

phpinfo logos
  • Access: protected

Type:   string


[ Top ]

$makefragments = array()

[line 174]

Makefile fragments
  • Access: protected

Type:   array


[ Top ]

$otherExtensions = array()

[line 165]

cross extension dependencies
  • Access: protected

Type:   array


[ Top ]

$phpini = array()

[line 127]

The extensions php.ini parameters
  • Access: protected

Type:   array


[ Top ]

$resources = array()

[line 141]

The PHP resources defined by this extension
  • Access: protected

Type:   array


[ Top ]

$streams = array()

[line 199]

PHP Streams
  • Access: protected

Type:   array


[ Top ]

$testcases = array()

[line 148]

Custom test cases
  • Access: protected

Type:   array


[ Top ]

$with = array()

[line 207]

--with configure options
  • Access: protected

Type:   array


[ Top ]


Method Detail

__construct (Constructor)   [line 227]

CodeGen_PECL_Extension __construct( )

The constructor
  • Access: public

[ Top ]

addClass   [line 396]

void addClass( CodeGen_PECL_Element_Class $class)

Add a PHP class to the extension
  • Access: public

Parameters:

object a   $class   —  class object

[ Top ]

addConstant   [line 299]

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

void addFunction( CodeGen_PECL_Element_Function $function)

Add a function to the extension
  • Access: public

Parameters:

object a   $function   —  function object

[ Top ]

addGlobal   [line 338]

void addGlobal( CodeGen_PECL_Element_Global $global)

Add a internal global variable
  • Access: public

Parameters:

object a   $global   —  global object

[ Top ]

addInterface   [line 413]

void addInterface( CodeGen_PECL_Element_Interface $interface)

Add a PHP interface to the extension
  • Access: public

Parameters:

object an   $interface   —  interface object

[ Top ]

addLogo   [line 468]

void addLogo( CodeGen_PECL_Element_Logo $logo)

Add phpinfo logo
  • Access: public

Parameters:

object the   $logo   —  logo

[ Top ]

addOtherExtension   [line 487]

void addOtherExtension( CodeGen_PECL_Dependency_Extension $ext)

Add cross-module dependency

Parameters:

object extension   $ext   —  dependency object

[ Top ]

addPhpIni   [line 319]

void addPhpIni( CodeGen_PECL_Element_Ini $phpini)

Add a PHP ini directive
  • Access: public

Parameters:

object a   $phpini   —  phpini object

[ Top ]

addResource   [line 356]

void addResource( CodeGen_PECL_Element_Resource $resource)

Add a PHP resource type
  • Access: public

Parameters:

object a   $resource   —  resource object

[ Top ]

addStream   [line 430]

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

void addTest( CodeGen_PECL_Element_Test $test)

add a custom test case
  • Access: public

Parameters:

object a   $test   —  Test object

[ Top ]

addWith   [line 448]

bool addWith( CodeGen_PECL_Dependency_With $with)

Add a --with configure option
  • Access: public

Parameters:

object 'With'   $with   —  object

[ Top ]

copyright   [line 78]

string copyright( )

CodeGen_PECL Copyright message

[ Top ]

createExtension   [line 533]

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

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

void generateDocumentation( string $docdir)

Create the extension documentation DocBook XML files
  • Access: public

Parameters:

string   $docdir   —  Directory to write to

[ Top ]

generateSource   [line 585]

void generateSource( )

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

[ Top ]

getConstants   [line 384]

array getConstants( )

Get PHP constants
  • Access: public

[ Top ]

getLinespecs   [line 517]

bool getLinespecs( )

linespec getter
  • Access: public

[ Top ]

getResources   [line 373]

array getResources( )

Get PHP resource types
  • Access: public

[ Top ]

minPhpVersion   [line 2266]

string minPhpVersion( )

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

[ Top ]

packageXmlFileList   [line 1915]

string packageXmlFileList( )

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

[ Top ]

setChannel   [line 1034]

void setChannel( string $channel)

Set pear installer channel
  • Access: public

Parameters:

string   $channel   — 

[ Top ]

setLicense   [line 983]

void setLicense( object $license)

Set license
  • Access: public

Parameters:

object   $license   — 

[ Top ]

setLinespecs   [line 506]

void setLinespecs( bool $state)

Generate #line specs?
  • Access: public

Parameters:

bool   $state   — 

[ Top ]

setPlatform   [line 283]

void setPlatform( string $type)

Set target platform for generated code
  • Access: public

Parameters:

string   $type   —  platform name

[ Top ]

terminate   [line 2319]

void terminate( string $msg)

Show error message and bailout

Parameters:

string   $msg   —  error message

[ Top ]

version   [line 68]

string version( )

Current CodeGen_PECL version number

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