Overview

Packages

  • Auth
    • Ads
    • Ldap
    • Xoops
  • Autotasks
  • Config
    • Category
    • Item
    • Option
  • Core
    • Filesystem
    • Filters
    • Logger
    • Mail
    • Message
    • Password
    • Security
    • StopSpammer
    • Template
    • Textsanitizer
    • VersionChecker
  • Data
    • Avatar
    • Comment
  • Database
    • Connection
    • Criteria
    • Legacy
    • MySQL
    • PDO
    • Updater
  • Feeds
    • RSS
  • File
  • Form
    • Base
    • Elements
  • ICMS
    • IPF
      • View
  • Image
    • Category
  • Ipf
    • Category
    • Controller
    • Export
    • form
    • Keyhighlighter
    • Member
    • Object
    • Permission
    • richfile
    • Tree
    • urllink
    • View
  • kernel
    • Set
  • Member
    • Group
    • GroupMembership
    • GroupPermission
    • User
  • Messaging
  • Module
  • None
  • Notification
  • Page
  • Plugins
    • Editor
  • Preload
    • Libraries
  • Privmessage
  • Session
  • SmartObject
  • View
    • Block
    • Breadcrumb
    • PageNav
    • PrinterFriendly
    • Template
    • Templates
    • Theme
    • Tree

