XOOPS Docs - kernel

[ ] [ ] [ ]

Packages:
XOOPS
class
kernal
kernel
PHPMailer
Smarty
xoops
xoops20
xos_kernel
xos_logos
xos_opal

Files:

block.php
comment.php
configcategory.php
configitem.php
configoption.php
group.php
groupperm.php
handlerregistry.php
image.php
member.php
module.php
object.php
online.php
privmessage.php
session.php
user.php
xoopsobject.php

subpackage auth

auth.php
authfactory.php
auth_ads.php
auth_ldap.php
auth_provisionning.php
auth_xoops.php

subpackage comment

commentrenderer.php

subpackage core

class.tar.php
downloader.php
module.errorhandler.php
module.textsanitizer.php
tardownloader.php
template.php
tree.php
uploader.php

subpackage database

criteria.php
database.php
mysqldatabase.php
sqlutility.php

subpackage form

subpackage notification

notification.php

subpackage util

Classes:

auth
   XoopsAuth
   XoopsAuthAds
   XoopsAuthFactory
   XoopsAuthLdap
   XoopsAuthProvisionning
   XoopsAuthXoops

XoopsAvatar
XoopsAvatarHandler
XoopsBlock
XoopsComment
XoopsComments
XoopsConfigCategory
XoopsConfigItem
XoopsConfigItemHandler
XoopsConfigOption
XoopsGroup
XoopsGroupPerm
XoopsGroupPermHandler
XoopsGuestUser
XoopsHandlerRegistry
XoopsImage
XoopsImagecategory
XoopsImagecategoryHandler
XoopsImageHandler
XoopsImageset
XoopsImagesetHandler
XoopsImagesetimg
XoopsImagesetimgHandler
XoopsMemberHandler
XoopsMembership
XoopsMembershipHandler
XoopsModule
XoopsModuleHandler
XoopsObject
XoopsObjectHandler
XoopsOnlineHandler
XoopsPrivmessage
XoopsPrivmessageHandler
XoopsRank
XoopsRankHandler
XoopsSessionHandler
XoopsTplfile
XoopsTplfileHandler
XoopsTplset
XoopsTplsetHandler
XoopsUser
XoopsUserHandler
XoUser
XoUserHandler

block
XoopsBlockHandler

core
   ErrorHandler
   MyTextSanitizer
   tar
   XoopsDownloader
   XoopsMediaUploader
   XoopsObjectTree
   XoopsTarDownloader
   XoopsTpl
   XoopsZipDownloader

comment
XoopsCommentHandler
XoopsCommentRenderer

config
XoopsConfigCategoryHandler
XoopsConfigOptionHandler

database
   Criteria
   CriteriaCompo
   CriteriaElement
   Database
   SqlUtility
   XoopsDatabase
   XoopsMySQLDatabase
   XoopsMySQLDatabaseProxy
   XoopsMySQLDatabaseSafe

form
   XoopsForm
   XoopsFormButton
   XoopsFormCheckBox
   XoopsFormDateTime
   XoopsFormDhtmlTextArea
   XoopsFormElement
   XoopsFormElementTray
   XoopsFormFile
   XoopsFormHidden
   XoopsFormHiddenToken
   XoopsFormLabel
   XoopsFormPassword
   XoopsFormRadio
   XoopsFormRadioYN
   XoopsFormSelect
   XoopsFormSelectCountry
   XoopsFormSelectGroup
   XoopsFormSelectLang
   XoopsFormSelectMatchOption
   XoopsFormSelectTheme
   XoopsFormSelectTimezone
   XoopsFormText
   XoopsFormTextArea
   XoopsFormTextDateSelect
   XoopsGroupFormCheckBox
   XoopsGroupPermForm
   XoopsSimpleForm
   XoopsTableForm
   XoopsThemeForm

member
XoopsGroupHandler

notification
XoopsNotification
XoopsNotificationHandler

util
XoopsPageNav

Class: XoopsConfigItemHandler

Source Location: /kernel/configitem.php

Class Overview

XoopsObjectHandler
   |
   --XoopsConfigItemHandler

XOOPS configuration handler class.

Author(s):

Kazumi Ono <onokazu@xoops.org>

Copyright:

copyright (c) 2000-2003 XOOPS.org

Methods

Inherited Variables

Class: XoopsObjectHandler

XoopsObjectHandler::$db

Inherited Methods

Class: XoopsObjectHandler

XoopsObjectHandler::XoopsObjectHandler(): called from child classes only
XoopsObjectHandler::create(): creates a new object
XoopsObjectHandler::delete(): delete obejct from database
XoopsObjectHandler::get(): gets a value object
XoopsObjectHandler::insert(): insert/update object

Class Details

[line 178]
XOOPS configuration handler class.

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

Tags:

author:	Kazumi Ono <onokazu@xoops.org>
copyright:	copyright (c) 2000-2003 XOOPS.org

[ Top ]

Class Methods

method create [line 188]

object reference &create(
[bool
$isNew = true])

Create a new XoopsConfigItem

Tags:

return:	to the new config
see:	XoopsConfigItem

Overrides XoopsObjectHandler::create() (creates a new object)

Parameters:

bool

$isNew

Flag the config as "new"?

[ Top ]

method delete [line 264]

bool delete(
object
&$config)

Delete a config from the database

Tags:

return:

Successful?

Overrides XoopsObjectHandler::delete() (delete obejct from database)

Parameters:

object

&$config

Config to delete

[ Top ]

method get [line 203]

object reference &get(
int
$id)

Load a config from the database

Tags:

return:

to the config, FALSE on fail

Overrides XoopsObjectHandler::get() (gets a value object)

Parameters:

int

$id

ID of the config

[ Top ]

method getCount [line 317]

int getCount(
[object
$criteria = null])

Count configs

Tags:

return:

Count of configs matching $criteria

Parameters:

object

$criteria

CriteriaElement

[ Top ]

method getObjects [line 283]

array getObjects(
[object
$criteria = null], [bool
$id_as_key = false])

Get configs from the database

Tags:

return:

Array of XoopsConfigItem objects

Parameters:

object	$criteria	CriteriaElement
bool	$id_as_key	return the config's id as key?

[ Top ]

method insert [line 228]

mixed insert(
object
&$config)

Write a config to the database

Tags:

return:

FALSE on fail.

Overrides XoopsObjectHandler::insert() (insert/update object)

Parameters:

object

&$config

XoopsConfigItem object

[ Top ]

XOOPS Docs generated by phpDocumentor