Zikula_Core
[ class tree: Zikula_Core ] [ index: Zikula_Core ] [ all elements ]
Packages:
Zikula 1.0.1
axmls
PHPLayersMenu
PHPMailer
phpSniff
pnForm
PostNuke_Core
RC4Crypt
SafeHTML
Services_JSON
SimplePie
Smarty
Xanthia_Templating_Environment
XML_HTMLSax3
ZikulaTemplate_Plugins
Zikula_Core
Zikula_Docs
Zikula_System_Modules
Zikula_Template_Plugins
Zikula_Themes
Zikula_Value_Addons

Source for file CategoryRegistryUtil.class.php

Documentation is available at CategoryRegistryUtil.class.php

  1. <?php
  2. /**
  3.  * Zikula Application Framework
  4.  *
  5.  * @copyright Robert Gasch
  6.  * @link http://www.zikula.org
  7.  * @version $Id: CategoryRegistry.class.php 19257 2006-06-12 10:12:27Z rgasch $
  8.  * @license GNU/GPL - http://www.gnu.org/copyleft/gpl.html
  9.  * @author Robert Gasch rgasch@gmail.com
  10.  * @uses category utililty class
  11.  * @package Zikula_Core
  12.  * @subpackage CategoryRegistryUtil
  13.  */
  14.  
  15. /**
  16.  * CategoryRegistryUtil
  17.  *
  18.  * @package Zikula_Core
  19.  * @subpackage CategoryRegistryUtil
  20.  */
  21. class CategoryRegistryUtil
  22. {
  23.     /**
  24.      * Register a module category
  25.      *
  26.      * @param catreg    The array of category map data objects
  27.      *
  28.      * @return boolean The DB insert operation result code cast to a boolean
  29.      */
  30.     function registerModuleCategory ($catreg)
  31.     {
  32.         if (!$catreg)
  33.             return false;
  34.  
  35.         if (!pnModDBInfoLoad ('Categories'))
  36.             return false;
  37.  
  38.         if ($catreg['id'])
  39.             $res = DBUtil::updateObject ($catreg, 'categories_registry');
  40.         else
  41.             $res = DBUtil::insertObject ($catreg, 'categories_registry');
  42.  
  43.         return (boolean)$res;
  44.     }
  45.  
  46.  
  47.     /**
  48.      * Register module categories
  49.      *
  50.      * @param catregs    The array of category map data objects
  51.      *
  52.      * @return true 
  53.      */
  54.     function registerModuleCategories ($catregs)
  55.     {
  56.         if (!$catregs)
  57.             return false;
  58.  
  59.         if (!pnModDBInfoLoad ('Categories'))
  60.             return false;
  61.  
  62.         foreach ($catregs as $catreg)
  63.         {
  64.             if ($catreg['id'])
  65.                 $res = DBUtil::updateObject ($catreg, 'categories_registry');
  66.             else
  67.                 $res = DBUtil::insertObject ($catreg, 'categories_registry');
  68.         }
  69.  
  70.         return true;
  71.     }
  72.  
  73.  
  74.     /**
  75.      * Get registered Categories for a module
  76.      *
  77.      * @param modname    The module name
  78.      * @param tablename  The tablename for which we wish to get the property for
  79.      * 
  80.      * @return The associative field array of registered categories for the specified module
  81.      */
  82.     function getRegisteredModuleCategories ($modname, $tablename)
  83.     {
  84.         if (!$modname || !$tablename)
  85.             return pn_exit ("Invalid specs [$modname], [$tablename] received ...");
  86.  
  87.         if (!pnModDBInfoLoad ('Categories'))
  88.             return false;
  89.  
  90.         static $cache = array();
  91.         if (isset($cache[$modname][$tablename]))
  92.             return $cache[$modname][$tablename];
  93.  
  94.         $wheres   = array();
  95.         $pntables = pnDBGetTables();
  96.         $col      = $pntables['categories_registry_column'];
  97.         $wheres[] = "$col[modname]='".DataUtil::formatForStore($modname)."'";
  98.         $wheres[] = "$col[table]='".DataUtil::formatForStore($tablename)."'";
  99.         $where    = implode (' AND ', $wheres);
  100.         $sort     = "$col[id] ASC";
  101.         $fArr     = DBUtil::selectFieldArray ('categories_registry', 'category_id', $where, $sort, false, 'property');
  102.  
  103.         $cache[$modname][$tablename] = $fArr;
  104.         return $fArr;
  105.     }
  106.  
  107.  
  108.     /**
  109.      * Get registered category for module property
  110.      *
  111.      * @param modname    The module we wish to get the property for
  112.      * @param tablename  The tablename for which we wish to get the property for
  113.      * @param property   The property name
  114.      * @param default    The default value to return if the requested value is not set (optional) (default=null)
  115.      *
  116.      * @return The associative field array of registered categories for the specified module
  117.      */
  118.     function getRegisteredModuleCategory ($modname, $tablename, $property, $default=null)
  119.     {
  120.         if (!$modname || !$property)
  121.             return $default;
  122.  
  123.         $fArr = CategoryRegistryUtil::getRegisteredModuleCategories ($modname, $tablename);
  124.  
  125.         if ($fArr && isset($fArr[$property]) && $fArr[$property])
  126.             return $fArr[$property];
  127.  
  128.         // if we have a path default, we get the ID
  129.         if ($default && !is_integer($default))
  130.         {
  131.             if (!($class = Loader::loadClass('CategoryUtil')))
  132.                 return pn_exit ("Unable to load class [$ot] ...");
  133.  
  134.             $cat = CategoryUtil::getCategoryByPath ($default);
  135.             if ($cat)
  136.                 $default = $cat['id'];
  137.         }
  138.  
  139.         return $default;
  140.     }
  141.  
  142.  
  143.     /**
  144.      * Get the IDs of the property registers
  145.      *
  146.      * @param modname    The module name
  147.      * @param tablename  The tablename for which we wish to get the property for
  148.      * 
  149.      * @return The associative field array of register ids for the specified module
  150.      */
  151.     function getRegisteredModuleCategoriesIds ($modname, $tablename)
  152.     {
  153.         if (!$modname || !$tablename)
  154.             return pn_exit ("Invalid specs [$modname], [$tablename] received ...");
  155.  
  156.         if (!pnModDBInfoLoad ('Categories'))
  157.             return false;
  158.  
  159.         $wheres   = array();
  160.         $pntables = pnDBGetTables();
  161.         $col      = $pntables['categories_registry_column'];
  162.         $wheres[] = "$col[modname]='".DataUtil::formatForStore($modname)."'";
  163.         $wheres[] = "$col[table]='".DataUtil::formatForStore($tablename)."'";
  164.         $where    = implode (' AND ', $wheres);
  165.         $fArr     = DBUtil::selectFieldArray ('categories_registry', 'id', $where, '', false, 'property');
  166.  
  167.         return $fArr;
  168.     }
  169. }
Documentation generated on Fri, 18 Jul 2008 21:43:15 +0200 by phpDocumentor 1.4.1