Class Modules

Direct known subclasses

ModuleAnnouncements, ModuleDates, ModuleLists, ModuleWeblinks

Abstract
Copyright: 2004-2016 The Admidio Team
License: GNU General Public License v2.0 only **********************************************************************************************
Brief:

This @b abstract @b class defines a parameter set for modules

This abstract class sets the parameters used in Admidio modules. The class gets a copy of the $_GET Array and validates the values with Admidio function admFuncVariableIsValid(); Values are set to default if no parameters are submitted. The class also defines a daterange and returns the daterange as array with English format and current System format. If no values are available the daterange is set by default: date_from = DATE_NOW; date_to = 9999-12-31 The class provides methods to return all single Variables and arrays or returns an Array with all setted parameters The returned array contains following settings:

Class: Modules
Code:

array('active_role' => '1', 'headline' => 'string', 'category-selection' => '0', 'cat_id' => '0', 'calendar-selection' => '1', 'id' => 'integer', 'mode' => 'string', 'order' => 'ASC' 'startelement' => 0 'view_mode' => 'string', 'daterange' => array( [english] (date_from => 'string', date_to => 'string'), [sytem] (date_from => 'string', date_to => 'string')) );

Endcode
Par: Return parameter array:
Located at modules.php

Methods summary

`abstract public array`	# `getDataSet( integer $startElement = 0, integer $limit = null )` Parameters `$startElement` `$limit` Returns array
`abstract public mixed`	# `getDataSetCount( )` Returns mixed
`public`	# `__construct( )` Constructor that will create an object of a parameter set needed in modules to get the recordsets. Initialize parameters Constructor that will create an object of a parameter set needed in modules to get the recordsets. Initialize parameters
`public integer`	# `getId( )` Return ID Return ID Returns integer Returns the ID of the record
`public array[]`	# `getDaterange( )` Return the daterange Return the daterange Returns array[] Returns daterange as array with English format and system format
`public string`	# `getMode( )` Return mode Return mode Returns string Returns mode as string
`public string`	# `getOrder( )` Return mode Return mode Returns string Returns order as string
`public integer`	# `getStartElement( )` Return start element Return start element Returns integer Returns Integer value for the start element
`public mixed\|null`	# `getParameter( string $parameterName )` Returns a module parameter from the class Returns a module parameter from the class Parameters `$parameterName` The name of the parameter whose value should be returned. Returns mixed\|null Returns the parameter value
`public array`	# `getParameters( )` Return parameter set as Array Return parameter set as Array Returns array Returns an Array with all needed parameters as Key/Value pair
`protected`	# `setId( )` Set ID Set ID
`protected`	# `setMode( )` Set mode Set mode Par If user string is set in $_GET Array the string is validated by Admidio function and set as mode in the modules. Otherwise mode is set to default
`protected`	# `setOrder( )` Set order Set order Par If user string is set in $_GET Array the string is validated by Admidio function and set as order for the results in the modules. Otherwise mode is set to default "ASC"
`protected`	# `setStartElement( )` Set startelement Set startelement Par If user string is set in $_GET Array the string is validated by Admidio function and set as startelement in the modules. Otherwise startelement is set to 0
`public`	# `setParameter( string $parameterName, mixed $parameterValue )` add a module parameter to the class add a module parameter to the class Parameters `$parameterName` The name of the parameter that should be added. `$parameterValue` The value of the parameter that should be added.

Constants summary

`string`	`HEADLINE`	# `''`

Properties summary

`protected`	`$activeRole`	#
`protected`	`$headline`	#
`protected`	`$catId`	#
`protected`	`$id`	#
`protected`	`$daterange`	#
`protected`	`$mode`	#
`protected`	`$order`	#
`protected`	`$start`	#
`protected`	`$properties`	#
`protected`	`$validModes`	#
`protected`	`$parameters`	#
`public`	`$arrParameter`	#

Packages

Classes

Exceptions

Functions

Class Modules

Direct known subclasses

Methods summary

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Returns

Par

Par

Par

Parameters

Constants summary

Properties summary