Admidio API
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo

Packages

  • com
    • tecnick
      • tcpdf
  • None
  • PHPMailer
    • easypeasyics
  • PHPWavUtils
  • Securimage
    • classes

Classes

  • AutoLogin
  • Component
  • ComponentUpdate
  • ConditionParser
  • Database
  • DateTimeExtended
  • Email
  • Folder
  • FormValidation
  • FunctionClass
  • Htaccess
  • HtmlDiv
  • HtmlElement
  • HtmlForm
  • HtmlFormBasic
  • HtmlFormInstallation
  • HtmlList
  • HtmlNavbar
  • HtmlPage
  • HtmlTable
  • HtmlTableBasic
  • Image
  • Inventory
  • InventoryFields
  • Language
  • LanguageData
  • ListConfiguration
  • Menu
  • Message
  • ModuleAnnouncements
  • ModuleDates
  • ModuleLists
  • ModuleMenu
  • ModuleMessages
  • Modules
  • ModuleWeblinks
  • MyFiles
  • Navigation
  • ntlm_sasl_client_class
  • Organization
  • Participants
  • PasswordHash
  • PasswordHashing
  • ProfileFields
  • RoleDependency
  • RolesRights
  • RSSfeed
  • Session
  • SystemMail
  • TableAccess
  • TableAnnouncement
  • TableCategory
  • TableDate
  • TableFile
  • TableFolder
  • TableGuestbook
  • TableGuestbookComment
  • TableInventory
  • TableInventoryField
  • TableLists
  • TableMembers
  • TableMessage
  • TablePhotos
  • TableRoles
  • TableRooms
  • TableText
  • TableUserField
  • TableUsers
  • TableWeblink
  • UploadHandlerDownload
  • UploadHandlerPhoto
  • User
  • UserRegistration

Exceptions

  • AdmException
  • WavFileException
  • WavFormatException

Functions

  • admFuncAutoload
  • admFuncGeneratePagination
  • admFuncGetBytesFromSize
  • admFuncGetDirectoryEntries
  • admFuncMaxUploadSize
  • admFuncProcessableImageSize
  • admFuncShowCreateChangeInfoById
  • admFuncShowCreateChangeInfoByName
  • admFuncVariableIsValid
  • admReadTemplateFile
  • admStrIsValidFileName
  • admStrStripTagsSpecial
  • admStrToLower
  • admStrToUpper
  • bzip2Version
  • checkDatabaseVersion
  • checkPhpVersion
  • EmailAttachment
  • FileSizeNiceDisplay
  • FormattedTimeRemaining
  • FunctionIsDisabled
  • getFormerRolesFromDatabase
  • getFutureRolesFromDatabase
  • getmicrotime
  • getRoleMemberships
  • getRolesFromDatabase
  • gzipVersion
  • hasRole
  • hl_attrval
  • hl_bal
  • hl_cmtcd
  • hl_ent
  • hl_prot
  • hl_regex
  • hl_spec
  • hl_tag
  • hl_tag2
  • hl_tidy
  • hl_version
  • htmLawed
  • HTMLFilter
  • isGroupLeader
  • isMember
  • kses
  • kses_hook
  • MySQLdumpVersion
  • OutputInformation
  • SafeExec
  • showNotice
  • strAddSlashesDeep
  • strNextLetter
  • strStripSlashesDeep
  • strStripTags
  • strValidCharacters
  • tln_body2div
  • tln_casenormalize
  • tln_deent
  • tln_defang
  • tln_findnxreg
  • tln_findnxstr
  • tln_fixatts
  • tln_fixstyle
  • tln_fixurl
  • tln_getnxtag
  • tln_sanitize
  • tln_skipspace
  • tln_tagprint
  • tln_unspace
  • version_compare_replacement
  • version_compare_replacement_sub

Class ModuleLists

Modules
Extended by ModuleLists
Copyright: 2004-2016 The Admidio Team
License: GNU General Public License v2.0 only **********************************************************************************************
Brief:

Class manages lists viewable for user

This class reads all available recordsets from table lists. and returns an Array with results, recordsets and validated parameters from $_GET Array.


Class: ModuleLists
Code:

