Open Journal Systems  2.4.4
 All Classes Namespaces Functions Variables Groups Pages
AdminCategoriesHandler Class Reference
Inheritance diagram for AdminCategoriesHandler:
AdminHandler Handler PKPHandler

Public Member Functions

 AdminCategoriesHandler ()
 
 categories ($args, &$request)
 
 createCategory ($args, &$request)
 
 deleteCategory ($args, &$request)
 
 editCategory ($args, &$request)
 
 moveCategory ($args, &$request)
 
 setCategoriesEnabled ($args, &$request)
 
 setupTemplate ($request=null, $category=null, $subclass=false)
 
 updateCategory ($args, &$request)
 
 validate (&$request, $categoryId=null)
 
- Public Member Functions inherited from AdminHandler
 AdminHandler ()
 
 index ()
 
 setupTemplate ($subclass=false)
 
- Public Member Functions inherited from PKPHandler
 addCheck (&$handlerValidator)
 
 addPolicy (&$authorizationPolicy, $addToTop=false)
 
 addRoleAssignment ($roleIds, $operations)
 
 authorize (&$request, &$args, $roleAssignments)
 
getAuthorizedContext ()
 
getAuthorizedContextObject ($assocType)
 
getDispatcher ()
 
 getId ()
 
 getLastAuthorizationMessage ()
 
 getLoginExemptions ()
 
getRangeInfo ($rangeName, $contextData=null)
 
 getRoleAssignment ($roleId)
 
 getRoleAssignments ()
 
 hashPageContext ($contextData=array())
 
 index ()
 
 initialize (&$request, $args=null)
 
 PKPHandler ()
 
 requireSSL ()
 
 setDispatcher (&$dispatcher)
 
 setId ($id)
 
 validate ($requiredContexts=null, $request=null)
 

Detailed Description

Handle requests for changing admin's category list.

Definition at line 19 of file AdminCategoriesHandler.inc.php.

Member Function Documentation

AdminCategoriesHandler::AdminCategoriesHandler ( )

Constructor

Definition at line 29 of file AdminCategoriesHandler.inc.php.

AdminCategoriesHandler::categories (   $args,
$request 
)

Display a list of categories.

Parameters
$argsarray
$requestPKPRequest

Definition at line 38 of file AdminCategoriesHandler.inc.php.

References ArrayItemIterator\fromRangeInfo(), DAORegistry\getDAO(), PKPHandler\getRangeInfo(), setupTemplate(), and validate().

AdminCategoriesHandler::createCategory (   $args,
$request 
)

Display form to create new category.

Parameters
$argsarray
$requestPKPRequest

Definition at line 162 of file AdminCategoriesHandler.inc.php.

References editCategory().

AdminCategoriesHandler::deleteCategory (   $args,
$request 
)

Delete a category.

Parameters
$argsarray first parameter is the ID of the category to delete
$requestPKPRequest

Definition at line 67 of file AdminCategoriesHandler.inc.php.

References DAORegistry\getDAO(), and validate().

AdminCategoriesHandler::editCategory (   $args,
$request 
)

Display form to edit a category.

Parameters
$argsarray optional, first parameter is the ID of the category to edit
$requestPKPRequest

Definition at line 131 of file AdminCategoriesHandler.inc.php.

References setupTemplate(), and validate().

Referenced by createCategory().

AdminCategoriesHandler::moveCategory (   $args,
$request 
)

Change the sequence of a category.

Parameters
$argsarray
$requestPKPRequest

Definition at line 88 of file AdminCategoriesHandler.inc.php.

References DAORegistry\getDAO(), and validate().

AdminCategoriesHandler::setCategoriesEnabled (   $args,
$request 
)

Set the site-wide categories enabled/disabled flag.

Parameters
$argsarray
$requestPKPRequest

Definition at line 213 of file AdminCategoriesHandler.inc.php.

References DAORegistry\getDAO(), and validate().

AdminCategoriesHandler::setupTemplate (   $request = null,
  $category = null,
  $subclass = false 
)

Set up the template.

Parameters
$requestPKPRequest
$categoryCategory optional
$subclassboolean optional

Definition at line 227 of file AdminCategoriesHandler.inc.php.

Referenced by categories(), editCategory(), and updateCategory().

AdminCategoriesHandler::updateCategory (   $args,
$request 
)

Save changes to a category.

Parameters
$argsarray
$requestPKPRequest

Definition at line 171 of file AdminCategoriesHandler.inc.php.

References DAORegistry\getDAO(), setupTemplate(), and validate().

AdminCategoriesHandler::validate ( $request,
  $categoryId = null 
)

Validate the request. If a category ID is supplied, the category object will be fetched and validated against. If, additionally, the user ID is supplied, the user and membership objects will be validated and fetched.

Parameters
$requestPKPRequest
$categoryIdint optional

Definition at line 246 of file AdminCategoriesHandler.inc.php.

References DAORegistry\getDAO().

Referenced by categories(), deleteCategory(), editCategory(), moveCategory(), setCategoriesEnabled(), and updateCategory().


The documentation for this class was generated from the following file: