UsersController

Package: Controller

class UsersController

extends Omeka_Controller_AbstractActionController

property UsersController::$_publicActions

protected array

Actions that are accessible by anonymous users.

property UsersController::$_browseRecordsPerPage

protected

UsersController::init()
UsersController::_handlePublicActions()

Peform common processing for the publicly accessible actions.

Set a view script variable for header and footer view scripts and don’t allow logged-in users access.

The script variables are set for actions in $_publicActions, so the scripts for those actions should use these variables.

UsersController::forgotPasswordAction()

Send an email providing a link that allows the user to reset their password.

UsersController::_sendResetPasswordEmail($toEmail, $activationCode)
Parameters:

  • $toEmail –

  • $activationCode –

UsersController::activateAction()
UsersController::addAction()
UsersController::editAction()

Similar to ‘add’ action, except this requires a pre-existing record.

The ID For this record must be passed via the ‘id’ parameter.

UsersController::changePasswordAction()
UsersController::apiKeysAction()
UsersController::browseAction()
UsersController::deleteAction()
UsersController::_getDeleteSuccessMessage($record)
Parameters:

  • $record –

UsersController::_getDeleteConfirmMessage($record)
Parameters:

  • $record –

UsersController::sendActivationEmail($user)

Send an activation email to a new user telling them how to activate their account.

Parameters:
Returns:

bool True if the email was successfully sent, false otherwise.

UsersController::loginAction()
UsersController::getLoginErrorMessages(Zend_Auth_Result $result)

This exists to customize the messages that people see when their attempt to login fails. ZF has some built-in default messages, but it seems like those messages may not make sense to a majority of people using the software.

Parameters:

  • $result (Zend_Auth_Result) –

Returns:

string

UsersController::logoutAction()
UsersController::_getUserForm(User $user, $ua = null)
Parameters:

  • $user (User) –

  • $ua –

UsersController::_getLog()