Array( [numResults] => 5 [limit] => 10 [totalCount] => 5 [recordset] => Array ( [0] => Array ( [0] => 2 [rol_id] => 2 [1] => 3 [rol_cat_id] => 3 [2] => [rol_lst_id] => [3] => Mitglieder [rol_name] => Mitglieder [4] => Alle Mitglieder der Organisation [rol_description] => Alle Mitglieder der Organisation [5] => 0 [rol_assign_roles] => 0 [6] => 0 [rol_approve_users] => 0 [7] => 0 [rol_announcements] => 0 [8] => 0 [rol_dates] => 0 [9] => 0 [rol_download] => 0 [10] => 0 [rol_edit_user] => 0 [11] => 0 [rol_guestbook] => 0 [12] => 1 [rol_guestbook_comments] => 1 [13] => 0 [rol_mail_to_all] => 0 [14] => 2 [rol_mail_this_role] => 2 [15] => 0 [rol_photo] => 0 [16] => 1 [rol_profile] => 1 [17] => 0 [rol_weblinks] => 0 [18] => 2 [rol_this_list_view] => 2 [19] => 0 [rol_all_lists_view] => 0 [20] => 1 [rol_default_registration] => 1 [21] => 1 [rol_leader_rights] => 1 [22] => [rol_start_date] => [23] => [rol_start_time] => [24] => [rol_end_date] => [25] => [rol_end_time] => [26] => 0 [rol_weekday] => 0 [27] => [rol_location] => [28] => [rol_max_members] => [29] => [rol_cost] => [30] => [rol_cost_period] => [31] => 1 [rol_usr_id_create] => 1 [32] => 2008-05-03 16:26:36 [rol_timestamp_create] => 2008-05-03 16:26:36 [33] => 1 [rol_usr_id_change] => 1 [34] => 2008-05-03 16:26:36 [rol_timestamp_change] => 2008-05-03 16:26:36 [35] => 1 [rol_valid] => 1 [36] => 0 [rol_system] => 0 [37] => 1 [rol_visible] => 1 [38] => 0 [rol_administrator] => 0 [39] => 3 [cat_id] => 3 [40] => 1 [cat_org_id] => 1 [41] => ROL [cat_type] => ROL [42] => COMMON [cat_name_intern] => COMMON [43] => Allgemein [cat_name] => Allgemein [44] => 0 [cat_hidden] => 0 [45] => 0 [cat_system] => 0 [46] => 0 [cat_default] => 0 [47] => 1 [cat_sequence] => 1 [48] => 1 [cat_usr_id_create] => 1 [49] => 2012-01-08 11:12:05 [cat_timestamp_create] => 2012-01-08 11:12:05 [50] => [cat_usr_id_change] => [51] => [cat_timestamp_change] => [52] => 145 [num_members] => 145 [53] => 0 [num_leader] => 0 [54] => 5 [num_former] => 5 )

     [parameter] => Array
         (
             [active_role] => 1
             [calendar-selection] => 1
             [cat_id] => 0
             [category-selection] => 1
             [date] =>
             [daterange] => Array
                 (
                     [english] => Array
                         (
                             [start_date] => 2013-09-24
                             [end_date] => 9999-12-31
                         )

                     [system] => Array
                         (
                             [start_date] => 24.09.2013
                             [end_date] => 31.12.9999
                         )

                 )

             [headline] => Übersicht der aktiven Rollen
             [id] => 0
             [mode] => Default
             [order] => ASC
             [startelement] => 0
             [view_mode] => Default
         )

)


Endcode
Par: Returned Array
Located at modulelists.php

Methods summary

public
# __construct( )

creates an new ModuleLists object

creates an new ModuleLists object

Overrides

Modules::__construct
private string
# getMemberStatusSql( )

Evaluates memberStatus an returns appropriate SQL conditions

Evaluates memberStatus an returns appropriate SQL conditions

Returns

string
SQL for member status
private string
# getCategorySql( )

returns SQL condition

returns SQL condition

Returns

string
SQL condition for category id
private string
# getVisibleRolesSql( )

assembles SQL roles visible for current user

assembles SQL roles visible for current user

Returns

string
SQL condition visible for current user
public array
# getDataSet( integer $startElement = 0, integer $limit = null )

Function returns a set of lists with corresponding information

Function returns a set of lists with corresponding information

Parameters

$startElement
Start element of result. First (and default) is 0.
$limit
Number of elements returned max. Default NULL will take number from preferences.

Returns

array
with list and corresponding information
public integer
# getDataSetCount( )

Function to get total number of lists limited by current conditions.

Function to get total number of lists limited by current conditions.

Returns

integer
Number of lists.
public array
# getListConfigurations( )

Function to get list configurations accessible by current user

Function to get list configurations accessible by current user

Returns

array
with accessible list configurations
public
# setMemberStatus( string $status = 'active' )

Sets the status of role members to be shown

Sets the status of role members to be shown

Parameters

$status
active(default), inactive, both

Methods inherited from Modules

getDaterange(), getId(), getMode(), getOrder(), getParameter(), getParameters(), getStartElement(), setId(), setMode(), setOrder(), setParameter(), setStartElement()

Constants summary

Constants inherited from Modules

HEADLINE

Properties summary

private $memberStatus
#

Properties inherited from Modules

$activeRole, $arrParameter, $catId, $daterange, $headline, $id, $mode, $order, $parameters, $properties, $start, $validModes

Admidio API API documentation generated by ApiGen