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

Class: PortletService

Source Location: /CORE/system/api/portlet/PortletService.php

Class PortletService

Class Overview

This class provides methods for reading and saving of Portlets.

Located in /CORE/system/api/portlet/PortletService.php [line 40]

Author(s):

Kevin Papst

Information Tags:

Version:	$Id: PortletService.php,v 1.2 2006/11/26 22:04:42 kpapst Exp $
Copyright:	Copyright (C) 2002-2006 Kevin Papst
License:	GNU Public License

Methods

[ Top ]

Descendants

Child Class	Description
PortletParser	This class provides methods for easy reading and parsing of Portlets.

[ Top ]

Method Summary

array

getPortlets()

Get an array with ready parsed and configured Portlets for the given Itemtype and ID. Even if Portlets are ment to be used with Menus, it is possible to fetch them for all Itemtypes.

boolean

savePortlets()

Saves the given Portlets for the Item.

void

setIgnoreDisplaySetting()

If this function is called with

true

also the Portlets are rendered, that return

false

for

Portlet->displayPortlet()

[ Top ]

Methods

getPortlets [line 64]

array getPortlets(
int
$itemtype, long
$itemid, String
$languageid, [String
$column = null] 
)

Get an array with ready parsed and configured Portlets for the given Itemtype and ID. Even if Portlets are ment to be used with Menus, it is possible to fetch them for all Itemtypes.

If no Column is submitted

PORTLET_DEFAULT_COLUMN

is used.

Parameters:

int	$itemtype:	itemtype the Itemtype to fetch the Portlets for
long	$itemid:	itemid the ItemID to fetch the Portlets for
String	$languageid:	languageid the LanguageID to fetch the Portlets for
String	$column:	column the Name of the Column to fetch the Portlets for

API Tags:

Return:

all Portlets for the given Item

Redefined in descendants as:

PortletParser::getPortlets() : Get an array with ready parsed and configured Portlets for the given Itemtype and ID.

[ Top ]

savePortlets [line 81]

boolean savePortlets(
int
$itemtype, long
$itemid, String
$languageid, array
$portlets, [String
$column = null] 
)

Saves the given Portlets for the Item.

Pass null or an empty array to delete portlet settings.

If no Column is submitted

PORTLET_DEFAULT_COLUMN

is used.

Parameters:

int	$itemtype:	itemtype the Itemtype to fetch the Portlets for
long	$itemid:	itemid the ItemID to fetch the Portlets for
String	$languageid:	languageid the LanguageID to fetch the Portlets for
array	$portlets:	portlets an Array with configured Portlets to save
String	$column:	column the Name of the Column to fetch the Portlets for

API Tags:

Return:

whther we cold save the Portlets or not

Redefined in descendants as:

PortletParser::savePortlets() : Converts and then saves the given Portlets.

[ Top ]

setIgnoreDisplaySetting [line 48]

void setIgnoreDisplaySetting(
boolean
$ignorePortletDisplaySetting 
)

If this function is called with

true

also the Portlets are rendered, that return
false

for
Portlet->displayPortlet()

.

Parameters:

boolean

$ignorePortletDisplaySetting:

ignorePortletDisplaySetting whether the Portlets setting should be ignored or not

Redefined in descendants as:

PortletParser::setIgnoreDisplaySetting() : If this function is called with
1. true
also the Portlets are rendered, that return
1. false
for
1. Portlet->displayPortlet()
.

[ Top ]