Overview
  • Package
  • Class

Packages

  • CT-API
  • CT-ChurchAuth
  • CT-ChurchCal
  • CT-ChurchCheckin
  • CT-ChurchCore
  • CT-ChurchDB
  • CT-ChurchFinance
  • CT-ChurchHome
  • CT-ChurchReport
  • CT-ChurchResource
  • CT-ChurchService
  • CT-ChurchTranslate
  • CT-ChurchWiki
  • CT-DB
  • CT-Form

Classes

  • CTAdminModule
  • CTAuthModule
  • CTChurchCalModule
  • CTChurchCheckinModule
  • CTChurchDBModule
  • CTChurchFinanceModule
  • CTChurchReportModule
  • CTChurchResourceModule
  • CTChurchServiceModule
  • CTChurchWikiModule
  • CTHomeModule
  • CTLoginModule

Interfaces

  • CTModuleInterface

Class CTChurchServiceModule

CTChurchServiceModule defines all API calls für ChurchService

CTAbstractModule implements CTModuleInterface
Extended by CTChurchServiceModule
Package: CT-API
Located at system/churchservice/classes/CTChurchServiceModule.class.php

Methods summary

public
# getMasterDataTablenames( $onlyEdit = false )

Get array with churchcore_getMasterDataEntry() entries for all MasterData tables. Or null if there is no table needed.

Get array with churchcore_getMasterDataEntry() entries for all MasterData tables. Or null if there is no table needed.

Overrides

CTAbstractModule::getMasterDataTablenames
public
# getMasterData( )

See

CTModuleInterface::getMasterData()
public
# updateEvent( $params )
public
# createEvent( $params )
public
# deleteEvent( $params )
public
# getEventChangeImpact( $params )
public
# saveSplittedEvent( $params )
public
# getEventTemplates( )
public
# updateEventService( $params )
public
# getAbsent( $params )
public
# getGroupAndTagInfos( )
public
# sendEMailToPersonIds( $params )
public
# saveTemplate( $params )
public
# deleteTemplate( $params )
public
# delFile( $params )
public
# renameFile( $params )
public
# copyFile( $params )
public
# getFiles( $params )
public
# getAllSongs( $params )
public
# getSongStatistic( $params )
public
# addNewSong( $params )
public
# editSong( $params )
public
# addNewTag( $params )
public
# addSongTag( $params )
public
# delSongTag( $params )
public
# editArrangement( $params )
public
# addArrangement( $params )
public
# delArrangement( $params )
public
# deleteSong( $params )
public
# makeAsStandardArrangement( $params )
public
# saveAbsent( $params )
public
# delAbsent( $params )
public
# saveNote( $params )
public
# getServiceGroupPersonWeight( $params )
public
# editServiceGroupPersonWeight( $params )
public
# getChurchDBMasterData( $params )
public
# loadAllAgendaTemplates( $params )

Load agenda templates, if allowed.

Load agenda templates, if allowed.

Throws

CTNoPermission
public agenda
# loadAgendas( array $params, $checkPerm = true )

Load agendas with ids including related Event_ids but without items Check if it's allowed to view or if user is involved in one of the events

Load agendas with ids including related Event_ids but without items Check if it's allowed to view or if user is involved in one of the events

Parameters

$params
$params; [ids] for ids to get
$checkPerm

Returns

agenda
oder null if not found or not allowed
public Agenda
# loadAgendaForEvent( unknown $params )

Gets the agenda belonging to the event $params["event_id"]

Gets the agenda belonging to the event $params["event_id"]

Parameters

$params

Returns

Agenda
with all items

Throws

CTWarnException
CTNoPermission
public array
# loadAgendaItems( array $params )

Load Agenda items

Load Agenda items

Parameters

$params
$params["agenda_id"]

Returns

array
with item objects

Throws

CTException
CTNoPermission
public
# isUserInvolvedOrAllowedForEventIds( $eventIds, $perm )
public
# isEventAdmin( $eventId, $userId )
public
# isUserInvolved( unknown $event_id )

Check, if I have a service in this event

Check, if I have a service in this event

Parameters

$event_id
public new
# saveItem( array $params, $checkPerm = true )

Saves item of agenda agenda_id

Saves item of agenda agenda_id

Parameters

$params
$params[...]
$checkPerm

Returns

new
item id
public array
# saveAgenda( array $params )

Save agenda and return saved one with all new Ids

Save agenda and return saved one with all new Ids

Parameters

$params

Returns

array
public item
# loadItem( array $params )

Load item $params["id"] with calcategory_id and template_yn from agenda

Load item $params["id"] with calcategory_id and template_yn from agenda

Parameters

$params

Returns

item

Throws

CTException
  • When item not found

CTNoPermission
  • When not allowed to edit or view
public
# saveServiceGroupNote( a $params )

save item related note for servicegroup

save item related note for servicegroup

Parameters

$params
public
# deleteItemEventRelation( array $params )

Parameters

$params
public
# addItemEventRelation( array $params )

Parameters

$params
public
# deleteItem( array $params )

Parameters

$params
public
# deleteAgenda( a $params )

Parameters

$params

Throws

CTException
public
# pollForNews( $params )
public
# getNewEventData( $params )
public
# getAllEventData( array $params )

Get all event data inclusive services

Get all event data inclusive services

Parameters

$params

Possible values are:

  • id - Id to get only one event

Throws

CTWarnException
public
# getAllFacts( $params )
public
# saveFact( $params )
public
# deleteService( $params )
public
# editService( $params )
public
# addOrRemoveServiceToEvent( $params )
protected multitype:
# getConstraints( )

Get constraints to prevent deleting of master Data

Get constraints to prevent deleting of master Data

Returns

multitype:

Overrides

CTAbstractModule::getConstraints
public
# disableCCLI( )
public
# getCCLIAuthorizationURL( $params )
public
# getCCLISongData( $params )
public
# getCCLISongsMatchingTitle( $params )
public
# saveCCLILyricsFile( $params )
public
# getCCLILyrics( $params )
public
# getCCLIChordsFile( $params )
public
# uploadLink( $params )

Methods inherited from CTAbstractModule

__construct(), call(), checkPerm(), deleteMasterData(), deleteMasterDataReferences(), editNotification(), generatePDF(), getMasterDataOfTables(), getModuleName(), getModulePath(), getSettings(), hasPDFGenerator(), log(), logGroup(), logMasterData(), logPerson(), makeDownloadFile(), notify(), prepareForLog(), prooveDeleteMasterData(), saveMasterData(), saveMasterDataToDB(), saveSetting(), setCookie(), setLanguage()

API documentation generated by ApiGen