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 CTLoginModule

CTLoginModule defines all API calls für login and logout user

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

Methods summary

public
# getMasterData( )

Make no sense in this context

Make no sense in this context

See

CTModuleInterface::getMasterData()
public
# login( array $params )

Login a user with email and password

Login a user with email and password

Parameters

$params

Possible values are:

  • email
  • password
  • directtool (optional) - Name of the tool for log info

Throws

CTWarnException
public
# getUserLoginToken( array $params )

Creates a new user login token.

Creates a new user login token.

Parameters

$params

Throws

CTWarnException
public
# loginWithToken( array $params )

Login a user with token. Get this token from getUserLoginToken()

Login a user with token. Get this token from getUserLoginToken()

Parameters

$params

Possible values are:

  • token
  • id
  • directtool (optional) - Name of the tool for log info

Throws

CTWarnException
public
# logout( )

Logout the current user

Logout the current user

Methods inherited from CTAbstractModule

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

API documentation generated by ApiGen