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

Class: PortletParser

Source Location: /CORE/system/classes/parser/PortletParser.php

Class PortletParser

Class Overview

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

The Portlet settings are saved (by default) in a Text-Project-Field with the Key:

PORTLET_COLUMN_PREFIX . PORTLET_DEFAULT_COLUMN

The Column can be changed, in order to save multiple Columns for one Item.

If one of the configured Portlet Classes can not be found in the environment by calling

class_exists($classname)

, it trys to load it from the Portlets Package by calling:

loadClass('portlets', $classname)

Located in /CORE/system/classes/parser/PortletParser.php [line 57]

PortletService
   |
   --PortletParser

Author(s):

Kevin Papst

Information Tags:

Version:	$Id: PortletParser.php,v 1.3 2007/04/23 12:23:26 kpapst Exp $
Copyright:	Copyright (C) 2002-2006 Kevin Papst
License:	GNU Public License

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From PortletService

PortletService::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.

PortletService::savePortlets()

Saves the given Portlets for the Item.

PortletService::setIgnoreDisplaySetting()

If this function is called with
true

also the Portlets are rendered, that return
false

for
Portlet->displayPortlet()

.

[ Top ]

Method Summary

PortletParser	PortletParser()	Create a new instance of the PortletParser.
void	getPortlets()	Get an array with ready parsed and configured Portlets for the given Itemtype and ID.
void	savePortlets()	Converts and then saves the given Portlets.
void	setIgnoreDisplaySetting()	If this function is called with true also the Portlets are rendered, that return false for Portlet->displayPortlet() .

[ Top ]

Methods

Constructor PortletParser [line 67]

PortletParser PortletParser(
)

Create a new instance of the PortletParser.

[ Top ]

getPortlets [line 93]

void getPortlets(

$itemtype, 
$itemid, 
$languageid, [
$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.

Parameters:

	$itemtype:
	$itemid:
	$languageid:
	$column:

Redefinition of:

PortletService::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.

[ Top ]

savePortlets [line 170]

void savePortlets(

$itemtype, 
$itemid, 
$languageid, 
$portlets, [
$column = null] 
)

Converts and then saves the given Portlets.

Pass null or an empty array to delete portlet settings.

Parameters:

	$itemtype:
	$itemid:
	$languageid:
	$portlets:
	$column:

Redefinition of:

PortletService::savePortlets(): Saves the given Portlets for the Item.

[ Top ]

setIgnoreDisplaySetting [line 75]

void setIgnoreDisplaySetting(
[
$ignorePortletDisplaySetting = false] 
)

If this function is called with

true

also the Portlets are rendered, that return
false

for
Portlet->displayPortlet()

.

Parameters:

$ignorePortletDisplaySetting:

Redefinition of:

PortletService::setIgnoreDisplaySetting()

If this function is called with

true

also the Portlets are rendered, that return

false

for

Portlet->displayPortlet()

[ Top ]