Docs For Class PortletService

Description

This class provides methods for reading and saving of Portlets.

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

Direct descendents

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

Method Summary

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

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

void setIgnoreDisplaySetting (boolean $ignorePortletDisplaySetting)

Methods

getPortlets (line 64)

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.

return: all Portlets for the given Item

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

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

Redefined in descendants as:

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

savePortlets (line 81)

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.

return: whther we cold save the Portlets or not

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

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

Redefined in descendants as:

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

setIgnoreDisplaySetting (line 48)

If this function is called with

true

also the Portlets are rendered, that return

false

for

Portlet->displayPortlet()

.

void setIgnoreDisplaySetting (boolean $ignorePortletDisplaySetting)

boolean $ignorePortletDisplaySetting: ignorePortletDisplaySetting whether the Portlets setting should be ignored or not

Redefined in descendants as:

PortletParser::setIgnoreDisplaySetting() : If this function is called with
also the Portlets are rendered, that return
for
.