[class tree: bigace-classes] [index: bigace-classes] [all elements]

Class: ItemRequest

Source Location: /CORE/system/classes/item/ItemRequest.php

Class ItemRequest

Class Overview

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

Located in /CORE/system/classes/item/ItemRequest.php [line 37]

Author(s):

Kevin Papst

Information Tags:

Version:	$Id: ItemRequest.php,v 1.10 2008/09/20 22:27:44 kpapst Exp $
Copyright:	Copyright (C) Kevin Papst
License:	GNU Public License

Properties

Methods

[ Top ]

Property Summary

mixed	$FLAG_ALL
mixed	$FLAG_ALL_EXCEPT_TRASH
mixed	$FLAG_ALL_EXCEPT_TRASH_AND_HIDDEN
mixed	$_ORDER_ASC
mixed	$_ORDER_DESC

[ Top ]

Method Summary

ItemRequest	ItemRequest()	Create a new ItemRequest for the given Itemtype and ItemID.
void	getCategories()
void	getExcludeFlags()
void	getID()
void	getItemType()
void	getLanguageID()
void	getLimitFrom()
void	getLimitTo()
void	getOrder()
void	getOrderBy()
void	getReturnType()
void	getTreetype()
void	setCategory()	If you want to fetch Items for one or more Categories, add their IDs.
void	setFlagToExclude()	Set an Array of Flags to exclude.
void	setID()	Set the ItemID to fetch.
void	setItemType()
void	setLanguageID()	Set the Language ID we are going to fetch.
void	setLimit()
void	setOrder()
void	setOrderBy()	Sets the field, the results will be ordered by.
void	setReturnType()	Sets the ClassName that should be used when returning the entries.
void	setTreetype()

[ Top ]

Properties

mixed $FLAG_ALL = array() [line 42]

[ Top ]

mixed $FLAG_ALL_EXCEPT_TRASH = array(FLAG_TRASH) [line 43]

[ Top ]

mixed $FLAG_ALL_EXCEPT_TRASH_AND_HIDDEN = array(FLAG_TRASH,FLAG_HIDDEN) [line 44]

[ Top ]

mixed $_ORDER_ASC = "ASC" [line 39]

[ Top ]

mixed $_ORDER_DESC = "DESC" [line 40]

[ Top ]

Methods

Constructor ItemRequest [line 96]

ItemRequest ItemRequest(
int
$itemtype, [int
$itemID = null] 
)

Create a new ItemRequest for the given Itemtype and ItemID.

Parameters:

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

[ Top ]

getCategories [line 146]

void getCategories(
)

[ Top ]

getExcludeFlags [line 198]

void getExcludeFlags(
)

[ Top ]

getID [line 194]

void getID(
)

[ Top ]

getItemType [line 222]

void getItemType(
)

[ Top ]

getLanguageID [line 210]

void getLanguageID(
)

[ Top ]

getLimitFrom [line 186]

void getLimitFrom(
)

[ Top ]

getLimitTo [line 190]

void getLimitTo(
)

[ Top ]

getOrder [line 206]

void getOrder(
)

[ Top ]

getOrderBy [line 202]

void getOrderBy(
)

[ Top ]

getReturnType [line 214]

void getReturnType(
)

[ Top ]

getTreetype [line 218]

void getTreetype(
)

[ Top ]

setCategory [line 142]

void setCategory(
int
$id 
)

If you want to fetch Items for one or more Categories, add their IDs.

Call this method oce for each Category.

Parameters:

int

$id:

a Category ID

[ Top ]

setFlagToExclude [line 119]

void setFlagToExclude(
array
$flags 
)

Set an Array of Flags to exclude.

Accepts:

FLAG_ALL
ALL_EXCEPT_TRASH
ALL_EXCEPT_TRASH_AND_HIDDEN (default)

Parameters:

array

$flags:

flags an array of int to exclude

[ Top ]

setID [line 107]

void setID(
int
$id 
)

Set the ItemID to fetch.

Parameters:

int

$id:

the Item ID

[ Top ]

setItemType [line 182]

void setItemType(

$itemtype 
)

Parameters:

$itemtype:

[ Top ]

setLanguageID [line 174]

void setLanguageID(
String
$languageID 
)

Set the Language ID we are going to fetch.

Parameters:

String

$languageID:

the Language ID

[ Top ]

setLimit [line 160]

void setLimit(

$from, 
$to 
)

Parameters:

	$from:
	$to:

[ Top ]

setOrder [line 165]

void setOrder(

$direction 
)

Parameters:

$direction:

[ Top ]

setOrderBy [line 132]

void setOrderBy(
string
$order 
)

Sets the field, the results will be ordered by.

Parameters:

string

$order:

the field name

[ Top ]

setReturnType [line 156]

void setReturnType(
String
$classname 
)

Sets the ClassName that should be used when returning the entries.

Remember to import the Class before fetching the Results!

Parameters:

String

$classname:

the Classname to return

[ Top ]

setTreetype [line 178]

void setTreetype(

$type 
)

Parameters:

$type:

[ Top ]