Classes

  • icms_auth_Ads
  • icms_auth_Factory
  • icms_auth_Ldap
  • icms_auth_Object
  • icms_auth_Provisionning
  • icms_auth_Xoops
  • icms_Autoloader
  • icms_config_category_Handler
  • icms_config_category_Object
  • icms_config_Handler
  • icms_config_Item_Handler
  • icms_config_Item_Object
  • icms_config_option_Handler
  • icms_config_option_Object
  • icms_core_DataFilter
  • icms_core_Debug
  • icms_core_Filesystem
  • icms_core_HTMLFilter
  • icms_core_Logger
  • icms_core_Message
  • icms_core_Object
  • icms_core_ObjectHandler
  • icms_core_OnlineHandler
  • icms_core_Password
  • icms_core_Security
  • icms_core_Session
  • icms_core_StopSpammer
  • icms_core_Textsanitizer
  • icms_core_Versionchecker
  • icms_data_avatar_Handler
  • icms_data_avatar_Object
  • icms_data_comment_Handler
  • icms_data_comment_Object
  • icms_data_comment_Renderer
  • icms_data_file_Handler
  • icms_data_file_Object
  • icms_data_notification_Handler
  • icms_data_notification_Object
  • icms_data_page_Handler
  • icms_data_page_Object
  • icms_data_privmessage_Handler
  • icms_data_privmessage_Object
  • icms_data_urllink_Handler
  • icms_data_urllink_Object
  • icms_db_Connection
  • icms_db_criteria_Compo
  • icms_db_criteria_Element
  • icms_db_criteria_Item
  • icms_db_Factory
  • icms_db_legacy_Database
  • icms_db_legacy_Factory
  • icms_db_legacy_mysql_Database
  • icms_db_legacy_mysql_Proxy
  • icms_db_legacy_mysql_Safe
  • icms_db_legacy_mysql_Utility
  • icms_db_legacy_PdoDatabase
  • icms_db_legacy_updater_Handler
  • icms_db_legacy_updater_Table
  • icms_db_mysql_Connection
  • icms_db_mysql_Utility
  • icms_Event
  • icms_feeds_Rss
  • icms_feeds_Simplerss
  • icms_file_DownloadHandler
  • icms_file_MediaUploadHandler
  • icms_file_TarDownloader
  • icms_file_TarFileHandler
  • icms_file_ZipDownloader
  • icms_file_ZipFileHandler
  • icms_form_Base
  • icms_form_Element
  • icms_form_elements_Button
  • icms_form_elements_Captcha
  • icms_form_elements_captcha_Image
  • icms_form_elements_captcha_ImageHandler
  • icms_form_elements_captcha_Object
  • icms_form_elements_captcha_Text
  • icms_form_elements_Checkbox
  • icms_form_elements_Colorpicker
  • icms_form_elements_Date
  • icms_form_elements_Datetime
  • icms_form_elements_Dhtmltextarea
  • icms_form_elements_Editor
  • icms_form_elements_File
  • icms_form_elements_Groupperm
  • icms_form_elements_Hidden
  • icms_form_elements_Hiddentoken
  • icms_form_elements_Label
  • icms_form_elements_Password
  • icms_form_elements_Radio
  • icms_form_elements_Radioyn
  • icms_form_elements_Select
  • icms_form_elements_select_Country
  • icms_form_elements_select_Editor
  • icms_form_elements_select_Group
  • icms_form_elements_select_Image
  • icms_form_elements_select_Lang
  • icms_form_elements_select_Matchoption
  • icms_form_elements_select_Theme
  • icms_form_elements_select_Timezone
  • icms_form_elements_select_User
  • icms_form_elements_Text
  • icms_form_elements_Textarea
  • icms_form_elements_Tray
  • icms_form_Groupperm
  • icms_form_Simple
  • icms_form_Table
  • icms_form_Theme
  • icms_image_category_Handler
  • icms_image_category_Object
  • icms_image_Handler
  • icms_image_Object
  • icms_image_set_Handler
  • icms_image_set_Object
  • icms_ipf_About
  • icms_ipf_category_Handler
  • icms_ipf_category_Object
  • icms_ipf_Controller
  • icms_ipf_export_Handler
  • icms_ipf_export_Renderer
  • icms_ipf_form_Base
  • icms_ipf_form_elements_Autocomplete
  • icms_ipf_form_elements_Blockoptions
  • icms_ipf_form_elements_Checkbox
  • icms_ipf_form_elements_Date
  • icms_ipf_form_elements_Datetime
  • icms_ipf_form_elements_File
  • icms_ipf_form_elements_Fileupload
  • icms_ipf_form_elements_Image
  • icms_ipf_form_elements_Imageupload
  • icms_ipf_form_elements_Language
  • icms_ipf_form_elements_Page
  • icms_ipf_form_elements_Parentcategory
  • icms_ipf_form_elements_Passwordtray
  • icms_ipf_form_elements_Radio
  • icms_ipf_form_elements_Richfile
  • icms_ipf_form_elements_Section
  • icms_ipf_form_elements_Select
  • icms_ipf_form_elements_Selectmulti
  • icms_ipf_form_elements_Signature
  • icms_ipf_form_elements_Source
  • icms_ipf_form_elements_Text
  • icms_ipf_form_elements_Time
  • icms_ipf_form_elements_Upload
  • icms_ipf_form_elements_Urllink
  • icms_ipf_form_elements_User
  • icms_ipf_form_elements_Yesno
  • icms_ipf_form_Secure
  • icms_ipf_Handler
  • icms_ipf_Highlighter
  • icms_ipf_member_Handler
  • icms_ipf_Metagen
  • icms_ipf_Object
  • icms_ipf_permission_Handler
  • icms_ipf_registry_Handler
  • icms_ipf_seo_Object
  • icms_ipf_Tree
  • icms_ipf_view_Column
  • icms_ipf_view_Row
  • icms_ipf_view_Single
  • icms_ipf_view_Table
  • icms_ipf_view_Tree
  • icms_member_group_Handler
  • icms_member_group_membership_Handler
  • icms_member_group_membership_Object
  • icms_member_group_Object
  • icms_member_groupperm_Handler
  • icms_member_groupperm_Object
  • icms_member_Handler
  • icms_member_user_Handler
  • icms_member_user_Object
  • icms_messaging_EmailHandler
  • icms_messaging_Handler
  • icms_module_Handler
  • icms_module_Object
  • icms_plugins_EditorHandler
  • icms_plugins_Handler
  • icms_plugins_Object
  • icms_preload_Handler
  • icms_preload_Item
  • icms_preload_LibrariesHandler
  • icms_sys_autotasks_System
  • icms_Utils
  • icms_view_block_Handler
  • icms_view_block_Object
  • icms_view_block_position_Handler
  • icms_view_block_position_Object
  • icms_view_Breadcrumb
  • icms_view_PageBuilder
  • icms_view_PageNav
  • icms_view_Printerfriendly
  • icms_view_template_file_Handler
  • icms_view_template_file_Object
  • icms_view_template_set_Handler
  • icms_view_template_set_Object
  • icms_view_theme_Factory
  • icms_view_theme_Object
  • icms_view_Tpl
  • icms_view_Tree

Interfaces

  • icms_db_IConnection
  • icms_db_IUtility
  • icms_db_legacy_IDatabase
  • icms_sys_autotasks_ISystem
  • Overview
  • Package
  • Class
  1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294: 295: 296: 297: 298: 299: 300: 301: 302: 303: 304: 305: 306: 307: 308: 309: 310: 311: 312: 313: 314: 315: 316: 317: 318: 319: 320: 321: 322: 323: 324: 325: 326: 327: 328: 329: 330: 331: 332: 333: 334: 335: 336: 337: 338: 339: 340: 341: 342: 343: 
