API - XOOPS 2.5.11 Beta 2
By monxoops.fr
XoopsAvatarHandler Class Reference
Inheritance diagram for XoopsAvatarHandler:
Collaboration diagram for XoopsAvatarHandler:

Public Member Functions

 create ($isNew=true)
 
 get ($id)
 
 insert (XoopsObject $avatar)
 
 delete (XoopsObject $avatar)
 
getObjects (CriteriaElement $criteria=null, $id_as_key=false)
 
 getCount (CriteriaElement $criteria=null)
 
 addUser ($avatar_id, $user_id)
 
 getUser (XoopsAvatar $avatar)
 
 getList ($avatar_type=null, $avatar_display=null)
 
- Public Member Functions inherited from XoopsObjectHandler
 __construct (XoopsDatabase $db)
 
 XoopsObjectHandler ($db)
 
 create ()
 
 get ($id)
 
 insert (XoopsObject $object)
 
 delete (XoopsObject $object)
 

Additional Inherited Members

- Data Fields inherited from XoopsObjectHandler
 $db
 

Member Function Documentation

◆ addUser()

addUser (   $avatar_id,
  $user_id 
)

Add user

Parameters
int$avatar_id
int$user_id
Returns
bool

◆ create()

create (   $isNew = true)

Create new Object

Parameters
bool$isNew
Returns
XoopsAvatar

Reimplemented in SystemAvatarHandler.

◆ delete()

delete ( XoopsObject  $avatar)

Delete an object from the database

Parameters
XoopsObject | XoopsAvatar$avatara XoopsAvatar object
Returns
bool true on success, otherwise false

Reimplemented from XoopsObjectHandler.

◆ get()

get (   $id)

Egt Object

Parameters
int$id
Returns
XoopsAvatar

Reimplemented from XoopsObjectHandler.

Reimplemented in SystemAvatarHandler.

◆ getCount()

getCount ( CriteriaElement  $criteria = null)

Get count

Parameters
CriteriaElement | CriteriaCompo$criteria
Returns
int

◆ getList()

getList (   $avatar_type = null,
  $avatar_display = null 
)

Get a list of Avatars

Parameters
string$avatar_type'S' for system, 'C' for custom
bool | null$avatar_displaynull lists all, bool respects avatar_display
Returns
array
Here is the call graph for this function:

◆ getObjects()

& getObjects ( CriteriaElement  $criteria = null,
  $id_as_key = false 
)

Fetch a row of objects from the database

Parameters
CriteriaElement | CriteriaCompo$criteria
bool$id_as_key
Returns
object
Here is the caller graph for this function:

◆ getUser()

getUser ( XoopsAvatar  $avatar)

Get User

Parameters
XoopsAvatar$avatar
Returns
array

@TODO: Change to if (!(class_exists($this->className) && $obj instanceof $this->className)) when going fully PHP5

◆ insert()

insert ( XoopsObject  $avatar)

Insert and Object into the database

Parameters
XoopsObject | XoopsAvatar$avatara XoopsAvatar object
Returns
bool true on success, otherwise false

Reimplemented from XoopsObjectHandler.


The documentation for this class was generated from the following file: