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 Feeds
*/
/**
* 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)
*/
function feeds_user_main()
{
// Security check
if (!SecurityUtil::checkPermission( 'Feeds::', '::', ACCESS_READ)) {
return LogUtil::registerPermissionError();
}
// Create output object
$pnRender = pnRender::getInstance('Feeds');
$enablecategorization = pnModGetVar('Feeds', 'enablecategorization');
if ($enablecategorization) {
if (!($class = Loader::loadClass ('CategoryRegistryUtil'))) {
pn_exit (pnML('_UNABLETOLOADCLASS', array('s' => 'CategoryRegistryUtil')));
}
// get the categories registered for the Pages
$catregistry = CategoryRegistryUtil::getRegisteredModuleCategories('Feeds', 'feeds');
$properties = array_keys($catregistry);
// Assign some useful vars to customize the main
$pnRender->assign('properties', $properties);
}
// Assign the module vars
$pnRender->assign('enablecategorization', $enablecategorization);
// Return the output that has been generated by this function
return $pnRender->fetch('feeds_user_main.htm');
}
/**
* view items
* This is a standard function to provide an overview of all of the items
* available from the module.
*/
function feeds_user_view()
{
// Security check
if (!SecurityUtil::checkPermission( 'Feeds::', '::', ACCESS_OVERVIEW)) {
return LogUtil::registerPermissionError();
}
// Get parameters from whatever input we need.
$startnum = (int)FormUtil::getPassedValue('startnum', isset($args['startnum']) ? $args['startnum'] : 1, 'GET');
$prop = (string)FormUtil::getPassedValue('prop', isset($args['prop']) ? $args['prop'] : null, 'GET');
$cat = (string)FormUtil::getPassedValue('cat', isset($args['cat']) ? $args['cat'] : null, 'GET');
// defaults and input validation
if (!is_numeric($startnum) || $startnum < 0) {
$startnum = 1;
}
// get all module vars for later use
$modvars = pnModGetVar('Feeds');
// check if categorisation is enabled
if ($modvars['enablecategorization']) {
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('Feeds', 'feeds');
$props = array_keys($catregistry);
// validate the property
if (empty($prop) || !in_array($prop, $props)) {
$prop = $props[0];
}
// if the property and the category are specified
// means that we'll list the feeds that belongs to that category
if (!empty($cat)) {
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 {
return LogUtil::registerError(_NOTAVALIDCATEGORY);
}
// if nothing or only property is specified
// means that we'll list the subcategories available on that property
} else {
$rootCat = CategoryUtil::getCategoryByID($catregistry[$prop]);
$rootCat['path'] .= '/'; // add this to make the relative paths of the subcategories with ease
$categories = CategoryUtil::getCategoriesByParentID($rootCat['id']);
}
}
// Create output object
$pnRender = pnRender::getInstance('Feeds');
// List of subcategories
if (!isset($catFilter) && $modvars['enablecategorization']) {
//Assign the action to perform
$pnRender->assign('action', 'subcatslist');
// Assign the data to display
$pnRender->assign('rootCat', $rootCat);
$pnRender->assign('property', $prop);
$pnRender->assign('categories', $categories);
// List of Feeds
// of an specific category if enabledcategorization
} else {
//Assign the action to perform
$pnRender->assign('action', 'feedslist');
if ($modvars['enablecategorization']) {
// Assign the data to display
$pnRender->assign('category', $cat);
}
// Get all matching feeds
$items = pnModAPIFunc('Feeds', 'user', 'getall',
array('startnum' => $startnum,
'numitems' => $modvars['itemsperpage'],
'category' => isset($catFilter) ? $catFilter : null,
'catregistry' => isset($catregistry) ? $catregistry : null));
if ($items == false) {
LogUtil::registerStatus (_NOITEMSFOUND);
}
// assign the values for the smarty plugin to produce a pager
$pnRender->assign('pager', array('numitems' => pnModAPIFunc('Feeds', 'user', 'countitems', array('category' => isset($catFilter) ? $catFilter : null)),
'itemsperpage' => $modvars['itemsperpage']));
// assign the items to the template
$pnRender->assign('items', $items);
}
// assign various useful template variables
$pnRender->assign('startnum', $startnum);
$pnRender->assign('lang', pnUserGetLang());
$pnRender->assign($modvars);
$pnRender->assign('shorturls', pnConfigGetVar('shorturls'));
$pnRender->assign('shorturlstype', pnConfigGetVar('shorturlstype'));
// Return the output that has been generated by this function
return $pnRender->fetch('feeds_user_view.htm');
}
/**
* display item
* This is a standard function to provide detailed informtion on a single item
* available from the module.
*/
function feeds_user_display($args)
{
$fid = FormUtil::getPassedValue('fid', isset($args['fid']) ? $args['fid'] : null, 'GET');
$title = FormUtil::getPassedValue('title', isset($args['title']) ? $args['title'] : null, 'REQUEST');
$objectid = FormUtil::getPassedValue('objectid', isset($args['objectid']) ? $args['objectid'] : null, 'GET');
if (!empty($objectid)) {
$fid = $objectid;
}
// Create output object
$pnRender = pnRender::getInstance('Feeds');
// Define the cache id
if (isset($fid) && is_numeric($fid)) {
$pnRender->cache_id = $fid;
} else {
$pnRender->cache_id = $title;
}
// check out if the contents are cached.
if ($pnRender->is_cached('feeds_user_display.htm')) {
return $pnRender->fetch('feeds_user_display.htm');
}
// Get the feed
if (isset($fid) && is_numeric($fid)) {
$item = pnModAPIFunc('Feeds', 'user', 'get', array('fid' => $fid));
} else {
$item = pnModAPIFunc('Feeds', 'user', 'get', array('title' => $title));
}
if ($item == false) {
return DataUtil::formatForDisplayHTML(_GETFAILED);
}
// read the feed source
$feed = pnModAPIFunc('Feeds', 'user', 'getfeed', array('fid' => $item['fid']));
// Assign the module vars
$pnRender->assign(pnModGetVar('Feeds'));
// Display details of the item.
$pnRender->assign('item', $item);
$pnRender->assign('feed', $feed);
// Return the output that has been generated by this function
return $pnRender->fetch('feeds_user_display.htm');
}

Source for file pnuser.php