pnadmin.php

<?php
/**
 * locations
 *
 * @copyright (c) 2008,2010, Locations Development Team
 * @link http://code.zikula.org/locations
 * @author Steffen Voß
 * @license GNU/GPL - http://www.gnu.org/copyleft/gpl.html
 * @package locations
 */

/**
 * Even though we're handling objects for multiple tables, we only have one function for any use case.
 * The specific functionality for each object is encapsulated in the actual class implementation within the
 * module's classes directory while the handling code can remain identical for any number of entities.
 * This component-based approach allows you to have generic handler code which relies on the functionality
 * implemented in the object's class in order to achieve it's goals.
 */

// preload common used classes
Loader::requireOnce('modules/locations/common.php');
// include pnForm in order to be able to inherit from pnFormHandler
Loader::requireOnce('includes/pnForm.php');


/**
 * This function is the default function, and is called whenever the
 * module's Admin area is called without defining arguments.
 *
 * @author       Steffen Voß
 * @params       TODO
 * @return       Render output
 */
function locations_admin_main($args)
{
    if (!SecurityUtil::checkPermission('locations::', '::', ACCESS_ADMIN)) {
        return LogUtil::registerPermissionError(pnModURL('locations', 'user', 'main'));
    }

    // call view method
    return locations_admin_view();

}


/**
 * This function provides a generic item list overview.
 *
 * @author       Steffen Voß
 * @params       TODO
 * @param        ot             string    treated object type
 * @param        sort           string    sorting field
 * @param        sdir           string    sorting direction
 * @param        pos            int       current pager position
 * @param        tpl            string    name of alternative template (for alternative display options, feeds and xml output)
 * @param        raw            boolean   optional way to display a template instead of fetching it (needed for standalone output)
 * @return       Render output
 */
function locations_admin_view($args)
{
    if (!SecurityUtil::checkPermission('locations::', '::', ACCESS_ADMIN)) {
        return LogUtil::registerPermissionError(pnModURL('locations', 'user', 'main'));
    }
    $dom = ZLanguage::getModuleDomain('locations');

    // parameter specifying which type of objects we are treating
    $objectType = FormUtil::getPassedValue('ot', 'location', 'GET');

    if (!in_array($objectType, locations_getObjectTypes())) {
        $objectType = 'location';
    }
    // load the object array class corresponding to $objectType
    if (!($class = Loader::loadArrayClassFromModule('locations', $objectType))) {
        pn_exit(__f('Error! Unable to load class [%s].', $objectType, $dom));
    }

    // instantiate the object-array
    $objectArray = new $class();

    if (pnModGetVar('locations', 'enablecategorization')) {
        $category = FormUtil :: getPassedValue('cat', null);

        if (!($categoryclass = Loader::loadClass('CategoryUtil'))) {
            pn_exit (__f('Error! Unable to load class [%s].', 'CategoryUtil', $dom));
        }
        if (!($categoryclass = Loader::loadClass('CategoryRegistryUtil'))) {
            pn_exit (__f('Error! Unable to load class [%s].', 'CategoryRegistryUtil', $dom));
        }

        $categories = CategoryRegistryUtil::getRegisteredModuleCategory('locations', 'locations_location', 'Type', '/__SYSTEM__/Modules/locations');

        if ($category > 0) {
            if (!is_array($objectArray->_objCategoryFilter)) {
                $objectArray->_objCategoryFilter = array();
            }

            $categoryWithSubIDs = array($category);
            $subCats = CategoryUtil::getSubCategories($category);

            foreach($subCats as $subCat) {
                $categoryWithSubIDs[] = $subCat['id'];
            }

            $objectArray->_objCategoryFilter['Type'] = $categoryWithSubIDs;
        }
    }

    // parameter for used sorting field
    $sort = FormUtil::getPassedValue('sort', '', 'GET');
    if (empty($sort) || !in_array($sort, $objectArray->getAllowedSortingFields())) {
        $sort = $objectArray->getDefaultSortingField();
    }

    // parameter for used sort order
    $sdir = FormUtil::getPassedValue('sdir', '', 'GET');
    if ($sdir != 'asc' && $sdir != 'desc') $sdir = 'asc';


    // startnum is the current offset which is used to calculate the pagination
    $startnum = (int) FormUtil::getPassedValue('pos', 1, 'GET');

    // pagesize is the number of items displayed on a page for pagination
    $pagesize = pnModGetVar('locations', 'pagesize', 10);


    // convenience vars to make code clearer
    $where = '';
    $sortParam = $sort . ' ' . $sdir;

    // use locationsFilterUtil to support generic filtering based on an object-oriented approach
    Loader::LoadClass('locationsFilterUtil', 'modules/locations/classes/FilterUtil/');
    $fu =& new locationsFilterUtil(array('table' => $objectArray->_objType));

    // you could set explicit filters at this point, something like
    // $fu->setFilter('type:eq:' . $args['type'] . ',id:eq:' . $args['id']);
    // supported operators: eq, ne, like, lt, le, gt, ge, null, notnull

    // process request input filters and get result for DBUtil
    $ret = $fu->GetSQL();
    $where = $ret['where'];

    // get() returns the cached object fetched from the DB during object instantiation
    // get() with parameters always performs a new select
    // while the result will be saved in the object, we assign in to a local variable for convenience.
    $objectData = $objectArray->get($where, $sortParam, $startnum-1, $pagesize);

    // get total number of records for building the pagination by method call
    $objcount = $objectArray->getCount($where);

    // get pnRender instance for this module
    $render = pnRender::getInstance('locations', false);
    $render->assign('modvar', pnModGetVar('locations'));
    $render->assign('categories', $categories);
    $render->assign('selectedCat', $category);

    // assign the object-array we loaded above
    $render->assign('objectArray', $objectData);

    // assign current sorting information
    $render->assign('sort', $sort);
    $render->assign('sdir', ($sdir == 'asc') ? 'desc' : 'asc'); // reverted for links

    // assign the information required to create the pager
    $render->assign('pager', array('numitems'     => $objcount,
                                   'itemsperpage' => $pagesize));

    // fetch and return the appropriate template
    return locations_processRenderTemplate($render, 'admin', $objectType, 'view', $args);
}


