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 ModuleAnnouncements

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

This class reads announcement recordsets from database

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


Class: ModuleAnnouncements
Code:

Array ( [numResults] => 3 [limit] => 10 [totalCount] => 3 [recordset] => Array ( [0] => Array ( [0] => 3 [ann_id] => 3 [1] => DEMO [ann_org_id] => 1 [2] => 1 [ann_global] => 1 [3] => Willkommen im Demobereich [ann_headline] => Willkommen im Demobereich [4] =>

In diesem Bereich kannst du mit Admidio herumspielen und schauen, ....

                [ann_description] => <p>In diesem Bereich kannst du mit Admidio herumspielen und schauen, ....</p>
                [5] => 1
                [ann_usr_id_create] => 1
                [6] => 2013-07-18 00:00:00
                [ann_timestamp_create] => 2013-07-18 00:00:00
                [7] =>
                [ann_usr_id_change] =>
                [8] =>
                [ann_timestamp_change] =>
                [9] => Paul Webmaster
                [create_name] => Paul Webmaster
                [10] =>
                [change_name] =>
            )
    )
[parameter] => Array
    (
        [active_role] => 1
        [calendar-selection] => 1
        [cat_id] => 0
        [category-selection] => 0,
        [date] => ''
        [daterange] => Array
            (
                [english] => Array
                    (
                        [start_date] => 2013-09-16 // current date
                        [end_date] => 9999-12-31
                    )

                [system] => Array
                    (
                        [start_date] => 16.09.2013 // current date
                        [end_date] => 31.12.9999
                    )
            )
        [headline] => Ankündigungen
        [id] => 0
        [mode] => Default
        [order] => 'ASC'
        [startelement] => 0
        [view_mode] => Default
    )

)


Endcode
Par: Returned Array
Located at moduleannouncements.php

Methods summary

public mixed
# getDataSetCount( )

Get number of available announcements

Get number of available announcements

Returns

mixed
public array
# getDataSet( integer $startElement = 0, integer $limit = null )

Get all records and push it to the array

Get all records and push it to the array

Parameters

$startElement
$limit

Returns

array
Returns the Array with results, recordsets and validated parameters from $_GET Array
public boolean
# setDateRange( string $dateRangeStart = '1970-01-01', string $dateRangeEnd = DATE_NOW )

Set a date range in which the dates should be searched. The method will fill 4 parameters @b dateStartFormatEnglish, @b dateStartFormatEnglish,

Set a date range in which the dates should be searched. The method will fill 4 parameters @b dateStartFormatEnglish, @b dateStartFormatEnglish,

Parameters

$dateRangeStart
A date in english or Admidio format that will be the start date of the range.
$dateRangeEnd
A date in english or Admidio format that will be the end date of the range.

Returns

boolean
Returns false if invalid date format is submitted

B

dateEndFormatEnglish and @b dateEndFormatAdmidio that could be read with getParameter and could be used in the script.


private boolean
# setDateRangeParams( string $dateRange, string $dateRangePoint, string $dateFormat )

Parameters

$dateRange
$dateRangePoint
$dateFormat

Returns

boolean

Methods inherited from Modules

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

Constants summary

Constants inherited from Modules

HEADLINE

Properties summary

protected $getConditions
#

Properties inherited from Modules

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

Admidio API API documentation generated by ApiGen