Documentation

Civi

Table of Contents

Packages

ActionSchedule
ActionScheduleTheRecipientBuilderpreparesalistofrecipientsbasedonanaction
Angular
API
APIPerformaseriesofexternalasynchronousconcurrentAPIcall
Api4
CCase
CiUtil
Codeception
Core
CoreTheCiviEventDispatcherisaSymfonydispatcher
CoreThisinterfaceallowsCRM
CoreThispathsclasstranslatespath
CoreReadandwritesettingsforagivendomainorcontact
CoreTheSettingsManagerisresponsiblefortrackingsettingsacrossvariousdomainsandusers
CoreSincesymfony4
Crypt
Crypto
Install
Payment
Report
Schema
TestThistraitdefinesanumberofhelperfunctionsfortestingAPIv3
TestThistraitdefinesapiv4helperfunctionstocreatetrackandcleanuptestdata
Test
TestCiviTestListenerparticipatesintest
TestThistraitdefinesanumberofhelperfunctionsformanagingtestcontacts
TestThistraitisintendedforusewithPHPUnit
TestTorunyourtestagainstaliveCMS
TestAsmalllibraryofgenericassertions
TestTorunyourtestagainstafakeheadlessdatabaseflagitwiththeHeadlessInterface
TestThistraitprovideshelpersassertionsfortestingCivisHTTPinterfaceseg
TestThistraitdefinesanumberofhelperfunctionsformanagingtestmailings
TestMarkatestwithTransactionalInterfacetoinstructCiviTestListenertowrapeachtestinatransactionandrollback
TokenAbstractTokenSubscriberisabaseclasswhichmaybeextendedtoimplementtokensinasomewhatmoreconcisefashion
Token
TokenThisclasshandlesthesmartyprocessingoftokens
TokenATokenRowisahelperstubprovidingsimplifiedaccesstotheTokenProcessor
TokenCombinetherow
AfformAdmin
Afform
AfformExaminesaformanddeterminestheentitiesfieldsjoinsinuse
AfformThisclassrepesentsalistofkeysymbolsusedbyanHTMLdocumentsuchaselementtagnamesattributenamesandCSSclassnames
AfformMock
Authx
AuthxEachuser
FlexMailer
FlexMailerTheFlexMailerisamail
FlexMailerAFlexMailerTaskdescribesanindividualmessagethatneedstobecomposedanddelivered
FlexMailerManagethesetupofanyservicesusedbyFlexMailer
FlexMailerThevalidatordetermineswhetheramailingiscompletelyspecifiedsendable
OAuthThisisavariantofGenericProviderwhichtriestosupportsomenewerconventionsout
Search
SetupTheModeldefinesthemainoptionsandinputsthatareusedtoconfiguretheinstaller
Setup

Classes

Kernel
WhitelistSubscriber
The WhitelistSubscriber listens to API requests and matches them against a whitelist of allowed API calls. If an API call does NOT appear in the whitelist, then it generates an error.
Frame
A "frame" is a layer in a series of nested transactions. Generally, the outermost frame is a normal SQL transaction (BEGIN/ROLLBACK/COMMIT) and any nested frames are SQL savepoints (SAVEPOINT foo/ROLLBACK TO SAVEPOINT).
Manager

        
On this page

Search results