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

Class: maintainer

Source Location: /pearweb-1.1.5/include/pear-database.php

Class Overview


Class to handle maintainers


Author(s):

Methods


Inherited Variables

Inherited Methods


Class Details

[line 1255]
Class to handle maintainers


[ Top ]


Method Detail

add   [line 1269]

mixed add( mixed $package, string $user, string $role, [integer $active = 1])

Add new maintainer
  • Return: True or PEAR error object

Parameters:

mixed   $package     Name of the package or it's ID
string   $user     Handle of the user
string   $role     Role of the user
integer   $active     Is the developer actively working on the project?

[ Top ]

get   [line 1304]

array get( mixed $package, [boolean $lead = false], [boolean $active = false])

Get maintainer(s) for package

Parameters:

mixed   $package     Name of the package or it's ID
boolean   $lead     Only return lead maintainers?
boolean   $active     Only get all maintainers but possibility of getting all maintainer if active is set to false.

[ Top ]

getByUser   [line 1335]

array getByUser( string $user)

Get the roles of a specific user

Parameters:

string   $user     Handle of the user

[ Top ]

isValidRole   [line 1352]

boolean isValidRole( string $role)

Check if role is valid

Parameters:

string   $role     Name of the role

[ Top ]

mayUpdate   [line 1506]

boolean mayUpdate( int $package)

Checks if the current user is allowed to update the maintainer data
  • Access: public

Parameters:

int   $package     ID of the package

[ Top ]

remove   [line 1374]

True remove( mixed $package, string $user)

Remove user from package
  • Return: or PEAR error object

Parameters:

mixed   $package     Name of the package or it's ID
string   $user     Handle of the user

[ Top ]

update   [line 1489]

void update( int $package, string $user, string $role, string $active)

Update maintainer entry
  • Access: public

Parameters:

int   $package     Package ID
string   $user     Username
string   $role     Role
string   $active     Is the developer actively working on the package?

[ Top ]

updateAll   [line 1400]

mixed updateAll( int $pkgid, array $users, [bool $print = false])

Update user and roles of a package
  • Return: PEAR_Error or true

Parameters:

int   $pkgid     The package id to update
array   $users     Assoc array containing the list of users in the form: '<user>' => array('role' => '<role>', 'active' => '<active>')
bool   $print     Whether to print the logging information to the screen

[ Top ]


Documentation generated on Sat, 06 Jan 2007 00:32:37 -0500 by phpDocumentor 1.3.0. PEAR Logo Copyright © PHP Group 2004.