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_image_category_Handler
  • icms_image_category_Object
  • Overview
  • Package
  • Class

Class icms_image_category_Handler

Image caetgory handler class. This class is responsible for providing data access mechanisms to the data source of image category class objects.

icms_core_ObjectHandler
Extended by icms_image_category_Handler
Package: Image\Category
Category: ICMS
Copyright: Copyright (c) 2000 XOOPS.org
License: LICENSE.txt
Author: Kazumi Ono onokazu@xoops.org
Located at image/category/Handler.php
Methods summary
public object &
# create( boolean $isNew = true )

Creates a new image category

Creates a new image category

Parameters

$isNew
is the new image category new??

Returns

object
$imgcat icms_image_category_Object reference to the new image category
public object &
# get( integer $id )

retrieve a specific icms_image_category_Object

retrieve a specific icms_image_category_Object

Parameters

$id
imgcatID (imgcat_id) of the image category

Returns

object
icms_image_category_Object reference to the image category

See

icms_image_category_Object
public boolean
# insert( object & $imgcat )

Insert a new icms_image_category_Object into the database

Insert a new icms_image_category_Object into the database

Parameters

$imgcat
$imgcat reference to the image category to insert

Returns

boolean
TRUE if succesful
public boolean
# delete( object & $imgcat )

delete an icms_image_category_Object from the database

delete an icms_image_category_Object from the database

Parameters

$imgcat
$imgcat reference to the image category to delete

Returns

boolean
TRUE if succesful
public array
# getObjects( object $criteria = null, boolean $id_as_key = false )

retrieve array of icms_image_category_Objects meeting certain conditions

retrieve array of icms_image_category_Objects meeting certain conditions

Parameters

$criteria
icms_db_criteria_Element with conditions for the image categories
$id_as_key
should the image category's imgcat_id be the key for the returned array?

Returns

array
icms_image_category_Objects matching the conditions
public integer
# getCount( string $criteria = null )

get number of icms_image_category_Objects matching certain conditions

get number of icms_image_category_Objects matching certain conditions

Parameters

$criteria
conditions to match

Returns

integer
number of icms_image_category_Objects matching the conditions
public array
# getList( string $groups = array(), $perm = 'imgcat_read', $display = null, $storetype = null )

get a list of icms_image_category_Objects matching certain conditions

get a list of icms_image_category_Objects matching certain conditions

Parameters

$groups
$criteria conditions to match
$perm
$display
$storetype

Returns

array
array of icms_image_category_Objects matching the conditions
public array
# getCategList( array $groups = array(), string $perm = 'imgcat_read', string $display = null, string $storetype = null, integer $imgcat_id = null )

Gets list of categories for that image

Gets list of categories for that image

Parameters

$groups
the usergroups to get the permissions for
$perm
the permissions to retrieve
$display
$storetype
$imgcat_id
the image cat id

Returns

array
list of categories
public string
# getCategFolder( integer & $imgcat, string $full = true, string $type = 'path' )

Get the folder path or url

Get the folder path or url

Parameters

$imgcat
$imgcat_id - Category ID
$full
  • if true return the full path or url else the relative path
$type
  • path or url

Returns

string
  • full folder path or url
Methods inherited from icms_core_ObjectHandler
__construct()
Properties inherited from icms_core_ObjectHandler
$db
API documentation generated by ApiGen