<?php
// $Id: function.pnmodapifunc.php,v 1.6 2004/07/30 12:50:36 jorg Exp $
// ----------------------------------------------------------------------
// PostNuke Content Management System
// Copyright (C) 2002 by the PostNuke Development Team.
// http://www.postnuke.com/
// ----------------------------------------------------------------------
// Based on:
// PHP-NUKE Web Portal System - http://phpnuke.org/
// Thatware - http://thatware.org/
// ----------------------------------------------------------------------
// LICENSE
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License (GPL)
// as published by the Free Software Foundation; either version 2
// of the License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// To read the license please visit http://www.gnu.org/copyleft/gpl.html
// ----------------------------------------------------------------------
/**
 * pnRender plugin
 * 
 * This file is a plugin for pnRender, the PostNuke implementation of Smarty
 *
 * @package      Xanthia_Templating_Environment
 * @subpackage   pnRender
 * @version      $Id: function.pnmodapifunc.php,v 1.6 2004/07/30 12:50:36 jorg Exp $
 * @author       The PostNuke development team
 * @link         http://www.postnuke.com  The PostNuke Home Page
 * @copyright    Copyright (C) 2002 by the PostNuke Development Team
 * @license      http://www.gnu.org/copyleft/gpl.html GNU General Public License
 */ 

 
/**
 * Smarty function to to execute a module API function
 * 
 * This function calls a calls a specific module API function. It returns whatever the return 
 * value of the resultant function is if it succeeds. 
 * Note that in contrast to the API function pnModAPIFunc you need not to load the
 * module API with pnModAPILoad.
 * 
 * 
 * Available parameters:
 *   - modname:  The well-known name of a module to execute a function from (required)
 *   - type:     The type of function to execute; currently one of 'user' or 'admin' (default is 'user')
 *   - func:     The name of the module function to execute (default is 'main')
 *   - assign:   The name of a variable to which the results are assigned
 *   - all remaining parameters are passed to the module API function
 * 
 * Examples
 *   <!--[pnmodfunc modname="News"  type="user" func="getarticles" id="3"]-->
 * 
 *   <!--[pnmodapifunc modname="foobar" type="user" func="getfoo" id="1" assign="myfoo"]-->
 *   <!--[myfoo.title]-->
 * 
 * 
 * @author       Andreas Stratmann
 * @author       Jörg Napp
 * @since        03/05/23
 * @see          function.pnmodfunc.php::smarty_function_pnmodfunc()
 * @param        array       $params      All attributes passed to this function from the template
 * @param        object      &$smarty     Reference to the Smarty object
 * @return       string      the results of the module API function
 */
function smarty_function_pnmodapifunc($params, &$smarty) 
{
    extract($params); 

    unset($params['modname']);
    unset($params['type']);
    unset($params['func']);
    unset($params['assign']);
        
    if (!isset($modname)) {
        $smarty->trigger_error("pnmodapifunc:  parameter 'modname' required");
        return false;
    }    

    if (!isset($type)) {
        $type='user';
    }
    if (!isset($func)) {
        $func='main';
    }

    if (!pnModAPILoad($modname, $type)) {        
        $smarty->trigger_error('pnmodapifunc:  could not load module API');
        return false;
    }

    $result = pnModAPIFunc($modname, $type, $func, $params);

    if (isset($assign)) {
        $smarty->assign($assign, $result);
    } else {
        return $result;        
    }      

}
?>