<?php
//  ------------------------------------------------------------------------ //
//                XOOPS - PHP Content Management System                      //
//                    Copyright (c) 2000 XOOPS.org                           //
//                       <http://www.xoops.org/>                             //
//  ------------------------------------------------------------------------ //
//  This program is free software; you can redistribute it and/or modify     //
//  it under the terms of the GNU General Public License as published by     //
//  the Free Software Foundation; either version 2 of the License, or        //
//  (at your option) any later version.                                      //
//                                                                           //
//  You may not change or alter any portion of this comment or credits       //
//  of supporting developers from this source code or any supporting         //
//  source code which is considered copyrighted (c) material of the          //
//  original comment or credit authors.                                      //
//                                                                           //
//  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.                             //
//                                                                           //
//  You should have received a copy of the GNU General Public License        //
//  along with this program; if not, write to the Free Software              //
//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA //
//  ------------------------------------------------------------------------ //
// Author: Kazumi Ono (AKA onokazu)                                          //
// URL: http://www.myweb.ne.jp/, http://www.xoops.org/, http://jp.xoops.org/ //
// Project: The XOOPS Project                                                //
// ------------------------------------------------------------------------- //
/**
 * Manage of Image categories
 *
 * @copyright   http://www.impresscms.org/ The ImpressCMS Project
 * @license     LICENSE.txt
 * @category    ICMS
 * @package     Image
 * @subpackage  Category
 * @version     SVN: $Id: Handler.php 12313 2013-09-15 21:14:35Z skenow $
 */
defined('ICMS_ROOT_PATH') or die("ImpressCMS root path not defined");

/**
 * Image caetgory handler class.
 * This class is responsible for providing data access mechanisms to the data source
 * of image category class objects.
 *
 * @category    ICMS
 * @package     Image
 * @subpackage  Category
 * @author      Kazumi Ono <onokazu@xoops.org>
 * @copyright   Copyright (c) 2000 XOOPS.org
 */
class icms_image_category_Handler extends icms_core_ObjectHandler {

    /**
     * Creates a new image category
     *
     * @param bool $isNew is the new image category new??
     * @return object $imgcat {@link icms_image_category_Object} reference to the new image category
     **/
    public function &create($isNew = true) {
        $imgcat = new icms_image_category_Object();
        if ($isNew) {
            $imgcat->setNew();
        }
        return $imgcat;
    }

    /**
     * retrieve a specific {@link icms_image_category_Object}
     *
     * @see icms_image_category_Object
     * @param integer $id imgcatID (imgcat_id) of the image category
     * @return object icms_image_category_Object reference to the image category
     **/
    public function &get($id) {
        $id = (int) ($id);
        $imgcat = false;
        if ($id > 0) {
            $sql = "SELECT * FROM ".$this->db->prefix('imagecategory') . " WHERE imgcat_id='" . $id . "'";
            if (!$result = $this->db->query($sql)) {
                return $imgcat;
            }
            $numrows = $this->db->getRowsNum($result);
            if ($numrows == 1) {
                $imgcat = new icms_image_category_Object();
                $imgcat->assignVars($this->db->fetchArray($result));
            }
        }
        return $imgcat;
    }

    /**
     * Insert a new {@link icms_image_category_Object} into the database
     *
     * @param object icms_image_category_Object $imgcat reference to the image category to insert
     * @return bool TRUE if succesful
     **/
    public function insert(&$imgcat) {
        /* As of PHP 5.3, is_a is no longer deprecated, this is an acceptable usage
         * and is compatible with more versions of PHP.  http://us2.php.net/manual/en/language.operators.type.php
         */
        if (!is_a($imgcat, 'icms_image_category_Object')) {
            return false;
        }

        if (!$imgcat->isDirty()) {
            return true;
        }
        if (!$imgcat->cleanVars()) {
            return false;
        }
        foreach ( $imgcat->cleanVars as $k => $v) {
            ${$k} = $v;
        }
        if ($imgcat->isNew()) {
            $imgcat_id = $this->db->genId('imgcat_imgcat_id_seq');
            $sql = sprintf("INSERT INTO %s (imgcat_id, imgcat_pid, imgcat_name, imgcat_foldername, imgcat_display, imgcat_weight, imgcat_maxsize, imgcat_maxwidth, imgcat_maxheight, imgcat_type, imgcat_storetype) VALUES ('%u', '%u', %s, %s, '%u', '%u', '%u', '%u', '%u', %s, %s)",
                $this->db->prefix('imagecategory'),
                (int) $imgcat_id,
                (int) $imgcat_pid,
                $this->db->quoteString($imgcat_name),
                $this->db->quoteString($imgcat_foldername),
                (int) $imgcat_display,
                (int) $imgcat_weight,
                (int) $imgcat_maxsize,
                (int) $imgcat_maxwidth,
                (int) $imgcat_maxheight,
                $this->db->quoteString($imgcat_type),
                $this->db->quoteString($imgcat_storetype)
            );
        } else {
            $sql = sprintf("UPDATE %s SET imgcat_pid = %u, imgcat_name = %s, imgcat_foldername = %s, imgcat_display = '%u', imgcat_weight = '%u', imgcat_maxsize = '%u', imgcat_maxwidth = '%u', imgcat_maxheight = '%u', imgcat_type = %s WHERE imgcat_id = '%u'",
                $this->db->prefix('imagecategory'),
                (int) $imgcat_pid,
                $this->db->quoteString($imgcat_name),
                $this->db->quoteString($imgcat_foldername),
                (int) $imgcat_display,
                (int) $imgcat_weight,
                (int) $imgcat_maxsize,
                (int) $imgcat_maxwidth,
                (int) $imgcat_maxheight,
                $this->db->quoteString($imgcat_type),
                (int) $imgcat_id
            );
        }
        if (!$result = $this->db->query($sql)) {
            return false;
        }
        if (empty($imgcat_id)) {
            $imgcat_id = $this->db->getInsertId();
        }
        $imgcat->assignVar('imgcat_id', $imgcat_id);
        return true;
    }

