Class: CodeGen_Maintainer

Source Location: /CodeGen-1.0.0/CodeGen/Maintainer.php

Class Overview

A class that describes an extension author or maintainer

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 36]
A class that describes an extension author or maintainer

This class wraps up the functionality needed for the command line script.

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

[ Top ]

Class Variables

$comment_prefix = "Authors:"

[line 78]

Prefix to use in comment headers

Access: protected

Type:

bool

[ Top ]

$email =

[line 57]

Email address

Access: protected

Type:

string

[ Top ]

$first = true

[line 71]

First maintainer added?

Access: protected

Type:

bool

[ Top ]

$name =

[line 50]

Real name

Access: protected

Type:

string

[ Top ]

$role = "developer"

[line 64]

Role in this project

Access: protected

Type:

string

[ Top ]

$user =

[line 43]

Users system account name

Access: protected

Type:

string

[ Top ]

Method Detail

__construct (Constructor) [line 89]

CodeGen_Maintainer __construct(
[string
$user = "unknown"], [string
$name = "Anonymous Coward"], [string
$email = "unknown"], [string
$role = "unknown"])

Constructor

Access: public

Parameters:

string	`$user`	—	CVS user name
string	`$name`	—	real name
string	`$email`	—	email address
string	`$role`	—	role in this project

[ Top ]

comment [line 198]

string comment(
)

Generate a comment header line for this author

Return: comment line
Access: public

[ Top ]

getName [line 150]

string getName(
)

real name getter

Access: public

[ Top ]

getUser [line 126]

string getUser(
)

CVS user getter

Access: public

[ Top ]

setEmail [line 163]

bool setEmail(
string
$email)

Set email address

Return: true on success
Access: public

Parameters:

string $email — email address

[ Top ]

setName [line 138]

bool setName(
string
$name)

Set real user name

Return: true on success
Access: public

Parameters:

string $name — user name

[ Top ]

setRole [line 178]

bool setRole(
string
$role)

Set project role

Return: true on success
Access: public

Parameters:

string $role — project role

[ Top ]

setUser [line 110]

bool setUser(
string
$name)

Set CVS user name

Return: true on success
Access: public

Parameters:

string $name — CVS user name

[ Top ]