Docs For Class ItemRequest

Description

The ItemRequest is a value Container, that is be used for defining a Request against the CMS ItemService.

version: $Id: ItemRequest.php,v 1.6 2006/11/26 22:04:09 kpapst Exp $
copyright: Copyright (C) 2002-2006 Kevin Papst
author: Kevin Papst
license: GNU Public License

Variable Summary

mixed $FLAG_ALL

mixed $FLAG_ALL_EXCEPT_TRASH

mixed $FLAG_ALL_EXCEPT_TRASH_AND_HIDDEN

mixed $_ORDER_ASC

mixed $_ORDER_DESC

Method Summary

ItemRequest ItemRequest (int $itemtype, int $itemID)

void getExcludeFlags ()

void getID ()

void getItemType ()

void getLanguageID ()

void getLimitFrom ()

void getLimitTo ()

void getOrder ()

void getOrderBy ()

void getTreetype ()

void setFlagToExclude (array $flags)

void setID (int $id)

void setItemType ( $itemtype)

void setLanguageID (String $languageID)

void setLimit ( $from, $to)

void setOrder ( $direction)

void setOrderBy ( $order)

void setTreetype ( $type)

Variables

mixed $FLAG_ALL = array() (line 41)

mixed $FLAG_ALL_EXCEPT_TRASH = array(FLAG_TRASH) (line 42)

mixed $FLAG_ALL_EXCEPT_TRASH_AND_HIDDEN = array(FLAG_TRASH,FLAG_HIDDEN) (line 43)

mixed $_ORDER_ASC = "ASC" (line 38)

mixed $_ORDER_DESC = "DESC" (line 39)

Methods

Constructor ItemRequest (line 87)

Create a new ItemRequest for the given Itemtype and ItemID.

ItemRequest ItemRequest (int $itemtype, int $itemID)

int $itemtype: the Itemtype
int $itemID: the Item ID

getExcludeFlags (line 159)

void getExcludeFlags ()

getID (line 155)

void getID ()

getItemType (line 179)

void getItemType ()

getLanguageID (line 171)

void getLanguageID ()

getLimitFrom (line 147)

void getLimitFrom ()

getLimitTo (line 151)

void getLimitTo ()

getOrder (line 167)

void getOrder ()

getOrderBy (line 163)

void getOrderBy ()

getTreetype (line 175)

void getTreetype ()

setFlagToExclude (line 109)

Set an Array of Flags to exclude.

Accepts:

FLAG_ALL
ALL_EXCEPT_TRASH
ALL_EXCEPT_TRASH_AND_HIDDEN (default)

void setFlagToExclude (array $flags)

array $flags: flags an array of int to exclude

setID (line 97)

Set the ItemID to fetch.

void setID (int $id)

int $id: the Item ID

setItemType (line 143)

void setItemType ( $itemtype)

$itemtype

setLanguageID (line 135)

Set the Language ID we are going to fetch.

void setLanguageID (String $languageID)

String $languageID: the Language ID

setLimit (line 121)

void setLimit ( $from, $to)

$from
$to

setOrder (line 126)

void setOrder ( $direction)

$direction

setOrderBy (line 117)

void setOrderBy ( $order)

$order

setTreetype (line 139)

void setTreetype ( $type)

$type