    /**
     * delete an {@link icms_image_category_Object} from the database
     *
     * @param object icms_image_category_Object $imgcat reference to the image category to delete
     * @return bool TRUE if succesful
     **/
    public function delete(&$imgcat) {
        /* As of PHP 5.3, is_a is no longer deprecated, this is an acceptable usage
         * and is compatible with more versions of PHP. http://us2.php.net/manual/en/language.operators.type.php
         */
        if (!is_a($imgcat, 'icms_image_category_Object')) {
            return false;
        }

        $sql = sprintf("DELETE FROM %s WHERE imgcat_id = '%u'", $this->db->prefix('imagecategory'), (int) ($imgcat->getVar('imgcat_id')));
        if (!$result = $this->db->query($sql)) {
            return false;
        }
        return true;
    }

    /**
     * retrieve array of {@link icms_image_category_Object}s meeting certain conditions
     * @param object $criteria {@link icms_db_criteria_Element} with conditions for the image categories
     * @param bool $id_as_key should the image category's imgcat_id be the key for the returned array?
     * @return array {@link icms_image_category_Object}s matching the conditions
     **/
    public function getObjects($criteria = null, $id_as_key = false) {
        $ret = array();
        $limit = $start = 0;
        $sql = 'SELECT DISTINCT c.* FROM ' . $this->db->prefix('imagecategory') . ' c LEFT JOIN '
            . $this->db->prefix('group_permission') . " l ON l.gperm_itemid=c.imgcat_id WHERE (l.gperm_name = 'imgcat_read' OR l.gperm_name = 'imgcat_write')";
        if (isset($criteria) && is_subclass_of($criteria, 'icms_db_criteria_Element')) {
            $where = $criteria->render();
            $sql .= ($where != '') ? ' AND ' . $where : '';
            $limit = $criteria->getLimit();
            $start = $criteria->getStart();
        }
        $sql .= ' ORDER BY imgcat_weight, imgcat_id ASC';
        $result = $this->db->query($sql, $limit, $start);
        if (!$result) {
            return $ret;
        }
        while ($myrow = $this->db->fetchArray($result)) {
            $imgcat = new icms_image_category_Object();
            $imgcat->assignVars($myrow);
            if (!$id_as_key) {
                $ret[] = &$imgcat;
            } else {
                $ret[$myrow['imgcat_id']] = &$imgcat;
            }
            unset($imgcat);
        }
        return $ret;
    }

    /**
     * get number of {@link icms_image_category_Object}s matching certain conditions
     *
     * @param string $criteria conditions to match
     * @return int number of {@link icms_image_category_Object}s matching the conditions
     **/
    public function getCount($criteria = null) {
        $sql = 'SELECT COUNT(*) FROM ' . $this->db->prefix('imagecategory') . ' i LEFT JOIN '
            . $this->db->prefix('group_permission') . " l ON l.gperm_itemid=i.imgcat_id WHERE (l.gperm_name = 'imgcat_read' OR l.gperm_name = 'imgcat_write')";
        if (isset($criteria) && is_subclass_of($criteria, 'icms_db_criteria_Element')) {
            $where = $criteria->render();
            $sql .= ($where != '') ? ' AND ' . $where : '';
        }
        if (!$result = &$this->db->query($sql)) {
            return 0;
        }
        list($count) = $this->db->fetchRow($result);
        return $count;
    }