/**
 * This function provides a generic handling of all edit requests.
 *
 * @author       Steffen Voß
 * @params       TODO
 * @param        ot             string    treated object type
 * @param        tpl            string    name of alternative template (for alternative display options, feeds and xml output)
 * @param        raw            boolean   optional way to display a template instead of fetching it (needed for standalone output)
 * @return       Render output
 */
function locations_admin_edit($args)
{
    if (!SecurityUtil::checkPermission('locations::', '::', ACCESS_EDIT)) {
        return LogUtil::registerPermissionError(pnModURL('locations', 'user', 'main'));
    }

    // parameter specifying which type of objects we are treating
    $objectType = FormUtil::getPassedValue('ot', 'location', 'GET');

    if (!in_array($objectType, locations_getObjectTypes())) {
        $objectType = 'location';
    }

    // create new pnForm reference
    $render = FormUtil::newpnForm('locations');

    $render->assign('DefaultCity', pnModGetVar('locations', 'DefaultCity'));
    $render->assign('DefaultState', pnModGetVar('locations', 'DefaultState'));
    $render->assign('DefaultCountry', pnModGetVar('locations', 'DefaultCountry'));

    // include event handler class
    Loader::requireOnce('modules/locations/classes/FormHandler/locations_admin_' . $objectType . '_edithandler.class.php');

    // build form handler class name
    $handlerClass = 'locations_admin_' . $objectType . '_editHandler';

    // Execute form using supplied template and page event handler
    return $render->pnFormExecute('locations_admin_' . $objectType . '_edit.htm', new $handlerClass());
}

/**
 *
 * @author       Steffen Voß
 * @params       TODO
 * @return       Render output
 */
function locations_admin_delete($args)
{
    if (!SecurityUtil::checkPermission('locations::', '::', ACCESS_DELETE)) {
        return LogUtil::registerPermissionError(pnModURL('locations', 'user', 'main'));
    }

    $dom = ZLanguage::getModuleDomain('locations');

    // parameter specifying which type of objects we are treating
    $objectType   = FormUtil::getPassedValue('ot', 'location', 'GETPOST');
    $confirmation = FormUtil::getPassedValue('confirmation', '', 'GETPOST');

    if (!in_array($objectType, locations_getObjectTypes())) {
        $objectType = 'location';
    }

    $id = (int)FormUtil::getPassedValue($objectType . 'id', '', 'GETPOST');

    // Check for confirmation.
    if (empty($confirmation)) {
        $render = pnRender::getInstance('locations', false);
        $render->assign('objectType', $objectType);
        $render->assign('locationid', $id);
        return $render->fetch('locations_admin_delete.htm');
    }

    if (DBUtil::deleteObjectByID('locations_' . $objectType, $id, $objectType . 'id')) {
        pnModCallHooks('item', 'delete', $id, array ('module' => 'locations'));
        LogUtil::registerStatus(__('Done! Location deleted.', $dom));
    } else {
        LogUtil::registerError(__('Error! Could not delete location.', $dom));
    }

    return pnRedirect(pnModURL('locations', 'admin', 'view'));
}


/**
 * This function takes care of the module configuration.
 *
 * @author       Steffen Voß
 * @return       Render output
 */
function locations_admin_modifyconfig()
{
    // Create new pnForm reference
    $render = FormUtil::newpnForm('locations');

    // include event handler class
    Loader::requireOnce('modules/locations/classes/FormHandler/locations_admin_confighandler.class.php');

    // Execute form using supplied template and page event handler
    return $render->pnFormExecute('locations_admin_modifyconfig.htm', new locations_admin_configHandler());
}


/**
 * This function deletes all selected locations
 *
 * @author       Carsten Volmer
 * @return       Render output
 */
function locations_admin_deleteselected($args)
{
    // Confirm authorisation code.
    if (!SecurityUtil::confirmAuthKey()) {
        return LogUtil::registerAuthidError(pnModURL('locations', 'admin', 'view'));
    }

    $dom = ZLanguage::getModuleDomain('locations');

    // Get parameters from whatever input we need.
    $locations = isset($args['locations']) ? $args['locations'] : FormUtil::getPassedValue('locations', null, 'POST');
    $action    = isset($args['action'])    ? $args['action']    : FormUtil::getPassedValue('action', null, 'POST');

    // loop round each comment deleted them in turn
    foreach ($locations as $location) {
        if ($action == 'delete') {
            if (DBUtil::deleteObjectByID('locations_location', $location, 'location' . 'id')) {
                pnModCallHooks('item', 'delete', $location, array ('module' => 'locations'));
                LogUtil::registerStatus(__('Done! Location deleted.', $dom));
            } else {
                LogUtil::registerError(__('Error! Could not delete location.', $dom));
            }
        }
    }

    return pnRedirect(pnModURL('locations', 'admin', 'view'));
}