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

Class: CodeGen_Maintainer

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

Class Overview


A class that describes an extension author or maintainer


Author(s):

Version:

  • Release: @package_version@

Copyright:

  • 2005-2008 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.



[ 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@example.org"], [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 226]

string comment( )

Generate a comment header line for this author
  • Return: comment line
  • Access: public

[ Top ]

getEmail   [line 193]

string getEmail( )

email getter
  • Access: public

[ Top ]

getName   [line 166]

string getName( )

real name getter
  • Access: public

[ Top ]

getUser   [line 142]

string getUser( )

CVS user getter
  • Access: public

[ Top ]

setEmail   [line 179]

bool setEmail( string $email)

Set email address
  • Return: true on success
  • Access: public

Parameters:

string   $email     email address

[ Top ]

setName   [line 154]

bool setName( string $name)

Set real user name
  • Return: true on success
  • Access: public

Parameters:

string   $name     user name

[ Top ]

setRole   [line 206]

bool setRole( string $role)

Set project role
  • Return: true on success
  • Access: public

Parameters:

string   $role     project role

[ Top ]

setUser   [line 126]

bool setUser( string $name)

Set CVS user name
  • Return: true on success
  • Access: public

Parameters:

string   $name     CVS user name

[ Top ]

systemUser   [line 109]

Maintainer systemUser( )

System user factory
  • Return: object
  • Access: public

[ Top ]


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