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_core_Debug
  • icms_core_Object
  • icms_core_ObjectHandler
  • icms_core_OnlineHandler
  • icms_file_ZipFileHandler
  • icms_image_set_Handler
  • Overview
  • Package
  • Class

Class icms_image_set_Handler

XOOPS imageset handler class. This class is responsible for providing data access mechanisms to the data source of XOOPS imageset class objects.

XoopsObjectHandler
Extended by icms_image_set_Handler
Package: Core
Copyright: Copyright (c) 2000 XOOPS.org
License: LICENSE.txt
Author: Kazumi Ono onokazu@xoops.org
Located at image/set/Handler.php
Methods summary
public object &
# create( boolean $isNew = true )

Creates a new imageset

Creates a new imageset

Parameters

$isNew
is the new imageset new??

Returns

object
$imgset icms_image_set_Object reference to the new imageset
public object &
# get( integer $id )

retrieve a specific icms_image_set_Object

retrieve a specific icms_image_set_Object

Parameters

$id
imgsetID (imgset_id) of the imageset

Returns

object
icms_image_set_Object reference to the image set

See

icms_image_set_Object
public boolean
# insert( object & $imgset )

Insert a new icms_image_set_Object into the database

Insert a new icms_image_set_Object into the database

Parameters

$imgset
$imgset reference to the imageset to insert

Returns

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

delete an icms_image_set_Object from the database

delete an icms_image_set_Object from the database

Parameters

$imgset
$imgset reference to the imageset to delete

Returns

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

retrieve array of icms_image_set_Objects meeting certain conditions

retrieve array of icms_image_set_Objects meeting certain conditions

Parameters

$criteria
CriteriaElement with conditions for the imagesets
$id_as_key
should the imageset's imgset_id be the key for the returned array?

Returns

array
icms_image_set_Objects matching the conditions
public boolean
# linkThemeset( integer $imgset_id, integer $tplset_name )

Links a icms_image_set_Object to a themeset (tplset)

Links a icms_image_set_Object to a themeset (tplset)

Parameters

$imgset_id
image set id to link
$tplset_name
theme set to link

Returns

boolean
TRUE if succesful FALSE if unsuccesful
public boolean
# unlinkThemeset( integer $imgset_id, integer $tplset_name )

Unlinks a icms_image_set_Object from a themeset (tplset)

Unlinks a icms_image_set_Object from a themeset (tplset)

Parameters

$imgset_id
image set id to unlink
$tplset_name
theme set to unlink

Returns

boolean
TRUE if succesful FALSE if unsuccesful
public array
# getList( integer $refid = null, integer $tplset = null )

get a list of icms_image_set_Objects matching certain conditions

get a list of icms_image_set_Objects matching certain conditions

Parameters

$refid
conditions to match
$tplset
conditions to match

Returns

array
array of icms_image_set_Objects matching the conditions
API documentation generated by ApiGen