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_data_avatar_Handler
  • icms_data_avatar_Object
  • Overview
  • Package
  • Class

Class icms_data_avatar_Handler

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

icms_core_ObjectHandler
Extended by icms_data_avatar_Handler
Package: Data\Avatar
Category: ICMS
Copyright: copyright (c) 2000-2007 XOOPS.org
License: LICENSE.txt
Author: Kazumi Ono onokazu@xoops.org
Located at data/avatar/Handler.php
Methods summary
public &
# create( $isNew = true )

Creates a new avatar object

Creates a new avatar object

See

icms_core_ObjectHandler#create()
public mixed &
# get( integer $id )

Gets an avatar object

Gets an avatar object

Parameters

$id
$int_id

Returns

mixed

See

icms_core_ObjectHandler#get($int_id)
public boolean
# insert( object & $avatar )

Inserts an avatar or updates an existing avatar

Inserts an avatar or updates an existing avatar

Parameters

$avatar
$object

Returns

boolean

See

icms_core_ObjectHandler#insert($object)
public boolean
# delete( object & $avatar )

Deletes an avatar

Deletes an avatar

Parameters

$avatar
$object

Returns

boolean

See

icms_core_ObjectHandler#delete($object)
public array &
# getObjects( object $criteria = null, boolean $id_as_key = false )

Parameters

$criteria
$id_as_key

Returns

array
public integer
# getCount( object $criteria = null )

Get a count of avatars meeting criteria

Get a count of avatars meeting criteria

Parameters

$criteria

Returns

integer
public boolean
# addUser( integer $avatar_id, integer $user_id )

Links a user with an avatar

Links a user with an avatar

Parameters

$avatar_id
$user_id

Returns

boolean
public array
# getUser( object & $avatar )

Get an array of users linked to an avatar

Get an array of users linked to an avatar

Parameters

$avatar

Returns

array
public array
# getList( string $avatar_type = null, integer $avatar_display = null )

Get a list of avatars

Get a list of avatars

Parameters

$avatar_type
$avatar_display

Returns

array
public static array
# getListFromDir( string $avatar_dir = "" )

Gets list of avatar file names in a certain directory if directory is not specified, default avatar directory will be searched

Gets list of avatar file names in a certain directory if directory is not specified, default avatar directory will be searched

Parameters

$avatar_dir
name of the directory to scan for files,

Returns

array
$avatars list of avatars in the directory
public static mixed
# getAllFromDir( )

Gets list of all avatar image files inside default avatars directory

Gets list of all avatar image files inside default avatars directory

Returns

mixed
$avatars|false list of avatar files in the directory or false if no avatars
Methods inherited from icms_core_ObjectHandler
__construct()
Properties inherited from icms_core_ObjectHandler
$db
API documentation generated by ApiGen