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_Handler
  • icms_image_Object
  • Overview
  • Package
  • Class

Class icms_image_Handler

Image handler class.

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

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

Create a new icms_image_Object

Create a new icms_image_Object

Parameters

$isNew
Flag the object as "new"

Returns

object
public object &
# get( integer $id, boolean $getbinary = true )

Load a icms_image_Object object from the database

Load a icms_image_Object object from the database

Parameters

$id
ID
$getbinary

Returns

object
icms_image_Object, FALSE on fail
public boolean
# insert( object & $image )

Write a icms_image_Object object to the database

Write a icms_image_Object object to the database

Parameters

$image
$image icms_image_Object

Returns

boolean
public boolean
# delete( object & $image )

Delete an image from the database

Delete an image from the database

Parameters

$image
$image icms_image_Object

Returns

boolean
public icms_image_Object[]
# getObjects( null|icms_db_criteria_Item $criteria = null, boolean $id_as_key = false, boolean $getbinary = false, boolean|string $sql = false, boolean $debug = false )

Load icms_image_Objects from the database

Load icms_image_Objects from the database

Parameters

$criteria
icms_db_criteria_Element
$id_as_key
Use the ID as key into the array
$getbinary
Get binary image?
$sql
Extra sql (unused; only used for compatibility function signature)
$debug
Debug mode?

Returns

icms_image_Object[]
public integer
# getCount( object $criteria = null )

Count some images

Count some images

Parameters

$criteria
icms_db_criteria_Element

Returns

integer
public array
# getList( integer|null $imgcat_id = null, boolean|null|integer $image_display = 0, integer $notinuse = 0, boolean $debug = false )

Get a list of images

Get a list of images

Parameters

$imgcat_id
Image category ID
$image_display
List only displayed images?
$notinuse
Not use param (only added for fixing Declaration of icms_image_Handler::getList($imgcat_id, $image_display = NULL, $notinuse1 = 0, $debug = false) should be compatible with icms_ipf_Handler::getList($criteria = NULL, $limit = 0, $start = 0, $debug = false) error)
$debug
Enable debug mode?

Returns

array

Array of icms_image_Object objects objects

Methods inherited from icms_core_ObjectHandler
__construct()
Properties inherited from icms_core_ObjectHandler
$db
API documentation generated by ApiGen