Class: PasswordInterface_1_0

Source Location: /modules/password/classes/PasswordInterface_1_0.class

Class PasswordInterface_1_0

Class Overview

This is an interface for the password module. Modules that wish to create password protected items can utilize an implementation of this interface.

Located in /modules/password/classes/PasswordInterface_1_0.class [line 39]

Author(s):

API Tags:

Abstract:

Methods

[ Top ]

Direct descendents

Child Class	Description
PasswordHelper	Helper functions for adding/removing passwords and changing permissions.

[ Top ]

Method Summary

array	hasPassword()	Is item password protected?
GalleryStatus	removePassword()	Remove password protection for an item
GalleryStatus	setPassword()	Password protect an item

[ Top ]

Methods

hasPassword [line 71]

array hasPassword(
GalleryItem
$item 
)

Is item password protected?

Parameters:

GalleryItem

$item:

API Tags:

Return:

GalleryStatus a status code boolean true if password protected

Redefined in descendants as:

PasswordHelper::hasPassword()

[ Top ]

removePassword [line 60]

GalleryStatus removePassword(

&$item, [boolean
$useProgressBar = false], GalleryItem
$item 
)

Remove password protection for an item

Parameters:

GalleryItem	$item:
boolean	$useProgressBar:	(default is false)
	&$item:

API Tags:

Return:

a status code

Redefined in descendants as:

PasswordHelper::removePassword() : Remove password protection.

[ Top ]

setPassword [line 49]

GalleryStatus setPassword(

&$item, string
$password, [boolean
$useProgressBar = false], GalleryItem
$item 
)

Password protect an item

Parameters:

GalleryItem	$item:
string	$password:
boolean	$useProgressBar:	(default is false)
	&$item:

API Tags:

Return:

a status code

Redefined in descendants as:

PasswordHelper::setPassword() : Password protect an item.

[ Top ]

Documentation generated on Sat, 21 Nov 2009 05:17:22 -0800 by phpDocumentor 1.3.0RC6

	Password Classes

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