File Source for pnadminapi.php

<?php
/**
* Zikula Application Framework
*
* @copyright (c) 2002, Zikula Development Team
* @link http://www.zikula.org
* @version $Id: pnadminapi.php 24342 2008-06-06 12:03:14Z markwest $
* @license GNU/GPL - http://www.gnu.org/copyleft/gpl.html
* @package Zikula_Value_Addons
* @subpackage HitCount
*/
/**
* create a new hitcount item (= create hook for type 'item')
*
* @param $args['objectid'] ID of the object
* @param $args['extrainfo'] extra information
* @param $args['modname'] name of the calling module (not used in hook calls)
* @param $args['hits'] optional hit count for the item (not used in hook calls)
* @return mixed hitcount item ID on success, void on failure
*/
function hitcount_adminapi_create($args)
{
if (!isset($args['objectid']) || !is_numeric($args['objectid'])) {
return LogUtil::registerError (_MODARGSERROR);
}
// When called via hooks, modname wil be empty, but we get it from the
// current module
if (empty($args['modname'])) {
$args['modname'] = pnModGetName();
}
$modid = pnModGetIDFromName($args['modname']);
if (empty($modid)) {
return LogUtil::registerError (_MODARGSERROR);
}
// TODO: re-evaluate this for hook calls !!
// Security check - important to do this as early on as possible to
// avoid potential security holes or just too much wasted processing
if (!SecurityUtil::checkPermission( 'Hitcount::', "$args[modname]::$args[objectid]", ACCESS_READ)) {
return LogUtil::registerPermissionError();
}
// Create new hitcount
if (!isset($args['hits']) || !is_numeric($args['hits'])) {
$args['hits'] = 0;
}
$hitcount = array();
$hitcount['moduleid'] = (int)$modid;
$hitcount['itemid'] = (int)$args['objectid'];
$hitcount['hits'] = (int)$args['hits'];
$res = DBUtil::insertObject ($hitcount, 'hitcount', 'hitcountid');
if ($res === false) {
return LogUtil::registerError (_CREATEFAILED);
}
// hmmm, I think we'll skip calling more hooks here... :-)
//pnModCallHooks('item', 'create', $hcid, 'hitcountid');
// Return the id of the newly created item to the calling process
// (not that this will be of any used when called via hooks, but
// who knows where else this might be used)
return $hitcount['hitcountid'];
}
/**
* delete a hitcount item (delete hook for type 'item')
*
* @param $args['objectid'] ID of the object
* @param $args['extrainfo'] extra information
* @param $args['modname'] name of the calling module (not used in hook calls)
* @return bool true on success, false on failure
*/
function hitcount_adminapi_delete($args)
{
if (!isset($args['objectid']) || !is_numeric($args['objectid'])) {
return LogUtil::registerError (_MODARGSERROR);
}
// When called via hooks, modname wil be empty, but we get it from the
// current module
if (empty($args['modname'])) {
$args['modname'] = pnModGetName();
}
$modid = pnModGetIDFromName($args['modname']);
if (empty($modid)) {
return LogUtil::registerError (_MODARGSERROR);
}
// TODO: re-evaluate this for hook calls !!
// Security check - important to do this as early on as possible to
// avoid potential security holes or just too much wasted processing
if (!SecurityUtil::checkPermission( 'Hitcount::', "$args[modname]::$args[objectid]", ACCESS_DELETE)) {
return LogUtil::registerPermissionError();
}
$where = "WHERE pn_moduleid = '" . (int)DataUtil::formatForStore($modid) . "'
AND pn_itemid = '" . (int)DataUtil::formatForStore($args['objectid']) . "'";
$res = DBUtil::deleteWhere ('hitcount', $where);
if ($res === false) {
return LogUtil::registerError (_DELETEFAILED);
}
// hmmm, I think we'll skip calling more hooks here... :-)
//pnModCallHooks('item', 'delete', $exid, '');
// Let the calling process know that we have finished successfully
return true;
}
/**
* update a hitcount item (used by display hook hitcount_user_display)
*
* @param $args['modname'] name of the calling module (see _user_display)
* @param $args['objectid'] ID of the object
* @param $args['extrainfo'] extra information (unused here)
* @param $args['hits'] (optional) hit count for the item
* @return mixed the new hitcount for this item, or void on failure
*/
function hitcount_adminapi_update($args)
{
if (!isset($args['objectid']) || !is_numeric($args['objectid'])) {
return LogUtil::registerError (_MODARGSERROR);
}
// When called via hooks, modname wil be empty, but we get it from the
// current module
if (empty($args['modname'])) {
$args['modname'] = pnModGetName();
}
$modid = pnModGetIDFromName($args['modname']);
if (empty($modid)) {
return LogUtil::registerError (_MODARGSERROR);
}
// TODO: re-evaluate this for hook calls !!
// Security check - important to do this as early on as possible to
// avoid potential security holes or just too much wasted processing
if (!SecurityUtil::checkPermission( 'Hitcount::', "$args[modname]::$args[objectid]", ACCESS_READ)) {
return LogUtil::registerPermissionError();
}
// get current hit count
$result = pnModAPIFunc('hitcount', 'user', 'get',
array('objectid' => $args['objectid'],
'modname' => $args['modname']));
// create the item if necessary
if (!$result) {
$hcid = pnModAPIFunc('hitcount','admin','create',
array('objectid' => $args['objectid'],
'modname' => $args['modname']));
if (!isset($hcid)) {
return; // throw back whatever it was that failed
}
$oldhits = 0;
} else {
$oldhits = $result['hits'];
}
$pntable = pnDBGetTables();
$hitcounttable = $pntable['hitcount'];
// set to the new hit count
if (!empty($args['hits']) && is_numeric($args['hits'])) {
$sql = "UPDATE $hitcounttable
SET pn_hits = '" . (int)DataUtil::formatForStore($args['hits']) . "'
WHERE pn_moduleid = '" . (int)DataUtil::formatForStore($modid) . "'
AND pn_itemid = '" . (int)DataUtil::formatForStore($args['objectid']) . "'";
} else {
$sql = "UPDATE $hitcounttable
SET pn_hits = pn_hits + 1
WHERE pn_moduleid = '" . (int)DataUtil::formatForStore($modid) . "'
AND pn_itemid = '" . (int)DataUtil::formatForStore($args['objectid']) . "'";
$args['hits'] = $oldhits + 1;
}
$res = DBUtil::executeSQL ($sql);
if ($res === false) {
return LogUtil::registerError (_CREATEFAILED);
}
// Return the new hitcount (give or take a few other hits in the meantime)
return $args['hits'];
}
/**
* clean up hits for a removed module
*
* @param $args['extrainfo'] array extrainfo array
* @return array extrainfo array
*/
function HitCount_adminapi_remove($args)
{
// optional arguments
if (!isset($args['extrainfo'])) {
$args['extrainfo'] = array();
}
// When called via hooks, the module name may be empty, so we get it from
// the current module
if (empty($args['extrainfo']['module'])) {
$modname = pnModGetName();
} else {
$modname = $args['extrainfo']['module'];
}
// Database information
$dbconn = pnDBGetConn(true);
$pntable = pnDBGetTables();
$hitcounttable = $pntable['hitcount'];
// Get items
$res = DBUtil::deleteObjectByID ('hitcount', pnModGetIDFromName($modname), 'moduleid');
if ($res === false) {
return LogUtil::registerError (_DELETEFAILED);
}
return $args['extrainfo'];
}

Source for file pnadminapi.php