File Source for pnuser.php

<?php
/**
* Zikula Application Framework
*
* @copyright (c) 2002, Zikula Development Team
* @link http://www.zikula.org
* @version $Id: pnuser.php 24342 2008-06-06 12:03:14Z markwest $
* @license GNU/GPL - http://www.gnu.org/copyleft/gpl.html
* @package Zikula_Value_Addons
* @subpackage FAQ
*/
/**
* the main user function
*
* This function is the default function, and is called whenever the module is
* initiated without defining arguments. As such it can be used for a number
* of things, but most commonly it either just shows the module menu and
* returns or calls whatever the module designer feels should be the default
* function (often this is the view() function)
*
* @author The Zikula Development Team
* @return output The main module page
*/
function FAQ_user_main()
{
// Security check
if (!SecurityUtil::checkPermission( 'FAQ::', '::', ACCESS_OVERVIEW)) {
return LogUtil::registerPermissionError();
}
// Create output object
$pnRender = pnRender::getInstance('FAQ');
// load the categories system
if (pnModGetVar('FAQ', 'enablecategorization')) {
if (!($class = Loader::loadClass('CategoryUtil')) || !($class = Loader::loadClass('CategoryRegistryUtil'))) {
pn_exit (pnML('_UNABLETOLOADCLASS', array('s' => 'CategoryUtil | CategoryRegistryUtil')));
}
$catregistry = CategoryRegistryUtil::getRegisteredModuleCategories('FAQ', 'faqanswer');
$categories = array();
$ak = array_keys($catregistry);
foreach ($ak as $k) {
$categories[$k] = CategoryUtil::getCategoryByID($catregistry[$k]);
$categories[$k]['path'] .= '/';
$categories[$k]['subcategories'] = CategoryUtil::getCategoriesByParentID($catregistry[$k]);
}
$pnRender->assign('categories', $categories);
}
$pnRender->assign('lang', pnUserGetLang());
$pnRender->assign(pnModGetVar('FAQ'));
$pnRender->assign('shorturls', pnConfigGetVar('shorturls'));
$pnRender->assign('shorturlstype', pnConfigGetVar('shorturlstype'));
// Return the output that has been generated by this function
return $pnRender->fetch('faq_user_main.htm');
}
/**
* view items
*
* This is a standard function to provide an overview of all of the items
* available from the module.
*
* @author The Zikula Development Team
* @param integer $startnum (optional) The number of the start item
* @return output The overview page
*/
function FAQ_user_view()
{
// Security check
if (!SecurityUtil::checkPermission( 'FAQ::', '::', ACCESS_OVERVIEW)) {
return LogUtil::registerPermissionError();
}
$startnum = (int)FormUtil::getPassedValue('startnum', isset($args['startnum']) ? $args['startnum'] : 1, 'GET');
$cat = (string)FormUtil::getPassedValue('cat', isset($args['cat']) ? $args['cat'] : null, 'GET');
$prop = (string)FormUtil::getPassedValue('prop', isset($args['prop']) ? $args['prop'] : null, 'GET');
$func = (string)FormUtil::getPassedValue('func');
// defaults and input validation
if (!is_numeric($startnum) || $startnum < 0) {
$startnum = 1;
}
// get all module vars for later use
$modvars = pnModGetVar('FAQ');
// check if categorisation is enabled
// and if its requested to list the recent faqs
if ($modvars['enablecategorization'] && !empty($prop) && !empty($cat)) {
if (!($class = Loader::loadClass('CategoryUtil')) || !($class = Loader::loadClass('CategoryRegistryUtil'))) {
pn_exit (pnML('_UNABLETOLOADCLASS', array('s' => 'CategoryUtil | CategoryRegistryUtil')));
}
// get the categories registered for the Pages
$catregistry = CategoryRegistryUtil::getRegisteredModuleCategories('FAQ', 'faqanswer');
$properties = array_keys($catregistry);
// if the property and the category are specified
// means that we'll list the FAQs that belongs to that category
if (in_array($prop, $properties)) {
if (!is_numeric($cat)) {
$rootCat = CategoryUtil::getCategoryByID($catregistry[$prop]);
$cat = CategoryUtil::getCategoryByPath($rootCat['path'].'/'.$cat);
} else {
$cat = CategoryUtil::getCategoryByID($cat);
}
if (!empty($cat) && isset($cat['path'])) {
// include all it's subcategories and build the filter
$categories = categoryUtil::getCategoriesByPath($cat['path'], '', 'path');
$catstofilter = array();
foreach ($categories as $category) {
$catstofilter[] = $category['id'];
}
$catFilter = array($prop => $catstofilter);
} else {
LogUtil::registerError(_NOTAVALIDCATEGORY);
}
}
}
// get all faqs
$items = pnModAPIFunc('FAQ', 'user', 'getall',
array('startnum' => $startnum,
'numitems' => $modvars['itemsperpage'],
'answered' => true,
'category' => isset($catFilter) ? $catFilter : null,
'catregistry' => isset($catregistry) ? $catregistry : null));
// Create output object
$pnRender = pnRender::getInstance('FAQ', false);
// assign various useful template variables
$pnRender->assign('startnum', $startnum);
$pnRender->assign('category', $cat);
$pnRender->assign('property', $prop);
$pnRender->assign('lang', pnUserGetLang());
$pnRender->assign($modvars);
$pnRender->assign('shorturls', pnConfigGetVar('shorturls'));
$pnRender->assign('shorturlstype', pnConfigGetVar('shorturlstype'));
// Loop through each item getting the rendered output from the item template
$faqitems = array();
$faqs = array();
foreach ($items as $item) {
if (SecurityUtil::checkPermission( 'FAQ::', "$item[faqid]::", ACCESS_OVERVIEW)) {
$pnRender->assign($item);
$faqitems[] = $pnRender->fetch('faq_user_row_read.htm', $item['faqid']);
$faqs[] = $item;
}
}
// Display the entries
$pnRender->assign('items', $faqitems);
$pnRender->assign('faqs', $faqs);
$pnRender->assign('func', $func);
// assign the start number
$pnRender->assign('startnum', $startnum);
// assign the values for the smarty plugin to produce a pager
$pnRender->assign('pager', array('numitems' => pnModAPIFunc('FAQ', 'user', 'countitems', array('category' => isset($catFilter) ? $catFilter : null)),
'itemsperpage' => pnModGetVar('FAQ', 'itemsperpage')));
// Return the output that has been generated by this function
return $pnRender->fetch('faq_user_view.htm');
}
/**
* display item
*
* This is a standard function to provide detailed informtion on a single item
* available from the module.
*
* @author The Zikula Development Team
* @param integer $tid the ID of the item to display
* @return output The item detail page
*/
function FAQ_user_display($args)
{
$faqid = FormUtil::getPassedValue('faqid', isset($args['faqid']) ? $args['faqid'] : null, 'REQUEST');
$title = FormUtil::getPassedValue('title', isset($args['title']) ? $args['title'] : null, 'REQUEST');
$objectid = FormUtil::getPassedValue('objectid', isset($args['objectid']) ? $args['objectid'] : null, 'REQUEST');
if (!empty($objectid)) {
$faqid = $objectid;
}
if (!is_numeric($faqid) && !is_string($title)) {
return LogUtil::registerError (_MODARGSERROR);
}
// Create output object
$pnRender = pnRender::getInstance('FAQ');
// set the cache id
if (isset($faqid) && is_numeric($faqid)) {
$pnRender->cache_id = $faqid;
} else {
$pnRender->cache_id = $faqid;
}
// check out if the contents are cached.
if ($pnRender->is_cached('faq_user_display.htm')) {
return $pnRender->fetch('FAQ_user_display.htm');
}
// Get the faq
if (isset($faqid) && is_numeric($faqid)) {
$item = pnModAPIFunc('FAQ', 'user', 'get', array('faqid' => $faqid));
} else {
$item = pnModAPIFunc('FAQ', 'user', 'get', array('title' => $title));
}
if (!$item) {
return DataUtil::formatForDisplayHTML(_FAQ_ITEMFAILED);
}
// set the page title
PageUtil::setVar('title', $item['question']);
// Assign details of the item.
$pnRender->assign($item);
// Return the output that has been generated by this function
return $pnRender->fetch('faq_user_display.htm');
}
/**
* ask a question
*
* @author The Zikula Development Team
* @return output A form to submit a question
*/
function FAQ_user_ask()
{
// Security check
if (!SecurityUtil::checkPermission( 'FAQ::', '::', ACCESS_COMMENT)) {
return LogUtil::registerPermissionError();
}
// Create output object
$pnRender = pnRender::getInstance('FAQ');
// assign logged in state
$pnRender->assign('loggedin', pnUserLoggedIn());
// Return the output that has been generated by this function
return $pnRender->fetch('faq_user_ask.htm');
}
/**
* Create an faq
*
* @author The Zikula Development Team
* @param question the question to be submitted
*/
function FAQ_user_create($args)
{
// Get parameters from whatever input we need
$faq = FormUtil::getPassedValue('faq', isset($args['faq']) ? $args['faq'] : null, 'POST');
// Confirm authorisation code
if (!SecurityUtil::confirmAuthKey()) {
return LogUtil::registerAuthidError (pnModURL('FAQ', 'user', 'view'));
}
if (pnUserLoggedIn() || !isset($faq['submittedby'])) {
$faq['submittedby'] = '';
}
// Create the FAQ
$faqid = pnModAPIFunc('FAQ', 'admin', 'create',
array('question' => $faq['question'],
'answer' => '',
'submittedby' => $faq['submittedby']));
if ($faqid != false) {
// Success
LogUtil::registerStatus (_FAQ_CREATED);
}
return pnRedirect(pnModURL('FAQ', 'user', 'view'));
}

Source for file pnuser.php