    /**
     * get a list of {@link icms_image_category_Object}s matching certain conditions
     * @param string $criteria conditions to match
     * @return array array of {@link icms_image_category_Object}s matching the conditions
     **/
    public function getList($groups = array(), $perm = 'imgcat_read', $display = null, $storetype = null) {
        $criteria = new icms_db_criteria_Compo();
        if (is_array($groups) && !empty($groups)) {
            $criteriaTray = new icms_db_criteria_Compo();
            foreach ( $groups as $gid) {
                $criteriaTray->add(new icms_db_criteria_Item('gperm_groupid', $gid), 'OR');
            }
            $criteria->add($criteriaTray);
            if ($perm == 'imgcat_read' || $perm == 'imgcat_write') {
                $criteria->add(new icms_db_criteria_Item('gperm_name', $perm));
                $criteria->add(new icms_db_criteria_Item('gperm_modid', 1));
            }
        }
        if (isset($display)) {
            $criteria->add(new icms_db_criteria_Item('imgcat_display', (int) ($display)));
        }
        if (isset($storetype)) {
            $criteria->add(new icms_db_criteria_Item('imgcat_storetype', $storetype));
        }
        $categories = &$this->getObjects($criteria, true);
        $ret = array();
        foreach (array_keys($categories) as $i) {
            $ret[$i] = $categories[$i]->getVar('imgcat_name');
        }
        return $ret;
    }

    /**
        * Gets list of categories for that image
        *
        * @param array  $groups  the usergroups to get the permissions for
        * @param string  $perm  the permissions to retrieve
        * @param string  $display
        * @param string  $storetype
        * @param int  $imgcat_id  the image cat id
        *
        * @return array  list of categories
        */
    public function getCategList($groups = array(), $perm = 'imgcat_read', $display = null, $storetype = null, $imgcat_id=null) {
        $criteria = new icms_db_criteria_Compo();
        if (is_array($groups) && !empty($groups)) {
            $criteriaTray = new icms_db_criteria_Compo();
            foreach ( $groups as $gid) {
                $criteriaTray->add(new icms_db_criteria_Item('gperm_groupid', $gid), 'OR');
            }
            $criteria->add($criteriaTray);
            if ($perm == 'imgcat_read' || $perm == 'imgcat_write') {
                $criteria->add(new icms_db_criteria_Item('gperm_name', $perm));
                $criteria->add(new icms_db_criteria_Item('gperm_modid', 1));
            }
        }
        if (isset($display)) {
            $criteria->add(new icms_db_criteria_Item('imgcat_display', (int) ($display)));
        }
        if (isset($storetype)) {
            $criteria->add(new icms_db_criteria_Item('imgcat_storetype', $storetype));
        }
        if ($imgcat_id === NULL ) $imgcat_id = 0;
        $criteria->add(new icms_db_criteria_Item('imgcat_pid', $imgcat_id));
        $categories = &$this->getObjects($criteria, true);
        $ret = array();
        foreach ( array_keys($categories) as $i) {
            $ret[$i] = $categories[$i]->getVar('imgcat_name');
            $subcategories = $this->getCategList($groups, $perm, $display, $storetype, $categories[$i]->getVar('imgcat_id'));
            foreach ( array_keys($subcategories) as $j) {
                $ret[$j] = '-' . $subcategories[$j];
            }
        }

        return $ret;
    }

    /**
     * Get the folder path or url
     *
     * @param integer $imgcat_id - Category ID
     * @param string $full - if true return the full path or url else the relative path
     * @param string $type - path or url
     *
     * @return string - full folder path or url
     */
    function getCategFolder(&$imgcat, $full=true, $type='path') {
        /* As of PHP 5.3, is_a is no longer deprecated, this is an acceptable usage
         * and is compatible with more versions of PHP. http://us2.php.net/manual/en/language.operators.type.php
         */
        if (!is_a($imgcat, 'icms_image_category_Object')) {
            return false;
        }
        if ($imgcat->getVar('imgcat_pid') != 0) {
            $sup = $this->get($imgcat->getVar('imgcat_pid'));
            $supcateg = $this->getCategFolder($sup, false, $type);
        } else {
            $supcateg = 0;
        }
        $folder = ($supcateg) ? $supcateg . '/' : '';
        if ($full) {
            $folder = ( $type == 'path' )
                    ? ICMS_IMANAGER_FOLDER_PATH . '/' . $folder
                    : ICMS_IMANAGER_FOLDER_URL . '/' . $folder;
        }

        return $folder . $imgcat->getVar('imgcat_foldername');
    }
}

API documentation generated by ApiGen