File Source for function.pnformcategoryselector.php

<?php
/**
* Category selector plugin
*
* @copyright (c) 2006, Zikula Development Team
* @link http://www.zikula.org
* @version $Id: function.pnformtextinput.php 21046 2007-01-11 21:36:57Z jornlind $
* @license GNU/GPL - http://www.gnu.org/copyleft/gpl.html
* @author Jorn Wildt
* @package Zikula_Template_Plugins
* @subpackage Functions
*/
/** Make sure to use require_once() instead of Loader::requireOnce() since "function.pnformdropdownlist.php"
is loaded by Smarty (the base render class) with the use of require_once(). We do not want to
get in conflict with that.*/
require_once 'system/pnForm/plugins/function.pnformdropdownlist.php';
/**
* Category selector
*
* This plugin creates a category selector using a dropdown list.
* The selected value of the base dropdown list will be set to ID of the selected category.
*
* @package pnForm
* @subpackage Plugins
*/
class pnFormCategorySelector extends pnFormDropdownList
{
var $editLink;
var $category;
/**
* Enable inclusion of an empty null value element
* @var bool (default false)
*/
var $includeEmptyElement;
/**
* Enable save/load of values in separate __CATEGORIES_ field for use in DBUtil.
*
* If enabled then selected category is returned in a sub-array named __CATEGORIES__
* such that it can be used directly with DBUtils standard categorization of
* data items. Example code:
* <code>
* // Template:
* // Result:
* array('title' => 'Item title',
* '__CATEGORIES__' => array('myCat' => zzz)
* )
* </code>
* @var bool (default false)
*/
var $enableDBUtil;
function getFilename()
{
return __FILE__;
}
/* Shared by other category plugins */
/* static */ function loadParameters(&$list, $includeEmptyElement, $params)
{
$list->category = isset($params['category']) ? $params['category'] : 0;
$path = isset($params['path']) ? $params['path'] : '';
$pathfield = isset($params['pathfield']) ? $params['pathfield'] : 'path';
$lang = isset($params['lang']) ? $params['lang'] : pnUserGetLang();
$recurse = isset($params['recurse']) ? $params['recurse'] : true;
$relative = isset($params['relative']) ? $params['relative'] : true;
$includeRoot = isset($params['includeRoot']) ? $params['includeRoot'] : false;
$includeLeaf = isset($params['includeLeaf']) ? $params['includeLeaf'] : true;
$all = isset($params['all']) ? $params['all'] : false;
$list->editLink = isset($params['editLink']) ? $params['editLink'] : true;
Loader::loadClass('CategoryUtil');
$allCats = array();
// if we don't have a category-id we see if we can get a category by path
if (!$list->category && $path) {
$list->category = CategoryUtil::getCategoryByPath ($path, $pathfield);
$allCats = CategoryUtil::getSubCategoriesForCategory ($list->category, $recurse, $relative, $includeRoot,
$includeLeaf, $all);
}
else
// check if we have an actual category object with a numeric ID set
if (is_array($list->category) && isset($list->category['id']) && is_integer($list->category['id'])) {
$allCats = CategoryUtil::getSubCategoriesForCategory ($list->category, $recurse, $relative, $includeRoot,
$includeLeaf, $all);
}
else
// check if we have a numeric category
if (is_numeric($list->category)) {
$list->category = CategoryUtil::getCategoryByID ($list->category);
$allCats = CategoryUtil::getSubCategoriesForCategory ($list->category, $recurse, $relative, $includeRoot,
$includeLeaf, $all);
}
else
// check if we have a string/path category
if (is_string($list->category) && strpos($list->category, '/')===0) {
$list->category = CategoryUtil::getCategoryByPath ($list->category, $pathfield);
$allCats = CategoryUtil::getSubCategoriesForCategory ($list->category, $recurse, $relative, $includeRoot,
$includeLeaf, $all);
}
if ($list->mandatory)
$list->addItem('- - -', null);
$line = '- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -';
if ($includeEmptyElement)
$list->addItem('', null);
foreach ($allCats as $cat)
{
$cslash = StringUtil::countInstances (isset($cat['ipath_relative']) ? $cat['ipath_relative'] : $cat['ipath'], '/');
$indent = '';
if ($cslash > 0)
$indent = '| ' . substr ($line, 0, $cslash*2);
$list->addItem($indent . ' ' . (isset($cat['display_name'][$lang]) ? $cat['display_name'][$lang] : $cat['name']), $cat['id']);
}
}
function load(&$render, $params)
{
$this->enableDBUtil = (isset($params['enableDBUtil']) ? $params['enableDBUtil'] : false);
pnFormCategorySelector::loadParameters($this, $this->includeEmptyElement, $params);
parent::load($render, $params);
}
function render(&$render)
{
$result = parent::render($render);
if ($this->editLink && !empty($this->category)
&& SecurityUtil::checkPermission( 'Categories::', "$this->category[id]::", ACCESS_EDIT))
{
$url = DataUtil::formatForDisplay(pnModURL ('Categories', 'user', 'edit', array('dr' => $this->category['id'])));
$result .= "  <a href=\"$url\"><img src=\"images/icons/extrasmall/xedit.gif\" title=\"" . _EDIT . '" alt="' . _EDIT . '" /></a>';
}
return $result;
}
function saveValue(&$render, &$data)
{
if ($this->enableDBUtil && $this->dataBased)
{
if ($this->group == null)
{
$data['__CATEGORIES__'][$this->dataField] = $this->getSelectedValue();
}
else
{
if (!array_key_exists($this->group, $data))
$data[$this->group] = array();
$data[$this->group]['__CATEGORIES__'][$this->dataField] = $this->getSelectedValue();
}
}
else
parent::saveValue($render, $data);
}
function loadValue(&$render, &$values)
{
if ($this->enableDBUtil && $this->dataBased)
{
$items = null;
$value = null;
if ($this->group == null)
{
if ($this->dataField != null && isset($values['__CATEGORIES__'][$this->dataField]))
$value = $values['__CATEGORIES__'][$this->dataField];
if ($this->itemsDataField != null && isset($values[$this->itemsDataField]))
$items = $values[$this->itemsDataField];
}
else
{
if (isset($values[$this->group]))
{
$data = $values[$this->group];
if (isset($data['__CATEGORIES__'][$this->dataField]))
{
$value = $data['__CATEGORIES__'][$this->dataField];
if ($this->itemsDataField != null && isset($data[$this->itemsDataField]))
$items = $data[$this->itemsDataField];
}
}
}
if ($items != null)
$this->setItems($items);
$this->setSelectedValue($value);
}
else
parent::loadValue($render, $values);
}
}
function smarty_function_pnformcategoryselector($params, &$render)
{
return $render->pnFormRegisterPlugin('pnFormCategorySelector', $params);
}

Source for file function.pnformcategoryselector.php