Class: CodeGen_Extension

Source Location: /CodeGen-0.9.0/CodeGen/Extension.php

Class Overview

Extension generator class

Author(s):

Hartmut Holzgraefe <hartmut at php.net>

Version:

Release: @package_version@

Copyright:

2005 Hartmut Holzgraefe

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

[line 43]
Extension generator class

Author: Hartmut Holzgraefe <hartmut@php.net>
Version: Release: @package_version@
Copyright: 2005 Hartmut Holzgraefe
Link: http://pear.php.net/package/CodeGen
Abstract:
License: PHP License 3.0

[ Top ]

Class Variables

$authors = array()

[line 106]

The authors contributing to this extension

Access: protected

Type:

array

[ Top ]

$description =

[line 66]

extension description

Access: protected

Type:

string

[ Top ]

$language = "c"

[line 89]

The implementation language

Currently we support "c" and "cpp"

Access: protected

Type:

string

[ Top ]

$license = NULL

[line 73]

The license for this extension

Access: protected

Type:

object

[ Top ]

$name = "unknown"

[line 50]

The extensions basename (C naming rules apply)

Access: protected

Type:

string

[ Top ]

$platform = null

[line 98]

The target platform for this extension

Possible values are "unix", "win" and "all"

Access: protected

Type:

string

[ Top ]

$prefix = ""

[line 114]

Name prefix for functions etc.

Access: protected

Type:

string

[ Top ]

$release = NULL

[line 80]

The release info for this extension

Access: protected

Type:

object

[ Top ]

$summary = "The unknown extension"

[line 58]

The extensions descriptive name

Access: protected

Type:

string

[ Top ]

Method Detail

addAuthor [line 257]

void addAuthor(
object a
$author)

Add an author or maintainer to the extension

Access: public

Parameters:

object a $author — maintainer object

[ Top ]

getChangelog [line 146]

string getChangelog(
)

changelog getter

Access: public

[ Top ]

getLanguage [line 230]

string getLanguage(
)

Get programming language

[ Top ]

getName [line 172]

string getName(
)

Get extension base name

[ Top ]

getPrefix [line 317]

string getPrefix(
)

Get extension name prefix

[ Top ]

setChangelog [line 133]

bool setChangelog(
string
$changelog)

Set method for changelog

Return: true on success
Access: public

Parameters:

string $changelog — changelog

[ Top ]

setDescription [line 195]

void setDescription(
string
$text)

Set extension documentation text

Access: public

Parameters:

string $text — long description

[ Top ]

setLanguage [line 207]

void setLanguage(
string
$lang)

Set the programming language to produce code for

Access: public

Parameters:

string $lang — programming language name

[ Top ]

setLicense [line 288]

void setLicense(
object
$license)

Set license

Access: public

Parameters:

object $license —

[ Top ]

setName [line 157]

void setName(
string
$name)

Set extension base name

Access: public

Parameters:

string $name — name

[ Top ]

setPlatform [line 241]

void setPlatform(
string
$type)

Set target platform for generated code

Access: public

Parameters:

string $type — platform name

[ Top ]

setPrefix [line 302]

void setPrefix(
string
$prefix)

Set extension name prefix (for functions etc.)

Access: public

Parameters:

string $prefix — name

[ Top ]

setRelease [line 274]

void setRelease(

$release)

Set release info

Access: public

Parameters:

$release —

[ Top ]

setSummary [line 183]

void setSummary(
string
$text)

Set extension summary text

Access: public

Parameters:

string $text — short summary

[ Top ]