<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Documentation</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="icon" href="images/favicon.ico"/>
<link rel="stylesheet" href="css/normalize.css">
<link rel="stylesheet" href="css/base.css">
<link rel="preconnect" href="https://fonts.gstatic.com">
<link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@100;200;300;400;600;700&display=swap" rel="stylesheet">
<link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
<link rel="stylesheet" href="css/template.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
<script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
<script src="js/template.js"></script>
<script src="js/search.js"></script>
<script defer src="js/searchIndex.js"></script>
</head>
<body id="top">
<header class="phpdocumentor-header phpdocumentor-section">
<h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
<input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
<label class="phpdocumentor-header__menu-icon" for="menu-button">
<i class="fas fa-bars"></i>
</label>
<section data-search-form class="phpdocumentor-search">
<label>
<span class="visually-hidden">Search for</span>
<svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
<circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
<line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
</svg>
<input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
</label>
</section>
<nav class="phpdocumentor-topnav">
<ul class="phpdocumentor-topnav__menu">
</ul>
</nav>
</header>
<main class="phpdocumentor">
<div class="phpdocumentor-section">
<input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
Menu
</label>
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category -namespaces">
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/civi.html" class="">Civi</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/civi-actionschedule.html" class="">ActionSchedule</a>
</li>
<li>
<a href="namespaces/civi-angular.html" class="">Angular</a>
</li>
<li>
<a href="namespaces/civi-api.html" class="">API</a>
</li>
<li>
<a href="namespaces/civi-api4.html" class="">Api4</a>
</li>
<li>
<a href="namespaces/civi-ccase.html" class="">CCase</a>
</li>
<li>
<a href="namespaces/civi-ciutil.html" class="">CiUtil</a>
</li>
<li>
<a href="namespaces/civi-codeception.html" class="">Codeception</a>
</li>
<li>
<a href="namespaces/civi-core.html" class="">Core</a>
</li>
<li>
<a href="namespaces/civi-crypto.html" class="">Crypto</a>
</li>
<li>
<a href="namespaces/civi-custom.html" class="">Custom</a>
</li>
<li>
<a href="namespaces/civi-esm.html" class="">Esm</a>
</li>
<li>
<a href="namespaces/civi-import.html" class="">Import</a>
</li>
<li>
<a href="namespaces/civi-install.html" class="">Install</a>
</li>
<li>
<a href="namespaces/civi-payment.html" class="">Payment</a>
</li>
<li>
<a href="namespaces/civi-pipe.html" class="">Pipe</a>
</li>
<li>
<a href="namespaces/civi-report.html" class="">Report</a>
</li>
<li>
<a href="namespaces/civi-schema.html" class="">Schema</a>
</li>
<li>
<a href="namespaces/civi-standalone.html" class="">Standalone</a>
</li>
<li>
<a href="namespaces/civi-test.html" class="">Test</a>
</li>
<li>
<a href="namespaces/civi-civi.html" class="">Civi</a>
</li>
<li>
<a href="namespaces/civi-token.html" class="">Token</a>
</li>
<li>
<a href="namespaces/civi-userjob.html" class="">UserJob</a>
</li>
<li>
<a href="namespaces/civi-visual.html" class="">Visual</a>
</li>
<li>
<a href="namespaces/civi-workflowmessage.html" class="">WorkflowMessage</a>
</li>
<li>
<a href="namespaces/civi-afformadmin.html" class="">AfformAdmin</a>
</li>
<li>
<a href="namespaces/civi-afform.html" class="">Afform</a>
</li>
<li>
<a href="namespaces/civi-afformlogintoken.html" class="">AfformLoginToken</a>
</li>
<li>
<a href="namespaces/civi-afformmock.html" class="">AfformMock</a>
</li>
<li>
<a href="namespaces/civi-authx.html" class="">Authx</a>
</li>
<li>
<a href="namespaces/civi-chartkit.html" class="">ChartKit</a>
</li>
<li>
<a href="namespaces/civi-entity.html" class="">Entity</a>
</li>
<li>
<a href="namespaces/civi-ext.html" class="">ext</a>
</li>
<li>
<a href="namespaces/civi-bao.html" class="">BAO</a>
</li>
<li>
<a href="namespaces/civi-financialacls.html" class="">Financialacls</a>
</li>
<li>
<a href="namespaces/civi-flexmailer.html" class="">FlexMailer</a>
</li>
<li>
<a href="namespaces/civi-iframe.html" class="">Iframe</a>
</li>
<li>
<a href="namespaces/civi-searches.html" class="">Searches</a>
</li>
<li>
<a href="namespaces/civi-oauth.html" class="">OAuth</a>
</li>
<li>
<a href="namespaces/civi-oembed.html" class="">Oembed</a>
</li>
<li>
<a href="namespaces/civi-search.html" class="">Search</a>
</li>
<li>
<a href="namespaces/civi-scheduledcommunications.html" class="">ScheduledCommunications</a>
</li>
<li>
<a href="namespaces/civi-shimmy.html" class="">Shimmy</a>
</li>
<li>
<a href="namespaces/civi-mixin.html" class="">Mixin</a>
</li>
<li>
<a href="namespaces/civi-setup.html" class="">Setup</a>
</li>
<li>
<a href="namespaces/civi-tests.html" class="">tests</a>
</li>
<li>
<a href="namespaces/civi-mock.html" class="">Mock</a>
</li>
<li>
<a href="namespaces/civi-phpstorm.html" class="">PhpStorm</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/e2e.html" class="">E2E</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/e2e-afformmock.html" class="">AfformMock</a>
</li>
<li>
<a href="namespaces/e2e-api4.html" class="">Api4</a>
</li>
<li>
<a href="namespaces/e2e-core.html" class="">Core</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/guzzlehttp.html" class="">GuzzleHttp</a>
</h4>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/civimix.html" class="">CiviMix</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/civimix-schema.html" class="">Schema</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/api.html" class="">api</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/api-v4.html" class="">v4</a>
</li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category -packages">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="packages/Application.html" class="">Application</a>
</h4>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="packages/CiviCRM.html" class="">CiviCRM</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="packages/CiviCRM-APIv3.html" class="">APIv3</a>
</li>
<li>
<a href="packages/CiviCRM-Hook.html" class="">Hook</a>
</li>
<li>
<a href="packages/CiviCRM-CRM.html" class="">CRM</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="packages/CRM.html" class="">CRM</a>
</h4>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="packages/Civi.html" class="">Civi</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="packages/Civi-ActionSchedule.html" class="">ActionSchedule</a>
</li>
<li>
<a href="packages/Civi-ActionScheduleTheRecipientBuilderpreparesalistofrecipientsbasedonanaction.html" class="">ActionScheduleTheRecipientBuilderpreparesalistofrecipientsbasedonanaction</a>
</li>
<li>
<a href="packages/Civi-Angular.html" class="">Angular</a>
</li>
<li>
<a href="packages/Civi-API.html" class="">API</a>
</li>
<li>
<a href="packages/Civi-APIPerformaseriesofexternalasynchronousconcurrentAPIcall.html" class="">APIPerformaseriesofexternalasynchronousconcurrentAPIcall</a>
</li>
<li>
<a href="packages/Civi-Api4.html" class="">Api4</a>
</li>
<li>
<a href="packages/Civi-CCase.html" class="">CCase</a>
</li>
<li>
<a href="packages/Civi-CiUtil.html" class="">CiUtil</a>
</li>
<li>
<a href="packages/Civi-Codeception.html" class="">Codeception</a>
</li>
<li>
<a href="packages/Civi-Core.html" class="">Core</a>
</li>
<li>
<a href="packages/Civi-CoreTheCiviEventDispatcherisaSymfonydispatcher.html" class="">CoreTheCiviEventDispatcherisaSymfonydispatcher</a>
</li>
<li>
<a href="packages/Civi-CoreThisinterfaceallowsCRM.html" class="">CoreThisinterfaceallowsCRM</a>
</li>
<li>
<a href="packages/Civi-CoreThispathsclasstranslatespath.html" class="">CoreThispathsclasstranslatespath</a>
</li>
<li>
<a href="packages/Civi-CoreReadandwritesettingsforagivendomainorcontact.html" class="">CoreReadandwritesettingsforagivendomainorcontact</a>
</li>
<li>
<a href="packages/Civi-CoreTheSettingsManagerisresponsiblefortrackingsettingsacrossvariousdomainsandusers.html" class="">CoreTheSettingsManagerisresponsiblefortrackingsettingsacrossvariousdomainsandusers</a>
</li>
<li>
<a href="packages/Civi-CoreSincesymfony4.html" class="">CoreSincesymfony4</a>
</li>
<li>
<a href="packages/Civi-Crypt.html" class="">Crypt</a>
</li>
<li>
<a href="packages/Civi-Crypto.html" class="">Crypto</a>
</li>
<li>
<a href="packages/Civi-Install.html" class="">Install</a>
</li>
<li>
<a href="packages/Civi-Payment.html" class="">Payment</a>
</li>
<li>
<a href="packages/Civi-Report.html" class="">Report</a>
</li>
<li>
<a href="packages/Civi-Schema.html" class="">Schema</a>
</li>
<li>
<a href="packages/Civi-TestThistraitdefinesanumberofhelperfunctionsfortestingAPIv3.html" class="">TestThistraitdefinesanumberofhelperfunctionsfortestingAPIv3</a>
</li>
<li>
<a href="packages/Civi-TestThistraitdefinesapiv4helperfunctionstocreatetrackandcleanuptestdata.html" class="">TestThistraitdefinesapiv4helperfunctionstocreatetrackandcleanuptestdata</a>
</li>
<li>
<a href="packages/Civi-Test.html" class="">Test</a>
</li>
<li>
<a href="packages/Civi-TestCiviTestListenerparticipatesintest.html" class="">TestCiviTestListenerparticipatesintest</a>
</li>
<li>
<a href="packages/Civi-TestThistraitdefinesanumberofhelperfunctionsformanagingtestcontacts.html" class="">TestThistraitdefinesanumberofhelperfunctionsformanagingtestcontacts</a>
</li>
<li>
<a href="packages/Civi-TestThistraitisintendedforusewithPHPUnit.html" class="">TestThistraitisintendedforusewithPHPUnit</a>
</li>
<li>
<a href="packages/Civi-TestTorunyourtestagainstaliveCMS.html" class="">TestTorunyourtestagainstaliveCMS</a>
</li>
<li>
<a href="packages/Civi-TestAsmalllibraryofgenericassertions.html" class="">TestAsmalllibraryofgenericassertions</a>
</li>
<li>
<a href="packages/Civi-TestTorunyourtestagainstafakeheadlessdatabaseflagitwiththeHeadlessInterface.html" class="">TestTorunyourtestagainstafakeheadlessdatabaseflagitwiththeHeadlessInterface</a>
</li>
<li>
<a href="packages/Civi-TestThistraitprovideshelpersassertionsfortestingCivisHTTPinterfaceseg.html" class="">TestThistraitprovideshelpersassertionsfortestingCivisHTTPinterfaceseg</a>
</li>
<li>
<a href="packages/Civi-TestThistraitdefinesanumberofhelperfunctionsformanagingtestmailings.html" class="">TestThistraitdefinesanumberofhelperfunctionsformanagingtestmailings</a>
</li>
<li>
<a href="packages/Civi-TestMarkatestwithTransactionalInterfacetoinstructCiviTestListenertowrapeachtestinatransactionandrollback.html" class="">TestMarkatestwithTransactionalInterfacetoinstructCiviTestListenertowrapeachtestinatransactionandrollback</a>
</li>
<li>
<a href="packages/Civi-TokenAbstractTokenSubscriberisabaseclasswhichmaybeextendedtoimplementtokensinasomewhatmoreconcisefashion.html" class="">TokenAbstractTokenSubscriberisabaseclasswhichmaybeextendedtoimplementtokensinasomewhatmoreconcisefashion</a>
</li>
<li>
<a href="packages/Civi-Token.html" class="">Token</a>
</li>
<li>
<a href="packages/Civi-TokenThisclasshandlesthesmartyprocessingoftokens.html" class="">TokenThisclasshandlesthesmartyprocessingoftokens</a>
</li>
<li>
<a href="packages/Civi-TokenATokenRowisahelperstubprovidingsimplifiedaccesstotheTokenProcessor.html" class="">TokenATokenRowisahelperstubprovidingsimplifiedaccesstotheTokenProcessor</a>
</li>
<li>
<a href="packages/Civi-TokenCombinetherow.html" class="">TokenCombinetherow</a>
</li>
<li>
<a href="packages/Civi-AfformAdmin.html" class="">AfformAdmin</a>
</li>
<li>
<a href="packages/Civi-Afform.html" class="">Afform</a>
</li>
<li>
<a href="packages/Civi-AfformExaminesaformanddeterminestheentitiesfieldsjoinsinuse.html" class="">AfformExaminesaformanddeterminestheentitiesfieldsjoinsinuse</a>
</li>
<li>
<a href="packages/Civi-AfformThisclassrepesentsalistofkeysymbolsusedbyanHTMLdocumentsuchaselementtagnamesattributenamesandCSSclassnames.html" class="">AfformThisclassrepesentsalistofkeysymbolsusedbyanHTMLdocumentsuchaselementtagnamesattributenamesandCSSclassnames</a>
</li>
<li>
<a href="packages/Civi-AfformMock.html" class="">AfformMock</a>
</li>
<li>
<a href="packages/Civi-Authx.html" class="">Authx</a>
</li>
<li>
<a href="packages/Civi-AuthxEachuser.html" class="">AuthxEachuser</a>
</li>
<li>
<a href="packages/Civi-FlexMailer.html" class="">FlexMailer</a>
</li>
<li>
<a href="packages/Civi-FlexMailerTheFlexMailerisamail.html" class="">FlexMailerTheFlexMailerisamail</a>
</li>
<li>
<a href="packages/Civi-FlexMailerAFlexMailerTaskdescribesanindividualmessagethatneedstobecomposedanddelivered.html" class="">FlexMailerAFlexMailerTaskdescribesanindividualmessagethatneedstobecomposedanddelivered</a>
</li>
<li>
<a href="packages/Civi-FlexMailerManagethesetupofanyservicesusedbyFlexMailer.html" class="">FlexMailerManagethesetupofanyservicesusedbyFlexMailer</a>
</li>
<li>
<a href="packages/Civi-FlexMailerThevalidatordetermineswhetheramailingiscompletelyspecifiedsendable.html" class="">FlexMailerThevalidatordetermineswhetheramailingiscompletelyspecifiedsendable</a>
</li>
<li>
<a href="packages/Civi-OAuthThisisavariantofGenericProviderwhichtriestosupportsomenewerconventionsout.html" class="">OAuthThisisavariantofGenericProviderwhichtriestosupportsomenewerconventionsout</a>
</li>
<li>
<a href="packages/Civi-Search.html" class="">Search</a>
</li>
<li>
<a href="packages/Civi-SetupTheModeldefinesthemainoptionsandinputsthatareusedtoconfiguretheinstaller.html" class="">SetupTheModeldefinesthemainoptionsandinputsthatareusedtoconfiguretheinstaller</a>
</li>
<li>
<a href="packages/Civi-Setup.html" class="">Setup</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="packages/Smarty.html" class="">Smarty</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="packages/Smarty-plugins.html" class="">plugins</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="packages/CiviApi4ActionAfform.html" class="">CiviApi4ActionAfform</a>
</h4>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="packages/Authx.html" class="">Authx</a>
</h4>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="packages/eventcart.html" class="">eventcart</a>
</h4>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="packages/CiviCRMThisfileispartofCiviCRMCiviCRMisfreesoftwareyoucanredistributeitandormodifyitunderthetermsoftheGNUAfferoGeneralPublicLicenseaspublishedbytheFreeSoftwareFoundationeitherversion3oftheLicenseoratyouroptionanylaterversion.html" class="">CiviCRMThisfileispartofCiviCRMCiviCRMisfreesoftwareyoucanredistributeitandormodifyitunderthetermsoftheGNUAfferoGeneralPublicLicenseaspublishedbytheFreeSoftwareFoundationeitherversion3oftheLicenseoratyouroptionanylaterversion</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="packages/CiviCRMThisfileispartofCiviCRMCiviCRMisfreesoftwareyoucanredistributeitandormodifyitunderthetermsoftheGNUAfferoGeneralPublicLicenseaspublishedbytheFreeSoftwareFoundationeitherversion3oftheLicenseoratyouroptionanylaterversion-CiviCRMisdistributedinthehopethatitwillbeusefulbutWITHOUTANYWARRANTYwithouteventheimpliedwarrantyofMERCHANTABILITYorFITNESSFORAPARTICULARPURPOSE.html" class="">CiviCRMisdistributedinthehopethatitwillbeusefulbutWITHOUTANYWARRANTYwithouteventheimpliedwarrantyofMERCHANTABILITYorFITNESSFORAPARTICULARPURPOSE</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="packages/standaloneusers.html" class="">standaloneusers</a>
</h4>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="packages/api.html" class="">api</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="packages/api-v4.html" class="">v4</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="packages/E2E.html" class="">E2E</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="packages/E2E-Api4.html" class="">Api4</a>
</li>
<li>
<a href="packages/E2E-Core.html" class="">Core</a>
</li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category -reports">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
</section>
<section class="phpdocumentor-sidebar__category -indices">
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
</section>
</aside>
<div class="phpdocumentor-column -nine phpdocumentor-content">
<section>
<h2>Documentation</h2>
<h3 id="toc">
Table of Contents
<a href="namespaces/default.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<h4 id="packages">
Packages
<a href="namespaces/default.html#packages" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -package"><a href="packages/Application.html"><abbr title="\Application">Application</abbr></a></dt>
<dt class="phpdocumentor-table-of-contents__entry -package"><a href="packages/CiviCRM.html"><abbr title="\CiviCRM">CiviCRM</abbr></a></dt>
<dt class="phpdocumentor-table-of-contents__entry -package"><a href="packages/CRM.html"><abbr title="\CRM">CRM</abbr></a></dt>
<dt class="phpdocumentor-table-of-contents__entry -package"><a href="packages/Civi.html"><abbr title="\Civi">Civi</abbr></a></dt>
<dt class="phpdocumentor-table-of-contents__entry -package"><a href="packages/Smarty.html"><abbr title="\Smarty">Smarty</abbr></a></dt>
<dt class="phpdocumentor-table-of-contents__entry -package"><a href="packages/CiviApi4ActionAfform.html"><abbr title="\CiviApi4ActionAfform">CiviApi4ActionAfform</abbr></a></dt>
<dt class="phpdocumentor-table-of-contents__entry -package"><a href="packages/Authx.html"><abbr title="\Authx">Authx</abbr></a></dt>
<dt class="phpdocumentor-table-of-contents__entry -package"><a href="packages/eventcart.html"><abbr title="\eventcart">eventcart</abbr></a></dt>
<dt class="phpdocumentor-table-of-contents__entry -package"><a href="packages/CiviCRMThisfileispartofCiviCRMCiviCRMisfreesoftwareyoucanredistributeitandormodifyitunderthetermsoftheGNUAfferoGeneralPublicLicenseaspublishedbytheFreeSoftwareFoundationeitherversion3oftheLicenseoratyouroptionanylaterversion.html"><abbr title="\CiviCRMThisfileispartofCiviCRMCiviCRMisfreesoftwareyoucanredistributeitandormodifyitunderthetermsoftheGNUAfferoGeneralPublicLicenseaspublishedbytheFreeSoftwareFoundationeitherversion3oftheLicenseoratyouroptionanylaterversion">CiviCRMThisfileispartofCiviCRMCiviCRMisfreesoftwareyoucanredistributeitandormodifyitunderthetermsoftheGNUAfferoGeneralPublicLicenseaspublishedbytheFreeSoftwareFoundationeitherversion3oftheLicenseoratyouroptionanylaterversion</abbr></a></dt>
<dt class="phpdocumentor-table-of-contents__entry -package"><a href="packages/standaloneusers.html"><abbr title="\standaloneusers">standaloneusers</abbr></a></dt>
<dt class="phpdocumentor-table-of-contents__entry -package"><a href="packages/api.html"><abbr title="\api">api</abbr></a></dt>
<dt class="phpdocumentor-table-of-contents__entry -package"><a href="packages/E2E.html"><abbr title="\E2E">E2E</abbr></a></dt>
</dl>
<h4 id="namespaces">
Namespaces
<a href="namespaces/default.html#namespaces" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -namespace"><a href="namespaces/civi.html"><abbr title="\Civi">Civi</abbr></a></dt>
<dt class="phpdocumentor-table-of-contents__entry -namespace"><a href="namespaces/e2e.html"><abbr title="\E2E">E2E</abbr></a></dt>
<dt class="phpdocumentor-table-of-contents__entry -namespace"><a href="namespaces/guzzlehttp.html"><abbr title="\GuzzleHttp">GuzzleHttp</abbr></a></dt>
<dt class="phpdocumentor-table-of-contents__entry -namespace"><a href="namespaces/civimix.html"><abbr title="\CiviMix">CiviMix</abbr></a></dt>
<dt class="phpdocumentor-table-of-contents__entry -namespace"><a href="namespaces/api.html"><abbr title="\api">api</abbr></a></dt>
</dl>
<h4 id="toc-interfaces">
Interfaces
<a href="namespaces/default.html#toc-interfaces" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -interface"><a href="classes/API-Wrapper.html"><abbr title="\API_Wrapper">API_Wrapper</abbr></a></dt><dd>Interface API_Wrapper</dd> <dt class="phpdocumentor-table-of-contents__entry -interface"><a href="classes/CRM-Contact-Form-Search-Interface.html"><abbr title="\CRM_Contact_Form_Search_Interface">CRM_Contact_Form_Search_Interface</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -interface"><a href="classes/CRM-Core-CodeGen-ITask.html"><abbr title="\CRM_Core_CodeGen_ITask">CRM_Core_CodeGen_ITask</abbr></a></dt><dd>Implemented by CG tasks</dd> <dt class="phpdocumentor-table-of-contents__entry -interface"><a href="classes/CRM-Core-FileSearchInterface.html"><abbr title="\CRM_Core_FileSearchInterface">CRM_Core_FileSearchInterface</abbr></a></dt><dd>Interface CRM_Core_FileSearchInterface</dd> <dt class="phpdocumentor-table-of-contents__entry -interface"><a href="classes/CRM-Core-PrevNextCache-Interface.html"><abbr title="\CRM_Core_PrevNextCache_Interface">CRM_Core_PrevNextCache_Interface</abbr></a></dt><dd>Interface CRM_Core_PrevNextCache_Interface</dd> <dt class="phpdocumentor-table-of-contents__entry -interface"><a href="classes/CRM-Core-Reference-Interface.html"><abbr title="\CRM_Core_Reference_Interface">CRM_Core_Reference_Interface</abbr></a></dt><dd>Interface CRM_Core_Reference_Interface</dd> <dt class="phpdocumentor-table-of-contents__entry -interface"><a href="classes/CRM-Core-Resources-CollectionAdderInterface.html"><abbr title="\CRM_Core_Resources_CollectionAdderInterface">CRM_Core_Resources_CollectionAdderInterface</abbr></a></dt><dd>The collection-adder interface provides write-only support for a collection.</dd> <dt class="phpdocumentor-table-of-contents__entry -interface"><a href="classes/CRM-Core-Resources-CollectionInterface.html"><abbr title="\CRM_Core_Resources_CollectionInterface">CRM_Core_Resources_CollectionInterface</abbr></a></dt><dd>Class CRM_Core_Resources_CollectionInterface</dd> <dt class="phpdocumentor-table-of-contents__entry -interface"><a href="classes/CRM-Core-Selector-API.html"><abbr title="\CRM_Core_Selector_API">CRM_Core_Selector_API</abbr></a></dt><dd>This interface defines the set of functions a class needs to implement
to use the CRM/Selector object.</dd> <dt class="phpdocumentor-table-of-contents__entry -interface"><a href="classes/CRM-Extension-Container-Interface.html"><abbr title="\CRM_Extension_Container_Interface">CRM_Extension_Container_Interface</abbr></a></dt><dd>An extension container is a locally-accessible source tree which can be
scanned for extensions.</dd> <dt class="phpdocumentor-table-of-contents__entry -interface"><a href="classes/CRM-Extension-Manager-Interface.html"><abbr title="\CRM_Extension_Manager_Interface">CRM_Extension_Manager_Interface</abbr></a></dt><dd>The extension manager handles installing, disabling enabling, and
uninstalling extensions.</dd> <dt class="phpdocumentor-table-of-contents__entry -interface"><a href="classes/CRM-Extension-Upgrader-Interface.html"><abbr title="\CRM_Extension_Upgrader_Interface">CRM_Extension_Upgrader_Interface</abbr></a></dt><dd>An "upgrader" is a class that handles the DB install+upgrade lifecycle
for an extension.</dd> <dt class="phpdocumentor-table-of-contents__entry -interface"><a href="classes/CRM-Queue-Queue-BatchQueueInterface.html"><abbr title="\CRM_Queue_Queue_BatchQueueInterface">CRM_Queue_Queue_BatchQueueInterface</abbr></a></dt><dd>Variation on CRM_Queue_Queue which can claim/release/delete items in batches.</dd> <dt class="phpdocumentor-table-of-contents__entry -interface"><a href="classes/CRM-Utils-Cache-Interface.html"><abbr title="\CRM_Utils_Cache_Interface">CRM_Utils_Cache_Interface</abbr></a></dt> </dl>
<h4 id="toc-classes">
Classes
<a href="namespaces/default.html#toc-classes" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/civicrm-api3.html"><abbr title="\civicrm_api3">civicrm_api3</abbr></a></dt><dd>This class allows to consume the API, either from within a module that knows civicrm already:</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/civicrm-cli.html"><abbr title="\civicrm_cli">civicrm_cli</abbr></a></dt><dd>base class for doing all command line operations via civicrm
used by cli.php</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/civicrm-cli-csv-exporter.html"><abbr title="\civicrm_cli_csv_exporter">civicrm_cli_csv_exporter</abbr></a></dt><dd>class used by csv/export.php to export records from
the database in a csv file format.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/civicrm-cli-csv-file.html"><abbr title="\civicrm_cli_csv_file">civicrm_cli_csv_file</abbr></a></dt><dd>base class used by both civicrm_cli_csv_import
and civicrm_cli_csv_deleter to add or delete
records based on those found in a csv file
passed to the script.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/civicrm-cli-csv-importer.html"><abbr title="\civicrm_cli_csv_importer">civicrm_cli_csv_importer</abbr></a></dt><dd>class for processing records to add
used by csv/import.php</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/civicrm-cli-csv-deleter.html"><abbr title="\civicrm_cli_csv_deleter">civicrm_cli_csv_deleter</abbr></a></dt><dd>class for processing records to delete
used by csv/delete.php</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CiviContributeProcessor.html"><abbr title="\CiviContributeProcessor">CiviContributeProcessor</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Civi.html"><abbr title="\Civi">Civi</abbr></a></dt><dd>Class Civi</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-ACL-API.html"><abbr title="\CRM_ACL_API">CRM_ACL_API</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-ACL-BAO-ACL.html"><abbr title="\CRM_ACL_BAO_ACL">CRM_ACL_BAO_ACL</abbr></a></dt><dd>Access Control List</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-ACL-BAO-ACLEntityRole.html"><abbr title="\CRM_ACL_BAO_ACLEntityRole">CRM_ACL_BAO_ACLEntityRole</abbr></a></dt><dd>Access Control AclRole.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-ACL-BAO-Cache.html"><abbr title="\CRM_ACL_BAO_Cache">CRM_ACL_BAO_Cache</abbr></a></dt><dd>Access Control Cache.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-ACL-BAO-EntityRole.html"><abbr title="\CRM_ACL_BAO_EntityRole">CRM_ACL_BAO_EntityRole</abbr></a></dt><dd>Access Control AclRole.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-ACL-DAO-ACL.html"><abbr title="\CRM_ACL_DAO_ACL">CRM_ACL_DAO_ACL</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-ACL-DAO-ACLCache.html"><abbr title="\CRM_ACL_DAO_ACLCache">CRM_ACL_DAO_ACLCache</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-ACL-DAO-ACLEntityRole.html"><abbr title="\CRM_ACL_DAO_ACLEntityRole">CRM_ACL_DAO_ACLEntityRole</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-ACL-Form-ACL.html"><abbr title="\CRM_ACL_Form_ACL">CRM_ACL_Form_ACL</abbr></a></dt><dd>Base class for admin forms.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-ACL-Form-EntityRole.html"><abbr title="\CRM_ACL_Form_EntityRole">CRM_ACL_Form_EntityRole</abbr></a></dt><dd>Base class for admin forms.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-ACL-Form-WordPress-Permissions.html"><abbr title="\CRM_ACL_Form_WordPress_Permissions">CRM_ACL_Form_WordPress_Permissions</abbr></a></dt><dd>This class provides the functionality to Grant access to CiviCRM components and other CiviCRM permissions.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-ACL-Page-ACL.html"><abbr title="\CRM_ACL_Page_ACL">CRM_ACL_Page_ACL</abbr></a></dt><dd>A Page is basically data in a nice pretty format.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-ACL-Page-EntityRole.html"><abbr title="\CRM_ACL_Page_EntityRole">CRM_ACL_Page_EntityRole</abbr></a></dt><dd>A Page is basically data in a nice pretty format.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Activity-ActionMapping.html"><abbr title="\CRM_Activity_ActionMapping">CRM_Activity_ActionMapping</abbr></a></dt><dd>This defines the scheduled-reminder functionality for Activities.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Activity-BAO-Activity.html"><abbr title="\CRM_Activity_BAO_Activity">CRM_Activity_BAO_Activity</abbr></a></dt><dd>This class is for activity functions.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Activity-BAO-ActivityAssignment.html"><abbr title="\CRM_Activity_BAO_ActivityAssignment">CRM_Activity_BAO_ActivityAssignment</abbr></a></dt><dd>This class is for activity assignment functions.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Activity-BAO-ActivityContact.html"><abbr title="\CRM_Activity_BAO_ActivityContact">CRM_Activity_BAO_ActivityContact</abbr></a></dt><dd>This class is for activity assignment functions.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Activity-BAO-ActivityType.html"><abbr title="\CRM_Activity_BAO_ActivityType">CRM_Activity_BAO_ActivityType</abbr></a></dt><dd>This class is a wrapper that moves some boilerplate code out of the Form class and helps remove some ambiguity with name and label.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Activity-BAO-ICalendar.html"><abbr title="\CRM_Activity_BAO_ICalendar">CRM_Activity_BAO_ICalendar</abbr></a></dt><dd>Generate ical invites for activities.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Activity-BAO-Query.html"><abbr title="\CRM_Activity_BAO_Query">CRM_Activity_BAO_Query</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Activity-Controller-Search.html"><abbr title="\CRM_Activity_Controller_Search">CRM_Activity_Controller_Search</abbr></a></dt><dd>This class is used by the Search functionality.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Activity-DAO-Activity.html"><abbr title="\CRM_Activity_DAO_Activity">CRM_Activity_DAO_Activity</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Activity-DAO-ActivityContact.html"><abbr title="\CRM_Activity_DAO_ActivityContact">CRM_Activity_DAO_ActivityContact</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Activity-Export-Form-Map.html"><abbr title="\CRM_Activity_Export_Form_Map">CRM_Activity_Export_Form_Map</abbr></a></dt><dd>This class gets the name of the file to upload</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Activity-Export-Form-Select.html"><abbr title="\CRM_Activity_Export_Form_Select">CRM_Activity_Export_Form_Select</abbr></a></dt><dd>This class gets the name of the file to upload</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Activity-Form-Activity.html"><abbr title="\CRM_Activity_Form_Activity">CRM_Activity_Form_Activity</abbr></a></dt><dd>This class generates form components for Activity.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Activity-Form-ActivityFilter.html"><abbr title="\CRM_Activity_Form_ActivityFilter">CRM_Activity_Form_ActivityFilter</abbr></a></dt><dd>This class generates form components for Activity Filter.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Activity-Form-ActivityLinks.html"><abbr title="\CRM_Activity_Form_ActivityLinks">CRM_Activity_Form_ActivityLinks</abbr></a></dt><dd>This class generates form components for Activity Links.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Activity-Form-ActivityView.html"><abbr title="\CRM_Activity_Form_ActivityView">CRM_Activity_Form_ActivityView</abbr></a></dt><dd>This class handle activity view mode.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Activity-Form-Search.html"><abbr title="\CRM_Activity_Form_Search">CRM_Activity_Form_Search</abbr></a></dt><dd>This file is for activity search.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Activity-Form-Task-AddToTag.html"><abbr title="\CRM_Activity_Form_Task_AddToTag">CRM_Activity_Form_Task_AddToTag</abbr></a></dt><dd>This class provides the functionality to tag a group of
activities (or a single activity)</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Activity-Form-Task-Batch.html"><abbr title="\CRM_Activity_Form_Task_Batch">CRM_Activity_Form_Task_Batch</abbr></a></dt><dd>This class provides the functionality for batch profile update for Activities</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Activity-Form-Task-Delete.html"><abbr title="\CRM_Activity_Form_Task_Delete">CRM_Activity_Form_Task_Delete</abbr></a></dt><dd>This class provides the functionality to delete a group of
Activities. This class provides functionality for the actual
deletion.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Activity-Form-Task-Email.html"><abbr title="\CRM_Activity_Form_Task_Email">CRM_Activity_Form_Task_Email</abbr></a></dt><dd>This class provides the functionality to email a group of contacts.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Activity-Form-Task-FileOnCase.html"><abbr title="\CRM_Activity_Form_Task_FileOnCase">CRM_Activity_Form_Task_FileOnCase</abbr></a></dt><dd>This class provides the functionality to email a group of contacts</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Activity-Form-Task-PDF.html"><abbr title="\CRM_Activity_Form_Task_PDF">CRM_Activity_Form_Task_PDF</abbr></a></dt><dd>This class provides the functionality to create PDF/Word letters for activities.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Activity-Form-Task-PickOption.html"><abbr title="\CRM_Activity_Form_Task_PickOption">CRM_Activity_Form_Task_PickOption</abbr></a></dt><dd>This class provides the functionality to email a group of contacts.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Activity-Form-Task-PickProfile.html"><abbr title="\CRM_Activity_Form_Task_PickProfile">CRM_Activity_Form_Task_PickProfile</abbr></a></dt><dd>This class provides the functionality for batch profile update for Activity.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Activity-Form-Task-Print.html"><abbr title="\CRM_Activity_Form_Task_Print">CRM_Activity_Form_Task_Print</abbr></a></dt><dd>This class provides the functionality to print activity records.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Activity-Form-Task-RemoveFromTag.html"><abbr title="\CRM_Activity_Form_Task_RemoveFromTag">CRM_Activity_Form_Task_RemoveFromTag</abbr></a></dt><dd>This class provides the functionality to remove tags of contact(s).</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Activity-Form-Task-SMS.html"><abbr title="\CRM_Activity_Form_Task_SMS">CRM_Activity_Form_Task_SMS</abbr></a></dt><dd>This class provides the functionality to sms a group of contacts.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Activity-Form-Task.html"><abbr title="\CRM_Activity_Form_Task">CRM_Activity_Form_Task</abbr></a></dt><dd>Class for activity form task actions.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Activity-Import-Form-DataSource.html"><abbr title="\CRM_Activity_Import_Form_DataSource">CRM_Activity_Import_Form_DataSource</abbr></a></dt><dd>This class gets the name of the file to upload.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Activity-Import-Form-MapField.html"><abbr title="\CRM_Activity_Import_Form_MapField">CRM_Activity_Import_Form_MapField</abbr></a></dt><dd>This class gets the name of the file to upload.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Activity-Import-Form-Preview.html"><abbr title="\CRM_Activity_Import_Form_Preview">CRM_Activity_Import_Form_Preview</abbr></a></dt><dd>This class previews the uploaded file and returns summary statistics.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Activity-Import-Parser-Activity.html"><abbr title="\CRM_Activity_Import_Parser_Activity">CRM_Activity_Import_Parser_Activity</abbr></a></dt><dd>Class to parse activity csv files.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Activity-Page-AJAX.html"><abbr title="\CRM_Activity_Page_AJAX">CRM_Activity_Page_AJAX</abbr></a></dt><dd>This class contains all the function that are called using AJAX (jQuery)</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Activity-Page-Tab.html"><abbr title="\CRM_Activity_Page_Tab">CRM_Activity_Page_Tab</abbr></a></dt><dd>Main page for viewing activities,</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Activity-Page-UserDashboard.html"><abbr title="\CRM_Activity_Page_UserDashboard">CRM_Activity_Page_UserDashboard</abbr></a></dt><dd>This class is for building event(participation) block on user dashboard.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Activity-Selector-Activity.html"><abbr title="\CRM_Activity_Selector_Activity">CRM_Activity_Selector_Activity</abbr></a></dt><dd>This class is used to retrieve and display activities for a contact.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Activity-Selector-Search.html"><abbr title="\CRM_Activity_Selector_Search">CRM_Activity_Selector_Search</abbr></a></dt><dd>This class is used to retrieve and display a range of contacts that match the given criteria.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Activity-StateMachine-Search.html"><abbr title="\CRM_Activity_StateMachine_Search">CRM_Activity_StateMachine_Search</abbr></a></dt><dd>Core StateMachine.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Activity-Task.html"><abbr title="\CRM_Activity_Task">CRM_Activity_Task</abbr></a></dt><dd>Class to represent the actions that can be performed on a group of contacts used by the search forms.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Activity-Tokens.html"><abbr title="\CRM_Activity_Tokens">CRM_Activity_Tokens</abbr></a></dt><dd>Generate "activity.*" tokens.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Form-CMSUser.html"><abbr title="\CRM_Admin_Form_CMSUser">CRM_Admin_Form_CMSUser</abbr></a></dt><dd>This class generates form components for Synchronizing CMS Users</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Form-ContactType.html"><abbr title="\CRM_Admin_Form_ContactType">CRM_Admin_Form_ContactType</abbr></a></dt><dd>This class generates form components for ContactSub Type.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Form-Extensions.html"><abbr title="\CRM_Admin_Form_Extensions">CRM_Admin_Form_Extensions</abbr></a></dt><dd>This class generates form components for Extensions.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Form-Generic.html"><abbr title="\CRM_Admin_Form_Generic">CRM_Admin_Form_Generic</abbr></a></dt><dd>Generic metadata based settings form.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Form-Job.html"><abbr title="\CRM_Admin_Form_Job">CRM_Admin_Form_Job</abbr></a></dt><dd>Class for configuring jobs.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Form-LabelFormats.html"><abbr title="\CRM_Admin_Form_LabelFormats">CRM_Admin_Form_LabelFormats</abbr></a></dt><dd>This class generates form components for Label Format Settings.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Form-LocationType.html"><abbr title="\CRM_Admin_Form_LocationType">CRM_Admin_Form_LocationType</abbr></a></dt><dd>This class generates form components for Location Type.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Form-MailSettings.html"><abbr title="\CRM_Admin_Form_MailSettings">CRM_Admin_Form_MailSettings</abbr></a></dt><dd>This class handles mail account settings.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Form-Mapping.html"><abbr title="\CRM_Admin_Form_Mapping">CRM_Admin_Form_Mapping</abbr></a></dt><dd>This class generates form components for Mapping.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Form-MessageTemplates.html"><abbr title="\CRM_Admin_Form_MessageTemplates">CRM_Admin_Form_MessageTemplates</abbr></a></dt><dd>This class generates form components for Message templates
used by membership, contributions, event registrations, etc.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Form-Navigation.html"><abbr title="\CRM_Admin_Form_Navigation">CRM_Admin_Form_Navigation</abbr></a></dt><dd>This class generates form components for Navigation.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Form-OptionGroup.html"><abbr title="\CRM_Admin_Form_OptionGroup">CRM_Admin_Form_OptionGroup</abbr></a></dt><dd>This class generates form components for Option Group.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Form-Options.html"><abbr title="\CRM_Admin_Form_Options">CRM_Admin_Form_Options</abbr></a></dt><dd>This class generates form components for Options.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Form-ParticipantStatusType.html"><abbr title="\CRM_Admin_Form_ParticipantStatusType">CRM_Admin_Form_ParticipantStatusType</abbr></a></dt><dd>Base class for admin forms.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Form-PaymentProcessor.html"><abbr title="\CRM_Admin_Form_PaymentProcessor">CRM_Admin_Form_PaymentProcessor</abbr></a></dt><dd>This class generates form components for Payment Processor.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Form-PaymentProcessorType.html"><abbr title="\CRM_Admin_Form_PaymentProcessorType">CRM_Admin_Form_PaymentProcessorType</abbr></a></dt><dd>This class generates form components for Location Type.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Form-PdfFormats.html"><abbr title="\CRM_Admin_Form_PdfFormats">CRM_Admin_Form_PdfFormats</abbr></a></dt><dd>This class generates form components for PDF Page Format Settings.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Form-Preferences-Address.html"><abbr title="\CRM_Admin_Form_Preferences_Address">CRM_Admin_Form_Preferences_Address</abbr></a></dt><dd>This class generates form components for Address Section.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Form-Preferences-Contribute.html"><abbr title="\CRM_Admin_Form_Preferences_Contribute">CRM_Admin_Form_Preferences_Contribute</abbr></a></dt><dd>This class generates form components for the display preferences.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Form-Preferences-Display.html"><abbr title="\CRM_Admin_Form_Preferences_Display">CRM_Admin_Form_Preferences_Display</abbr></a></dt><dd>This class generates form components for the display preferences.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Form-Preferences-Mailing.html"><abbr title="\CRM_Admin_Form_Preferences_Mailing">CRM_Admin_Form_Preferences_Mailing</abbr></a></dt><dd>This class generates form components for the mailing component preferences.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Form-Preferences-Member.html"><abbr title="\CRM_Admin_Form_Preferences_Member">CRM_Admin_Form_Preferences_Member</abbr></a></dt><dd>This class generates form components for component preferences.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Form-Preferences.html"><abbr title="\CRM_Admin_Form_Preferences">CRM_Admin_Form_Preferences</abbr></a></dt><dd>Base class for settings forms.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Form-PreferencesDate.html"><abbr title="\CRM_Admin_Form_PreferencesDate">CRM_Admin_Form_PreferencesDate</abbr></a></dt><dd>This class generates form components for Location Type.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Form-RelationshipType.html"><abbr title="\CRM_Admin_Form_RelationshipType">CRM_Admin_Form_RelationshipType</abbr></a></dt><dd>This class generates form components for Relationship Type.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Form-ScheduleReminders.html"><abbr title="\CRM_Admin_Form_ScheduleReminders">CRM_Admin_Form_ScheduleReminders</abbr></a></dt><dd>ActionSchedule (aka Scheduled Reminder) create/edit/delete form.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Form-Setting-Case.html"><abbr title="\CRM_Admin_Form_Setting_Case">CRM_Admin_Form_Setting_Case</abbr></a></dt><dd>This class generates form components for CiviCase.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Form-Setting-Component.html"><abbr title="\CRM_Admin_Form_Setting_Component">CRM_Admin_Form_Setting_Component</abbr></a></dt><dd>This class generates form components for Component.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Form-Setting-Date.html"><abbr title="\CRM_Admin_Form_Setting_Date">CRM_Admin_Form_Setting_Date</abbr></a></dt><dd>This class generates form components for Date Formatting.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Form-Setting-Debugging.html"><abbr title="\CRM_Admin_Form_Setting_Debugging">CRM_Admin_Form_Setting_Debugging</abbr></a></dt><dd>This class generates form components for Error Handling and Debugging.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Form-Setting-Localization.html"><abbr title="\CRM_Admin_Form_Setting_Localization">CRM_Admin_Form_Setting_Localization</abbr></a></dt><dd>This class generates form components for Localization.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Form-Setting-Mail.html"><abbr title="\CRM_Admin_Form_Setting_Mail">CRM_Admin_Form_Setting_Mail</abbr></a></dt><dd>This class generates form components for CiviMail.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Form-Setting-Mapping.html"><abbr title="\CRM_Admin_Form_Setting_Mapping">CRM_Admin_Form_Setting_Mapping</abbr></a></dt><dd>This class generates form components for Mapping and Geocoding.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Form-Setting-Miscellaneous.html"><abbr title="\CRM_Admin_Form_Setting_Miscellaneous">CRM_Admin_Form_Setting_Miscellaneous</abbr></a></dt><dd>This class generates form components for Miscellaneous.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Form-Setting-Path.html"><abbr title="\CRM_Admin_Form_Setting_Path">CRM_Admin_Form_Setting_Path</abbr></a></dt><dd>This class generates form components for File System Path.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Form-Setting-Search.html"><abbr title="\CRM_Admin_Form_Setting_Search">CRM_Admin_Form_Setting_Search</abbr></a></dt><dd>This class generates form components for Search Parameters</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Form-Setting-Smtp.html"><abbr title="\CRM_Admin_Form_Setting_Smtp">CRM_Admin_Form_Setting_Smtp</abbr></a></dt><dd>This class generates form components for Smtp Server.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Form-Setting-UF.html"><abbr title="\CRM_Admin_Form_Setting_UF">CRM_Admin_Form_Setting_UF</abbr></a></dt><dd>This class generates form components for Site Url.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Form-Setting-UpdateConfigBackend.html"><abbr title="\CRM_Admin_Form_Setting_UpdateConfigBackend">CRM_Admin_Form_Setting_UpdateConfigBackend</abbr></a></dt><dd>This class generates form components for Error Handling and Debugging</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Form-Setting-Url.html"><abbr title="\CRM_Admin_Form_Setting_Url">CRM_Admin_Form_Setting_Url</abbr></a></dt><dd>This class generates form components for Site Url.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Form-Setting.html"><abbr title="\CRM_Admin_Form_Setting">CRM_Admin_Form_Setting</abbr></a></dt><dd>This class generates form components generic to CiviCRM settings.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Form-WordReplacements.html"><abbr title="\CRM_Admin_Form_WordReplacements">CRM_Admin_Form_WordReplacements</abbr></a></dt><dd>Class CRM_Core_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Form.html"><abbr title="\CRM_Admin_Form">CRM_Admin_Form</abbr></a></dt><dd>Base class for admin forms.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Page-Access.html"><abbr title="\CRM_Admin_Page_Access">CRM_Admin_Page_Access</abbr></a></dt><dd>Dashboard page for managing Access Control.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Page-Admin.html"><abbr title="\CRM_Admin_Page_Admin">CRM_Admin_Page_Admin</abbr></a></dt><dd>Page for displaying Administer CiviCRM Control Panel.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Page-AJAX.html"><abbr title="\CRM_Admin_Page_AJAX">CRM_Admin_Page_AJAX</abbr></a></dt><dd>This class contains all the function that are called using AJAX.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Page-APIExplorer.html"><abbr title="\CRM_Admin_Page_APIExplorer">CRM_Admin_Page_APIExplorer</abbr></a></dt><dd>Api Explorer</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Page-ConfigTaskList.html"><abbr title="\CRM_Admin_Page_ConfigTaskList">CRM_Admin_Page_ConfigTaskList</abbr></a></dt><dd>Page for displaying list of site configuration tasks with links to each setting form.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Page-ContactType.html"><abbr title="\CRM_Admin_Page_ContactType">CRM_Admin_Page_ContactType</abbr></a></dt><dd>Page for displaying list of contact Subtypes.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Page-EventTemplate.html"><abbr title="\CRM_Admin_Page_EventTemplate">CRM_Admin_Page_EventTemplate</abbr></a></dt><dd>Page for displaying list of event templates.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Page-Extensions.html"><abbr title="\CRM_Admin_Page_Extensions">CRM_Admin_Page_Extensions</abbr></a></dt><dd>This page displays the list of extensions registered in the system.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Page-ExtensionsUpgrade.html"><abbr title="\CRM_Admin_Page_ExtensionsUpgrade">CRM_Admin_Page_ExtensionsUpgrade</abbr></a></dt><dd>Display a page which displays a progress bar while executing
upgrade tasks.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Page-Job.html"><abbr title="\CRM_Admin_Page_Job">CRM_Admin_Page_Job</abbr></a></dt><dd>Page for displaying list of jobs.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Page-JobLog.html"><abbr title="\CRM_Admin_Page_JobLog">CRM_Admin_Page_JobLog</abbr></a></dt><dd>Page for displaying log of jobs.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Page-LabelFormats.html"><abbr title="\CRM_Admin_Page_LabelFormats">CRM_Admin_Page_LabelFormats</abbr></a></dt><dd>Page for displaying list of Label Formats.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Page-LocationType.html"><abbr title="\CRM_Admin_Page_LocationType">CRM_Admin_Page_LocationType</abbr></a></dt><dd>Page for displaying list of location types.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Page-MailSettings.html"><abbr title="\CRM_Admin_Page_MailSettings">CRM_Admin_Page_MailSettings</abbr></a></dt><dd>Page for displaying list of Mail account settings.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Page-Mapping.html"><abbr title="\CRM_Admin_Page_Mapping">CRM_Admin_Page_Mapping</abbr></a></dt><dd>Page for displaying list of categories.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Page-MessageTemplates.html"><abbr title="\CRM_Admin_Page_MessageTemplates">CRM_Admin_Page_MessageTemplates</abbr></a></dt><dd>Page for displaying list of message templates.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Page-Navigation.html"><abbr title="\CRM_Admin_Page_Navigation">CRM_Admin_Page_Navigation</abbr></a></dt><dd>Page for editing the navigation menu.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Page-Options.html"><abbr title="\CRM_Admin_Page_Options">CRM_Admin_Page_Options</abbr></a></dt><dd>Page for displaying list of option groups and option values.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Page-ParticipantStatusType.html"><abbr title="\CRM_Admin_Page_ParticipantStatusType">CRM_Admin_Page_ParticipantStatusType</abbr></a></dt><dd>A Page is basically data in a nice pretty format.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Page-PaymentProcessor.html"><abbr title="\CRM_Admin_Page_PaymentProcessor">CRM_Admin_Page_PaymentProcessor</abbr></a></dt><dd>Page for displaying list of payment processors.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Page-PaymentProcessorType.html"><abbr title="\CRM_Admin_Page_PaymentProcessorType">CRM_Admin_Page_PaymentProcessorType</abbr></a></dt><dd>Page for displaying list of payment processor types.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Page-PdfFormats.html"><abbr title="\CRM_Admin_Page_PdfFormats">CRM_Admin_Page_PdfFormats</abbr></a></dt><dd>Page for displaying list of PDF Page Formats.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Page-PreferencesDate.html"><abbr title="\CRM_Admin_Page_PreferencesDate">CRM_Admin_Page_PreferencesDate</abbr></a></dt><dd>Page for displaying list of date preferences.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Page-RelationshipType.html"><abbr title="\CRM_Admin_Page_RelationshipType">CRM_Admin_Page_RelationshipType</abbr></a></dt><dd>Page for displaying list of relationship types.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Page-ScheduleReminders.html"><abbr title="\CRM_Admin_Page_ScheduleReminders">CRM_Admin_Page_ScheduleReminders</abbr></a></dt><dd>Page for displaying list of Reminders.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Api4-Page-AJAX.html"><abbr title="\CRM_Api4_Page_AJAX">CRM_Api4_Page_AJAX</abbr></a></dt><dd>A Page is basically data in a nice pretty format.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Api4-Page-Api4Explorer.html"><abbr title="\CRM_Api4_Page_Api4Explorer">CRM_Api4_Page_Api4Explorer</abbr></a></dt><dd>A Page is basically data in a nice pretty format.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Badge-BAO-Badge.html"><abbr title="\CRM_Badge_BAO_Badge">CRM_Badge_BAO_Badge</abbr></a></dt><dd>Class CRM_Badge_Format_Badge.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Badge-BAO-Layout.html"><abbr title="\CRM_Badge_BAO_Layout">CRM_Badge_BAO_Layout</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Badge-Form-Layout.html"><abbr title="\CRM_Badge_Form_Layout">CRM_Badge_Form_Layout</abbr></a></dt><dd>This class generates form components for name badge layout.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Badge-Page-AJAX.html"><abbr title="\CRM_Badge_Page_AJAX">CRM_Badge_Page_AJAX</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Badge-Page-Layout.html"><abbr title="\CRM_Badge_Page_Layout">CRM_Badge_Page_Layout</abbr></a></dt><dd>Page for list page badges.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Batch-BAO-Batch.html"><abbr title="\CRM_Batch_BAO_Batch">CRM_Batch_BAO_Batch</abbr></a></dt><dd>Batch BAO class.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Batch-BAO-EntityBatch.html"><abbr title="\CRM_Batch_BAO_EntityBatch">CRM_Batch_BAO_EntityBatch</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Batch-DAO-Batch.html"><abbr title="\CRM_Batch_DAO_Batch">CRM_Batch_DAO_Batch</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Batch-DAO-EntityBatch.html"><abbr title="\CRM_Batch_DAO_EntityBatch">CRM_Batch_DAO_EntityBatch</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Batch-Form-Batch.html"><abbr title="\CRM_Batch_Form_Batch">CRM_Batch_Form_Batch</abbr></a></dt><dd>This class generates form components for batch entry.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Batch-Form-Entry.html"><abbr title="\CRM_Batch_Form_Entry">CRM_Batch_Form_Entry</abbr></a></dt><dd>This class provides the functionality for batch entry for contributions/memberships.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Batch-Form-Search.html"><abbr title="\CRM_Batch_Form_Search">CRM_Batch_Form_Search</abbr></a></dt><dd>Class CRM_Core_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Batch-Page-AJAX.html"><abbr title="\CRM_Batch_Page_AJAX">CRM_Batch_Page_AJAX</abbr></a></dt><dd>This class contains functions that are called using AJAX.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Batch-Page-Batch.html"><abbr title="\CRM_Batch_Page_Batch">CRM_Batch_Page_Batch</abbr></a></dt><dd>Page for displaying list of current batches</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Bridge-OG-CiviCRM.html"><abbr title="\CRM_Bridge_OG_CiviCRM">CRM_Bridge_OG_CiviCRM</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Bridge-OG-Drupal.html"><abbr title="\CRM_Bridge_OG_Drupal">CRM_Bridge_OG_Drupal</abbr></a></dt><dd>d6 compatible?</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Bridge-OG-Utils.html"><abbr title="\CRM_Bridge_OG_Utils">CRM_Bridge_OG_Utils</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Campaign-BAO-Campaign.html"><abbr title="\CRM_Campaign_BAO_Campaign">CRM_Campaign_BAO_Campaign</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Campaign-BAO-Petition.html"><abbr title="\CRM_Campaign_BAO_Petition">CRM_Campaign_BAO_Petition</abbr></a></dt><dd>Class CRM_Campaign_BAO_Survey.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Campaign-BAO-Query.html"><abbr title="\CRM_Campaign_BAO_Query">CRM_Campaign_BAO_Query</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Campaign-BAO-Survey.html"><abbr title="\CRM_Campaign_BAO_Survey">CRM_Campaign_BAO_Survey</abbr></a></dt><dd>Class CRM_Campaign_BAO_Survey.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Campaign-Controller-Search.html"><abbr title="\CRM_Campaign_Controller_Search">CRM_Campaign_Controller_Search</abbr></a></dt><dd>This class is used by the Search functionality.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Campaign-DAO-Campaign.html"><abbr title="\CRM_Campaign_DAO_Campaign">CRM_Campaign_DAO_Campaign</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Campaign-DAO-CampaignGroup.html"><abbr title="\CRM_Campaign_DAO_CampaignGroup">CRM_Campaign_DAO_CampaignGroup</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Campaign-DAO-Survey.html"><abbr title="\CRM_Campaign_DAO_Survey">CRM_Campaign_DAO_Survey</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Campaign-Form-Campaign.html"><abbr title="\CRM_Campaign_Form_Campaign">CRM_Campaign_Form_Campaign</abbr></a></dt><dd>This class generates form components for processing a campaign.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Campaign-Form-Gotv.html"><abbr title="\CRM_Campaign_Form_Gotv">CRM_Campaign_Form_Gotv</abbr></a></dt><dd>Files required</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Campaign-Form-Petition-Signature.html"><abbr title="\CRM_Campaign_Form_Petition_Signature">CRM_Campaign_Form_Petition_Signature</abbr></a></dt><dd>This class generates form components for processing a petition signature.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Campaign-Form-Petition.html"><abbr title="\CRM_Campaign_Form_Petition">CRM_Campaign_Form_Petition</abbr></a></dt><dd>This class generates form components for adding a petition.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Campaign-Form-Search.html"><abbr title="\CRM_Campaign_Form_Search">CRM_Campaign_Form_Search</abbr></a></dt><dd>Files required.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Campaign-Form-Survey-Delete.html"><abbr title="\CRM_Campaign_Form_Survey_Delete">CRM_Campaign_Form_Survey_Delete</abbr></a></dt><dd>This class is to build the form for deleting a Survey.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Campaign-Form-Survey-Main.html"><abbr title="\CRM_Campaign_Form_Survey_Main">CRM_Campaign_Form_Survey_Main</abbr></a></dt><dd>This class generates form components for processing a survey.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Campaign-Form-Survey-Questions.html"><abbr title="\CRM_Campaign_Form_Survey_Questions">CRM_Campaign_Form_Survey_Questions</abbr></a></dt><dd>This class generates form components for processing a survey.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Campaign-Form-Survey-Results.html"><abbr title="\CRM_Campaign_Form_Survey_Results">CRM_Campaign_Form_Survey_Results</abbr></a></dt><dd>This class generates form components for processing a survey.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Campaign-Form-Survey-TabHeader.html"><abbr title="\CRM_Campaign_Form_Survey_TabHeader">CRM_Campaign_Form_Survey_TabHeader</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Campaign-Form-Survey.html"><abbr title="\CRM_Campaign_Form_Survey">CRM_Campaign_Form_Survey</abbr></a></dt><dd>This class generates form components for processing a survey.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Campaign-Form-SurveyType.html"><abbr title="\CRM_Campaign_Form_SurveyType">CRM_Campaign_Form_SurveyType</abbr></a></dt><dd>This class generates form components for Option Group.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Campaign-Form-Task-Interview.html"><abbr title="\CRM_Campaign_Form_Task_Interview">CRM_Campaign_Form_Task_Interview</abbr></a></dt><dd>This class provides the functionality to record voter's interview.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Campaign-Form-Task-Print.html"><abbr title="\CRM_Campaign_Form_Task_Print">CRM_Campaign_Form_Task_Print</abbr></a></dt><dd>This class provides the functionality to print voter records</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Campaign-Form-Task-Release.html"><abbr title="\CRM_Campaign_Form_Task_Release">CRM_Campaign_Form_Task_Release</abbr></a></dt><dd>This class provides the functionality to add contacts for voter reservation.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Campaign-Form-Task-Reserve.html"><abbr title="\CRM_Campaign_Form_Task_Reserve">CRM_Campaign_Form_Task_Reserve</abbr></a></dt><dd>This class provides the functionality to add contacts for voter reservation.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Campaign-Form-Task-Result.html"><abbr title="\CRM_Campaign_Form_Task_Result">CRM_Campaign_Form_Task_Result</abbr></a></dt><dd>Used for displaying results.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Campaign-Form-Task.html"><abbr title="\CRM_Campaign_Form_Task">CRM_Campaign_Form_Task</abbr></a></dt><dd>This class generates form components for relationship.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Campaign-Info.html"><abbr title="\CRM_Campaign_Info">CRM_Campaign_Info</abbr></a></dt><dd>This class introduces component to the system and provides all the
information about it. It needs to extend CRM_Core_Component_Info
abstract class.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Campaign-Page-AJAX.html"><abbr title="\CRM_Campaign_Page_AJAX">CRM_Campaign_Page_AJAX</abbr></a></dt><dd>This class contains all campaign related functions that are called using AJAX (jQuery)</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Campaign-Page-Petition-Confirm.html"><abbr title="\CRM_Campaign_Page_Petition_Confirm">CRM_Campaign_Page_Petition_Confirm</abbr></a></dt><dd>A Page is basically data in a nice pretty format.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Campaign-Page-Petition-ThankYou.html"><abbr title="\CRM_Campaign_Page_Petition_ThankYou">CRM_Campaign_Page_Petition_ThankYou</abbr></a></dt><dd>A Page is basically data in a nice pretty format.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Campaign-Page-Petition.html"><abbr title="\CRM_Campaign_Page_Petition">CRM_Campaign_Page_Petition</abbr></a></dt><dd>Page for displaying Petition Signatures.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Campaign-Page-SurveyType.html"><abbr title="\CRM_Campaign_Page_SurveyType">CRM_Campaign_Page_SurveyType</abbr></a></dt><dd>Page for displaying list of survey types.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Campaign-Page-Vote.html"><abbr title="\CRM_Campaign_Page_Vote">CRM_Campaign_Page_Vote</abbr></a></dt><dd>Page for voting tab interface.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Campaign-Selector-Search.html"><abbr title="\CRM_Campaign_Selector_Search">CRM_Campaign_Selector_Search</abbr></a></dt><dd>This class is used to retrieve and display a range of contacts that match the given criteria.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Campaign-StateMachine-Search.html"><abbr title="\CRM_Campaign_StateMachine_Search">CRM_Campaign_StateMachine_Search</abbr></a></dt><dd>Core StateMachine.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Campaign-SurveyTokens.html"><abbr title="\CRM_Campaign_SurveyTokens">CRM_Campaign_SurveyTokens</abbr></a></dt><dd>Generate "survey.*" tokens.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Campaign-Task.html"><abbr title="\CRM_Campaign_Task">CRM_Campaign_Task</abbr></a></dt><dd>class to represent the actions that can be performed on a group of voters.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Campaign-WorkflowMessage-PetitionConfirmationNeeded.html"><abbr title="\CRM_Campaign_WorkflowMessage_PetitionConfirmationNeeded">CRM_Campaign_WorkflowMessage_PetitionConfirmationNeeded</abbr></a></dt><dd>Invoice generated when invoicing is enabled.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Campaign-WorkflowMessage-PetitionSign.html"><abbr title="\CRM_Campaign_WorkflowMessage_PetitionSign">CRM_Campaign_WorkflowMessage_PetitionSign</abbr></a></dt><dd>Invoice generated when invoicing is enabled.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Campaign-WorkflowMessage-Survey-Survey.html"><abbr title="\CRM_Campaign_WorkflowMessage_Survey_Survey">CRM_Campaign_WorkflowMessage_Survey_Survey</abbr></a></dt><dd>Basic contribution example for contribution templates.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-Audit-Audit.html"><abbr title="\CRM_Case_Audit_Audit">CRM_Case_Audit_Audit</abbr></a></dt><dd>Class CRM_Case_Audit_Audit</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-Audit-AuditConfig.html"><abbr title="\CRM_Case_Audit_AuditConfig">CRM_Case_Audit_AuditConfig</abbr></a></dt><dd>Class CRM_Case_Audit_AuditConfig</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-BAO-Case.html"><abbr title="\CRM_Case_BAO_Case">CRM_Case_BAO_Case</abbr></a></dt><dd>This class contains the functions for Case Management.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-BAO-CaseContact.html"><abbr title="\CRM_Case_BAO_CaseContact">CRM_Case_BAO_CaseContact</abbr></a></dt><dd>This class contains the functions for Case Contact management.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-BAO-CaseType.html"><abbr title="\CRM_Case_BAO_CaseType">CRM_Case_BAO_CaseType</abbr></a></dt><dd>This class contains the functions for Case Type management.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-BAO-Query.html"><abbr title="\CRM_Case_BAO_Query">CRM_Case_BAO_Query</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-Controller-Search.html"><abbr title="\CRM_Case_Controller_Search">CRM_Case_Controller_Search</abbr></a></dt><dd>This class is used by the Search functionality.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-DAO-Case.html"><abbr title="\CRM_Case_DAO_Case">CRM_Case_DAO_Case</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-DAO-CaseActivity.html"><abbr title="\CRM_Case_DAO_CaseActivity">CRM_Case_DAO_CaseActivity</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-DAO-CaseContact.html"><abbr title="\CRM_Case_DAO_CaseContact">CRM_Case_DAO_CaseContact</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-DAO-CaseType.html"><abbr title="\CRM_Case_DAO_CaseType">CRM_Case_DAO_CaseType</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-Export-Form-Map.html"><abbr title="\CRM_Case_Export_Form_Map">CRM_Case_Export_Form_Map</abbr></a></dt><dd>This class gets the name of the file to upload</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-Export-Form-Select.html"><abbr title="\CRM_Case_Export_Form_Select">CRM_Case_Export_Form_Select</abbr></a></dt><dd>This class gets the name of the file to upload</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-Form-Activity-ChangeCaseStartDate.html"><abbr title="\CRM_Case_Form_Activity_ChangeCaseStartDate">CRM_Case_Form_Activity_ChangeCaseStartDate</abbr></a></dt><dd>This class generates form components for OpenCase Activity.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-Form-Activity-ChangeCaseStatus.html"><abbr title="\CRM_Case_Form_Activity_ChangeCaseStatus">CRM_Case_Form_Activity_ChangeCaseStatus</abbr></a></dt><dd>This class generates form components for OpenCase Activity.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-Form-Activity-ChangeCaseType.html"><abbr title="\CRM_Case_Form_Activity_ChangeCaseType">CRM_Case_Form_Activity_ChangeCaseType</abbr></a></dt><dd>This class generates form components for OpenCase Activity.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-Form-Activity-LinkCases.html"><abbr title="\CRM_Case_Form_Activity_LinkCases">CRM_Case_Form_Activity_LinkCases</abbr></a></dt><dd>This class generates form components for LinkCase Activity.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-Form-Activity-OpenCase.html"><abbr title="\CRM_Case_Form_Activity_OpenCase">CRM_Case_Form_Activity_OpenCase</abbr></a></dt><dd>This class generates form components for OpenCase Activity.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-Form-Activity.html"><abbr title="\CRM_Case_Form_Activity">CRM_Case_Form_Activity</abbr></a></dt><dd>This class create activities for a case.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-Form-ActivityToCase.html"><abbr title="\CRM_Case_Form_ActivityToCase">CRM_Case_Form_ActivityToCase</abbr></a></dt><dd>This class generates form components for building activity to a case.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-Form-ActivityView.html"><abbr title="\CRM_Case_Form_ActivityView">CRM_Case_Form_ActivityView</abbr></a></dt><dd>This class does pre processing for viewing an activity or their revisions.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-Form-AddToCaseAsRole.html"><abbr title="\CRM_Case_Form_AddToCaseAsRole">CRM_Case_Form_AddToCaseAsRole</abbr></a></dt><dd>Class CRM_Case_Form_AddToCaseAsRole</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-Form-Case.html"><abbr title="\CRM_Case_Form_Case">CRM_Case_Form_Case</abbr></a></dt><dd>This class generates form components for case activity.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-Form-CaseView.html"><abbr title="\CRM_Case_Form_CaseView">CRM_Case_Form_CaseView</abbr></a></dt><dd>This class generates view mode for CiviCase.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-Form-CustomData.html"><abbr title="\CRM_Case_Form_CustomData">CRM_Case_Form_CustomData</abbr></a></dt><dd>This class generates form components for custom data</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-Form-DeleteClient.html"><abbr title="\CRM_Case_Form_DeleteClient">CRM_Case_Form_DeleteClient</abbr></a></dt><dd>This class assigns the current case to another client.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-Form-EditClient.html"><abbr title="\CRM_Case_Form_EditClient">CRM_Case_Form_EditClient</abbr></a></dt><dd>This class assigns the current case to another client.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-Form-Report.html"><abbr title="\CRM_Case_Form_Report">CRM_Case_Form_Report</abbr></a></dt><dd>This class generates form components for case report.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-Form-Search.html"><abbr title="\CRM_Case_Form_Search">CRM_Case_Form_Search</abbr></a></dt><dd>This file is for Case search.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-Form-Task-Batch.html"><abbr title="\CRM_Case_Form_Task_Batch">CRM_Case_Form_Task_Batch</abbr></a></dt><dd>This class provides the functionality for batch profile update for cases</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-Form-Task-Delete.html"><abbr title="\CRM_Case_Form_Task_Delete">CRM_Case_Form_Task_Delete</abbr></a></dt><dd>This class provides the functionality to delete a group of case records.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-Form-Task-Email.html"><abbr title="\CRM_Case_Form_Task_Email">CRM_Case_Form_Task_Email</abbr></a></dt><dd>This class provides the functionality to email a group of contacts.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-Form-Task-PDF.html"><abbr title="\CRM_Case_Form_Task_PDF">CRM_Case_Form_Task_PDF</abbr></a></dt><dd>This class provides the functionality to create PDF letter for a group of contacts.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-Form-Task-PickProfile.html"><abbr title="\CRM_Case_Form_Task_PickProfile">CRM_Case_Form_Task_PickProfile</abbr></a></dt><dd>This class provides the functionality for batch profile update for case</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-Form-Task-Print.html"><abbr title="\CRM_Case_Form_Task_Print">CRM_Case_Form_Task_Print</abbr></a></dt><dd>This class provides the functionality to save a search
Saved Searches are used for saving frequently used queries</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-Form-Task-Restore.html"><abbr title="\CRM_Case_Form_Task_Restore">CRM_Case_Form_Task_Restore</abbr></a></dt><dd>This class provides the functionality to restore a group of participations.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-Form-Task-Result.html"><abbr title="\CRM_Case_Form_Task_Result">CRM_Case_Form_Task_Result</abbr></a></dt><dd>Used for displaying results.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-Form-Task.html"><abbr title="\CRM_Case_Form_Task">CRM_Case_Form_Task</abbr></a></dt><dd>This class generates form task actions for CiviCase.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-Info.html"><abbr title="\CRM_Case_Info">CRM_Case_Info</abbr></a></dt><dd>This class introduces component to the system and provides all the
information about it. It needs to extend CRM_Core_Component_Info
abstract class.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-ManagedEntities.html"><abbr title="\CRM_Case_ManagedEntities">CRM_Case_ManagedEntities</abbr></a></dt><dd>Class CRM_Case_ManagedEntities</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-Page-AJAX.html"><abbr title="\CRM_Case_Page_AJAX">CRM_Case_Page_AJAX</abbr></a></dt><dd>This class contains all case related functions that are called using AJAX</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-Page-CaseDetails.html"><abbr title="\CRM_Case_Page_CaseDetails">CRM_Case_Page_CaseDetails</abbr></a></dt><dd>A Page is basically data in a nice pretty format.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-Page-DashBoard.html"><abbr title="\CRM_Case_Page_DashBoard">CRM_Case_Page_DashBoard</abbr></a></dt><dd>This page is for Case Dashboard.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-Page-Tab.html"><abbr title="\CRM_Case_Page_Tab">CRM_Case_Page_Tab</abbr></a></dt><dd>This class handle case related functions.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-PseudoConstant.html"><abbr title="\CRM_Case_PseudoConstant">CRM_Case_PseudoConstant</abbr></a></dt><dd>This class holds all the Pseudo constants that are specific for CiviCase.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-Selector-Search.html"><abbr title="\CRM_Case_Selector_Search">CRM_Case_Selector_Search</abbr></a></dt><dd>This class is used to retrieve and display a range of contacts that match the given criteria.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-StateMachine-Search.html"><abbr title="\CRM_Case_StateMachine_Search">CRM_Case_StateMachine_Search</abbr></a></dt><dd>Core StateMachine.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-Task.html"><abbr title="\CRM_Case_Task">CRM_Case_Task</abbr></a></dt><dd>Class to represent the actions that can be performed on a group of contacts.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-Tokens.html"><abbr title="\CRM_Case_Tokens">CRM_Case_Tokens</abbr></a></dt><dd>Class CRM_Case_Tokens</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-WorkflowMessage-ActivityExamples.html"><abbr title="\CRM_Case_WorkflowMessage_ActivityExamples">CRM_Case_WorkflowMessage_ActivityExamples</abbr></a></dt><dd>Basic contribution example for contribution templates.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-WorkflowMessage-CaseActivity.html"><abbr title="\CRM_Case_WorkflowMessage_CaseActivity">CRM_Case_WorkflowMessage_CaseActivity</abbr></a></dt><dd>When an activity is created in a case, the "case_activity" email is sent.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-XMLProcessor-Process.html"><abbr title="\CRM_Case_XMLProcessor_Process">CRM_Case_XMLProcessor_Process</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-XMLProcessor-Report.html"><abbr title="\CRM_Case_XMLProcessor_Report">CRM_Case_XMLProcessor_Report</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-XMLProcessor-Settings.html"><abbr title="\CRM_Case_XMLProcessor_Settings">CRM_Case_XMLProcessor_Settings</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-XMLProcessor.html"><abbr title="\CRM_Case_XMLProcessor">CRM_Case_XMLProcessor</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-XMLRepository.html"><abbr title="\CRM_Case_XMLRepository">CRM_Case_XMLRepository</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-ActionMapping.html"><abbr title="\CRM_Contact_ActionMapping">CRM_Contact_ActionMapping</abbr></a></dt><dd>This defines the scheduled-reminder functionality for contact
entities. It is useful for, e.g., sending a reminder based on
birth date, modification date, or other custom dates on
the contact record.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-BAO-Contact-Location.html"><abbr title="\CRM_Contact_BAO_Contact_Location">CRM_Contact_BAO_Contact_Location</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-BAO-Contact-Permission.html"><abbr title="\CRM_Contact_BAO_Contact_Permission">CRM_Contact_BAO_Contact_Permission</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-BAO-Contact-Utils.html"><abbr title="\CRM_Contact_BAO_Contact_Utils">CRM_Contact_BAO_Contact_Utils</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-BAO-Contact.html"><abbr title="\CRM_Contact_BAO_Contact">CRM_Contact_BAO_Contact</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-BAO-ContactType.html"><abbr title="\CRM_Contact_BAO_ContactType">CRM_Contact_BAO_ContactType</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-BAO-DashboardContact.html"><abbr title="\CRM_Contact_BAO_DashboardContact">CRM_Contact_BAO_DashboardContact</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-BAO-Group.html"><abbr title="\CRM_Contact_BAO_Group">CRM_Contact_BAO_Group</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-BAO-GroupContact.html"><abbr title="\CRM_Contact_BAO_GroupContact">CRM_Contact_BAO_GroupContact</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-BAO-GroupContactCache.html"><abbr title="\CRM_Contact_BAO_GroupContactCache">CRM_Contact_BAO_GroupContactCache</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-BAO-GroupNesting.html"><abbr title="\CRM_Contact_BAO_GroupNesting">CRM_Contact_BAO_GroupNesting</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-BAO-GroupNestingCache.html"><abbr title="\CRM_Contact_BAO_GroupNestingCache">CRM_Contact_BAO_GroupNestingCache</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-BAO-GroupOrganization.html"><abbr title="\CRM_Contact_BAO_GroupOrganization">CRM_Contact_BAO_GroupOrganization</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-BAO-Household.html"><abbr title="\CRM_Contact_BAO_Household">CRM_Contact_BAO_Household</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-BAO-Individual.html"><abbr title="\CRM_Contact_BAO_Individual">CRM_Contact_BAO_Individual</abbr></a></dt><dd>Class contains functions for individual contact type.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-BAO-ProximityQuery.html"><abbr title="\CRM_Contact_BAO_ProximityQuery">CRM_Contact_BAO_ProximityQuery</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-BAO-Query-Hook.html"><abbr title="\CRM_Contact_BAO_Query_Hook">CRM_Contact_BAO_Query_Hook</abbr></a></dt><dd>Delegate query functions based on hook system.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-BAO-Query-Interface.html"><abbr title="\CRM_Contact_BAO_Query_Interface">CRM_Contact_BAO_Query_Interface</abbr></a></dt><dd>Abstract class for search BAO query objects</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-BAO-Query.html"><abbr title="\CRM_Contact_BAO_Query">CRM_Contact_BAO_Query</abbr></a></dt><dd>This is the heart of the search query building mechanism.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-BAO-Relationship.html"><abbr title="\CRM_Contact_BAO_Relationship">CRM_Contact_BAO_Relationship</abbr></a></dt><dd>Class CRM_Contact_BAO_Relationship.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-BAO-RelationshipCache.html"><abbr title="\CRM_Contact_BAO_RelationshipCache">CRM_Contact_BAO_RelationshipCache</abbr></a></dt><dd>Class CRM_Contact_BAO_RelationshipCache.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-BAO-RelationshipType.html"><abbr title="\CRM_Contact_BAO_RelationshipType">CRM_Contact_BAO_RelationshipType</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-BAO-SavedSearch.html"><abbr title="\CRM_Contact_BAO_SavedSearch">CRM_Contact_BAO_SavedSearch</abbr></a></dt><dd>Business object for Saved searches.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-BAO-SubscriptionHistory.html"><abbr title="\CRM_Contact_BAO_SubscriptionHistory">CRM_Contact_BAO_SubscriptionHistory</abbr></a></dt><dd>BAO object for civicrm_subscription_history table.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Controller-Search.html"><abbr title="\CRM_Contact_Controller_Search">CRM_Contact_Controller_Search</abbr></a></dt><dd>This class is used by the Search functionality.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-DAO-ACLContactCache.html"><abbr title="\CRM_Contact_DAO_ACLContactCache">CRM_Contact_DAO_ACLContactCache</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-DAO-Contact.html"><abbr title="\CRM_Contact_DAO_Contact">CRM_Contact_DAO_Contact</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-DAO-ContactType.html"><abbr title="\CRM_Contact_DAO_ContactType">CRM_Contact_DAO_ContactType</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-DAO-DashboardContact.html"><abbr title="\CRM_Contact_DAO_DashboardContact">CRM_Contact_DAO_DashboardContact</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-DAO-Group.html"><abbr title="\CRM_Contact_DAO_Group">CRM_Contact_DAO_Group</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-DAO-GroupContact.html"><abbr title="\CRM_Contact_DAO_GroupContact">CRM_Contact_DAO_GroupContact</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-DAO-GroupContactCache.html"><abbr title="\CRM_Contact_DAO_GroupContactCache">CRM_Contact_DAO_GroupContactCache</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-DAO-GroupNesting.html"><abbr title="\CRM_Contact_DAO_GroupNesting">CRM_Contact_DAO_GroupNesting</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-DAO-GroupOrganization.html"><abbr title="\CRM_Contact_DAO_GroupOrganization">CRM_Contact_DAO_GroupOrganization</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-DAO-Relationship.html"><abbr title="\CRM_Contact_DAO_Relationship">CRM_Contact_DAO_Relationship</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-DAO-RelationshipCache.html"><abbr title="\CRM_Contact_DAO_RelationshipCache">CRM_Contact_DAO_RelationshipCache</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-DAO-RelationshipType.html"><abbr title="\CRM_Contact_DAO_RelationshipType">CRM_Contact_DAO_RelationshipType</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-DAO-SavedSearch.html"><abbr title="\CRM_Contact_DAO_SavedSearch">CRM_Contact_DAO_SavedSearch</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-DAO-SubscriptionHistory.html"><abbr title="\CRM_Contact_DAO_SubscriptionHistory">CRM_Contact_DAO_SubscriptionHistory</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Export-Form-Map.html"><abbr title="\CRM_Contact_Export_Form_Map">CRM_Contact_Export_Form_Map</abbr></a></dt><dd>This class gets the name of the file to upload</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Export-Form-Select.html"><abbr title="\CRM_Contact_Export_Form_Select">CRM_Contact_Export_Form_Select</abbr></a></dt><dd>This class gets the name of the file to upload</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Contact.html"><abbr title="\CRM_Contact_Form_Contact">CRM_Contact_Form_Contact</abbr></a></dt><dd>This class generates form components generic to all the contact types.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-CustomData.html"><abbr title="\CRM_Contact_Form_CustomData">CRM_Contact_Form_CustomData</abbr></a></dt><dd>This class generates form components for custom data.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-DedupeFind.html"><abbr title="\CRM_Contact_Form_DedupeFind">CRM_Contact_Form_DedupeFind</abbr></a></dt><dd>This class generates form components for DedupeRules.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-DedupeRules.html"><abbr title="\CRM_Contact_Form_DedupeRules">CRM_Contact_Form_DedupeRules</abbr></a></dt><dd>This class generates form components for DedupeRules.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Domain.html"><abbr title="\CRM_Contact_Form_Domain">CRM_Contact_Form_Domain</abbr></a></dt><dd>This class is to build the form for adding Group.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Edit-Address.html"><abbr title="\CRM_Contact_Form_Edit_Address">CRM_Contact_Form_Edit_Address</abbr></a></dt><dd>This class is used to build address block.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Edit-CommunicationPreferences.html"><abbr title="\CRM_Contact_Form_Edit_CommunicationPreferences">CRM_Contact_Form_Edit_CommunicationPreferences</abbr></a></dt><dd>Form helper class for an Communication Preferences object.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Edit-CustomData.html"><abbr title="\CRM_Contact_Form_Edit_CustomData">CRM_Contact_Form_Edit_CustomData</abbr></a></dt><dd>Form helper class for an Demographics object (ahem).</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Edit-Demographics.html"><abbr title="\CRM_Contact_Form_Edit_Demographics">CRM_Contact_Form_Edit_Demographics</abbr></a></dt><dd>Form helper class for an Demographics object.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Edit-Email.html"><abbr title="\CRM_Contact_Form_Edit_Email">CRM_Contact_Form_Edit_Email</abbr></a></dt><dd>Form helper class for an Email object.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Edit-Household.html"><abbr title="\CRM_Contact_Form_Edit_Household">CRM_Contact_Form_Edit_Household</abbr></a></dt><dd>Auxiliary class to provide support to the Contact Form class.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Edit-IM.html"><abbr title="\CRM_Contact_Form_Edit_IM">CRM_Contact_Form_Edit_IM</abbr></a></dt><dd>Form helper class for an IM object.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Edit-Individual.html"><abbr title="\CRM_Contact_Form_Edit_Individual">CRM_Contact_Form_Edit_Individual</abbr></a></dt><dd>Auxiliary class to provide support to the Contact Form class.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Edit-Lock.html"><abbr title="\CRM_Contact_Form_Edit_Lock">CRM_Contact_Form_Edit_Lock</abbr></a></dt><dd>Auxiliary class to provide support for locking (and ignoring locks on) contact records.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Edit-Notes.html"><abbr title="\CRM_Contact_Form_Edit_Notes">CRM_Contact_Form_Edit_Notes</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Edit-OpenID.html"><abbr title="\CRM_Contact_Form_Edit_OpenID">CRM_Contact_Form_Edit_OpenID</abbr></a></dt><dd>Form helper class for an OpenID object.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Edit-Organization.html"><abbr title="\CRM_Contact_Form_Edit_Organization">CRM_Contact_Form_Edit_Organization</abbr></a></dt><dd>Auxiliary class to provide support to the Contact Form class.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Edit-Phone.html"><abbr title="\CRM_Contact_Form_Edit_Phone">CRM_Contact_Form_Edit_Phone</abbr></a></dt><dd>Form helper class for a phone object.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Edit-TagsAndGroups.html"><abbr title="\CRM_Contact_Form_Edit_TagsAndGroups">CRM_Contact_Form_Edit_TagsAndGroups</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Edit-Website.html"><abbr title="\CRM_Contact_Form_Edit_Website">CRM_Contact_Form_Edit_Website</abbr></a></dt><dd>Form helper class for an Website object.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-GroupContact.html"><abbr title="\CRM_Contact_Form_GroupContact">CRM_Contact_Form_GroupContact</abbr></a></dt><dd>This class generates form components for groupContact.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Inline-Address.html"><abbr title="\CRM_Contact_Form_Inline_Address">CRM_Contact_Form_Inline_Address</abbr></a></dt><dd>Form helper class for address section.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Inline-CommunicationPreferences.html"><abbr title="\CRM_Contact_Form_Inline_CommunicationPreferences">CRM_Contact_Form_Inline_CommunicationPreferences</abbr></a></dt><dd>Form helper class for communication preferences inline edit section.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Inline-ContactInfo.html"><abbr title="\CRM_Contact_Form_Inline_ContactInfo">CRM_Contact_Form_Inline_ContactInfo</abbr></a></dt><dd>Form helper class for contact info section.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Inline-ContactName.html"><abbr title="\CRM_Contact_Form_Inline_ContactName">CRM_Contact_Form_Inline_ContactName</abbr></a></dt><dd>Form helper class for contact name section.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Inline-CustomData.html"><abbr title="\CRM_Contact_Form_Inline_CustomData">CRM_Contact_Form_Inline_CustomData</abbr></a></dt><dd>Form helper class for custom data section.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Inline-Demographics.html"><abbr title="\CRM_Contact_Form_Inline_Demographics">CRM_Contact_Form_Inline_Demographics</abbr></a></dt><dd>Form helper class for demographics section.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Inline-Email.html"><abbr title="\CRM_Contact_Form_Inline_Email">CRM_Contact_Form_Inline_Email</abbr></a></dt><dd>Form helper class for an Email object.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Inline-IM.html"><abbr title="\CRM_Contact_Form_Inline_IM">CRM_Contact_Form_Inline_IM</abbr></a></dt><dd>Form helper class for an IM object.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Inline-Lock.html"><abbr title="\CRM_Contact_Form_Inline_Lock">CRM_Contact_Form_Inline_Lock</abbr></a></dt><dd>Auxiliary class to provide support for locking (and ignoring locks on) contact records.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Inline-OpenID.html"><abbr title="\CRM_Contact_Form_Inline_OpenID">CRM_Contact_Form_Inline_OpenID</abbr></a></dt><dd>Form helper class for an OpenID object.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Inline-Phone.html"><abbr title="\CRM_Contact_Form_Inline_Phone">CRM_Contact_Form_Inline_Phone</abbr></a></dt><dd>Form helper class for an Phone object.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Inline-Website.html"><abbr title="\CRM_Contact_Form_Inline_Website">CRM_Contact_Form_Inline_Website</abbr></a></dt><dd>Form helper class for an Website object,</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Inline.html"><abbr title="\CRM_Contact_Form_Inline">CRM_Contact_Form_Inline</abbr></a></dt><dd>Parent class for inline contact forms.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Location.html"><abbr title="\CRM_Contact_Form_Location">CRM_Contact_Form_Location</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Merge.html"><abbr title="\CRM_Contact_Form_Merge">CRM_Contact_Form_Merge</abbr></a></dt><dd>Class CRM_Contact_Form_Merge.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-RelatedContact.html"><abbr title="\CRM_Contact_Form_RelatedContact">CRM_Contact_Form_RelatedContact</abbr></a></dt><dd>This class generates form components generic to all the contact types.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Relationship.html"><abbr title="\CRM_Contact_Form_Relationship">CRM_Contact_Form_Relationship</abbr></a></dt><dd>This class generates form components for relationship.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Search-Advanced.html"><abbr title="\CRM_Contact_Form_Search_Advanced">CRM_Contact_Form_Search_Advanced</abbr></a></dt><dd>Advanced search, extends basic search.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Search-Basic.html"><abbr title="\CRM_Contact_Form_Search_Basic">CRM_Contact_Form_Search_Basic</abbr></a></dt><dd>Base Search / View form for *all* listing of multiple contacts.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Search-Builder.html"><abbr title="\CRM_Contact_Form_Search_Builder">CRM_Contact_Form_Search_Builder</abbr></a></dt><dd>This class is for search builder processing.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Search-Criteria.html"><abbr title="\CRM_Contact_Form_Search_Criteria">CRM_Contact_Form_Search_Criteria</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Search.html"><abbr title="\CRM_Contact_Form_Search">CRM_Contact_Form_Search</abbr></a></dt><dd>Base Search / View form for *all* listing of multiple
contacts</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Task-AddToGroup.html"><abbr title="\CRM_Contact_Form_Task_AddToGroup">CRM_Contact_Form_Task_AddToGroup</abbr></a></dt><dd>This class provides the functionality to group contacts.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Task-AddToHousehold.html"><abbr title="\CRM_Contact_Form_Task_AddToHousehold">CRM_Contact_Form_Task_AddToHousehold</abbr></a></dt><dd>This class provides the functionality to add contact(s) to Household.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Task-AddToIndividual.html"><abbr title="\CRM_Contact_Form_Task_AddToIndividual">CRM_Contact_Form_Task_AddToIndividual</abbr></a></dt><dd>This class provides the functionality to add contact(s) to Individual.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Task-AddToOrganization.html"><abbr title="\CRM_Contact_Form_Task_AddToOrganization">CRM_Contact_Form_Task_AddToOrganization</abbr></a></dt><dd>This class provides the functionality to add contact(s) to Organization.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Task-AddToParentClass.html"><abbr title="\CRM_Contact_Form_Task_AddToParentClass">CRM_Contact_Form_Task_AddToParentClass</abbr></a></dt><dd>This class provides the shared functionality for addToHousehold and addToOrganization.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Task-AddToTag.html"><abbr title="\CRM_Contact_Form_Task_AddToTag">CRM_Contact_Form_Task_AddToTag</abbr></a></dt><dd>This class provides the functionality to delete a group of contacts.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Task-AlterPreferences.html"><abbr title="\CRM_Contact_Form_Task_AlterPreferences">CRM_Contact_Form_Task_AlterPreferences</abbr></a></dt><dd>This class provides the functionality to alter a privacy
options for selected contacts</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Task-Batch.html"><abbr title="\CRM_Contact_Form_Task_Batch">CRM_Contact_Form_Task_Batch</abbr></a></dt><dd>This class provides the functionality for batch profile update.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Task-Delete.html"><abbr title="\CRM_Contact_Form_Task_Delete">CRM_Contact_Form_Task_Delete</abbr></a></dt><dd>This class provides the functionality to delete a group of contacts.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Task-Email.html"><abbr title="\CRM_Contact_Form_Task_Email">CRM_Contact_Form_Task_Email</abbr></a></dt><dd>This class provides the functionality to email a group of contacts.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Task-EmailCommon.html"><abbr title="\CRM_Contact_Form_Task_EmailCommon">CRM_Contact_Form_Task_EmailCommon</abbr></a></dt><dd>This class provides the common functionality for sending email to
one or a group of contact ids. This class is reused by all the search
components in CiviCRM (since they all have send email as a task)</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Task-HookSample.html"><abbr title="\CRM_Contact_Form_Task_HookSample">CRM_Contact_Form_Task_HookSample</abbr></a></dt><dd>This class provides the functionality to save a search.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Task-Label.html"><abbr title="\CRM_Contact_Form_Task_Label">CRM_Contact_Form_Task_Label</abbr></a></dt><dd>This class helps to print the labels for contacts.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Task-LabelCommon.html"><abbr title="\CRM_Contact_Form_Task_LabelCommon">CRM_Contact_Form_Task_LabelCommon</abbr></a></dt><dd>This class provides the common functionality for sending email to one or a group of contact ids.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Task-Map-Event.html"><abbr title="\CRM_Contact_Form_Task_Map_Event">CRM_Contact_Form_Task_Map_Event</abbr></a></dt><dd>This class provides the functionality to map the address for group of contacts.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Task-Map.html"><abbr title="\CRM_Contact_Form_Task_Map">CRM_Contact_Form_Task_Map</abbr></a></dt><dd>This class provides the functionality to map
the address for group of
contacts.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Task-Merge.html"><abbr title="\CRM_Contact_Form_Task_Merge">CRM_Contact_Form_Task_Merge</abbr></a></dt><dd>This class provides the functionality to Merge contacts.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Task-PDF.html"><abbr title="\CRM_Contact_Form_Task_PDF">CRM_Contact_Form_Task_PDF</abbr></a></dt><dd>This class provides the functionality to create PDF letter for a group of contacts or a single contact.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Task-PDFLetterCommon.html"><abbr title="\CRM_Contact_Form_Task_PDFLetterCommon">CRM_Contact_Form_Task_PDFLetterCommon</abbr></a></dt><dd>This class provides the common functionality for creating PDF letter for one or a group of contact ids.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Task-PickProfile.html"><abbr title="\CRM_Contact_Form_Task_PickProfile">CRM_Contact_Form_Task_PickProfile</abbr></a></dt><dd>This class provides the functionality for Update multiple contacts</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Task-Print.html"><abbr title="\CRM_Contact_Form_Task_Print">CRM_Contact_Form_Task_Print</abbr></a></dt><dd>This class provides the functionality to save a search
Saved Searches are used for saving frequently used queries</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Task-ProximityCommon.html"><abbr title="\CRM_Contact_Form_Task_ProximityCommon">CRM_Contact_Form_Task_ProximityCommon</abbr></a></dt><dd>This class provides the functionality to support Proximity Searches.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Task-RemoveFromGroup.html"><abbr title="\CRM_Contact_Form_Task_RemoveFromGroup">CRM_Contact_Form_Task_RemoveFromGroup</abbr></a></dt><dd>This class provides the functionality to delete a group of
contacts. This class provides functionality for the actual
addition of contacts to groups.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Task-RemoveFromTag.html"><abbr title="\CRM_Contact_Form_Task_RemoveFromTag">CRM_Contact_Form_Task_RemoveFromTag</abbr></a></dt><dd>This class provides the functionality to remove tags of contact(s).</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Task-Result.html"><abbr title="\CRM_Contact_Form_Task_Result">CRM_Contact_Form_Task_Result</abbr></a></dt><dd>Used for displaying results</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Task-SaveSearch-Update.html"><abbr title="\CRM_Contact_Form_Task_SaveSearch_Update">CRM_Contact_Form_Task_SaveSearch_Update</abbr></a></dt><dd>This class provides the functionality to update a saved search.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Task-SaveSearch.html"><abbr title="\CRM_Contact_Form_Task_SaveSearch">CRM_Contact_Form_Task_SaveSearch</abbr></a></dt><dd>This class provides the functionality to save a search.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Task-SMS.html"><abbr title="\CRM_Contact_Form_Task_SMS">CRM_Contact_Form_Task_SMS</abbr></a></dt><dd>This class provides the functionality to sms a group of contacts.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Task-SMSCommon.html"><abbr title="\CRM_Contact_Form_Task_SMSCommon">CRM_Contact_Form_Task_SMSCommon</abbr></a></dt><dd>This class provides the common functionality for sending sms to one or a group of contact ids.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Task-Unhold.html"><abbr title="\CRM_Contact_Form_Task_Unhold">CRM_Contact_Form_Task_Unhold</abbr></a></dt><dd>Class CRM_Contact_Form_Task_Unhold</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Task-Useradd.html"><abbr title="\CRM_Contact_Form_Task_Useradd">CRM_Contact_Form_Task_Useradd</abbr></a></dt><dd>This class generates form components generic to useradd.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Task.html"><abbr title="\CRM_Contact_Form_Task">CRM_Contact_Form_Task</abbr></a></dt><dd>This class generates form components for search-result tasks.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Import-Form-DataSource.html"><abbr title="\CRM_Contact_Import_Form_DataSource">CRM_Contact_Import_Form_DataSource</abbr></a></dt><dd>This class delegates to the chosen DataSource to grab the data to be imported.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Import-Form-MapField.html"><abbr title="\CRM_Contact_Import_Form_MapField">CRM_Contact_Import_Form_MapField</abbr></a></dt><dd>This class gets the name of the file to upload.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Import-Form-Preview.html"><abbr title="\CRM_Contact_Import_Form_Preview">CRM_Contact_Import_Form_Preview</abbr></a></dt><dd>This class previews the uploaded file and returns summary statistics.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Import-Form-Summary.html"><abbr title="\CRM_Contact_Import_Form_Summary">CRM_Contact_Import_Form_Summary</abbr></a></dt><dd>This class summarizes the import results.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Import-Page-AJAX.html"><abbr title="\CRM_Contact_Import_Page_AJAX">CRM_Contact_Import_Page_AJAX</abbr></a></dt><dd>This class contains all the function that are called using AJAX.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Import-Parser-Contact.html"><abbr title="\CRM_Contact_Import_Parser_Contact">CRM_Contact_Import_Parser_Contact</abbr></a></dt><dd>class to parse contact csv files</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Page-AJAX.html"><abbr title="\CRM_Contact_Page_AJAX">CRM_Contact_Page_AJAX</abbr></a></dt><dd>This class contains all contact related functions that are called using AJAX (jQuery)</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Page-DashBoard.html"><abbr title="\CRM_Contact_Page_DashBoard">CRM_Contact_Page_DashBoard</abbr></a></dt><dd>CiviCRM Dashboard.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Page-DedupeException.html"><abbr title="\CRM_Contact_Page_DedupeException">CRM_Contact_Page_DedupeException</abbr></a></dt><dd>Main page for viewing contact.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Page-DedupeFind.html"><abbr title="\CRM_Contact_Page_DedupeFind">CRM_Contact_Page_DedupeFind</abbr></a></dt><dd>A Page is basically data in a nice pretty format.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Page-DedupeMerge.html"><abbr title="\CRM_Contact_Page_DedupeMerge">CRM_Contact_Page_DedupeMerge</abbr></a></dt><dd>A Page is basically data in a nice pretty format.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Page-DedupeRules.html"><abbr title="\CRM_Contact_Page_DedupeRules">CRM_Contact_Page_DedupeRules</abbr></a></dt><dd>A Page is basically data in a nice pretty format.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Page-ImageFile.html"><abbr title="\CRM_Contact_Page_ImageFile">CRM_Contact_Page_ImageFile</abbr></a></dt><dd>A Page is basically data in a nice pretty format.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Page-Inline-Actions.html"><abbr title="\CRM_Contact_Page_Inline_Actions">CRM_Contact_Page_Inline_Actions</abbr></a></dt><dd>Dummy page for actions button.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Page-Inline-Address.html"><abbr title="\CRM_Contact_Page_Inline_Address">CRM_Contact_Page_Inline_Address</abbr></a></dt><dd>Dummy page for details of address.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Page-Inline-CommunicationPreferences.html"><abbr title="\CRM_Contact_Page_Inline_CommunicationPreferences">CRM_Contact_Page_Inline_CommunicationPreferences</abbr></a></dt><dd>Dummy page for details of communication preferences.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Page-Inline-ContactInfo.html"><abbr title="\CRM_Contact_Page_Inline_ContactInfo">CRM_Contact_Page_Inline_ContactInfo</abbr></a></dt><dd>Page to display contact information on top of summary.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Page-Inline-ContactName.html"><abbr title="\CRM_Contact_Page_Inline_ContactName">CRM_Contact_Page_Inline_ContactName</abbr></a></dt><dd>Page to display contact name on top of the summary.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Page-Inline-CustomData.html"><abbr title="\CRM_Contact_Page_Inline_CustomData">CRM_Contact_Page_Inline_CustomData</abbr></a></dt><dd>This page displays custom data during inline edit.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Page-Inline-Demographics.html"><abbr title="\CRM_Contact_Page_Inline_Demographics">CRM_Contact_Page_Inline_Demographics</abbr></a></dt><dd>Dummy page for details of demographics.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Page-Inline-Email.html"><abbr title="\CRM_Contact_Page_Inline_Email">CRM_Contact_Page_Inline_Email</abbr></a></dt><dd>Dummy page for details of Email.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Page-Inline-IM.html"><abbr title="\CRM_Contact_Page_Inline_IM">CRM_Contact_Page_Inline_IM</abbr></a></dt><dd>Dummy page for details for IM.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Page-Inline-OpenID.html"><abbr title="\CRM_Contact_Page_Inline_OpenID">CRM_Contact_Page_Inline_OpenID</abbr></a></dt><dd>Dummy page for details for OpenID.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Page-Inline-Phone.html"><abbr title="\CRM_Contact_Page_Inline_Phone">CRM_Contact_Page_Inline_Phone</abbr></a></dt><dd>Dummy page for details of Phone.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Page-Inline-Website.html"><abbr title="\CRM_Contact_Page_Inline_Website">CRM_Contact_Page_Inline_Website</abbr></a></dt><dd>Dummy page for details of website.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Page-SavedSearch.html"><abbr title="\CRM_Contact_Page_SavedSearch">CRM_Contact_Page_SavedSearch</abbr></a></dt><dd>Main page for viewing all Saved searches.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Page-Task.html"><abbr title="\CRM_Contact_Page_Task">CRM_Contact_Page_Task</abbr></a></dt><dd>This is a dummy class that does nothing at the moment.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Page-View-ContactSmartGroup.html"><abbr title="\CRM_Contact_Page_View_ContactSmartGroup">CRM_Contact_Page_View_ContactSmartGroup</abbr></a></dt><dd>A Page is basically data in a nice pretty format.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Page-View-CustomData.html"><abbr title="\CRM_Contact_Page_View_CustomData">CRM_Contact_Page_View_CustomData</abbr></a></dt><dd>Page for displaying custom data.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Page-View-GroupContact.html"><abbr title="\CRM_Contact_Page_View_GroupContact">CRM_Contact_Page_View_GroupContact</abbr></a></dt><dd>A Page is basically data in a nice pretty format.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Page-View-Log.html"><abbr title="\CRM_Contact_Page_View_Log">CRM_Contact_Page_View_Log</abbr></a></dt><dd>A Page is basically data in a nice pretty format.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Page-View-Print.html"><abbr title="\CRM_Contact_Page_View_Print">CRM_Contact_Page_View_Print</abbr></a></dt><dd>Main page for viewing contact.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Page-View-Relationship.html"><abbr title="\CRM_Contact_Page_View_Relationship">CRM_Contact_Page_View_Relationship</abbr></a></dt><dd>A Page is basically data in a nice pretty format.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Page-View-Summary.html"><abbr title="\CRM_Contact_Page_View_Summary">CRM_Contact_Page_View_Summary</abbr></a></dt><dd>Main page for viewing contact.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Page-View-Tag.html"><abbr title="\CRM_Contact_Page_View_Tag">CRM_Contact_Page_View_Tag</abbr></a></dt><dd>A Page is basically data in a nice pretty format.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Page-View-Useradd.html"><abbr title="\CRM_Contact_Page_View_Useradd">CRM_Contact_Page_View_Useradd</abbr></a></dt><dd>Dummy page for details of Email.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Page-View-UserDashBoard-GroupContact.html"><abbr title="\CRM_Contact_Page_View_UserDashBoard_GroupContact">CRM_Contact_Page_View_UserDashBoard_GroupContact</abbr></a></dt><dd>This class is used to build User Dashboard</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Page-View-UserDashBoard.html"><abbr title="\CRM_Contact_Page_View_UserDashBoard">CRM_Contact_Page_View_UserDashBoard</abbr></a></dt><dd>This class is used to build User Dashboard</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Page-View-Vcard.html"><abbr title="\CRM_Contact_Page_View_Vcard">CRM_Contact_Page_View_Vcard</abbr></a></dt><dd>vCard export class.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Page-View.html"><abbr title="\CRM_Contact_Page_View">CRM_Contact_Page_View</abbr></a></dt><dd>Main page for viewing contact.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Selector-Controller.html"><abbr title="\CRM_Contact_Selector_Controller">CRM_Contact_Selector_Controller</abbr></a></dt><dd>This class is a generic class to be used when we want to display
a list of rows along with a set of associated actions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Selector.html"><abbr title="\CRM_Contact_Selector">CRM_Contact_Selector</abbr></a></dt><dd>Class is to retrieve and display a range of contacts that match the given criteria.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-StateMachine-Search.html"><abbr title="\CRM_Contact_StateMachine_Search">CRM_Contact_StateMachine_Search</abbr></a></dt><dd>Core StateMachine.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Task.html"><abbr title="\CRM_Contact_Task">CRM_Contact_Task</abbr></a></dt><dd>Class to represent the actions that can be performed on a group of contacts used by the search forms.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Tokens.html"><abbr title="\CRM_Contact_Tokens">CRM_Contact_Tokens</abbr></a></dt><dd>Class CRM_Contact_Tokens</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-ActionMapping-ByPage.html"><abbr title="\CRM_Contribute_ActionMapping_ByPage">CRM_Contribute_ActionMapping_ByPage</abbr></a></dt><dd>Class CRM_Contribute_ActionMapping_ByPage</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-ActionMapping-ByType.html"><abbr title="\CRM_Contribute_ActionMapping_ByType">CRM_Contribute_ActionMapping_ByType</abbr></a></dt><dd>Class CRM_Contribute_ActionMapping_ByType</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-BAO-Contribution-Utils.html"><abbr title="\CRM_Contribute_BAO_Contribution_Utils">CRM_Contribute_BAO_Contribution_Utils</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-BAO-Contribution.html"><abbr title="\CRM_Contribute_BAO_Contribution">CRM_Contribute_BAO_Contribution</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-BAO-ContributionPage.html"><abbr title="\CRM_Contribute_BAO_ContributionPage">CRM_Contribute_BAO_ContributionPage</abbr></a></dt><dd>This class contains Contribution Page related functions.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-BAO-ContributionRecur.html"><abbr title="\CRM_Contribute_BAO_ContributionRecur">CRM_Contribute_BAO_ContributionRecur</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-BAO-ContributionSoft.html"><abbr title="\CRM_Contribute_BAO_ContributionSoft">CRM_Contribute_BAO_ContributionSoft</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-BAO-Premium.html"><abbr title="\CRM_Contribute_BAO_Premium">CRM_Contribute_BAO_Premium</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-BAO-Product.html"><abbr title="\CRM_Contribute_BAO_Product">CRM_Contribute_BAO_Product</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-BAO-Query.html"><abbr title="\CRM_Contribute_BAO_Query">CRM_Contribute_BAO_Query</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-BAO-Widget.html"><abbr title="\CRM_Contribute_BAO_Widget">CRM_Contribute_BAO_Widget</abbr></a></dt><dd>Class to retrieve information about a contribution page.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Controller-Contribution.html"><abbr title="\CRM_Contribute_Controller_Contribution">CRM_Contribute_Controller_Contribution</abbr></a></dt><dd>This class is used by the Search functionality.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Controller-ContributionPage.html"><abbr title="\CRM_Contribute_Controller_ContributionPage">CRM_Contribute_Controller_ContributionPage</abbr></a></dt><dd>This class is used by the Search functionality.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Controller-Search.html"><abbr title="\CRM_Contribute_Controller_Search">CRM_Contribute_Controller_Search</abbr></a></dt><dd>This class is used by the Search functionality.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Controller-Task.html"><abbr title="\CRM_Contribute_Controller_Task">CRM_Contribute_Controller_Task</abbr></a></dt><dd>Class CRM_Export_Controller_Standalone</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-DAO-Contribution.html"><abbr title="\CRM_Contribute_DAO_Contribution">CRM_Contribute_DAO_Contribution</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-DAO-ContributionPage.html"><abbr title="\CRM_Contribute_DAO_ContributionPage">CRM_Contribute_DAO_ContributionPage</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-DAO-ContributionProduct.html"><abbr title="\CRM_Contribute_DAO_ContributionProduct">CRM_Contribute_DAO_ContributionProduct</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-DAO-ContributionRecur.html"><abbr title="\CRM_Contribute_DAO_ContributionRecur">CRM_Contribute_DAO_ContributionRecur</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-DAO-ContributionSoft.html"><abbr title="\CRM_Contribute_DAO_ContributionSoft">CRM_Contribute_DAO_ContributionSoft</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-DAO-Premium.html"><abbr title="\CRM_Contribute_DAO_Premium">CRM_Contribute_DAO_Premium</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-DAO-PremiumsProduct.html"><abbr title="\CRM_Contribute_DAO_PremiumsProduct">CRM_Contribute_DAO_PremiumsProduct</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-DAO-Product.html"><abbr title="\CRM_Contribute_DAO_Product">CRM_Contribute_DAO_Product</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-DAO-Widget.html"><abbr title="\CRM_Contribute_DAO_Widget">CRM_Contribute_DAO_Widget</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Exception-CheckLineItemsException.html"><abbr title="\CRM_Contribute_Exception_CheckLineItemsException">CRM_Contribute_Exception_CheckLineItemsException</abbr></a></dt><dd>Class CRM_Contribute_Exception_CheckLineItemsException</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Exception-FutureContributionPageException.html"><abbr title="\CRM_Contribute_Exception_FutureContributionPageException">CRM_Contribute_Exception_FutureContributionPageException</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Exception-InactiveContributionPageException.html"><abbr title="\CRM_Contribute_Exception_InactiveContributionPageException">CRM_Contribute_Exception_InactiveContributionPageException</abbr></a></dt><dd>Created by PhpStorm.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Exception-PastContributionPageException.html"><abbr title="\CRM_Contribute_Exception_PastContributionPageException">CRM_Contribute_Exception_PastContributionPageException</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Export-Form-Map.html"><abbr title="\CRM_Contribute_Export_Form_Map">CRM_Contribute_Export_Form_Map</abbr></a></dt><dd>This class gets the name of the file to upload</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Export-Form-Select.html"><abbr title="\CRM_Contribute_Export_Form_Select">CRM_Contribute_Export_Form_Select</abbr></a></dt><dd>This class gets the name of the file to upload</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Form-AbstractEditPayment.html"><abbr title="\CRM_Contribute_Form_AbstractEditPayment">CRM_Contribute_Form_AbstractEditPayment</abbr></a></dt><dd>This class generates form components for processing a contribution
CRM-16229 - During the event registration bulk action via search we
need to inherit CRM_Contact_Form_Task so that we can inherit functions
like getContactIds and make use of controller state. But this is not possible
because CRM_Event_Form_Participant inherits this class.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Form-AdditionalInfo.html"><abbr title="\CRM_Contribute_Form_AdditionalInfo">CRM_Contribute_Form_AdditionalInfo</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Form-AdditionalPayment.html"><abbr title="\CRM_Contribute_Form_AdditionalPayment">CRM_Contribute_Form_AdditionalPayment</abbr></a></dt><dd>This form records additional payments needed when event/contribution is partially paid.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Form-CancelSubscription.html"><abbr title="\CRM_Contribute_Form_CancelSubscription">CRM_Contribute_Form_CancelSubscription</abbr></a></dt><dd>This class provides support for canceling recurring subscriptions.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Form-Contribution-Confirm.html"><abbr title="\CRM_Contribute_Form_Contribution_Confirm">CRM_Contribute_Form_Contribution_Confirm</abbr></a></dt><dd>form to process actions on the group aspect of Custom Data</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Form-Contribution-Main.html"><abbr title="\CRM_Contribute_Form_Contribution_Main">CRM_Contribute_Form_Contribution_Main</abbr></a></dt><dd>This class generates form components for processing a Contribution.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Form-Contribution-ThankYou.html"><abbr title="\CRM_Contribute_Form_Contribution_ThankYou">CRM_Contribute_Form_Contribution_ThankYou</abbr></a></dt><dd>Form for thank-you / success page - 3rd step of online contribution process.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Form-Contribution.html"><abbr title="\CRM_Contribute_Form_Contribution">CRM_Contribute_Form_Contribution</abbr></a></dt><dd>This class generates form components for processing a contribution.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Form-ContributionBase.html"><abbr title="\CRM_Contribute_Form_ContributionBase">CRM_Contribute_Form_ContributionBase</abbr></a></dt><dd>This class generates form components for processing a contribution.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Form-ContributionCharts.html"><abbr title="\CRM_Contribute_Form_ContributionCharts">CRM_Contribute_Form_ContributionCharts</abbr></a></dt><dd>Class CRM_Core_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Form-ContributionPage-AddProduct.html"><abbr title="\CRM_Contribute_Form_ContributionPage_AddProduct">CRM_Contribute_Form_ContributionPage_AddProduct</abbr></a></dt><dd>form to process actions fo adding product to contribution page</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Form-ContributionPage-Amount.html"><abbr title="\CRM_Contribute_Form_ContributionPage_Amount">CRM_Contribute_Form_ContributionPage_Amount</abbr></a></dt><dd>form to process actions on the group aspect of Custom Data</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Form-ContributionPage-Custom.html"><abbr title="\CRM_Contribute_Form_ContributionPage_Custom">CRM_Contribute_Form_ContributionPage_Custom</abbr></a></dt><dd>Form to process actions on the group aspect of Custom Data.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Form-ContributionPage-Delete.html"><abbr title="\CRM_Contribute_Form_ContributionPage_Delete">CRM_Contribute_Form_ContributionPage_Delete</abbr></a></dt><dd>This class is to build the form for Deleting Group.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Form-ContributionPage-Premium.html"><abbr title="\CRM_Contribute_Form_ContributionPage_Premium">CRM_Contribute_Form_ContributionPage_Premium</abbr></a></dt><dd>Form to process actions on Premiums.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Form-ContributionPage-Settings.html"><abbr title="\CRM_Contribute_Form_ContributionPage_Settings">CRM_Contribute_Form_ContributionPage_Settings</abbr></a></dt><dd>Contribution Page form.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Form-ContributionPage-TabHeader.html"><abbr title="\CRM_Contribute_Form_ContributionPage_TabHeader">CRM_Contribute_Form_ContributionPage_TabHeader</abbr></a></dt><dd>Helper class to build navigation links.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Form-ContributionPage-ThankYou.html"><abbr title="\CRM_Contribute_Form_ContributionPage_ThankYou">CRM_Contribute_Form_ContributionPage_ThankYou</abbr></a></dt><dd>Form to configure thank-you messages and receipting features for an online contribution page.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Form-ContributionPage-Widget.html"><abbr title="\CRM_Contribute_Form_ContributionPage_Widget">CRM_Contribute_Form_ContributionPage_Widget</abbr></a></dt><dd>Contribution Page form.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Form-ContributionPage.html"><abbr title="\CRM_Contribute_Form_ContributionPage">CRM_Contribute_Form_ContributionPage</abbr></a></dt><dd>Contribution Page form.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Form-ContributionRecur.html"><abbr title="\CRM_Contribute_Form_ContributionRecur">CRM_Contribute_Form_ContributionRecur</abbr></a></dt><dd>Shared parent class for recurring contribution forms.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Form-ContributionView.html"><abbr title="\CRM_Contribute_Form_ContributionView">CRM_Contribute_Form_ContributionView</abbr></a></dt><dd>This class generates form components for Payment-Instrument.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Form-ManagePremiums.html"><abbr title="\CRM_Contribute_Form_ManagePremiums">CRM_Contribute_Form_ManagePremiums</abbr></a></dt><dd>This class generates form components for Premiums.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Form-Search.html"><abbr title="\CRM_Contribute_Form_Search">CRM_Contribute_Form_Search</abbr></a></dt><dd>Advanced search, extends basic search.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Form-SearchContribution.html"><abbr title="\CRM_Contribute_Form_SearchContribution">CRM_Contribute_Form_SearchContribution</abbr></a></dt><dd>Class CRM_Core_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Form-SoftCredit.html"><abbr title="\CRM_Contribute_Form_SoftCredit">CRM_Contribute_Form_SoftCredit</abbr></a></dt><dd>This class build form elements for select existing or create new soft block.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Form-Task-Batch.html"><abbr title="\CRM_Contribute_Form_Task_Batch">CRM_Contribute_Form_Task_Batch</abbr></a></dt><dd>This class provides the functionality for batch profile update for contributions.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Form-Task-Delete.html"><abbr title="\CRM_Contribute_Form_Task_Delete">CRM_Contribute_Form_Task_Delete</abbr></a></dt><dd>This class provides the functionality to delete a group of contributions.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Form-Task-Email.html"><abbr title="\CRM_Contribute_Form_Task_Email">CRM_Contribute_Form_Task_Email</abbr></a></dt><dd>This class provides the functionality to email a group of contacts.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Form-Task-Invoice.html"><abbr title="\CRM_Contribute_Form_Task_Invoice">CRM_Contribute_Form_Task_Invoice</abbr></a></dt><dd>This class provides the functionality to email a group of
contacts.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Form-Task-PDF.html"><abbr title="\CRM_Contribute_Form_Task_PDF">CRM_Contribute_Form_Task_PDF</abbr></a></dt><dd>This class provides the functionality to email a group of
contacts.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Form-Task-PDFLetter.html"><abbr title="\CRM_Contribute_Form_Task_PDFLetter">CRM_Contribute_Form_Task_PDFLetter</abbr></a></dt><dd>This class provides the functionality to create PDF letter for a group of contacts or a single contact.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Form-Task-PickProfile.html"><abbr title="\CRM_Contribute_Form_Task_PickProfile">CRM_Contribute_Form_Task_PickProfile</abbr></a></dt><dd>This class provides the functionality for batch profile update for contributions.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Form-Task-Print.html"><abbr title="\CRM_Contribute_Form_Task_Print">CRM_Contribute_Form_Task_Print</abbr></a></dt><dd>This class provides the functionality to print contribution records.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Form-Task-Result.html"><abbr title="\CRM_Contribute_Form_Task_Result">CRM_Contribute_Form_Task_Result</abbr></a></dt><dd>Used for displaying results</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Form-Task-Status.html"><abbr title="\CRM_Contribute_Form_Task_Status">CRM_Contribute_Form_Task_Status</abbr></a></dt><dd>This class provides the functionality to email a group of contacts.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Form-Task.html"><abbr title="\CRM_Contribute_Form_Task">CRM_Contribute_Form_Task</abbr></a></dt><dd>Class for contribute form task actions.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Form-UpdateBilling.html"><abbr title="\CRM_Contribute_Form_UpdateBilling">CRM_Contribute_Form_UpdateBilling</abbr></a></dt><dd>This class generates form components for processing a contribution.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Form-UpdateSubscription.html"><abbr title="\CRM_Contribute_Form_UpdateSubscription">CRM_Contribute_Form_UpdateSubscription</abbr></a></dt><dd>This class generates form components generic to recurring contributions.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Form.html"><abbr title="\CRM_Contribute_Form">CRM_Contribute_Form</abbr></a></dt><dd>This class generates form components generic to Contribution admin.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Import-Form-DataSource.html"><abbr title="\CRM_Contribute_Import_Form_DataSource">CRM_Contribute_Import_Form_DataSource</abbr></a></dt><dd>This class gets the name of the file to upload</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Import-Form-MapField.html"><abbr title="\CRM_Contribute_Import_Form_MapField">CRM_Contribute_Import_Form_MapField</abbr></a></dt><dd>This class gets the name of the file to upload.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Import-Form-Preview.html"><abbr title="\CRM_Contribute_Import_Form_Preview">CRM_Contribute_Import_Form_Preview</abbr></a></dt><dd>This class previews the uploaded file and returns summary statistics.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Import-Parser-Contribution.html"><abbr title="\CRM_Contribute_Import_Parser_Contribution">CRM_Contribute_Import_Parser_Contribution</abbr></a></dt><dd>Class to parse contribution csv files.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Info.html"><abbr title="\CRM_Contribute_Info">CRM_Contribute_Info</abbr></a></dt><dd>This class introduces component to the system and provides all the
information about it. It needs to extend CRM_Core_Component_Info
abstract class.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Page-AJAX.html"><abbr title="\CRM_Contribute_Page_AJAX">CRM_Contribute_Page_AJAX</abbr></a></dt><dd>This class contains all the function that are called using AJAX (jQuery)</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Page-ContributionPage.html"><abbr title="\CRM_Contribute_Page_ContributionPage">CRM_Contribute_Page_ContributionPage</abbr></a></dt><dd>Create a page for displaying Contribute Pages
Contribute Pages are pages that are used to display
contributions of different types. Pages consist
of many customizable sections which can be
accessed.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Page-ContributionRecur.html"><abbr title="\CRM_Contribute_Page_ContributionRecur">CRM_Contribute_Page_ContributionRecur</abbr></a></dt><dd>Main page for viewing Recurring Contributions.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Page-ContributionRecurPayments.html"><abbr title="\CRM_Contribute_Page_ContributionRecurPayments">CRM_Contribute_Page_ContributionRecurPayments</abbr></a></dt><dd>Shows list of contributions done as payments within a recurring contribution.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Page-DashBoard.html"><abbr title="\CRM_Contribute_Page_DashBoard">CRM_Contribute_Page_DashBoard</abbr></a></dt><dd>Page for displaying list of Payment-Instrument.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Page-ManagePremiums.html"><abbr title="\CRM_Contribute_Page_ManagePremiums">CRM_Contribute_Page_ManagePremiums</abbr></a></dt><dd>Page for displaying list of Premiums.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Page-PaymentInfo.html"><abbr title="\CRM_Contribute_Page_PaymentInfo">CRM_Contribute_Page_PaymentInfo</abbr></a></dt><dd>A Page is basically data in a nice pretty format.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Page-Premium.html"><abbr title="\CRM_Contribute_Page_Premium">CRM_Contribute_Page_Premium</abbr></a></dt><dd>Page for displaying list of Premiums.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Page-SubscriptionStatus.html"><abbr title="\CRM_Contribute_Page_SubscriptionStatus">CRM_Contribute_Page_SubscriptionStatus</abbr></a></dt><dd>A Page is basically data in a nice pretty format.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Page-Tab.html"><abbr title="\CRM_Contribute_Page_Tab">CRM_Contribute_Page_Tab</abbr></a></dt><dd>A Page is basically data in a nice pretty format.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Page-UserDashboard.html"><abbr title="\CRM_Contribute_Page_UserDashboard">CRM_Contribute_Page_UserDashboard</abbr></a></dt><dd>This class is used to build User Dashboard</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Page-Widget.html"><abbr title="\CRM_Contribute_Page_Widget">CRM_Contribute_Page_Widget</abbr></a></dt><dd>A Page is basically data in a nice pretty format.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-RecurTokens.html"><abbr title="\CRM_Contribute_RecurTokens">CRM_Contribute_RecurTokens</abbr></a></dt><dd>Class CRM_Contribute_RecurTokens</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Selector-Search.html"><abbr title="\CRM_Contribute_Selector_Search">CRM_Contribute_Selector_Search</abbr></a></dt><dd>Class to render contribution search results.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-StateMachine-Contribution.html"><abbr title="\CRM_Contribute_StateMachine_Contribution">CRM_Contribute_StateMachine_Contribution</abbr></a></dt><dd>State machine for managing different states of the Import process.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-StateMachine-ContributionPage.html"><abbr title="\CRM_Contribute_StateMachine_ContributionPage">CRM_Contribute_StateMachine_ContributionPage</abbr></a></dt><dd>State machine for managing different states of the Import process.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-StateMachine-Search.html"><abbr title="\CRM_Contribute_StateMachine_Search">CRM_Contribute_StateMachine_Search</abbr></a></dt><dd>Core StateMachine.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Task.html"><abbr title="\CRM_Contribute_Task">CRM_Contribute_Task</abbr></a></dt><dd>Class to represent the actions that can be performed on a group of contacts.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Tokens.html"><abbr title="\CRM_Contribute_Tokens">CRM_Contribute_Tokens</abbr></a></dt><dd>Class CRM_Contribute_Tokens</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-WorkflowMessage-Contribution-BasicContribution.html"><abbr title="\CRM_Contribute_WorkflowMessage_Contribution_BasicContribution">CRM_Contribute_WorkflowMessage_Contribution_BasicContribution</abbr></a></dt><dd>Basic contribution example for contribution templates.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-WorkflowMessage-ContributionInvoiceReceipt.html"><abbr title="\CRM_Contribute_WorkflowMessage_ContributionInvoiceReceipt">CRM_Contribute_WorkflowMessage_ContributionInvoiceReceipt</abbr></a></dt><dd>Invoice generated when invoicing is enabled.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-WorkflowMessage-ContributionOfflineReceipt.html"><abbr title="\CRM_Contribute_WorkflowMessage_ContributionOfflineReceipt">CRM_Contribute_WorkflowMessage_ContributionOfflineReceipt</abbr></a></dt><dd>Receipt sent when confirming a back office contribution.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-WorkflowMessage-ContributionOnlineReceipt.html"><abbr title="\CRM_Contribute_WorkflowMessage_ContributionOnlineReceipt">CRM_Contribute_WorkflowMessage_ContributionOnlineReceipt</abbr></a></dt><dd>Receipt sent when confirming contribution add payment.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-WorkflowMessage-PaymentOrRefundNotification.html"><abbr title="\CRM_Contribute_WorkflowMessage_PaymentOrRefundNotification">CRM_Contribute_WorkflowMessage_PaymentOrRefundNotification</abbr></a></dt><dd>Receipt sent when confirming contribution add payment.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-WorkflowMessage-RecurringCancelled.html"><abbr title="\CRM_Contribute_WorkflowMessage_RecurringCancelled">CRM_Contribute_WorkflowMessage_RecurringCancelled</abbr></a></dt><dd>Generic base-class for describing the inputs for a workflow email template.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-WorkflowMessage-RecurringEdit-AlexCancelled.html"><abbr title="\CRM_Contribute_WorkflowMessage_RecurringEdit_AlexCancelled">CRM_Contribute_WorkflowMessage_RecurringEdit_AlexCancelled</abbr></a></dt><dd>Helper class for defining WorkflowMessage example-data.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-WorkflowMessage-RecurringEdit-BarbPending.html"><abbr title="\CRM_Contribute_WorkflowMessage_RecurringEdit_BarbPending">CRM_Contribute_WorkflowMessage_RecurringEdit_BarbPending</abbr></a></dt><dd>Helper class for defining WorkflowMessage example-data.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-WorkflowMessage-RecurringEdit.html"><abbr title="\CRM_Contribute_WorkflowMessage_RecurringEdit">CRM_Contribute_WorkflowMessage_RecurringEdit</abbr></a></dt><dd>Generic base-class for describing the inputs for a workflow email template.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Action.html"><abbr title="\CRM_Core_Action">CRM_Core_Action</abbr></a></dt><dd>The core concept of the system is an action performed on an object. Typically this will be a "data model" object
as specified in the API specs. We attempt to keep the number and type of actions consistent
and similar across all objects (thus providing both reuse and standards)</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-ActionLog.html"><abbr title="\CRM_Core_BAO_ActionLog">CRM_Core_BAO_ActionLog</abbr></a></dt><dd>This class contains functions for managing Action Logs</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-ActionSchedule.html"><abbr title="\CRM_Core_BAO_ActionSchedule">CRM_Core_BAO_ActionSchedule</abbr></a></dt><dd>This class contains functions for managing Scheduled Reminders</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-Address.html"><abbr title="\CRM_Core_BAO_Address">CRM_Core_BAO_Address</abbr></a></dt><dd>This is class to handle address related functions.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-Block.html"><abbr title="\CRM_Core_BAO_Block">CRM_Core_BAO_Block</abbr></a></dt><dd>Add static functions to include some common functionality used across location sub object BAO classes.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-Cache.html"><abbr title="\CRM_Core_BAO_Cache">CRM_Core_BAO_Cache</abbr></a></dt><dd>BAO object for civicrm_cache table.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-CMSUser.html"><abbr title="\CRM_Core_BAO_CMSUser">CRM_Core_BAO_CMSUser</abbr></a></dt><dd>Class CRM_Core_BAO_CMSUser</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-ConfigSetting.html"><abbr title="\CRM_Core_BAO_ConfigSetting">CRM_Core_BAO_ConfigSetting</abbr></a></dt><dd>File contains functions used in civicrm configuration.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-Country.html"><abbr title="\CRM_Core_BAO_Country">CRM_Core_BAO_Country</abbr></a></dt><dd>This class contains functions for managing Action Logs</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-County.html"><abbr title="\CRM_Core_BAO_County">CRM_Core_BAO_County</abbr></a></dt><dd>This class contains functions for managing Counties.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-CustomField.html"><abbr title="\CRM_Core_BAO_CustomField">CRM_Core_BAO_CustomField</abbr></a></dt><dd>Class CRM_Core_BAO_CustomField</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-CustomGroup.html"><abbr title="\CRM_Core_BAO_CustomGroup">CRM_Core_BAO_CustomGroup</abbr></a></dt><dd>Business object for managing custom data groups.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-CustomOption.html"><abbr title="\CRM_Core_BAO_CustomOption">CRM_Core_BAO_CustomOption</abbr></a></dt><dd>Business objects for managing custom data options.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-CustomQuery.html"><abbr title="\CRM_Core_BAO_CustomQuery">CRM_Core_BAO_CustomQuery</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-CustomValue.html"><abbr title="\CRM_Core_BAO_CustomValue">CRM_Core_BAO_CustomValue</abbr></a></dt><dd>Business objects for managing custom data values.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-CustomValueTable.html"><abbr title="\CRM_Core_BAO_CustomValueTable">CRM_Core_BAO_CustomValueTable</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-Dashboard.html"><abbr title="\CRM_Core_BAO_Dashboard">CRM_Core_BAO_Dashboard</abbr></a></dt><dd>Class contains Contact dashboard related functions.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-Discount.html"><abbr title="\CRM_Core_BAO_Discount">CRM_Core_BAO_Discount</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-Domain.html"><abbr title="\CRM_Core_BAO_Domain">CRM_Core_BAO_Domain</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-Email.html"><abbr title="\CRM_Core_BAO_Email">CRM_Core_BAO_Email</abbr></a></dt><dd>This class contains functions for email handling.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-EntityTag.html"><abbr title="\CRM_Core_BAO_EntityTag">CRM_Core_BAO_EntityTag</abbr></a></dt><dd>This class contains functions for managing Tag(tag) for a contact</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-Extension.html"><abbr title="\CRM_Core_BAO_Extension">CRM_Core_BAO_Extension</abbr></a></dt><dd>This class contains functions for managing extensions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-File.html"><abbr title="\CRM_Core_BAO_File">CRM_Core_BAO_File</abbr></a></dt><dd>BAO object for crm_log table</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-FinancialTrxn.html"><abbr title="\CRM_Core_BAO_FinancialTrxn">CRM_Core_BAO_FinancialTrxn</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-IM.html"><abbr title="\CRM_Core_BAO_IM">CRM_Core_BAO_IM</abbr></a></dt><dd>This class contain function for IM handling</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-Job.html"><abbr title="\CRM_Core_BAO_Job">CRM_Core_BAO_Job</abbr></a></dt><dd>This class contains scheduled jobs related functions.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-LabelFormat.html"><abbr title="\CRM_Core_BAO_LabelFormat">CRM_Core_BAO_LabelFormat</abbr></a></dt><dd>This class contains functions for managing Label Formats.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-Location.html"><abbr title="\CRM_Core_BAO_Location">CRM_Core_BAO_Location</abbr></a></dt><dd>This class handle creation of location block elements.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-LocationType.html"><abbr title="\CRM_Core_BAO_LocationType">CRM_Core_BAO_LocationType</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-Log.html"><abbr title="\CRM_Core_BAO_Log">CRM_Core_BAO_Log</abbr></a></dt><dd>BAO object for crm_log table</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-MailSettings.html"><abbr title="\CRM_Core_BAO_MailSettings">CRM_Core_BAO_MailSettings</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-Managed.html"><abbr title="\CRM_Core_BAO_Managed">CRM_Core_BAO_Managed</abbr></a></dt><dd>This class contains functions for managed entities.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-Mapping.html"><abbr title="\CRM_Core_BAO_Mapping">CRM_Core_BAO_Mapping</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-MessageTemplate.html"><abbr title="\CRM_Core_BAO_MessageTemplate">CRM_Core_BAO_MessageTemplate</abbr></a></dt><dd>Class CRM_Core_BAO_MessageTemplate.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-Navigation.html"><abbr title="\CRM_Core_BAO_Navigation">CRM_Core_BAO_Navigation</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-Note.html"><abbr title="\CRM_Core_BAO_Note">CRM_Core_BAO_Note</abbr></a></dt><dd>BAO object for crm_note table.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-OpenID.html"><abbr title="\CRM_Core_BAO_OpenID">CRM_Core_BAO_OpenID</abbr></a></dt><dd>This class contains function for Open Id</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-OptionGroup.html"><abbr title="\CRM_Core_BAO_OptionGroup">CRM_Core_BAO_OptionGroup</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-OptionValue.html"><abbr title="\CRM_Core_BAO_OptionValue">CRM_Core_BAO_OptionValue</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-PaperSize.html"><abbr title="\CRM_Core_BAO_PaperSize">CRM_Core_BAO_PaperSize</abbr></a></dt><dd>This class contains functions for managing Paper Sizes.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-PdfFormat.html"><abbr title="\CRM_Core_BAO_PdfFormat">CRM_Core_BAO_PdfFormat</abbr></a></dt><dd>This class contains functions for managing PDF Page Formats.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-Phone.html"><abbr title="\CRM_Core_BAO_Phone">CRM_Core_BAO_Phone</abbr></a></dt><dd>Class contains functions for phone.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-PreferencesDate.html"><abbr title="\CRM_Core_BAO_PreferencesDate">CRM_Core_BAO_PreferencesDate</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-PrevNextCache.html"><abbr title="\CRM_Core_BAO_PrevNextCache">CRM_Core_BAO_PrevNextCache</abbr></a></dt><dd>BAO object for civicrm_prevnext_cache table.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-Query.html"><abbr title="\CRM_Core_BAO_Query">CRM_Core_BAO_Query</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-RecurringEntity.html"><abbr title="\CRM_Core_BAO_RecurringEntity">CRM_Core_BAO_RecurringEntity</abbr></a></dt><dd>Class CRM_Core_BAO_RecurringEntity.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-SchemaHandler.html"><abbr title="\CRM_Core_BAO_SchemaHandler">CRM_Core_BAO_SchemaHandler</abbr></a></dt><dd>This file contains functions for creating and altering CiviCRM-tables structure.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-Setting.html"><abbr title="\CRM_Core_BAO_Setting">CRM_Core_BAO_Setting</abbr></a></dt><dd>BAO object for civicrm_setting table. This table is used to store civicrm settings that are not used
very frequently (i.e. not on every page load)</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-SiteToken.html"><abbr title="\CRM_Core_BAO_SiteToken">CRM_Core_BAO_SiteToken</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-StatusPreference.html"><abbr title="\CRM_Core_BAO_StatusPreference">CRM_Core_BAO_StatusPreference</abbr></a></dt><dd>This class contains functions for managing Status Preferences.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-Tag.html"><abbr title="\CRM_Core_BAO_Tag">CRM_Core_BAO_Tag</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-TranslateGetWrapper.html"><abbr title="\CRM_Core_BAO_TranslateGetWrapper">CRM_Core_BAO_TranslateGetWrapper</abbr></a></dt><dd>Wrapper to swap in translated text.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-Translation.html"><abbr title="\CRM_Core_BAO_Translation">CRM_Core_BAO_Translation</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-UFField.html"><abbr title="\CRM_Core_BAO_UFField">CRM_Core_BAO_UFField</abbr></a></dt><dd>This class contains function for UFField.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-UFGroup.html"><abbr title="\CRM_Core_BAO_UFGroup">CRM_Core_BAO_UFGroup</abbr></a></dt><dd>UF group BAO class.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-UFJoin.html"><abbr title="\CRM_Core_BAO_UFJoin">CRM_Core_BAO_UFJoin</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-UFMatch.html"><abbr title="\CRM_Core_BAO_UFMatch">CRM_Core_BAO_UFMatch</abbr></a></dt><dd>The basic class that interfaces with the external user framework.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-UserJob.html"><abbr title="\CRM_Core_BAO_UserJob">CRM_Core_BAO_UserJob</abbr></a></dt><dd>This class contains user jobs functionality.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-Website.html"><abbr title="\CRM_Core_BAO_Website">CRM_Core_BAO_Website</abbr></a></dt><dd>This class contain function for Website handling.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-WordReplacement.html"><abbr title="\CRM_Core_BAO_WordReplacement">CRM_Core_BAO_WordReplacement</abbr></a></dt><dd>Class CRM_Core_BAO_WordReplacement.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Block.html"><abbr title="\CRM_Core_Block">CRM_Core_Block</abbr></a></dt><dd>Defines a simple implementation of a drupal block.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-ClassLoader.html"><abbr title="\CRM_Core_ClassLoader">CRM_Core_ClassLoader</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-CodeGen-BaseTask.html"><abbr title="\CRM_Core_CodeGen_BaseTask">CRM_Core_CodeGen_BaseTask</abbr></a></dt><dd>Class CRM_Core_CodeGen_BaseTask</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-CodeGen-BounceType.html"><abbr title="\CRM_Core_CodeGen_BounceType">CRM_Core_CodeGen_BounceType</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-CodeGen-Config.html"><abbr title="\CRM_Core_CodeGen_Config">CRM_Core_CodeGen_Config</abbr></a></dt><dd>Generate configuration files</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-CodeGen-DAO.html"><abbr title="\CRM_Core_CodeGen_DAO">CRM_Core_CodeGen_DAO</abbr></a></dt><dd>Create DAO ORM classes.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-CodeGen-DedupeRule.html"><abbr title="\CRM_Core_CodeGen_DedupeRule">CRM_Core_CodeGen_DedupeRule</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-CodeGen-GenerateData.html"><abbr title="\CRM_Core_CodeGen_GenerateData">CRM_Core_CodeGen_GenerateData</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-CodeGen-I18n.html"><abbr title="\CRM_Core_CodeGen_I18n">CRM_Core_CodeGen_I18n</abbr></a></dt><dd>Generate language files and classes</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-CodeGen-Main.html"><abbr title="\CRM_Core_CodeGen_Main">CRM_Core_CodeGen_Main</abbr></a></dt><dd>Class CRM_Core_CodeGen_Main</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-CodeGen-Reflection.html"><abbr title="\CRM_Core_CodeGen_Reflection">CRM_Core_CodeGen_Reflection</abbr></a></dt><dd>Create classes which are used for schema introspection.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-CodeGen-Schema.html"><abbr title="\CRM_Core_CodeGen_Schema">CRM_Core_CodeGen_Schema</abbr></a></dt><dd>Create SQL files to create and populate a new schema.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-CodeGen-Specification.html"><abbr title="\CRM_Core_CodeGen_Specification">CRM_Core_CodeGen_Specification</abbr></a></dt><dd>Read the schema specification and parse into internal data structures</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-CodeGen-Test.html"><abbr title="\CRM_Core_CodeGen_Test">CRM_Core_CodeGen_Test</abbr></a></dt><dd>Generate files used during testing.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-CodeGen-Util-ArraySyntaxConverter.html"><abbr title="\CRM_Core_CodeGen_Util_ArraySyntaxConverter">CRM_Core_CodeGen_Util_ArraySyntaxConverter</abbr></a></dt><dd>Class CRM_Core_CodeGen_Util_ArraySyntaxConverter</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-CodeGen-Util-File.html"><abbr title="\CRM_Core_CodeGen_Util_File">CRM_Core_CodeGen_Util_File</abbr></a></dt><dd>Class CRM_Core_CodeGen_Util_File</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-CodeGen-Util-MessageTemplates.html"><abbr title="\CRM_Core_CodeGen_Util_MessageTemplates">CRM_Core_CodeGen_Util_MessageTemplates</abbr></a></dt><dd>Class CRM_Core_CodeGen_Util_MessageTemplate</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-CodeGen-Util-Smarty.html"><abbr title="\CRM_Core_CodeGen_Util_Smarty">CRM_Core_CodeGen_Util_Smarty</abbr></a></dt><dd>Class CRM_Core_CodeGen_Util_Smarty</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-CodeGen-Util-Template.html"><abbr title="\CRM_Core_CodeGen_Util_Template">CRM_Core_CodeGen_Util_Template</abbr></a></dt><dd>Class CRM_Core_CodeGen_Util_Template</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-CodeGen-Util-Xml.html"><abbr title="\CRM_Core_CodeGen_Util_Xml">CRM_Core_CodeGen_Util_Xml</abbr></a></dt><dd>Class CRM_Core_CodeGen_Util_Xml</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-CommunityMessages.html"><abbr title="\CRM_Core_CommunityMessages">CRM_Core_CommunityMessages</abbr></a></dt><dd>Manage the download, validation, and rendering of community messages</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Component-Info.html"><abbr title="\CRM_Core_Component_Info">CRM_Core_Component_Info</abbr></a></dt><dd>This interface defines methods that need to be implemented
for a component to introduce itself to the system.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Component.html"><abbr title="\CRM_Core_Component">CRM_Core_Component</abbr></a></dt><dd>Component stores all the static and dynamic information of the various
CiviCRM components</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Config-MagicMerge.html"><abbr title="\CRM_Core_Config_MagicMerge">CRM_Core_Config_MagicMerge</abbr></a></dt><dd>Class CRM_Core_Config_MagicMerge</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Config-Runtime.html"><abbr title="\CRM_Core_Config_Runtime">CRM_Core_Config_Runtime</abbr></a></dt><dd>Class CRM_Core_Config_Runtime</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Config.html"><abbr title="\CRM_Core_Config">CRM_Core_Config</abbr></a></dt><dd>Class CRM_Core_Config</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Controller-Simple.html"><abbr title="\CRM_Core_Controller_Simple">CRM_Core_Controller_Simple</abbr></a></dt><dd>We use QFC for both single page and multi page wizards. We want to make
creation of single page forms as easy and as seamless as possible. This
class is used to optimize and make single form pages a relatively trivial
process</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Controller-Task.html"><abbr title="\CRM_Core_Controller_Task">CRM_Core_Controller_Task</abbr></a></dt><dd>Class CRM_Export_Controller_Standalone</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Controller.html"><abbr title="\CRM_Core_Controller">CRM_Core_Controller</abbr></a></dt><dd>Class CRM_Core_Controller</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-ActionLog.html"><abbr title="\CRM_Core_DAO_ActionLog">CRM_Core_DAO_ActionLog</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-ActionSchedule.html"><abbr title="\CRM_Core_DAO_ActionSchedule">CRM_Core_DAO_ActionSchedule</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-Address.html"><abbr title="\CRM_Core_DAO_Address">CRM_Core_DAO_Address</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-AddressFormat.html"><abbr title="\CRM_Core_DAO_AddressFormat">CRM_Core_DAO_AddressFormat</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-AllCoreTables.html"><abbr title="\CRM_Core_DAO_AllCoreTables">CRM_Core_DAO_AllCoreTables</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-Base.html"><abbr title="\CRM_Core_DAO_Base">CRM_Core_DAO_Base</abbr></a></dt><dd>Base for concrete DAO/BAO classes which are defined with a schema/entityType.php file.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-Cache.html"><abbr title="\CRM_Core_DAO_Cache">CRM_Core_DAO_Cache</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-Component.html"><abbr title="\CRM_Core_DAO_Component">CRM_Core_DAO_Component</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-Country.html"><abbr title="\CRM_Core_DAO_Country">CRM_Core_DAO_Country</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-County.html"><abbr title="\CRM_Core_DAO_County">CRM_Core_DAO_County</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-CustomField.html"><abbr title="\CRM_Core_DAO_CustomField">CRM_Core_DAO_CustomField</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-CustomGroup.html"><abbr title="\CRM_Core_DAO_CustomGroup">CRM_Core_DAO_CustomGroup</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-Dashboard.html"><abbr title="\CRM_Core_DAO_Dashboard">CRM_Core_DAO_Dashboard</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-Discount.html"><abbr title="\CRM_Core_DAO_Discount">CRM_Core_DAO_Discount</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-Domain.html"><abbr title="\CRM_Core_DAO_Domain">CRM_Core_DAO_Domain</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-Email.html"><abbr title="\CRM_Core_DAO_Email">CRM_Core_DAO_Email</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-EntityFile.html"><abbr title="\CRM_Core_DAO_EntityFile">CRM_Core_DAO_EntityFile</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-EntityTag.html"><abbr title="\CRM_Core_DAO_EntityTag">CRM_Core_DAO_EntityTag</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-Extension.html"><abbr title="\CRM_Core_DAO_Extension">CRM_Core_DAO_Extension</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-Factory.html"><abbr title="\CRM_Core_DAO_Factory">CRM_Core_DAO_Factory</abbr></a></dt><dd>Class CRM_Core_DAO_Factory</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-File.html"><abbr title="\CRM_Core_DAO_File">CRM_Core_DAO_File</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-IM.html"><abbr title="\CRM_Core_DAO_IM">CRM_Core_DAO_IM</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-Job.html"><abbr title="\CRM_Core_DAO_Job">CRM_Core_DAO_Job</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-JobLog.html"><abbr title="\CRM_Core_DAO_JobLog">CRM_Core_DAO_JobLog</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-LocationType.html"><abbr title="\CRM_Core_DAO_LocationType">CRM_Core_DAO_LocationType</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-LocBlock.html"><abbr title="\CRM_Core_DAO_LocBlock">CRM_Core_DAO_LocBlock</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-Log.html"><abbr title="\CRM_Core_DAO_Log">CRM_Core_DAO_Log</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-MailSettings.html"><abbr title="\CRM_Core_DAO_MailSettings">CRM_Core_DAO_MailSettings</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-Managed.html"><abbr title="\CRM_Core_DAO_Managed">CRM_Core_DAO_Managed</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-Mapping.html"><abbr title="\CRM_Core_DAO_Mapping">CRM_Core_DAO_Mapping</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-MappingField.html"><abbr title="\CRM_Core_DAO_MappingField">CRM_Core_DAO_MappingField</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-Menu.html"><abbr title="\CRM_Core_DAO_Menu">CRM_Core_DAO_Menu</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-MessageTemplate.html"><abbr title="\CRM_Core_DAO_MessageTemplate">CRM_Core_DAO_MessageTemplate</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-Navigation.html"><abbr title="\CRM_Core_DAO_Navigation">CRM_Core_DAO_Navigation</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-Note.html"><abbr title="\CRM_Core_DAO_Note">CRM_Core_DAO_Note</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-OpenID.html"><abbr title="\CRM_Core_DAO_OpenID">CRM_Core_DAO_OpenID</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-OptionGroup.html"><abbr title="\CRM_Core_DAO_OptionGroup">CRM_Core_DAO_OptionGroup</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-OptionValue.html"><abbr title="\CRM_Core_DAO_OptionValue">CRM_Core_DAO_OptionValue</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-Phone.html"><abbr title="\CRM_Core_DAO_Phone">CRM_Core_DAO_Phone</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-PreferencesDate.html"><abbr title="\CRM_Core_DAO_PreferencesDate">CRM_Core_DAO_PreferencesDate</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-PrevNextCache.html"><abbr title="\CRM_Core_DAO_PrevNextCache">CRM_Core_DAO_PrevNextCache</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-PrintLabel.html"><abbr title="\CRM_Core_DAO_PrintLabel">CRM_Core_DAO_PrintLabel</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-RecurringEntity.html"><abbr title="\CRM_Core_DAO_RecurringEntity">CRM_Core_DAO_RecurringEntity</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-Setting.html"><abbr title="\CRM_Core_DAO_Setting">CRM_Core_DAO_Setting</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-SiteToken.html"><abbr title="\CRM_Core_DAO_SiteToken">CRM_Core_DAO_SiteToken</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-StateProvince.html"><abbr title="\CRM_Core_DAO_StateProvince">CRM_Core_DAO_StateProvince</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-StatusPreference.html"><abbr title="\CRM_Core_DAO_StatusPreference">CRM_Core_DAO_StatusPreference</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-SystemLog.html"><abbr title="\CRM_Core_DAO_SystemLog">CRM_Core_DAO_SystemLog</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-Tag.html"><abbr title="\CRM_Core_DAO_Tag">CRM_Core_DAO_Tag</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-Timezone.html"><abbr title="\CRM_Core_DAO_Timezone">CRM_Core_DAO_Timezone</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-Translation.html"><abbr title="\CRM_Core_DAO_Translation">CRM_Core_DAO_Translation</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-UFField.html"><abbr title="\CRM_Core_DAO_UFField">CRM_Core_DAO_UFField</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-UFGroup.html"><abbr title="\CRM_Core_DAO_UFGroup">CRM_Core_DAO_UFGroup</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-UFJoin.html"><abbr title="\CRM_Core_DAO_UFJoin">CRM_Core_DAO_UFJoin</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-UFMatch.html"><abbr title="\CRM_Core_DAO_UFMatch">CRM_Core_DAO_UFMatch</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-UserJob.html"><abbr title="\CRM_Core_DAO_UserJob">CRM_Core_DAO_UserJob</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-Website.html"><abbr title="\CRM_Core_DAO_Website">CRM_Core_DAO_Website</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-WordReplacement.html"><abbr title="\CRM_Core_DAO_WordReplacement">CRM_Core_DAO_WordReplacement</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-Worldregion.html"><abbr title="\CRM_Core_DAO_Worldregion">CRM_Core_DAO_Worldregion</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO.html"><abbr title="\CRM_Core_DAO">CRM_Core_DAO</abbr></a></dt><dd>Class CRM_Core_DAO</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DomainTokens.html"><abbr title="\CRM_Core_DomainTokens">CRM_Core_DomainTokens</abbr></a></dt><dd>Class CRM_Case_Tokens</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-EntityTokens.html"><abbr title="\CRM_Core_EntityTokens">CRM_Core_EntityTokens</abbr></a></dt><dd>Class CRM_Core_EntityTokens</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Error-Log.html"><abbr title="\CRM_Core_Error_Log">CRM_Core_Error_Log</abbr></a></dt><dd>Class CRM_Core_Error_Log</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Error.html"><abbr title="\CRM_Core_Error">CRM_Core_Error</abbr></a></dt><dd>Class CRM_Core_Error</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Exception-PrematureExitException.html"><abbr title="\CRM_Core_Exception_PrematureExitException">CRM_Core_Exception_PrematureExitException</abbr></a></dt><dd>Exception thrown during tests where live code would exit.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Exception-ResourceConflictException.html"><abbr title="\CRM_Core_Exception_ResourceConflictException">CRM_Core_Exception_ResourceConflictException</abbr></a></dt><dd>Exception thrown when contention over a resource causes process to abort.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></dt><dd>Base class for exceptions generated by CiviCRM.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Form-Date.html"><abbr title="\CRM_Core_Form_Date">CRM_Core_Form_Date</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Form-RecurringEntity.html"><abbr title="\CRM_Core_Form_RecurringEntity">CRM_Core_Form_RecurringEntity</abbr></a></dt><dd>This class generates form components for processing Entity.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Form-Renderer.html"><abbr title="\CRM_Core_Form_Renderer">CRM_Core_Form_Renderer</abbr></a></dt><dd>Customize QF output to meet our specific requirements</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Form-Search.html"><abbr title="\CRM_Core_Form_Search">CRM_Core_Form_Search</abbr></a></dt><dd>Base class for most search forms</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Form-ShortCode.html"><abbr title="\CRM_Core_Form_ShortCode">CRM_Core_Form_ShortCode</abbr></a></dt><dd>Builds a form of shortcodes that can be added to WP posts.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Form-Tag.html"><abbr title="\CRM_Core_Form_Tag">CRM_Core_Form_Tag</abbr></a></dt><dd>This class generates form element for free tag widget.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Form-Task-Batch.html"><abbr title="\CRM_Core_Form_Task_Batch">CRM_Core_Form_Task_Batch</abbr></a></dt><dd>This class provides the functionality for batch profile update</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Form-Task-PDFLetterCommon.html"><abbr title="\CRM_Core_Form_Task_PDFLetterCommon">CRM_Core_Form_Task_PDFLetterCommon</abbr></a></dt><dd>This is the base class for common PDF/Doc Merge functionality.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Form-Task-PickProfile.html"><abbr title="\CRM_Core_Form_Task_PickProfile">CRM_Core_Form_Task_PickProfile</abbr></a></dt><dd>This class provides the functionality for batch profile update for case</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Form-Task.html"><abbr title="\CRM_Core_Form_Task">CRM_Core_Form_Task</abbr></a></dt><dd>This is a shared parent class for form task actions.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Form.html"><abbr title="\CRM_Core_Form">CRM_Core_Form</abbr></a></dt><dd>Class CRM_Core_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-GroupTokens.html"><abbr title="\CRM_Core_GroupTokens">CRM_Core_GroupTokens</abbr></a></dt><dd>Class CRM_Core_GroupTokens</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-HTMLInputCoder.html"><abbr title="\CRM_Core_HTMLInputCoder">CRM_Core_HTMLInputCoder</abbr></a></dt><dd>Class CRM_Core_HTMLInputCoder</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-I18n-Form.html"><abbr title="\CRM_Core_I18n_Form">CRM_Core_I18n_Form</abbr></a></dt><dd>Class CRM_Core_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-I18n-NativeGettext.html"><abbr title="\CRM_Core_I18n_NativeGettext">CRM_Core_I18n_NativeGettext</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-I18n-PseudoConstant.html"><abbr title="\CRM_Core_I18n_PseudoConstant">CRM_Core_I18n_PseudoConstant</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-I18n-Schema.html"><abbr title="\CRM_Core_I18n_Schema">CRM_Core_I18n_Schema</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-I18n-SchemaStructure.html"><abbr title="\CRM_Core_I18n_SchemaStructure">CRM_Core_I18n_SchemaStructure</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-I18n-SchemaStructure-4-7-31.html"><abbr title="\CRM_Core_I18n_SchemaStructure_4_7_31">CRM_Core_I18n_SchemaStructure_4_7_31</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-I18n-SchemaStructure-5-13-alpha1.html"><abbr title="\CRM_Core_I18n_SchemaStructure_5_13_alpha1">CRM_Core_I18n_SchemaStructure_5_13_alpha1</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-I18n-SchemaStructure-5-20-alpha1.html"><abbr title="\CRM_Core_I18n_SchemaStructure_5_20_alpha1">CRM_Core_I18n_SchemaStructure_5_20_alpha1</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-I18n-SchemaStructure-5-31-alpha1.html"><abbr title="\CRM_Core_I18n_SchemaStructure_5_31_alpha1">CRM_Core_I18n_SchemaStructure_5_31_alpha1</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-I18n-SchemaStructure-5-4-alpha1.html"><abbr title="\CRM_Core_I18n_SchemaStructure_5_4_alpha1">CRM_Core_I18n_SchemaStructure_5_4_alpha1</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-I18n-SchemaStructure-5-61-alpha1.html"><abbr title="\CRM_Core_I18n_SchemaStructure_5_61_alpha1">CRM_Core_I18n_SchemaStructure_5_61_alpha1</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-I18n.html"><abbr title="\CRM_Core_I18n">CRM_Core_I18n</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-IDS.html"><abbr title="\CRM_Core_IDS">CRM_Core_IDS</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Invoke.html"><abbr title="\CRM_Core_Invoke">CRM_Core_Invoke</abbr></a></dt><dd>Given an argument list, invoke the appropriate CRM function
Serves as a wrapper between the UserFrameWork and Core CRM</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-JobManager.html"><abbr title="\CRM_Core_JobManager">CRM_Core_JobManager</abbr></a></dt><dd>This interface defines methods that need to be implemented
by every scheduled job (cron task) in CiviCRM.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Joomla.html"><abbr title="\CRM_Core_Joomla">CRM_Core_Joomla</abbr></a></dt><dd>Joomla class.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Key.html"><abbr title="\CRM_Core_Key">CRM_Core_Key</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-LegacyErrorHandler.html"><abbr title="\CRM_Core_LegacyErrorHandler">CRM_Core_LegacyErrorHandler</abbr></a></dt><dd>Class CRM_Core_LegacyErrorHandler</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Lock.html"><abbr title="\CRM_Core_Lock">CRM_Core_Lock</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-ManagedEntities.html"><abbr title="\CRM_Core_ManagedEntities">CRM_Core_ManagedEntities</abbr></a></dt><dd>The ManagedEntities system allows modules to add records to the database
declaratively. Those records will be automatically inserted, updated,
deactivated, and deleted in tandem with their modules.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Menu.html"><abbr title="\CRM_Core_Menu">CRM_Core_Menu</abbr></a></dt><dd>Class CRM_Core_Menu.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Module.html"><abbr title="\CRM_Core_Module">CRM_Core_Module</abbr></a></dt><dd>A module is any software package that participates in the hook
system, such as CiviCRM Module-Extension, a Drupal Module, or
a Joomla Plugin.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-OptionGroup.html"><abbr title="\CRM_Core_OptionGroup">CRM_Core_OptionGroup</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-OptionValue.html"><abbr title="\CRM_Core_OptionValue">CRM_Core_OptionValue</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Page-AJAX-Attachment.html"><abbr title="\CRM_Core_Page_AJAX_Attachment">CRM_Core_Page_AJAX_Attachment</abbr></a></dt><dd>CRM_Core_Page_AJAX_Attachment defines an end-point for AJAX operations which upload file-attachments.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Page-AJAX-Location.html"><abbr title="\CRM_Core_Page_AJAX_Location">CRM_Core_Page_AJAX_Location</abbr></a></dt><dd>This class contains all the function that are called using AJAX</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Page-AJAX-RecurringEntity.html"><abbr title="\CRM_Core_Page_AJAX_RecurringEntity">CRM_Core_Page_AJAX_RecurringEntity</abbr></a></dt><dd>Description of EntityApplyChangesTo</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Page-AJAX.html"><abbr title="\CRM_Core_Page_AJAX">CRM_Core_Page_AJAX</abbr></a></dt><dd>This is base class for all ajax calls</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Page-Basic.html"><abbr title="\CRM_Core_Page_Basic">CRM_Core_Page_Basic</abbr></a></dt><dd>A Page is basically data in a nice pretty format.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Page-FakeError.html"><abbr title="\CRM_Core_Page_FakeError">CRM_Core_Page_FakeError</abbr></a></dt><dd>The "civicrm/dev/fake-error" page is a mock to facilitate E2E testing of the error-reporting mechanism.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Page-File.html"><abbr title="\CRM_Core_Page_File">CRM_Core_Page_File</abbr></a></dt><dd>A Page is basically data in a nice pretty format.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Page-Inline-Help.html"><abbr title="\CRM_Core_Page_Inline_Help">CRM_Core_Page_Inline_Help</abbr></a></dt><dd>This loads a smarty help file via ajax and returns as html</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Page-QUnit.html"><abbr title="\CRM_Core_Page_QUnit">CRM_Core_Page_QUnit</abbr></a></dt><dd>Accept requests for "civicrm/dev/qunit/$ext/$suite"; locate the qunit
test-suite ($suite) in an extension ($ext) and render it.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Page-RecurringEntityPreview.html"><abbr title="\CRM_Core_Page_RecurringEntityPreview">CRM_Core_Page_RecurringEntityPreview</abbr></a></dt><dd>A Page is basically data in a nice pretty format.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Page-Redirect.html"><abbr title="\CRM_Core_Page_Redirect">CRM_Core_Page_Redirect</abbr></a></dt><dd>Placeholder page which generates a redirect</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Page-RemoteTestFunction.html"><abbr title="\CRM_Core_Page_RemoteTestFunction">CRM_Core_Page_RemoteTestFunction</abbr></a></dt><dd>Handle requests for civicrm/dev/rtf</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Page.html"><abbr title="\CRM_Core_Page">CRM_Core_Page</abbr></a></dt><dd>A Page is basically data in a nice pretty format.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Payment-AuthorizeNet.html"><abbr title="\CRM_Core_Payment_AuthorizeNet">CRM_Core_Payment_AuthorizeNet</abbr></a></dt><dd>NOTE:
When looking up response codes in the Authorize.Net API, they
begin at one, so always delete one from the "Position in Response"</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Payment-AuthorizeNetIPN.html"><abbr title="\CRM_Core_Payment_AuthorizeNetIPN">CRM_Core_Payment_AuthorizeNetIPN</abbr></a></dt><dd>Class CRM_Core_Payment_BaseIPN.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Payment-BaseIPN.html"><abbr title="\CRM_Core_Payment_BaseIPN">CRM_Core_Payment_BaseIPN</abbr></a></dt><dd>Class CRM_Core_Payment_BaseIPN.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Payment-Dummy.html"><abbr title="\CRM_Core_Payment_Dummy">CRM_Core_Payment_Dummy</abbr></a></dt><dd>Dummy payment processor</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Payment-FirstData.html"><abbr title="\CRM_Core_Payment_FirstData">CRM_Core_Payment_FirstData</abbr></a></dt><dd>From Payment processor documentation
For testing purposes, you can use any of the card numbers listed below. The test card numbers
will not result in any charges to the card. Use these card numbers with any expiration date in the
future.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Payment-Form.html"><abbr title="\CRM_Core_Payment_Form">CRM_Core_Payment_Form</abbr></a></dt><dd>Class for constructing the payment processor block.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Payment-Manual.html"><abbr title="\CRM_Core_Payment_Manual">CRM_Core_Payment_Manual</abbr></a></dt><dd>Class CRM_Core_Payment.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Payment-PayJunction.html"><abbr title="\CRM_Core_Payment_PayJunction">CRM_Core_Payment_PayJunction</abbr></a></dt><dd>Class CRM_Core_Payment_PayJunction.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Payment-PayPalImpl.html"><abbr title="\CRM_Core_Payment_PayPalImpl">CRM_Core_Payment_PayPalImpl</abbr></a></dt><dd>Class CRM_Core_Payment_PayPalImpl for paypal pro, paypal standard & paypal express.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Payment-PayPalIPN.html"><abbr title="\CRM_Core_Payment_PayPalIPN">CRM_Core_Payment_PayPalIPN</abbr></a></dt><dd>Class CRM_Core_Payment_BaseIPN.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Payment-PayPalProIPN.html"><abbr title="\CRM_Core_Payment_PayPalProIPN">CRM_Core_Payment_PayPalProIPN</abbr></a></dt><dd>Class CRM_Core_Payment_BaseIPN.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Payment-ProcessorForm.html"><abbr title="\CRM_Core_Payment_ProcessorForm">CRM_Core_Payment_ProcessorForm</abbr></a></dt><dd>Base class for building payment block for online contribution / event pages.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Payment-Realex.html"><abbr title="\CRM_Core_Payment_Realex">CRM_Core_Payment_Realex</abbr></a></dt><dd>Class CRM_Core_Payment.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Payment.html"><abbr title="\CRM_Core_Payment">CRM_Core_Payment</abbr></a></dt><dd>Class CRM_Core_Payment.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Permission-Backdrop.html"><abbr title="\CRM_Core_Permission_Backdrop">CRM_Core_Permission_Backdrop</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Permission-Base.html"><abbr title="\CRM_Core_Permission_Base">CRM_Core_Permission_Base</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Permission-Drupal.html"><abbr title="\CRM_Core_Permission_Drupal">CRM_Core_Permission_Drupal</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Permission-Drupal8.html"><abbr title="\CRM_Core_Permission_Drupal8">CRM_Core_Permission_Drupal8</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Permission-DrupalBase.html"><abbr title="\CRM_Core_Permission_DrupalBase">CRM_Core_Permission_DrupalBase</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Permission-Joomla.html"><abbr title="\CRM_Core_Permission_Joomla">CRM_Core_Permission_Joomla</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Permission-List.html"><abbr title="\CRM_Core_Permission_List">CRM_Core_Permission_List</abbr></a></dt><dd>Class CRM_Core_Permission_List</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Permission-Soap.html"><abbr title="\CRM_Core_Permission_Soap">CRM_Core_Permission_Soap</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Permission-Standalone.html"><abbr title="\CRM_Core_Permission_Standalone">CRM_Core_Permission_Standalone</abbr></a></dt><dd>Permissions class for Standalone.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Permission-Temp.html"><abbr title="\CRM_Core_Permission_Temp">CRM_Core_Permission_Temp</abbr></a></dt><dd>This supplements the permissions of the CMS system, allowing us
to temporarily acknowledge permission grants for API keys.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Permission-UnitTests.html"><abbr title="\CRM_Core_Permission_UnitTests">CRM_Core_Permission_UnitTests</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Permission-WordPress.html"><abbr title="\CRM_Core_Permission_WordPress">CRM_Core_Permission_WordPress</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Permission.html"><abbr title="\CRM_Core_Permission">CRM_Core_Permission</abbr></a></dt><dd>This is the basic permission class wrapper</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-PrevNextCache-Redis.html"><abbr title="\CRM_Core_PrevNextCache_Redis">CRM_Core_PrevNextCache_Redis</abbr></a></dt><dd>Class CRM_Core_PrevNextCache_Memory</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-PrevNextCache-Sql.html"><abbr title="\CRM_Core_PrevNextCache_Sql">CRM_Core_PrevNextCache_Sql</abbr></a></dt><dd>Class CRM_Core_PrevNextCache_Sql</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-PseudoConstant.html"><abbr title="\CRM_Core_PseudoConstant">CRM_Core_PseudoConstant</abbr></a></dt><dd>Stores all constants and pseudo constants for CRM application.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-QuickForm-Action-Back.html"><abbr title="\CRM_Core_QuickForm_Action_Back">CRM_Core_QuickForm_Action_Back</abbr></a></dt><dd>Redefine the back action.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-QuickForm-Action-Cancel.html"><abbr title="\CRM_Core_QuickForm_Action_Cancel">CRM_Core_QuickForm_Action_Cancel</abbr></a></dt><dd>Redefine the cancel action</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-QuickForm-Action-Display.html"><abbr title="\CRM_Core_QuickForm_Action_Display">CRM_Core_QuickForm_Action_Display</abbr></a></dt><dd>Redefine the display action.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-QuickForm-Action-Done.html"><abbr title="\CRM_Core_QuickForm_Action_Done">CRM_Core_QuickForm_Action_Done</abbr></a></dt><dd>Redefine the back action.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-QuickForm-Action-Jump.html"><abbr title="\CRM_Core_QuickForm_Action_Jump">CRM_Core_QuickForm_Action_Jump</abbr></a></dt><dd>Redefine the jump action.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-QuickForm-Action-Next.html"><abbr title="\CRM_Core_QuickForm_Action_Next">CRM_Core_QuickForm_Action_Next</abbr></a></dt><dd>Redefine the next action.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-QuickForm-Action-Process.html"><abbr title="\CRM_Core_QuickForm_Action_Process">CRM_Core_QuickForm_Action_Process</abbr></a></dt><dd>Redefine the process action.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-QuickForm-Action-Refresh.html"><abbr title="\CRM_Core_QuickForm_Action_Refresh">CRM_Core_QuickForm_Action_Refresh</abbr></a></dt><dd>Redefine the refresh action.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-QuickForm-Action-Reload.html"><abbr title="\CRM_Core_QuickForm_Action_Reload">CRM_Core_QuickForm_Action_Reload</abbr></a></dt><dd>Define the reload action. Reload the page but do not do any validation.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-QuickForm-Action-Submit.html"><abbr title="\CRM_Core_QuickForm_Action_Submit">CRM_Core_QuickForm_Action_Submit</abbr></a></dt><dd>Redefine the submit action.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-QuickForm-Action-Upload.html"><abbr title="\CRM_Core_QuickForm_Action_Upload">CRM_Core_QuickForm_Action_Upload</abbr></a></dt><dd>Redefine the upload action.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-QuickForm-Action.html"><abbr title="\CRM_Core_QuickForm_Action">CRM_Core_QuickForm_Action</abbr></a></dt><dd>Class CRM_Core_QuickForm_Action</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-QuickForm-GroupMultiSelect.html"><abbr title="\CRM_Core_QuickForm_GroupMultiSelect">CRM_Core_QuickForm_GroupMultiSelect</abbr></a></dt><dd>Class CRM_Core_QuickForm_NestedAdvMultiSelect</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-QuickForm-NestedAdvMultiSelect.html"><abbr title="\CRM_Core_QuickForm_NestedAdvMultiSelect">CRM_Core_QuickForm_NestedAdvMultiSelect</abbr></a></dt><dd>Class CRM_Core_QuickForm_NestedAdvMultiSelect</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Reference-Basic.html"><abbr title="\CRM_Core_Reference_Basic">CRM_Core_Reference_Basic</abbr></a></dt><dd>Description of a one-way link between two entities</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Reference-Dynamic.html"><abbr title="\CRM_Core_Reference_Dynamic">CRM_Core_Reference_Dynamic</abbr></a></dt><dd>Description of a one-way link between two entities</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Reference-OptionValue.html"><abbr title="\CRM_Core_Reference_OptionValue">CRM_Core_Reference_OptionValue</abbr></a></dt><dd>Description of a one-way link between an option-value and an entity</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Region.html"><abbr title="\CRM_Core_Region">CRM_Core_Region</abbr></a></dt><dd>Maintain a set of markup/templates to inject inside various regions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Report-Excel.html"><abbr title="\CRM_Core_Report_Excel">CRM_Core_Report_Excel</abbr></a></dt><dd>Class CRM_Core_Report_Excel</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Resources-Bundle.html"><abbr title="\CRM_Core_Resources_Bundle">CRM_Core_Resources_Bundle</abbr></a></dt><dd>Class CRM_Core_Resources_Bundle</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Resources-Common.html"><abbr title="\CRM_Core_Resources_Common">CRM_Core_Resources_Common</abbr></a></dt><dd>Define some common, global lists of resources.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Resources-Strings.html"><abbr title="\CRM_Core_Resources_Strings">CRM_Core_Resources_Strings</abbr></a></dt><dd>Manage translatable strings on behalf of resource files.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Resources.html"><abbr title="\CRM_Core_Resources">CRM_Core_Resources</abbr></a></dt><dd>This class facilitates the loading of resources
such as JavaScript files and CSS files.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-ScheduledJob.html"><abbr title="\CRM_Core_ScheduledJob">CRM_Core_ScheduledJob</abbr></a></dt><dd>This interface defines methods that need to be implemented
by every scheduled job (cron task) in CiviCRM.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Selector-Base.html"><abbr title="\CRM_Core_Selector_Base">CRM_Core_Selector_Base</abbr></a></dt><dd>A simple base class for objects that need to implement the selector api
interface. This class provides common functionality with regard to actions
and display names</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Selector-Controller.html"><abbr title="\CRM_Core_Selector_Controller">CRM_Core_Selector_Controller</abbr></a></dt><dd>This class is a generic class to be used when we want to display
a list of rows along with a set of associated actions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-SelectValues.html"><abbr title="\CRM_Core_SelectValues">CRM_Core_SelectValues</abbr></a></dt><dd>One place to store frequently used values in Select Elements. Note that
some of the below elements will be dynamic, so we'll probably have a
smart caching scheme on a per domain basis</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Session.html"><abbr title="\CRM_Core_Session">CRM_Core_Session</abbr></a></dt><dd>Class CRM_Core_Session.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-ShowHideBlocks.html"><abbr title="\CRM_Core_ShowHideBlocks">CRM_Core_ShowHideBlocks</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-SiteTokens.html"><abbr title="\CRM_Core_SiteTokens">CRM_Core_SiteTokens</abbr></a></dt><dd>Class CRM_Site_Tokens</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Smarty-Permissions.html"><abbr title="\CRM_Core_Smarty_Permissions">CRM_Core_Smarty_Permissions</abbr></a></dt><dd>Class CRM_Core_Smarty_Permissions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Smarty-UserContentPolicy.html"><abbr title="\CRM_Core_Smarty_UserContentPolicy">CRM_Core_Smarty_UserContentPolicy</abbr></a></dt><dd>Define the security-constraints to apply to user-supplied Smarty content.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Smarty.html"><abbr title="\CRM_Core_Smarty">CRM_Core_Smarty</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-SmartyCompatibility.html"><abbr title="\CRM_Core_SmartyCompatibility">CRM_Core_SmartyCompatibility</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-State.html"><abbr title="\CRM_Core_State">CRM_Core_State</abbr></a></dt><dd>The basic state element. Each state element is linked to a form and
represents the form in the transition diagram. We use the state to
determine what action to take on various user input. Actions include
things like going back / stepping forward / process etc</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-StateMachine.html"><abbr title="\CRM_Core_StateMachine">CRM_Core_StateMachine</abbr></a></dt><dd>Core StateMachine.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-TableHierarchy.html"><abbr title="\CRM_Core_TableHierarchy">CRM_Core_TableHierarchy</abbr></a></dt><dd>Class representing the table relationships</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Task.html"><abbr title="\CRM_Core_Task">CRM_Core_Task</abbr></a></dt><dd>Class to represent the actions that can be performed on a group of contacts used by the search forms.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-TemporaryErrorScope.html"><abbr title="\CRM_Core_TemporaryErrorScope">CRM_Core_TemporaryErrorScope</abbr></a></dt><dd>This is an evil, evil work-around for CRM-11043. It is used to
temporarily change the error-handling behavior and then automatically
restore it -- that protocol is an improvement over the current protocol
(in which random bits of code will change the global error handler
setting and then forget to change it back). This class and all
references to it should be removed in 4.3/4.4 (when we adopt
exception-based error handling).</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-TestEntity.html"><abbr title="\CRM_Core_TestEntity">CRM_Core_TestEntity</abbr></a></dt><dd>Class CRM_Core_TestEntity.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-TokenSmarty.html"><abbr title="\CRM_Core_TokenSmarty">CRM_Core_TokenSmarty</abbr></a></dt><dd>`Token-Smarty` is a hybrid template format, combining Civi token notation with
Smarty notation, as in `{if {contact.id} > 10}...{/if}`.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Transaction.html"><abbr title="\CRM_Core_Transaction">CRM_Core_Transaction</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-WorkflowMessage-Profile-Profile.html"><abbr title="\CRM_Core_WorkflowMessage_Profile_Profile">CRM_Core_WorkflowMessage_Profile_Profile</abbr></a></dt><dd>Basic profile example.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-WorkflowMessage-UFNotify.html"><abbr title="\CRM_Core_WorkflowMessage_UFNotify">CRM_Core_WorkflowMessage_UFNotify</abbr></a></dt><dd>Receipt sent when someone receives a copy of profile that has been filled out.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Custom-Form-CustomData.html"><abbr title="\CRM_Custom_Form_CustomData">CRM_Custom_Form_CustomData</abbr></a></dt><dd>Deprecated class no longer used in core.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Custom-Form-CustomDataByType.html"><abbr title="\CRM_Custom_Form_CustomDataByType">CRM_Custom_Form_CustomDataByType</abbr></a></dt><dd>This form is loaded when custom data is loaded by ajax.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Custom-Form-DeleteField.html"><abbr title="\CRM_Custom_Form_DeleteField">CRM_Custom_Form_DeleteField</abbr></a></dt><dd>This class is to build the form for deleting a field</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Custom-Form-DeleteGroup.html"><abbr title="\CRM_Custom_Form_DeleteGroup">CRM_Custom_Form_DeleteGroup</abbr></a></dt><dd>This class is to build the form for Deleting Group</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Custom-Form-Field.html"><abbr title="\CRM_Custom_Form_Field">CRM_Custom_Form_Field</abbr></a></dt><dd>form to process actions on the field aspect of Custom</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Custom-Form-Group.html"><abbr title="\CRM_Custom_Form_Group">CRM_Custom_Form_Group</abbr></a></dt><dd>form to process actions on the set aspect of Custom Data</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Custom-Form-MoveField.html"><abbr title="\CRM_Custom_Form_MoveField">CRM_Custom_Form_MoveField</abbr></a></dt><dd>This class is to build the form for Deleting Group</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Custom-Form-Option.html"><abbr title="\CRM_Custom_Form_Option">CRM_Custom_Form_Option</abbr></a></dt><dd>form to process actions on the field aspect of Custom</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Custom-Form-Preview.html"><abbr title="\CRM_Custom_Form_Preview">CRM_Custom_Form_Preview</abbr></a></dt><dd>This class generates form components for previewing custom data</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Custom-Import-Form-DataSource.html"><abbr title="\CRM_Custom_Import_Form_DataSource">CRM_Custom_Import_Form_DataSource</abbr></a></dt><dd>This class gets the name of the file to upload</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Custom-Import-Form-MapField.html"><abbr title="\CRM_Custom_Import_Form_MapField">CRM_Custom_Import_Form_MapField</abbr></a></dt><dd>Class CRM_Custom_Import_Form_MapField</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Custom-Import-Form-Preview.html"><abbr title="\CRM_Custom_Import_Form_Preview">CRM_Custom_Import_Form_Preview</abbr></a></dt><dd>Class CRM_Custom_Import_Form_Preview</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Custom-Import-Parser-Api.html"><abbr title="\CRM_Custom_Import_Parser_Api">CRM_Custom_Import_Parser_Api</abbr></a></dt><dd>Class CRM_Custom_Import_Parser_Api</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Custom-Page-AJAX.html"><abbr title="\CRM_Custom_Page_AJAX">CRM_Custom_Page_AJAX</abbr></a></dt><dd>This class contains the functions that are called using AJAX (jQuery)</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Custom-Page-Field.html"><abbr title="\CRM_Custom_Page_Field">CRM_Custom_Page_Field</abbr></a></dt><dd>Create a page for displaying Custom Fields.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Custom-Page-Group.html"><abbr title="\CRM_Custom_Page_Group">CRM_Custom_Page_Group</abbr></a></dt><dd>Create a page for displaying Custom Sets.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Custom-Page-Option.html"><abbr title="\CRM_Custom_Page_Option">CRM_Custom_Page_Option</abbr></a></dt><dd>Create a page for displaying Custom Options.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Cxn-ApiRouter.html"><abbr title="\CRM_Cxn_ApiRouter">CRM_Cxn_ApiRouter</abbr></a></dt><dd>Class CRM_Cxn_ApiRouter</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Cxn-BAO-Cxn.html"><abbr title="\CRM_Cxn_BAO_Cxn">CRM_Cxn_BAO_Cxn</abbr></a></dt><dd>This class helps to manage connections to third-party apps.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Cxn-CiviCxnHttp.html"><abbr title="\CRM_Cxn_CiviCxnHttp">CRM_Cxn_CiviCxnHttp</abbr></a></dt><dd>Class CRM_Cxn_CiviCxnHttp</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Cxn-CiviCxnStore.html"><abbr title="\CRM_Cxn_CiviCxnStore">CRM_Cxn_CiviCxnStore</abbr></a></dt><dd>Class CRM_Cxn_CiviCxnStore</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Cxn-DAO-Cxn.html"><abbr title="\CRM_Cxn_DAO_Cxn">CRM_Cxn_DAO_Cxn</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Dashlet-Page-Activity.html"><abbr title="\CRM_Dashlet_Page_Activity">CRM_Dashlet_Page_Activity</abbr></a></dt><dd>Main page for activity dashlet</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Dashlet-Page-AllCases.html"><abbr title="\CRM_Dashlet_Page_AllCases">CRM_Dashlet_Page_AllCases</abbr></a></dt><dd>Main page for Cases dashlet</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Dashlet-Page-Blog.html"><abbr title="\CRM_Dashlet_Page_Blog">CRM_Dashlet_Page_Blog</abbr></a></dt><dd>Main page for blog dashlet</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Dashlet-Page-CaseDashboard.html"><abbr title="\CRM_Dashlet_Page_CaseDashboard">CRM_Dashlet_Page_CaseDashboard</abbr></a></dt><dd>Main page for Case Dashboard dashlet</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Dashlet-Page-GettingStarted.html"><abbr title="\CRM_Dashlet_Page_GettingStarted">CRM_Dashlet_Page_GettingStarted</abbr></a></dt><dd>Main page for getting started dashlet</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Dashlet-Page-MyCases.html"><abbr title="\CRM_Dashlet_Page_MyCases">CRM_Dashlet_Page_MyCases</abbr></a></dt><dd>Main page for Cases dashlet</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Dedupe-BAO-DedupeException.html"><abbr title="\CRM_Dedupe_BAO_DedupeException">CRM_Dedupe_BAO_DedupeException</abbr></a></dt><dd>Manages dedupe exceptions - ie pairs marked as non-duplicates.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Dedupe-BAO-DedupeRule.html"><abbr title="\CRM_Dedupe_BAO_DedupeRule">CRM_Dedupe_BAO_DedupeRule</abbr></a></dt><dd>The CiviCRM duplicate discovery engine is based on an
algorithm designed by David Strauss <david@fourkitchens.com>.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Dedupe-BAO-DedupeRuleGroup.html"><abbr title="\CRM_Dedupe_BAO_DedupeRuleGroup">CRM_Dedupe_BAO_DedupeRuleGroup</abbr></a></dt><dd>The CiviCRM duplicate discovery engine is based on an
algorithm designed by David Strauss <david@fourkitchens.com>.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Dedupe-BAO-Exception.html"><abbr title="\CRM_Dedupe_BAO_Exception">CRM_Dedupe_BAO_Exception</abbr></a></dt><dd>Manages dedupe exceptions - ie pairs marked as non-duplicates.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Dedupe-BAO-QueryBuilder-IndividualGeneral.html"><abbr title="\CRM_Dedupe_BAO_QueryBuilder_IndividualGeneral">CRM_Dedupe_BAO_QueryBuilder_IndividualGeneral</abbr></a></dt><dd>TODO: How to handle NULL values/records?
Class CRM_Dedupe_BAO_QueryBuilder_IndividualGeneral</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Dedupe-BAO-QueryBuilder-IndividualSupervised.html"><abbr title="\CRM_Dedupe_BAO_QueryBuilder_IndividualSupervised">CRM_Dedupe_BAO_QueryBuilder_IndividualSupervised</abbr></a></dt><dd>TODO: How to handle NULL values/records?
Class CRM_Dedupe_BAO_QueryBuilder_IndividualSupervised</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Dedupe-BAO-QueryBuilder-IndividualUnsupervised.html"><abbr title="\CRM_Dedupe_BAO_QueryBuilder_IndividualUnsupervised">CRM_Dedupe_BAO_QueryBuilder_IndividualUnsupervised</abbr></a></dt><dd>Class CRM_Dedupe_BAO_QueryBuilder_IndividualUnsupervised</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Dedupe-BAO-QueryBuilder.html"><abbr title="\CRM_Dedupe_BAO_QueryBuilder">CRM_Dedupe_BAO_QueryBuilder</abbr></a></dt><dd>Class CRM_Dedupe_BAO_QueryBuilder</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Dedupe-BAO-Rule.html"><abbr title="\CRM_Dedupe_BAO_Rule">CRM_Dedupe_BAO_Rule</abbr></a></dt><dd>The CiviCRM duplicate discovery engine is based on an
algorithm designed by David Strauss <david@fourkitchens.com>.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Dedupe-BAO-RuleGroup.html"><abbr title="\CRM_Dedupe_BAO_RuleGroup">CRM_Dedupe_BAO_RuleGroup</abbr></a></dt><dd>The CiviCRM duplicate discovery engine is based on an
algorithm designed by David Strauss <david@fourkitchens.com>.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Dedupe-DAO-DedupeException.html"><abbr title="\CRM_Dedupe_DAO_DedupeException">CRM_Dedupe_DAO_DedupeException</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Dedupe-DAO-DedupeRule.html"><abbr title="\CRM_Dedupe_DAO_DedupeRule">CRM_Dedupe_DAO_DedupeRule</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Dedupe-DAO-DedupeRuleGroup.html"><abbr title="\CRM_Dedupe_DAO_DedupeRuleGroup">CRM_Dedupe_DAO_DedupeRuleGroup</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Dedupe-Finder.html"><abbr title="\CRM_Dedupe_Finder">CRM_Dedupe_Finder</abbr></a></dt><dd>The CiviCRM duplicate discovery engine is based on an
algorithm designed by David Strauss <david@fourkitchens.com>.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Dedupe-MergeHandler.html"><abbr title="\CRM_Dedupe_MergeHandler">CRM_Dedupe_MergeHandler</abbr></a></dt><dd>This class exists primarily for the purposes of supporting code clean up in the Merger class.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Dedupe-Merger.html"><abbr title="\CRM_Dedupe_Merger">CRM_Dedupe_Merger</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-ActionMapping-ByEvent.html"><abbr title="\CRM_Event_ActionMapping_ByEvent">CRM_Event_ActionMapping_ByEvent</abbr></a></dt><dd>This defines the scheduled-reminder functionality for CiviEvent
participants with filtering by event-type.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-ActionMapping-ByTemplate.html"><abbr title="\CRM_Event_ActionMapping_ByTemplate">CRM_Event_ActionMapping_ByTemplate</abbr></a></dt><dd>This defines the scheduled-reminder functionality for CiviEvent
participants with filtering by event-type.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-ActionMapping-ByType.html"><abbr title="\CRM_Event_ActionMapping_ByType">CRM_Event_ActionMapping_ByType</abbr></a></dt><dd>This defines the scheduled-reminder functionality for CiviEvent
participants with filtering by event-type.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-ActionMapping.html"><abbr title="\CRM_Event_ActionMapping">CRM_Event_ActionMapping</abbr></a></dt><dd>Shared scheduled-reminder functionality for CiviEvent participants.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Badge-Logo.html"><abbr title="\CRM_Event_Badge_Logo">CRM_Event_Badge_Logo</abbr></a></dt><dd>Class CRM_Event_Badge_Logo</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Badge-Logo5395.html"><abbr title="\CRM_Event_Badge_Logo5395">CRM_Event_Badge_Logo5395</abbr></a></dt><dd>Class CRM_Event_Badge_Logo5395</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Badge-NameTent.html"><abbr title="\CRM_Event_Badge_NameTent">CRM_Event_Badge_NameTent</abbr></a></dt><dd>This class print the name badges for the participants
It isn't supposed to be called directly, but is the parent class of the classes in CRM/Event/Badges/XXX.php</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Badge-Simple.html"><abbr title="\CRM_Event_Badge_Simple">CRM_Event_Badge_Simple</abbr></a></dt><dd>This class print the name badges for the participants
It isn't supposed to be called directly, but is the parent class of the classes in CRM/Event/Badges/XXX.php</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Badge.html"><abbr title="\CRM_Event_Badge">CRM_Event_Badge</abbr></a></dt><dd>This class print the name badges for the participants
It isn't supposed to be called directly, but is the parent class of the classes in CRM/Event/Badges/XXX.php</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-BAO-Event.html"><abbr title="\CRM_Event_BAO_Event">CRM_Event_BAO_Event</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-BAO-Participant.html"><abbr title="\CRM_Event_BAO_Participant">CRM_Event_BAO_Participant</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-BAO-ParticipantPayment.html"><abbr title="\CRM_Event_BAO_ParticipantPayment">CRM_Event_BAO_ParticipantPayment</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-BAO-ParticipantStatusType.html"><abbr title="\CRM_Event_BAO_ParticipantStatusType">CRM_Event_BAO_ParticipantStatusType</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-BAO-Query.html"><abbr title="\CRM_Event_BAO_Query">CRM_Event_BAO_Query</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Controller-Registration.html"><abbr title="\CRM_Event_Controller_Registration">CRM_Event_Controller_Registration</abbr></a></dt><dd>Class CRM_Event_Controller_Registration</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Controller-Search.html"><abbr title="\CRM_Event_Controller_Search">CRM_Event_Controller_Search</abbr></a></dt><dd>This class is used by the Search functionality.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-DAO-Event.html"><abbr title="\CRM_Event_DAO_Event">CRM_Event_DAO_Event</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-DAO-Participant.html"><abbr title="\CRM_Event_DAO_Participant">CRM_Event_DAO_Participant</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-DAO-ParticipantPayment.html"><abbr title="\CRM_Event_DAO_ParticipantPayment">CRM_Event_DAO_ParticipantPayment</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-DAO-ParticipantStatusType.html"><abbr title="\CRM_Event_DAO_ParticipantStatusType">CRM_Event_DAO_ParticipantStatusType</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Export-Form-Map.html"><abbr title="\CRM_Event_Export_Form_Map">CRM_Event_Export_Form_Map</abbr></a></dt><dd>This class gets the name of the file to upload</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Export-Form-Select.html"><abbr title="\CRM_Event_Export_Form_Select">CRM_Event_Export_Form_Select</abbr></a></dt><dd>This class gets the name of the file to upload</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Form-EventFees.html"><abbr title="\CRM_Event_Form_EventFees">CRM_Event_Form_EventFees</abbr></a></dt><dd>This class generates form components for processing a participation fee block</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Form-ManageEvent-Delete.html"><abbr title="\CRM_Event_Form_ManageEvent_Delete">CRM_Event_Form_ManageEvent_Delete</abbr></a></dt><dd>This class is to build the form for Deleting Group.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Form-ManageEvent-EventInfo.html"><abbr title="\CRM_Event_Form_ManageEvent_EventInfo">CRM_Event_Form_ManageEvent_EventInfo</abbr></a></dt><dd>This class generates form components for processing Event.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Form-ManageEvent-Fee.html"><abbr title="\CRM_Event_Form_ManageEvent_Fee">CRM_Event_Form_ManageEvent_Fee</abbr></a></dt><dd>This class generates form components for Event Fees.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Form-ManageEvent-Location.html"><abbr title="\CRM_Event_Form_ManageEvent_Location">CRM_Event_Form_ManageEvent_Location</abbr></a></dt><dd>This class generates form components for processing Event Location
civicrm_event_page.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Form-ManageEvent-Registration.html"><abbr title="\CRM_Event_Form_ManageEvent_Registration">CRM_Event_Form_ManageEvent_Registration</abbr></a></dt><dd>This class generates form components for processing Event.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Form-ManageEvent-Repeat.html"><abbr title="\CRM_Event_Form_ManageEvent_Repeat">CRM_Event_Form_ManageEvent_Repeat</abbr></a></dt><dd>Class to manage the "Repeat" functionality for event</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Form-ManageEvent-ScheduleReminders.html"><abbr title="\CRM_Event_Form_ManageEvent_ScheduleReminders">CRM_Event_Form_ManageEvent_ScheduleReminders</abbr></a></dt><dd>This class generates form components for scheduling reminders for Event</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Form-ManageEvent-TabHeader.html"><abbr title="\CRM_Event_Form_ManageEvent_TabHeader">CRM_Event_Form_ManageEvent_TabHeader</abbr></a></dt><dd>Helper class to build navigation links</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Form-ManageEvent.html"><abbr title="\CRM_Event_Form_ManageEvent">CRM_Event_Form_ManageEvent</abbr></a></dt><dd>This class generates form components for processing Event.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Form-Participant-Delete.html"><abbr title="\CRM_Event_Form_Participant_Delete">CRM_Event_Form_Participant_Delete</abbr></a></dt><dd>Back office participant delete form.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Form-Participant.html"><abbr title="\CRM_Event_Form_Participant">CRM_Event_Form_Participant</abbr></a></dt><dd>Back office participant form.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Form-ParticipantFeeSelection.html"><abbr title="\CRM_Event_Form_ParticipantFeeSelection">CRM_Event_Form_ParticipantFeeSelection</abbr></a></dt><dd>This form used for changing / updating fee selections for the events
event/contribution is partially paid</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Form-ParticipantView.html"><abbr title="\CRM_Event_Form_ParticipantView">CRM_Event_Form_ParticipantView</abbr></a></dt><dd>This class generates form components for Participant</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Form-Registration-AdditionalParticipant.html"><abbr title="\CRM_Event_Form_Registration_AdditionalParticipant">CRM_Event_Form_Registration_AdditionalParticipant</abbr></a></dt><dd>This class generates form components for processing Event.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Form-Registration-Confirm.html"><abbr title="\CRM_Event_Form_Registration_Confirm">CRM_Event_Form_Registration_Confirm</abbr></a></dt><dd>This class generates form components for processing Event.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Form-Registration-ParticipantConfirm.html"><abbr title="\CRM_Event_Form_Registration_ParticipantConfirm">CRM_Event_Form_Registration_ParticipantConfirm</abbr></a></dt><dd>This class generates form components for processing Event</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Form-Registration-Register.html"><abbr title="\CRM_Event_Form_Registration_Register">CRM_Event_Form_Registration_Register</abbr></a></dt><dd>This class generates form components for processing Event.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Form-Registration-ThankYou.html"><abbr title="\CRM_Event_Form_Registration_ThankYou">CRM_Event_Form_Registration_ThankYou</abbr></a></dt><dd>This class generates form components for processing Event</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Form-Registration.html"><abbr title="\CRM_Event_Form_Registration">CRM_Event_Form_Registration</abbr></a></dt><dd>This class generates form components for processing Event.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Form-Search.html"><abbr title="\CRM_Event_Form_Search">CRM_Event_Form_Search</abbr></a></dt><dd>This file is for civievent search</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Form-SearchEvent.html"><abbr title="\CRM_Event_Form_SearchEvent">CRM_Event_Form_SearchEvent</abbr></a></dt><dd>Class CRM_Core_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Form-SelfSvcTransfer.html"><abbr title="\CRM_Event_Form_SelfSvcTransfer">CRM_Event_Form_SelfSvcTransfer</abbr></a></dt><dd>This class generates form components to transfer an Event to another participant</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Form-SelfSvcUpdate.html"><abbr title="\CRM_Event_Form_SelfSvcUpdate">CRM_Event_Form_SelfSvcUpdate</abbr></a></dt><dd>This class generates form components to allow an Event to be cancelled or transferred from an email link</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Form-Task-AddToGroup.html"><abbr title="\CRM_Event_Form_Task_AddToGroup">CRM_Event_Form_Task_AddToGroup</abbr></a></dt><dd>This class provides the functionality to group
contacts. This class provides functionality for the actual
addition of contacts to groups.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Form-Task-Badge.html"><abbr title="\CRM_Event_Form_Task_Badge">CRM_Event_Form_Task_Badge</abbr></a></dt><dd>This class helps to print the labels for contacts.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Form-Task-Batch.html"><abbr title="\CRM_Event_Form_Task_Batch">CRM_Event_Form_Task_Batch</abbr></a></dt><dd>This class provides the functionality for batch profile update for events.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Form-Task-Cancel.html"><abbr title="\CRM_Event_Form_Task_Cancel">CRM_Event_Form_Task_Cancel</abbr></a></dt><dd>This class provides the functionality for cancel registration for event participations</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Form-Task-Delete.html"><abbr title="\CRM_Event_Form_Task_Delete">CRM_Event_Form_Task_Delete</abbr></a></dt><dd>This class provides the functionality to delete a group of
participations. This class provides functionality for the actual
deletion.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Form-Task-Email.html"><abbr title="\CRM_Event_Form_Task_Email">CRM_Event_Form_Task_Email</abbr></a></dt><dd>This class provides the functionality to email a group of
contacts.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Form-Task-ParticipantStatus.html"><abbr title="\CRM_Event_Form_Task_ParticipantStatus">CRM_Event_Form_Task_ParticipantStatus</abbr></a></dt><dd>This class provides the functionality for batch profile update for events.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Form-Task-PDF.html"><abbr title="\CRM_Event_Form_Task_PDF">CRM_Event_Form_Task_PDF</abbr></a></dt><dd>This class provides the functionality to create PDF letter for a group of
participants or a single participant.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Form-Task-PickProfile.html"><abbr title="\CRM_Event_Form_Task_PickProfile">CRM_Event_Form_Task_PickProfile</abbr></a></dt><dd>This class provides the functionality for batch profile update for event participations</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Form-Task-Print.html"><abbr title="\CRM_Event_Form_Task_Print">CRM_Event_Form_Task_Print</abbr></a></dt><dd>This class provides the functionality to participant records</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Form-Task-Register.html"><abbr title="\CRM_Event_Form_Task_Register">CRM_Event_Form_Task_Register</abbr></a></dt><dd>This class provides the register functionality from a search context.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Form-Task-Result.html"><abbr title="\CRM_Event_Form_Task_Result">CRM_Event_Form_Task_Result</abbr></a></dt><dd>Used for displaying results</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Form-Task-SaveSearch-Update.html"><abbr title="\CRM_Event_Form_Task_SaveSearch_Update">CRM_Event_Form_Task_SaveSearch_Update</abbr></a></dt><dd>This class provides the functionality to update a saved search</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Form-Task-SaveSearch.html"><abbr title="\CRM_Event_Form_Task_SaveSearch">CRM_Event_Form_Task_SaveSearch</abbr></a></dt><dd>This class provides the functionality to save a search
Saved Searches are used for saving frequently used queries
regarding the event participations</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Form-Task.html"><abbr title="\CRM_Event_Form_Task">CRM_Event_Form_Task</abbr></a></dt><dd>Class for event form task actions.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-ICalendar.html"><abbr title="\CRM_Event_ICalendar">CRM_Event_ICalendar</abbr></a></dt><dd>Class to generate various "icalendar" type event feeds</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Import-Form-DataSource.html"><abbr title="\CRM_Event_Import_Form_DataSource">CRM_Event_Import_Form_DataSource</abbr></a></dt><dd>This class gets the name of the file to upload</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Import-Form-MapField.html"><abbr title="\CRM_Event_Import_Form_MapField">CRM_Event_Import_Form_MapField</abbr></a></dt><dd>This class gets the name of the file to upload</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Import-Form-Preview.html"><abbr title="\CRM_Event_Import_Form_Preview">CRM_Event_Import_Form_Preview</abbr></a></dt><dd>This class previews the uploaded file and returns summary
statistics</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Import-Parser-Participant.html"><abbr title="\CRM_Event_Import_Parser_Participant">CRM_Event_Import_Parser_Participant</abbr></a></dt><dd>class to parse membership csv files</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Info.html"><abbr title="\CRM_Event_Info">CRM_Event_Info</abbr></a></dt><dd>This class introduces component to the system and provides all the
information about it. It needs to extend CRM_Core_Component_Info
abstract class.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Page-AJAX.html"><abbr title="\CRM_Event_Page_AJAX">CRM_Event_Page_AJAX</abbr></a></dt><dd>This class contains all the function that are called using AJAX</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Page-DashBoard.html"><abbr title="\CRM_Event_Page_DashBoard">CRM_Event_Page_DashBoard</abbr></a></dt><dd>This is page is for Event Dashboard</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Page-EventInfo.html"><abbr title="\CRM_Event_Page_EventInfo">CRM_Event_Page_EventInfo</abbr></a></dt><dd>Event Info Page - Summary about the event</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Page-List.html"><abbr title="\CRM_Event_Page_List">CRM_Event_Page_List</abbr></a></dt><dd>Display a list of events on a page</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Page-ManageEvent.html"><abbr title="\CRM_Event_Page_ManageEvent">CRM_Event_Page_ManageEvent</abbr></a></dt><dd>Page for displaying list of events</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Page-ParticipantListing-Name.html"><abbr title="\CRM_Event_Page_ParticipantListing_Name">CRM_Event_Page_ParticipantListing_Name</abbr></a></dt><dd>A Page is basically data in a nice pretty format.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Page-ParticipantListing-NameAndEmail.html"><abbr title="\CRM_Event_Page_ParticipantListing_NameAndEmail">CRM_Event_Page_ParticipantListing_NameAndEmail</abbr></a></dt><dd>A Page is basically data in a nice pretty format.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Page-ParticipantListing-NameStatusAndDate.html"><abbr title="\CRM_Event_Page_ParticipantListing_NameStatusAndDate">CRM_Event_Page_ParticipantListing_NameStatusAndDate</abbr></a></dt><dd>A Page is basically data in a nice pretty format.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Page-ParticipantListing-Simple.html"><abbr title="\CRM_Event_Page_ParticipantListing_Simple">CRM_Event_Page_ParticipantListing_Simple</abbr></a></dt><dd>A Page is basically data in a nice pretty format.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Page-ParticipantListing.html"><abbr title="\CRM_Event_Page_ParticipantListing">CRM_Event_Page_ParticipantListing</abbr></a></dt><dd>A Page is basically data in a nice pretty format.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Page-Tab.html"><abbr title="\CRM_Event_Page_Tab">CRM_Event_Page_Tab</abbr></a></dt><dd>A Page is basically data in a nice pretty format.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Page-UserDashboard.html"><abbr title="\CRM_Event_Page_UserDashboard">CRM_Event_Page_UserDashboard</abbr></a></dt><dd>This class is for building event(participation) block on user dashboard</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-ParticipantTokens.html"><abbr title="\CRM_Event_ParticipantTokens">CRM_Event_ParticipantTokens</abbr></a></dt><dd>Class CRM_Event_ParticipantTokens</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-PseudoConstant.html"><abbr title="\CRM_Event_PseudoConstant">CRM_Event_PseudoConstant</abbr></a></dt><dd>Stores all constants and pseudo constants for CRM application.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Selector-Search.html"><abbr title="\CRM_Event_Selector_Search">CRM_Event_Selector_Search</abbr></a></dt><dd>This class is used to retrieve and display a range of
contacts that match the given criteria (specifically for
results of advanced search options.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-StateMachine-Registration.html"><abbr title="\CRM_Event_StateMachine_Registration">CRM_Event_StateMachine_Registration</abbr></a></dt><dd>State machine for managing different states of the EventWizard process.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-StateMachine-Search.html"><abbr title="\CRM_Event_StateMachine_Search">CRM_Event_StateMachine_Search</abbr></a></dt><dd>Class CRM_Event_StateMachine_Search</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Task.html"><abbr title="\CRM_Event_Task">CRM_Event_Task</abbr></a></dt><dd>class to represent the actions that can be performed on a group of contacts
used by the search forms</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Tokens.html"><abbr title="\CRM_Event_Tokens">CRM_Event_Tokens</abbr></a></dt><dd>Class CRM_Event_Tokens</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-WorkflowMessage-EventExamples.html"><abbr title="\CRM_Event_WorkflowMessage_EventExamples">CRM_Event_WorkflowMessage_EventExamples</abbr></a></dt><dd>Basic contribution example for contribution templates.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-WorkflowMessage-EventOfflineReceipt.html"><abbr title="\CRM_Event_WorkflowMessage_EventOfflineReceipt">CRM_Event_WorkflowMessage_EventOfflineReceipt</abbr></a></dt><dd>Receipt sent when confirming a back office participation record.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-WorkflowMessage-EventOnlineReceipt.html"><abbr title="\CRM_Event_WorkflowMessage_EventOnlineReceipt">CRM_Event_WorkflowMessage_EventOnlineReceipt</abbr></a></dt><dd>Receipt sent when confirming a back office participation record.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-WorkflowMessage-ParticipantCancelled.html"><abbr title="\CRM_Event_WorkflowMessage_ParticipantCancelled">CRM_Event_WorkflowMessage_ParticipantCancelled</abbr></a></dt><dd>Notification that a registration has been cancelled.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-WorkflowMessage-ParticipantConfirm.html"><abbr title="\CRM_Event_WorkflowMessage_ParticipantConfirm">CRM_Event_WorkflowMessage_ParticipantConfirm</abbr></a></dt><dd>Notification that a registration has been cancelled.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-WorkflowMessage-ParticipantExpired.html"><abbr title="\CRM_Event_WorkflowMessage_ParticipantExpired">CRM_Event_WorkflowMessage_ParticipantExpired</abbr></a></dt><dd>Notification that a registration has been cancelled.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-WorkflowMessage-ParticipantTransferred.html"><abbr title="\CRM_Event_WorkflowMessage_ParticipantTransferred">CRM_Event_WorkflowMessage_ParticipantTransferred</abbr></a></dt><dd>Notification that a registration has been transferred to a different person.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Export-BAO-Export.html"><abbr title="\CRM_Export_BAO_Export">CRM_Export_BAO_Export</abbr></a></dt><dd>This class contains the functions for Component export</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Export-BAO-ExportProcessor.html"><abbr title="\CRM_Export_BAO_ExportProcessor">CRM_Export_BAO_ExportProcessor</abbr></a></dt><dd>Class CRM_Export_BAO_ExportProcessor</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Export-Controller-Standalone.html"><abbr title="\CRM_Export_Controller_Standalone">CRM_Export_Controller_Standalone</abbr></a></dt><dd>Class CRM_Export_Controller_Standalone</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Export-Form-Map.html"><abbr title="\CRM_Export_Form_Map">CRM_Export_Form_Map</abbr></a></dt><dd>This class gets the name of the file to upload</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Export-Form-Select.html"><abbr title="\CRM_Export_Form_Select">CRM_Export_Form_Select</abbr></a></dt><dd>This class gets the name of the file to upload</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Export-StateMachine-Standalone.html"><abbr title="\CRM_Export_StateMachine_Standalone">CRM_Export_StateMachine_Standalone</abbr></a></dt><dd>Core StateMachine.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Export-Utils.html"><abbr title="\CRM_Export_Utils">CRM_Export_Utils</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Extension-BootCache.html"><abbr title="\CRM_Extension_BootCache">CRM_Extension_BootCache</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Extension-Browser.html"><abbr title="\CRM_Extension_Browser">CRM_Extension_Browser</abbr></a></dt><dd>This class glues together the various parts of the extension
system.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Extension-ClassLoader.html"><abbr title="\CRM_Extension_ClassLoader">CRM_Extension_ClassLoader</abbr></a></dt><dd>Class CRM_Extension_ClassLoader</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Extension-Container-Basic.html"><abbr title="\CRM_Extension_Container_Basic">CRM_Extension_Container_Basic</abbr></a></dt><dd>An extension container is a locally-accessible source tree which can be
scanned for extensions.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Extension-Container-Collection.html"><abbr title="\CRM_Extension_Container_Collection">CRM_Extension_Container_Collection</abbr></a></dt><dd>An extension container is a locally-accessible source tree which can be
scanned for extensions.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Extension-Container-Default.html"><abbr title="\CRM_Extension_Container_Default">CRM_Extension_Container_Default</abbr></a></dt><dd>The default container is just a basic container which can be configured via
the web UI.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Extension-Container-Static.html"><abbr title="\CRM_Extension_Container_Static">CRM_Extension_Container_Static</abbr></a></dt><dd>An extension container is a locally-accessible source tree which can be
scanned for extensions.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Extension-Downloader.html"><abbr title="\CRM_Extension_Downloader">CRM_Extension_Downloader</abbr></a></dt><dd>This class handles downloads of remotely-provided extensions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Extension-Exception-DependencyException.html"><abbr title="\CRM_Extension_Exception_DependencyException">CRM_Extension_Exception_DependencyException</abbr></a></dt><dd>An extension management operation failed because it would
break a dependency.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Extension-Exception-MissingException.html"><abbr title="\CRM_Extension_Exception_MissingException">CRM_Extension_Exception_MissingException</abbr></a></dt><dd>An extension could not be located</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Extension-Exception-ParseException.html"><abbr title="\CRM_Extension_Exception_ParseException">CRM_Extension_Exception_ParseException</abbr></a></dt><dd>Error reading XML for an extension</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Extension-Exception.html"><abbr title="\CRM_Extension_Exception">CRM_Extension_Exception</abbr></a></dt><dd>Class CRM_Extension_Exception</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Extension-Info.html"><abbr title="\CRM_Extension_Info">CRM_Extension_Info</abbr></a></dt><dd>Metadata for an extension (e.g. the extension's "info.xml" file)</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Extension-Manager-Base.html"><abbr title="\CRM_Extension_Manager_Base">CRM_Extension_Manager_Base</abbr></a></dt><dd>The extension manager handles installing, disabling enabling, and
uninstalling extensions.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Extension-Manager-Module.html"><abbr title="\CRM_Extension_Manager_Module">CRM_Extension_Manager_Module</abbr></a></dt><dd>This class stores logic for managing CiviCRM extensions.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Extension-Manager-Payment.html"><abbr title="\CRM_Extension_Manager_Payment">CRM_Extension_Manager_Payment</abbr></a></dt><dd>This class stores logic for managing CiviCRM extensions.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Extension-Manager-Report.html"><abbr title="\CRM_Extension_Manager_Report">CRM_Extension_Manager_Report</abbr></a></dt><dd>This class stores logic for managing CiviCRM extensions.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Extension-Manager-Search.html"><abbr title="\CRM_Extension_Manager_Search">CRM_Extension_Manager_Search</abbr></a></dt><dd>This class stores logic for managing CiviCRM extensions.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Extension-Manager.html"><abbr title="\CRM_Extension_Manager">CRM_Extension_Manager</abbr></a></dt><dd>The extension manager handles installing, disabling enabling, and
uninstalling extensions.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Extension-Mapper.html"><abbr title="\CRM_Extension_Mapper">CRM_Extension_Mapper</abbr></a></dt><dd>This class proivdes various helper functions for locating extensions
data. It's designed for compatibility with pre-existing functions from
CRM_Core_Extensions.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Extension-MixInfo.html"><abbr title="\CRM_Extension_MixInfo">CRM_Extension_MixInfo</abbr></a></dt><dd>"Mixins" allow extensions to be initialized with small, reusable chunks of code.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Extension-MixinLoader.html"><abbr title="\CRM_Extension_MixinLoader">CRM_Extension_MixinLoader</abbr></a></dt><dd>The MixinLoader gets a list of extensions and mixins - then loads them.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Extension-MixinScanner.html"><abbr title="\CRM_Extension_MixinScanner">CRM_Extension_MixinScanner</abbr></a></dt><dd>The MixinScanner scans the list of actives extensions and their required mixins.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Extension-System.html"><abbr title="\CRM_Extension_System">CRM_Extension_System</abbr></a></dt><dd>This class glues together the various parts of the extension
system.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Extension-Upgrader-Base.html"><abbr title="\CRM_Extension_Upgrader_Base">CRM_Extension_Upgrader_Base</abbr></a></dt><dd>Base class which provides helpers to execute upgrade logic.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Extension-Upgrader-Component.html"><abbr title="\CRM_Extension_Upgrader_Component">CRM_Extension_Upgrader_Component</abbr></a></dt><dd>Upgrader base class ONLY for core component extensions (e.g. `civi_mail`, `civi_event`).</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Extension-Upgrades.html"><abbr title="\CRM_Extension_Upgrades">CRM_Extension_Upgrades</abbr></a></dt><dd>This class stores logic for managing schema upgrades in CiviCRM extensions.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Financial-BAO-EntityFinancialAccount.html"><abbr title="\CRM_Financial_BAO_EntityFinancialAccount">CRM_Financial_BAO_EntityFinancialAccount</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Financial-BAO-EntityFinancialTrxn.html"><abbr title="\CRM_Financial_BAO_EntityFinancialTrxn">CRM_Financial_BAO_EntityFinancialTrxn</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Financial-BAO-ExportFormat-CSV.html"><abbr title="\CRM_Financial_BAO_ExportFormat_CSV">CRM_Financial_BAO_ExportFormat_CSV</abbr></a></dt><dd>Base class for Export Formats
Create a subclass for a specific format.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Financial-BAO-ExportFormat-IIF.html"><abbr title="\CRM_Financial_BAO_ExportFormat_IIF">CRM_Financial_BAO_ExportFormat_IIF</abbr></a></dt><dd>Base class for Export Formats
Create a subclass for a specific format.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Financial-BAO-ExportFormat.html"><abbr title="\CRM_Financial_BAO_ExportFormat">CRM_Financial_BAO_ExportFormat</abbr></a></dt><dd>Base class for Export Formats
Create a subclass for a specific format.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Financial-BAO-FinancialAccount.html"><abbr title="\CRM_Financial_BAO_FinancialAccount">CRM_Financial_BAO_FinancialAccount</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Financial-BAO-FinancialItem.html"><abbr title="\CRM_Financial_BAO_FinancialItem">CRM_Financial_BAO_FinancialItem</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Financial-BAO-FinancialTrxn.html"><abbr title="\CRM_Financial_BAO_FinancialTrxn">CRM_Financial_BAO_FinancialTrxn</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Financial-BAO-FinancialType.html"><abbr title="\CRM_Financial_BAO_FinancialType">CRM_Financial_BAO_FinancialType</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Financial-BAO-Payment.html"><abbr title="\CRM_Financial_BAO_Payment">CRM_Financial_BAO_Payment</abbr></a></dt><dd>This class contains payment related functions.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Financial-BAO-PaymentProcessor.html"><abbr title="\CRM_Financial_BAO_PaymentProcessor">CRM_Financial_BAO_PaymentProcessor</abbr></a></dt><dd>This class contains payment processor related functions.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Financial-BAO-PaymentProcessorType.html"><abbr title="\CRM_Financial_BAO_PaymentProcessorType">CRM_Financial_BAO_PaymentProcessorType</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Financial-DAO-Currency.html"><abbr title="\CRM_Financial_DAO_Currency">CRM_Financial_DAO_Currency</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Financial-DAO-EntityFinancialAccount.html"><abbr title="\CRM_Financial_DAO_EntityFinancialAccount">CRM_Financial_DAO_EntityFinancialAccount</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Financial-DAO-EntityFinancialTrxn.html"><abbr title="\CRM_Financial_DAO_EntityFinancialTrxn">CRM_Financial_DAO_EntityFinancialTrxn</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Financial-DAO-FinancialAccount.html"><abbr title="\CRM_Financial_DAO_FinancialAccount">CRM_Financial_DAO_FinancialAccount</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Financial-DAO-FinancialItem.html"><abbr title="\CRM_Financial_DAO_FinancialItem">CRM_Financial_DAO_FinancialItem</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Financial-DAO-FinancialTrxn.html"><abbr title="\CRM_Financial_DAO_FinancialTrxn">CRM_Financial_DAO_FinancialTrxn</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Financial-DAO-FinancialType.html"><abbr title="\CRM_Financial_DAO_FinancialType">CRM_Financial_DAO_FinancialType</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Financial-DAO-PaymentProcessor.html"><abbr title="\CRM_Financial_DAO_PaymentProcessor">CRM_Financial_DAO_PaymentProcessor</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Financial-DAO-PaymentProcessorType.html"><abbr title="\CRM_Financial_DAO_PaymentProcessorType">CRM_Financial_DAO_PaymentProcessorType</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Financial-DAO-PaymentToken.html"><abbr title="\CRM_Financial_DAO_PaymentToken">CRM_Financial_DAO_PaymentToken</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Financial-FinancialTrxnTokens.html"><abbr title="\CRM_Financial_FinancialTrxnTokens">CRM_Financial_FinancialTrxnTokens</abbr></a></dt><dd>Class CRM_Event_Tokens</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Financial-Form-BatchTransaction.html"><abbr title="\CRM_Financial_Form_BatchTransaction">CRM_Financial_Form_BatchTransaction</abbr></a></dt><dd>This class generates form components for Financial Type</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Financial-Form-Export.html"><abbr title="\CRM_Financial_Form_Export">CRM_Financial_Form_Export</abbr></a></dt><dd>This class provides the functionality to delete a group of
contributions. This class provides functionality for the actual
deletion.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Financial-Form-FinancialAccount.html"><abbr title="\CRM_Financial_Form_FinancialAccount">CRM_Financial_Form_FinancialAccount</abbr></a></dt><dd>This class generates form components for Financial Account</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Financial-Form-FinancialBatch.html"><abbr title="\CRM_Financial_Form_FinancialBatch">CRM_Financial_Form_FinancialBatch</abbr></a></dt><dd>This class generates form components for Accounting Batch</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Financial-Form-FinancialType.html"><abbr title="\CRM_Financial_Form_FinancialType">CRM_Financial_Form_FinancialType</abbr></a></dt><dd>This class generates form components for Financial Type</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Financial-Form-FinancialTypeAccount.html"><abbr title="\CRM_Financial_Form_FinancialTypeAccount">CRM_Financial_Form_FinancialTypeAccount</abbr></a></dt><dd>This class generates form components for Financial Type Account</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Financial-Form-Payment.html"><abbr title="\CRM_Financial_Form_Payment">CRM_Financial_Form_Payment</abbr></a></dt><dd>Class CRM_Core_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Financial-Form-PaymentEdit.html"><abbr title="\CRM_Financial_Form_PaymentEdit">CRM_Financial_Form_PaymentEdit</abbr></a></dt><dd>Class CRM_Core_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Financial-Form-Search.html"><abbr title="\CRM_Financial_Form_Search">CRM_Financial_Form_Search</abbr></a></dt><dd>Class CRM_Core_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Financial-Page-AJAX.html"><abbr title="\CRM_Financial_Page_AJAX">CRM_Financial_Page_AJAX</abbr></a></dt><dd>This class contains all the function that are called using AJAX</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Financial-Page-Batch.html"><abbr title="\CRM_Financial_Page_Batch">CRM_Financial_Page_Batch</abbr></a></dt><dd>Page for displaying list of current batches</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Financial-Page-BatchTransaction.html"><abbr title="\CRM_Financial_Page_BatchTransaction">CRM_Financial_Page_BatchTransaction</abbr></a></dt><dd>Page for displaying list of financial batches</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Financial-Page-FinancialAccount.html"><abbr title="\CRM_Financial_Page_FinancialAccount">CRM_Financial_Page_FinancialAccount</abbr></a></dt><dd>Page for displaying list of financial accounts</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Financial-Page-FinancialBatch.html"><abbr title="\CRM_Financial_Page_FinancialBatch">CRM_Financial_Page_FinancialBatch</abbr></a></dt><dd>Page for displaying list of financial batches</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Financial-Page-FinancialType.html"><abbr title="\CRM_Financial_Page_FinancialType">CRM_Financial_Page_FinancialType</abbr></a></dt><dd>Page for displaying list of financial types</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Financial-Page-FinancialTypeAccount.html"><abbr title="\CRM_Financial_Page_FinancialTypeAccount">CRM_Financial_Page_FinancialTypeAccount</abbr></a></dt><dd>Page for displaying list of financial type accounts</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Friend-DAO-Friend.html"><abbr title="\CRM_Friend_DAO_Friend">CRM_Friend_DAO_Friend</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Group-Controller.html"><abbr title="\CRM_Group_Controller">CRM_Group_Controller</abbr></a></dt><dd>Class CRM_Core_Controller</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Group-Form-Edit.html"><abbr title="\CRM_Group_Form_Edit">CRM_Group_Form_Edit</abbr></a></dt><dd>This class is to build the form for adding Group.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Group-Form-Search.html"><abbr title="\CRM_Group_Form_Search">CRM_Group_Form_Search</abbr></a></dt><dd>Class CRM_Core_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Group-Page-AJAX.html"><abbr title="\CRM_Group_Page_AJAX">CRM_Group_Page_AJAX</abbr></a></dt><dd>This class contains the functions that are called using AJAX (jQuery)</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Group-Page-Group.html"><abbr title="\CRM_Group_Page_Group">CRM_Group_Page_Group</abbr></a></dt><dd>A Page is basically data in a nice pretty format.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Group-StateMachine.html"><abbr title="\CRM_Group_StateMachine">CRM_Group_StateMachine</abbr></a></dt><dd>Core StateMachine.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Import-Controller.html"><abbr title="\CRM_Import_Controller">CRM_Import_Controller</abbr></a></dt><dd>Class CRM_Core_Controller</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Import-DataSource-CSV.html"><abbr title="\CRM_Import_DataSource_CSV">CRM_Import_DataSource_CSV</abbr></a></dt><dd>This class defines the DataSource interface but must be subclassed to be
useful.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Import-DataSource-SQL.html"><abbr title="\CRM_Import_DataSource_SQL">CRM_Import_DataSource_SQL</abbr></a></dt><dd>This class defines the DataSource interface but must be subclassed to be
useful.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Import-DataSource.html"><abbr title="\CRM_Import_DataSource">CRM_Import_DataSource</abbr></a></dt><dd>This class defines the DataSource interface but must be subclassed to be
useful.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Import-Exception-ImportTableUnavailable.html"><abbr title="\CRM_Import_Exception_ImportTableUnavailable">CRM_Import_Exception_ImportTableUnavailable</abbr></a></dt><dd>Base class for exceptions generated by CiviCRM.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Import-Form-DataSource.html"><abbr title="\CRM_Import_Form_DataSource">CRM_Import_Form_DataSource</abbr></a></dt><dd>Base class for upload-only import forms (all but Contact import).</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Import-Form-DataSourceConfig.html"><abbr title="\CRM_Import_Form_DataSourceConfig">CRM_Import_Form_DataSourceConfig</abbr></a></dt><dd>This class allows datasource specific fields to be added to the datasource form.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Import-Form-MapField.html"><abbr title="\CRM_Import_Form_MapField">CRM_Import_Form_MapField</abbr></a></dt><dd>This class gets the name of the file to upload.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Import-Form-Preview.html"><abbr title="\CRM_Import_Form_Preview">CRM_Import_Form_Preview</abbr></a></dt><dd>This class previews the uploaded file and returns summary statistics.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Import-Forms.html"><abbr title="\CRM_Import_Forms">CRM_Import_Forms</abbr></a></dt><dd>This class helps the forms within the import flow access submitted & parsed values.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Import-ImportProcessor.html"><abbr title="\CRM_Import_ImportProcessor">CRM_Import_ImportProcessor</abbr></a></dt><dd>Class CRM_Import_ImportProcessor.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Invoicing-Utils.html"><abbr title="\CRM_Invoicing_Utils">CRM_Invoicing_Utils</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Logging-Differ.html"><abbr title="\CRM_Logging_Differ">CRM_Logging_Differ</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Logging-ReportDetail.html"><abbr title="\CRM_Logging_ReportDetail">CRM_Logging_ReportDetail</abbr></a></dt><dd>Class CRM_Report_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Logging-ReportSummary.html"><abbr title="\CRM_Logging_ReportSummary">CRM_Logging_ReportSummary</abbr></a></dt><dd>Class CRM_Logging_ReportSummary</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Logging-Reverter.html"><abbr title="\CRM_Logging_Reverter">CRM_Logging_Reverter</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Logging-Schema.html"><abbr title="\CRM_Logging_Schema">CRM_Logging_Schema</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-ActionTokens.html"><abbr title="\CRM_Mailing_ActionTokens">CRM_Mailing_ActionTokens</abbr></a></dt><dd>Class CRM_Mailing_ActionTokens</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-BAO-BouncePattern.html"><abbr title="\CRM_Mailing_BAO_BouncePattern">CRM_Mailing_BAO_BouncePattern</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-BAO-Component.html"><abbr title="\CRM_Mailing_BAO_Component">CRM_Mailing_BAO_Component</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-BAO-Mailing.html"><abbr title="\CRM_Mailing_BAO_Mailing">CRM_Mailing_BAO_Mailing</abbr></a></dt><dd>Class CRM_Mailing_BAO_Mailing</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-BAO-MailingAB.html"><abbr title="\CRM_Mailing_BAO_MailingAB">CRM_Mailing_BAO_MailingAB</abbr></a></dt><dd>Class CRM_Mailing_BAO_MailingAB</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-BAO-MailingComponent.html"><abbr title="\CRM_Mailing_BAO_MailingComponent">CRM_Mailing_BAO_MailingComponent</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-BAO-MailingJob.html"><abbr title="\CRM_Mailing_BAO_MailingJob">CRM_Mailing_BAO_MailingJob</abbr></a></dt><dd>Class CRM_Mailing_BAO_MailingJob</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-BAO-MailingRecipients.html"><abbr title="\CRM_Mailing_BAO_MailingRecipients">CRM_Mailing_BAO_MailingRecipients</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-BAO-MailingTrackableURL.html"><abbr title="\CRM_Mailing_BAO_MailingTrackableURL">CRM_Mailing_BAO_MailingTrackableURL</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-BAO-Query.html"><abbr title="\CRM_Mailing_BAO_Query">CRM_Mailing_BAO_Query</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-BAO-SMSJob.html"><abbr title="\CRM_Mailing_BAO_SMSJob">CRM_Mailing_BAO_SMSJob</abbr></a></dt><dd>Job for SMS deliery functions.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-BAO-Spool.html"><abbr title="\CRM_Mailing_BAO_Spool">CRM_Mailing_BAO_Spool</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-Config.html"><abbr title="\CRM_Mailing_Config">CRM_Mailing_Config</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-Controller-Send.html"><abbr title="\CRM_Mailing_Controller_Send">CRM_Mailing_Controller_Send</abbr></a></dt><dd>Class CRM_Core_Controller</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-DAO-BouncePattern.html"><abbr title="\CRM_Mailing_DAO_BouncePattern">CRM_Mailing_DAO_BouncePattern</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-DAO-BounceType.html"><abbr title="\CRM_Mailing_DAO_BounceType">CRM_Mailing_DAO_BounceType</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-DAO-Mailing.html"><abbr title="\CRM_Mailing_DAO_Mailing">CRM_Mailing_DAO_Mailing</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-DAO-MailingAB.html"><abbr title="\CRM_Mailing_DAO_MailingAB">CRM_Mailing_DAO_MailingAB</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-DAO-MailingComponent.html"><abbr title="\CRM_Mailing_DAO_MailingComponent">CRM_Mailing_DAO_MailingComponent</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-DAO-MailingGroup.html"><abbr title="\CRM_Mailing_DAO_MailingGroup">CRM_Mailing_DAO_MailingGroup</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-DAO-MailingJob.html"><abbr title="\CRM_Mailing_DAO_MailingJob">CRM_Mailing_DAO_MailingJob</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-DAO-MailingRecipients.html"><abbr title="\CRM_Mailing_DAO_MailingRecipients">CRM_Mailing_DAO_MailingRecipients</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-DAO-MailingTrackableURL.html"><abbr title="\CRM_Mailing_DAO_MailingTrackableURL">CRM_Mailing_DAO_MailingTrackableURL</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-DAO-Spool.html"><abbr title="\CRM_Mailing_DAO_Spool">CRM_Mailing_DAO_Spool</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-Event-BAO-MailingEventBounce.html"><abbr title="\CRM_Mailing_Event_BAO_MailingEventBounce">CRM_Mailing_Event_BAO_MailingEventBounce</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-Event-BAO-MailingEventConfirm.html"><abbr title="\CRM_Mailing_Event_BAO_MailingEventConfirm">CRM_Mailing_Event_BAO_MailingEventConfirm</abbr></a></dt><dd>Class CRM_Mailing_Event_BAO_Confirm</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-Event-BAO-MailingEventDelivered.html"><abbr title="\CRM_Mailing_Event_BAO_MailingEventDelivered">CRM_Mailing_Event_BAO_MailingEventDelivered</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-Event-BAO-MailingEventForward.html"><abbr title="\CRM_Mailing_Event_BAO_MailingEventForward">CRM_Mailing_Event_BAO_MailingEventForward</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-Event-BAO-MailingEventOpened.html"><abbr title="\CRM_Mailing_Event_BAO_MailingEventOpened">CRM_Mailing_Event_BAO_MailingEventOpened</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-Event-BAO-MailingEventQueue.html"><abbr title="\CRM_Mailing_Event_BAO_MailingEventQueue">CRM_Mailing_Event_BAO_MailingEventQueue</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-Event-BAO-MailingEventReply.html"><abbr title="\CRM_Mailing_Event_BAO_MailingEventReply">CRM_Mailing_Event_BAO_MailingEventReply</abbr></a></dt><dd>Class CRM_Mailing_Event_BAO_Reply</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-Event-BAO-MailingEventResubscribe.html"><abbr title="\CRM_Mailing_Event_BAO_MailingEventResubscribe">CRM_Mailing_Event_BAO_MailingEventResubscribe</abbr></a></dt><dd>Class CRM_Mailing_Event_BAO_MailingEventResubscribe</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-Event-BAO-MailingEventSubscribe.html"><abbr title="\CRM_Mailing_Event_BAO_MailingEventSubscribe">CRM_Mailing_Event_BAO_MailingEventSubscribe</abbr></a></dt><dd>Class CRM_Mailing_Event_BAO_Subscribe</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-Event-BAO-MailingEventTrackableURLOpen.html"><abbr title="\CRM_Mailing_Event_BAO_MailingEventTrackableURLOpen">CRM_Mailing_Event_BAO_MailingEventTrackableURLOpen</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-Event-BAO-MailingEventUnsubscribe.html"><abbr title="\CRM_Mailing_Event_BAO_MailingEventUnsubscribe">CRM_Mailing_Event_BAO_MailingEventUnsubscribe</abbr></a></dt><dd>Class CRM_Mailing_Event_BAO_Unsubscribe</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-Event-DAO-MailingEventBounce.html"><abbr title="\CRM_Mailing_Event_DAO_MailingEventBounce">CRM_Mailing_Event_DAO_MailingEventBounce</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-Event-DAO-MailingEventConfirm.html"><abbr title="\CRM_Mailing_Event_DAO_MailingEventConfirm">CRM_Mailing_Event_DAO_MailingEventConfirm</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-Event-DAO-MailingEventDelivered.html"><abbr title="\CRM_Mailing_Event_DAO_MailingEventDelivered">CRM_Mailing_Event_DAO_MailingEventDelivered</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-Event-DAO-MailingEventForward.html"><abbr title="\CRM_Mailing_Event_DAO_MailingEventForward">CRM_Mailing_Event_DAO_MailingEventForward</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-Event-DAO-MailingEventOpened.html"><abbr title="\CRM_Mailing_Event_DAO_MailingEventOpened">CRM_Mailing_Event_DAO_MailingEventOpened</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-Event-DAO-MailingEventQueue.html"><abbr title="\CRM_Mailing_Event_DAO_MailingEventQueue">CRM_Mailing_Event_DAO_MailingEventQueue</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-Event-DAO-MailingEventReply.html"><abbr title="\CRM_Mailing_Event_DAO_MailingEventReply">CRM_Mailing_Event_DAO_MailingEventReply</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-Event-DAO-MailingEventSubscribe.html"><abbr title="\CRM_Mailing_Event_DAO_MailingEventSubscribe">CRM_Mailing_Event_DAO_MailingEventSubscribe</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-Event-DAO-MailingEventTrackableURLOpen.html"><abbr title="\CRM_Mailing_Event_DAO_MailingEventTrackableURLOpen">CRM_Mailing_Event_DAO_MailingEventTrackableURLOpen</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-Event-DAO-MailingEventUnsubscribe.html"><abbr title="\CRM_Mailing_Event_DAO_MailingEventUnsubscribe">CRM_Mailing_Event_DAO_MailingEventUnsubscribe</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-Form-Approve.html"><abbr title="\CRM_Mailing_Form_Approve">CRM_Mailing_Form_Approve</abbr></a></dt><dd>Class CRM_Core_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-Form-Browse.html"><abbr title="\CRM_Mailing_Form_Browse">CRM_Mailing_Form_Browse</abbr></a></dt><dd>Build the form object for disable mail feature</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-Form-Component.html"><abbr title="\CRM_Mailing_Form_Component">CRM_Mailing_Form_Component</abbr></a></dt><dd>This class generates form components for Location Type.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-Form-ForwardMailing.html"><abbr title="\CRM_Mailing_Form_ForwardMailing">CRM_Mailing_Form_ForwardMailing</abbr></a></dt><dd>Class CRM_Core_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-Form-Optout.html"><abbr title="\CRM_Mailing_Form_Optout">CRM_Mailing_Form_Optout</abbr></a></dt><dd>Class CRM_Core_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-Form-Search.html"><abbr title="\CRM_Mailing_Form_Search">CRM_Mailing_Form_Search</abbr></a></dt><dd>Base class for most search forms</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-Form-Subscribe.html"><abbr title="\CRM_Mailing_Form_Subscribe">CRM_Mailing_Form_Subscribe</abbr></a></dt><dd>Class CRM_Core_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-Form-Task-AdhocMailing.html"><abbr title="\CRM_Mailing_Form_Task_AdhocMailing">CRM_Mailing_Form_Task_AdhocMailing</abbr></a></dt><dd>Given the selected contacts, prepare a mailing with a hidden group.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-Form-Task-Print.html"><abbr title="\CRM_Mailing_Form_Task_Print">CRM_Mailing_Form_Task_Print</abbr></a></dt><dd>This class provides the functionality to print mailing recipient records</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-Form-Task.html"><abbr title="\CRM_Mailing_Form_Task">CRM_Mailing_Form_Task</abbr></a></dt><dd>Class for mailing form task actions.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-Form-Unsubscribe.html"><abbr title="\CRM_Mailing_Form_Unsubscribe">CRM_Mailing_Form_Unsubscribe</abbr></a></dt><dd>Class CRM_Core_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-Info.html"><abbr title="\CRM_Mailing_Info">CRM_Mailing_Info</abbr></a></dt><dd>This class introduces component to the system and provides all the
information about it. It needs to extend CRM_Core_Component_Info
abstract class.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-MailStore-Imap.html"><abbr title="\CRM_Mailing_MailStore_Imap">CRM_Mailing_MailStore_Imap</abbr></a></dt><dd>Class CRM_Mailing_MailStore_Imap</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-MailStore-Localdir.html"><abbr title="\CRM_Mailing_MailStore_Localdir">CRM_Mailing_MailStore_Localdir</abbr></a></dt><dd>Class CRM_Mailing_MailStore_Localdir</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-MailStore-Maildir.html"><abbr title="\CRM_Mailing_MailStore_Maildir">CRM_Mailing_MailStore_Maildir</abbr></a></dt><dd>Class CRM_Mailing_MailStore_Maildir</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-MailStore-Mbox.html"><abbr title="\CRM_Mailing_MailStore_Mbox">CRM_Mailing_MailStore_Mbox</abbr></a></dt><dd>Class CRM_Mailing_MailStore_Mbox</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-MailStore-Pop3.html"><abbr title="\CRM_Mailing_MailStore_Pop3">CRM_Mailing_MailStore_Pop3</abbr></a></dt><dd>Class CRM_Mailing_MailStore_Pop3</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-MailStore.html"><abbr title="\CRM_Mailing_MailStore">CRM_Mailing_MailStore</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-Page-AJAX.html"><abbr title="\CRM_Mailing_Page_AJAX">CRM_Mailing_Page_AJAX</abbr></a></dt><dd>This class contains all the function that are called using AJAX</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-Page-Browse.html"><abbr title="\CRM_Mailing_Page_Browse">CRM_Mailing_Page_Browse</abbr></a></dt><dd>This implements the profile page for all contacts. It uses a selector
object to do the actual display. The fields displayed are controlled by
the admin</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-Page-Common.html"><abbr title="\CRM_Mailing_Page_Common">CRM_Mailing_Page_Common</abbr></a></dt><dd>A Page is basically data in a nice pretty format.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-Page-Component.html"><abbr title="\CRM_Mailing_Page_Component">CRM_Mailing_Page_Component</abbr></a></dt><dd>Page to display / edit the header / footer of a mailing</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-Page-Confirm.html"><abbr title="\CRM_Mailing_Page_Confirm">CRM_Mailing_Page_Confirm</abbr></a></dt><dd>A Page is basically data in a nice pretty format.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-Page-Event.html"><abbr title="\CRM_Mailing_Page_Event">CRM_Mailing_Page_Event</abbr></a></dt><dd>This implements the profile page for all contacts.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-Page-Open.html"><abbr title="\CRM_Mailing_Page_Open">CRM_Mailing_Page_Open</abbr></a></dt><dd>Indicate that a CiviMail message has been opened</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-Page-Report.html"><abbr title="\CRM_Mailing_Page_Report">CRM_Mailing_Page_Report</abbr></a></dt><dd>Page to display / edit the header / footer of a mailing.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-Page-Resubscribe.html"><abbr title="\CRM_Mailing_Page_Resubscribe">CRM_Mailing_Page_Resubscribe</abbr></a></dt><dd>A Page is basically data in a nice pretty format.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-Page-Tab.html"><abbr title="\CRM_Mailing_Page_Tab">CRM_Mailing_Page_Tab</abbr></a></dt><dd>This class handle mailing and contact related functions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-Page-Unsubscribe.html"><abbr title="\CRM_Mailing_Page_Unsubscribe">CRM_Mailing_Page_Unsubscribe</abbr></a></dt><dd>A Page is basically data in a nice pretty format.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-Page-Url.html"><abbr title="\CRM_Mailing_Page_Url">CRM_Mailing_Page_Url</abbr></a></dt><dd>Redirects a user to the full url from a mailing url.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-Page-View.html"><abbr title="\CRM_Mailing_Page_View">CRM_Mailing_Page_View</abbr></a></dt><dd>A page for mailing preview.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-PseudoConstant.html"><abbr title="\CRM_Mailing_PseudoConstant">CRM_Mailing_PseudoConstant</abbr></a></dt><dd>This class holds all the Pseudo constants that are specific to Mass mailing. This avoids
polluting the core class and isolates the mass mailer class.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-Selector-Browse.html"><abbr title="\CRM_Mailing_Selector_Browse">CRM_Mailing_Selector_Browse</abbr></a></dt><dd>This class is used to browse past mailings.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-Selector-Event.html"><abbr title="\CRM_Mailing_Selector_Event">CRM_Mailing_Selector_Event</abbr></a></dt><dd>This class is used to retrieve and display a range of
contacts that match the given criteria (specifically for
results of advanced search options.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-Selector-Search.html"><abbr title="\CRM_Mailing_Selector_Search">CRM_Mailing_Selector_Search</abbr></a></dt><dd>This class is used to retrieve and display a range of
contacts that match the given criteria (specifically for
results of advanced search options.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-Service-ListUnsubscribe.html"><abbr title="\CRM_Mailing_Service_ListUnsubscribe">CRM_Mailing_Service_ListUnsubscribe</abbr></a></dt><dd>Apply a full range of `List-Unsubscribe` header options.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-Task.html"><abbr title="\CRM_Mailing_Task">CRM_Mailing_Task</abbr></a></dt><dd>class to represent the actions that can be performed on a group of contacts
used by the search forms.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-Tokens.html"><abbr title="\CRM_Mailing_Tokens">CRM_Mailing_Tokens</abbr></a></dt><dd>Class CRM_Mailing_Tokens</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-ActionMapping.html"><abbr title="\CRM_Member_ActionMapping">CRM_Member_ActionMapping</abbr></a></dt><dd>This defines the scheduled-reminder functionality for CiviMember
memberships. It allows one to target reminders based on join date
or end date, with additional filtering based on membership-type.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-BAO-Membership.html"><abbr title="\CRM_Member_BAO_Membership">CRM_Member_BAO_Membership</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-BAO-MembershipBlock.html"><abbr title="\CRM_Member_BAO_MembershipBlock">CRM_Member_BAO_MembershipBlock</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-BAO-MembershipLog.html"><abbr title="\CRM_Member_BAO_MembershipLog">CRM_Member_BAO_MembershipLog</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-BAO-MembershipPayment.html"><abbr title="\CRM_Member_BAO_MembershipPayment">CRM_Member_BAO_MembershipPayment</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-BAO-MembershipStatus.html"><abbr title="\CRM_Member_BAO_MembershipStatus">CRM_Member_BAO_MembershipStatus</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-BAO-MembershipType.html"><abbr title="\CRM_Member_BAO_MembershipType">CRM_Member_BAO_MembershipType</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-BAO-Query.html"><abbr title="\CRM_Member_BAO_Query">CRM_Member_BAO_Query</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-Controller-Search.html"><abbr title="\CRM_Member_Controller_Search">CRM_Member_Controller_Search</abbr></a></dt><dd>This class is used by the Search functionality.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-DAO-Membership.html"><abbr title="\CRM_Member_DAO_Membership">CRM_Member_DAO_Membership</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-DAO-MembershipBlock.html"><abbr title="\CRM_Member_DAO_MembershipBlock">CRM_Member_DAO_MembershipBlock</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-DAO-MembershipLog.html"><abbr title="\CRM_Member_DAO_MembershipLog">CRM_Member_DAO_MembershipLog</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-DAO-MembershipPayment.html"><abbr title="\CRM_Member_DAO_MembershipPayment">CRM_Member_DAO_MembershipPayment</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-DAO-MembershipStatus.html"><abbr title="\CRM_Member_DAO_MembershipStatus">CRM_Member_DAO_MembershipStatus</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-DAO-MembershipType.html"><abbr title="\CRM_Member_DAO_MembershipType">CRM_Member_DAO_MembershipType</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-Export-Form-Map.html"><abbr title="\CRM_Member_Export_Form_Map">CRM_Member_Export_Form_Map</abbr></a></dt><dd>This class gets the name of the file to upload</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-Export-Form-Select.html"><abbr title="\CRM_Member_Export_Form_Select">CRM_Member_Export_Form_Select</abbr></a></dt><dd>This class gets the name of the file to upload</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-Form-Membership.html"><abbr title="\CRM_Member_Form_Membership">CRM_Member_Form_Membership</abbr></a></dt><dd>This class generates form components for offline membership form.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-Form-MembershipBlock.html"><abbr title="\CRM_Member_Form_MembershipBlock">CRM_Member_Form_MembershipBlock</abbr></a></dt><dd>form to process actions on Membership</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-Form-MembershipConfig.html"><abbr title="\CRM_Member_Form_MembershipConfig">CRM_Member_Form_MembershipConfig</abbr></a></dt><dd>Base class for offline membership / membership type / membership renewal and membership status forms</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-Form-MembershipRenewal.html"><abbr title="\CRM_Member_Form_MembershipRenewal">CRM_Member_Form_MembershipRenewal</abbr></a></dt><dd>This class generates form components for Membership Renewal</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-Form-MembershipStatus.html"><abbr title="\CRM_Member_Form_MembershipStatus">CRM_Member_Form_MembershipStatus</abbr></a></dt><dd>This class generates form components for Membership Type</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-Form-MembershipType.html"><abbr title="\CRM_Member_Form_MembershipType">CRM_Member_Form_MembershipType</abbr></a></dt><dd>This class generates form components for Membership Type</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-Form-MembershipView.html"><abbr title="\CRM_Member_Form_MembershipView">CRM_Member_Form_MembershipView</abbr></a></dt><dd>This class generates form components for Payment-Instrument</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-Form-Search.html"><abbr title="\CRM_Member_Form_Search">CRM_Member_Form_Search</abbr></a></dt><dd>Membership search.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-Form-Task-Batch.html"><abbr title="\CRM_Member_Form_Task_Batch">CRM_Member_Form_Task_Batch</abbr></a></dt><dd>This class provides the functionality for batch profile update for members</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-Form-Task-Delete.html"><abbr title="\CRM_Member_Form_Task_Delete">CRM_Member_Form_Task_Delete</abbr></a></dt><dd>This class provides the functionality to delete a group of
members. This class provides functionality for the actual
deletion.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-Form-Task-Email.html"><abbr title="\CRM_Member_Form_Task_Email">CRM_Member_Form_Task_Email</abbr></a></dt><dd>This class provides the functionality to email a group of
contacts.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-Form-Task-Label.html"><abbr title="\CRM_Member_Form_Task_Label">CRM_Member_Form_Task_Label</abbr></a></dt><dd>This class helps to print the labels for contacts</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-Form-Task-PDFLetter.html"><abbr title="\CRM_Member_Form_Task_PDFLetter">CRM_Member_Form_Task_PDFLetter</abbr></a></dt><dd>This class provides the functionality to create PDF letter for a group of
contacts or a single contact.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-Form-Task-PickProfile.html"><abbr title="\CRM_Member_Form_Task_PickProfile">CRM_Member_Form_Task_PickProfile</abbr></a></dt><dd>This class provides the functionality for batch profile update for membership</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-Form-Task-Print.html"><abbr title="\CRM_Member_Form_Task_Print">CRM_Member_Form_Task_Print</abbr></a></dt><dd>This class provides the functionality to print members</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-Form-Task-Result.html"><abbr title="\CRM_Member_Form_Task_Result">CRM_Member_Form_Task_Result</abbr></a></dt><dd>Used for displaying results</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-Form-Task.html"><abbr title="\CRM_Member_Form_Task">CRM_Member_Form_Task</abbr></a></dt><dd>Class for member form task actions.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-Form.html"><abbr title="\CRM_Member_Form">CRM_Member_Form</abbr></a></dt><dd>Base class for offline membership / membership type / membership renewal and membership status forms</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-Import-Form-DataSource.html"><abbr title="\CRM_Member_Import_Form_DataSource">CRM_Member_Import_Form_DataSource</abbr></a></dt><dd>This class gets the name of the file to upload</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-Import-Form-MapField.html"><abbr title="\CRM_Member_Import_Form_MapField">CRM_Member_Import_Form_MapField</abbr></a></dt><dd>This class gets the name of the file to upload</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-Import-Form-Preview.html"><abbr title="\CRM_Member_Import_Form_Preview">CRM_Member_Import_Form_Preview</abbr></a></dt><dd>This class previews the uploaded file and returns summary
statistics</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-Import-Parser-Membership.html"><abbr title="\CRM_Member_Import_Parser_Membership">CRM_Member_Import_Parser_Membership</abbr></a></dt><dd>class to parse membership csv files</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-Info.html"><abbr title="\CRM_Member_Info">CRM_Member_Info</abbr></a></dt><dd>This class introduces component to the system and provides all the
information about it. It needs to extend CRM_Core_Component_Info
abstract class.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-Page-AJAX.html"><abbr title="\CRM_Member_Page_AJAX">CRM_Member_Page_AJAX</abbr></a></dt><dd>This class contains all the function that are called using AJAX (dojo)</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-Page-DashBoard.html"><abbr title="\CRM_Member_Page_DashBoard">CRM_Member_Page_DashBoard</abbr></a></dt><dd>Page for displaying members.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-Page-MembershipStatus.html"><abbr title="\CRM_Member_Page_MembershipStatus">CRM_Member_Page_MembershipStatus</abbr></a></dt><dd>Page for displaying list of membership statuses</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-Page-MembershipType.html"><abbr title="\CRM_Member_Page_MembershipType">CRM_Member_Page_MembershipType</abbr></a></dt><dd>Page for displaying list of membership types</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-Page-RecurringContributions.html"><abbr title="\CRM_Member_Page_RecurringContributions">CRM_Member_Page_RecurringContributions</abbr></a></dt><dd>Shows list of recurring contributions related to membership.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-Page-Tab.html"><abbr title="\CRM_Member_Page_Tab">CRM_Member_Page_Tab</abbr></a></dt><dd>A Page is basically data in a nice pretty format.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-Page-UserDashboard.html"><abbr title="\CRM_Member_Page_UserDashboard">CRM_Member_Page_UserDashboard</abbr></a></dt><dd>This class is for building membership block on user dashboard</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-PseudoConstant.html"><abbr title="\CRM_Member_PseudoConstant">CRM_Member_PseudoConstant</abbr></a></dt><dd>This class holds all the Pseudo constants that are specific to the civimember component. This avoids
polluting the core class and isolates the mass mailer class</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-Selector-Search.html"><abbr title="\CRM_Member_Selector_Search">CRM_Member_Selector_Search</abbr></a></dt><dd>This class is used to retrieve and display a range of
contacts that match the given criteria (specifically for
results of advanced search options.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-StateMachine-Search.html"><abbr title="\CRM_Member_StateMachine_Search">CRM_Member_StateMachine_Search</abbr></a></dt><dd>Core StateMachine.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-StatusOverrideTypes.html"><abbr title="\CRM_Member_StatusOverrideTypes">CRM_Member_StatusOverrideTypes</abbr></a></dt><dd>Membership status override types.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-Task.html"><abbr title="\CRM_Member_Task">CRM_Member_Task</abbr></a></dt><dd>class to represent the actions that can be performed on a group of
contacts (CiviMember)
used by the search forms</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-Tokens.html"><abbr title="\CRM_Member_Tokens">CRM_Member_Tokens</abbr></a></dt><dd>Class CRM_Member_Tokens</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-Utils-RelationshipProcessor.html"><abbr title="\CRM_Member_Utils_RelationshipProcessor">CRM_Member_Utils_RelationshipProcessor</abbr></a></dt><dd>Class CRM_Member_Utils_RelationshipProcessor</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-WorkflowMessage-Membership-Membership.html"><abbr title="\CRM_Member_WorkflowMessage_Membership_Membership">CRM_Member_WorkflowMessage_Membership_Membership</abbr></a></dt><dd>Examples for membership templates.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-WorkflowMessage-MembershipOfflineReceipt.html"><abbr title="\CRM_Member_WorkflowMessage_MembershipOfflineReceipt">CRM_Member_WorkflowMessage_MembershipOfflineReceipt</abbr></a></dt><dd>Receipt sent when confirming a back office membership.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-WorkflowMessage-MembershipOnlineReceipt.html"><abbr title="\CRM_Member_WorkflowMessage_MembershipOnlineReceipt">CRM_Member_WorkflowMessage_MembershipOnlineReceipt</abbr></a></dt><dd>Receipt sent when confirming a back office membership.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Note-Form-Note.html"><abbr title="\CRM_Note_Form_Note">CRM_Note_Form_Note</abbr></a></dt><dd>This class generates form components generic to note</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-PCP-BAO-PCP.html"><abbr title="\CRM_PCP_BAO_PCP">CRM_PCP_BAO_PCP</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-PCP-BAO-PCPBlock.html"><abbr title="\CRM_PCP_BAO_PCPBlock">CRM_PCP_BAO_PCPBlock</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-PCP-Controller-PCP.html"><abbr title="\CRM_PCP_Controller_PCP">CRM_PCP_Controller_PCP</abbr></a></dt><dd>This class is used by the Search functionality.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-PCP-DAO-PCP.html"><abbr title="\CRM_PCP_DAO_PCP">CRM_PCP_DAO_PCP</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-PCP-DAO-PCPBlock.html"><abbr title="\CRM_PCP_DAO_PCPBlock">CRM_PCP_DAO_PCPBlock</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-PCP-Form-Campaign.html"><abbr title="\CRM_PCP_Form_Campaign">CRM_PCP_Form_Campaign</abbr></a></dt><dd>This class generates form components for processing a pcp page.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-PCP-Form-Contribute.html"><abbr title="\CRM_PCP_Form_Contribute">CRM_PCP_Form_Contribute</abbr></a></dt><dd>This class generates form components for Tell A Friend</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-PCP-Form-Event.html"><abbr title="\CRM_PCP_Form_Event">CRM_PCP_Form_Event</abbr></a></dt><dd>This class generates form components for PCP</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-PCP-Form-PCP.html"><abbr title="\CRM_PCP_Form_PCP">CRM_PCP_Form_PCP</abbr></a></dt><dd>Administer Personal Campaign Pages - Search form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-PCP-Form-PCPAccount.html"><abbr title="\CRM_PCP_Form_PCPAccount">CRM_PCP_Form_PCPAccount</abbr></a></dt><dd>This class generates form components for processing a contribution.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-PCP-Page-PCP.html"><abbr title="\CRM_PCP_Page_PCP">CRM_PCP_Page_PCP</abbr></a></dt><dd>Page for displaying list of personal campaign pages</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-PCP-Page-PCPInfo.html"><abbr title="\CRM_PCP_Page_PCPInfo">CRM_PCP_Page_PCPInfo</abbr></a></dt><dd>PCP Info Page - Summary about the PCP</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-PCP-StateMachine-PCP.html"><abbr title="\CRM_PCP_StateMachine_PCP">CRM_PCP_StateMachine_PCP</abbr></a></dt><dd>State machine for managing different pages while setting up PCP flow.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Pledge-BAO-Pledge.html"><abbr title="\CRM_Pledge_BAO_Pledge">CRM_Pledge_BAO_Pledge</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Pledge-BAO-PledgeBlock.html"><abbr title="\CRM_Pledge_BAO_PledgeBlock">CRM_Pledge_BAO_PledgeBlock</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Pledge-BAO-PledgePayment.html"><abbr title="\CRM_Pledge_BAO_PledgePayment">CRM_Pledge_BAO_PledgePayment</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Pledge-BAO-Query.html"><abbr title="\CRM_Pledge_BAO_Query">CRM_Pledge_BAO_Query</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Pledge-Controller-Search.html"><abbr title="\CRM_Pledge_Controller_Search">CRM_Pledge_Controller_Search</abbr></a></dt><dd>This class is used by the Search functionality.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Pledge-DAO-Pledge.html"><abbr title="\CRM_Pledge_DAO_Pledge">CRM_Pledge_DAO_Pledge</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Pledge-DAO-PledgeBlock.html"><abbr title="\CRM_Pledge_DAO_PledgeBlock">CRM_Pledge_DAO_PledgeBlock</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Pledge-DAO-PledgePayment.html"><abbr title="\CRM_Pledge_DAO_PledgePayment">CRM_Pledge_DAO_PledgePayment</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Pledge-Export-Form-Map.html"><abbr title="\CRM_Pledge_Export_Form_Map">CRM_Pledge_Export_Form_Map</abbr></a></dt><dd>This class gets the name of the file to upload</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Pledge-Export-Form-Select.html"><abbr title="\CRM_Pledge_Export_Form_Select">CRM_Pledge_Export_Form_Select</abbr></a></dt><dd>This class gets the name of the file to upload</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Pledge-Form-Payment.html"><abbr title="\CRM_Pledge_Form_Payment">CRM_Pledge_Form_Payment</abbr></a></dt><dd>This class generates form components for processing a pledge payment.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Pledge-Form-Pledge.html"><abbr title="\CRM_Pledge_Form_Pledge">CRM_Pledge_Form_Pledge</abbr></a></dt><dd>This class generates form components for processing a pledge</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Pledge-Form-PledgeView.html"><abbr title="\CRM_Pledge_Form_PledgeView">CRM_Pledge_Form_PledgeView</abbr></a></dt><dd>This class generates form components for Pledge</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Pledge-Form-Search.html"><abbr title="\CRM_Pledge_Form_Search">CRM_Pledge_Form_Search</abbr></a></dt><dd>This file is for Pledge search</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Pledge-Form-Task-Delete.html"><abbr title="\CRM_Pledge_Form_Task_Delete">CRM_Pledge_Form_Task_Delete</abbr></a></dt><dd>This class provides the functionality to delete a group of
participations. This class provides functionality for the actual
deletion.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Pledge-Form-Task-Print.html"><abbr title="\CRM_Pledge_Form_Task_Print">CRM_Pledge_Form_Task_Print</abbr></a></dt><dd>This class provides the functionality to save a search
Saved Searches are used for saving frequently used queries</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Pledge-Form-Task-Result.html"><abbr title="\CRM_Pledge_Form_Task_Result">CRM_Pledge_Form_Task_Result</abbr></a></dt><dd>Used for displaying results.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Pledge-Form-Task.html"><abbr title="\CRM_Pledge_Form_Task">CRM_Pledge_Form_Task</abbr></a></dt><dd>Class for pledge form task actions.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Pledge-Info.html"><abbr title="\CRM_Pledge_Info">CRM_Pledge_Info</abbr></a></dt><dd>This class introduces component to the system and provides all the
information about it. It needs to extend CRM_Core_Component_Info
abstract class.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Pledge-Page-AJAX.html"><abbr title="\CRM_Pledge_Page_AJAX">CRM_Pledge_Page_AJAX</abbr></a></dt><dd>This class contains all the function that are called using AJAX</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Pledge-Page-DashBoard.html"><abbr title="\CRM_Pledge_Page_DashBoard">CRM_Pledge_Page_DashBoard</abbr></a></dt><dd>This page is for the Pledge Dashboard.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Pledge-Page-Payment.html"><abbr title="\CRM_Pledge_Page_Payment">CRM_Pledge_Page_Payment</abbr></a></dt><dd>A Page is basically data in a nice pretty format.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Pledge-Page-Tab.html"><abbr title="\CRM_Pledge_Page_Tab">CRM_Pledge_Page_Tab</abbr></a></dt><dd>A Page is basically data in a nice pretty format.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Pledge-Page-UserDashboard.html"><abbr title="\CRM_Pledge_Page_UserDashboard">CRM_Pledge_Page_UserDashboard</abbr></a></dt><dd>This class is used to build User Dashboard</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Pledge-Selector-Search.html"><abbr title="\CRM_Pledge_Selector_Search">CRM_Pledge_Selector_Search</abbr></a></dt><dd>This class is used to retrieve and display a range of
contacts that match the given criteria (specifically for
results of advanced search options.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Pledge-StateMachine-Search.html"><abbr title="\CRM_Pledge_StateMachine_Search">CRM_Pledge_StateMachine_Search</abbr></a></dt><dd>Core StateMachine.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Pledge-Task.html"><abbr title="\CRM_Pledge_Task">CRM_Pledge_Task</abbr></a></dt><dd>class to represent the actions that can be performed on a group of contacts
used by the search forms.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Pledge-Tokens.html"><abbr title="\CRM_Pledge_Tokens">CRM_Pledge_Tokens</abbr></a></dt><dd>Class CRM_Pledge_Tokens</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Pledge-WorkflowMessage-PledgeAcknowledge.html"><abbr title="\CRM_Pledge_WorkflowMessage_PledgeAcknowledge">CRM_Pledge_WorkflowMessage_PledgeAcknowledge</abbr></a></dt><dd>Acknowledge a new pledge being set up</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Pledge-WorkflowMessage-PledgeReminder.html"><abbr title="\CRM_Pledge_WorkflowMessage_PledgeReminder">CRM_Pledge_WorkflowMessage_PledgeReminder</abbr></a></dt><dd>Reminder pledger that a payment is due.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Price-BAO-LineItem.html"><abbr title="\CRM_Price_BAO_LineItem">CRM_Price_BAO_LineItem</abbr></a></dt><dd>Business objects for Line Items generated by monetary transactions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Price-BAO-PriceField.html"><abbr title="\CRM_Price_BAO_PriceField">CRM_Price_BAO_PriceField</abbr></a></dt><dd>Business objects for managing price fields.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Price-BAO-PriceFieldValue.html"><abbr title="\CRM_Price_BAO_PriceFieldValue">CRM_Price_BAO_PriceFieldValue</abbr></a></dt><dd>Business objects for managing price fields values.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Price-BAO-PriceSet.html"><abbr title="\CRM_Price_BAO_PriceSet">CRM_Price_BAO_PriceSet</abbr></a></dt><dd>Business object for managing price sets.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Price-DAO-LineItem.html"><abbr title="\CRM_Price_DAO_LineItem">CRM_Price_DAO_LineItem</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Price-DAO-PriceField.html"><abbr title="\CRM_Price_DAO_PriceField">CRM_Price_DAO_PriceField</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Price-DAO-PriceFieldValue.html"><abbr title="\CRM_Price_DAO_PriceFieldValue">CRM_Price_DAO_PriceFieldValue</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Price-DAO-PriceSet.html"><abbr title="\CRM_Price_DAO_PriceSet">CRM_Price_DAO_PriceSet</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Price-DAO-PriceSetEntity.html"><abbr title="\CRM_Price_DAO_PriceSetEntity">CRM_Price_DAO_PriceSetEntity</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Price-Form-DeleteField.html"><abbr title="\CRM_Price_Form_DeleteField">CRM_Price_Form_DeleteField</abbr></a></dt><dd>This class is to build the form for Deleting Group</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Price-Form-DeleteSet.html"><abbr title="\CRM_Price_Form_DeleteSet">CRM_Price_Form_DeleteSet</abbr></a></dt><dd>This class is to build the form for Deleting Set</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Price-Form-Field.html"><abbr title="\CRM_Price_Form_Field">CRM_Price_Form_Field</abbr></a></dt><dd>form to process actions on the field aspect of Price</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Price-Form-Option.html"><abbr title="\CRM_Price_Form_Option">CRM_Price_Form_Option</abbr></a></dt><dd>form to process actions on the field aspect of Custom</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Price-Form-Preview.html"><abbr title="\CRM_Price_Form_Preview">CRM_Price_Form_Preview</abbr></a></dt><dd>This class generates form components for previewing custom data</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Price-Form-Set.html"><abbr title="\CRM_Price_Form_Set">CRM_Price_Form_Set</abbr></a></dt><dd>Form to process actions on Price Sets.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Price-Page-Field.html"><abbr title="\CRM_Price_Page_Field">CRM_Price_Page_Field</abbr></a></dt><dd>Create a page for displaying Price Fields.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Price-Page-Option.html"><abbr title="\CRM_Price_Page_Option">CRM_Price_Page_Option</abbr></a></dt><dd>Create a page for displaying Custom Options.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Price-Page-Set.html"><abbr title="\CRM_Price_Page_Set">CRM_Price_Page_Set</abbr></a></dt><dd>Create a page for displaying Price Sets.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Profile-Form-Dynamic.html"><abbr title="\CRM_Profile_Form_Dynamic">CRM_Profile_Form_Dynamic</abbr></a></dt><dd>This class generates form components for custom data</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Profile-Form-Edit.html"><abbr title="\CRM_Profile_Form_Edit">CRM_Profile_Form_Edit</abbr></a></dt><dd>This class generates form components for custom data</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Profile-Form-Search.html"><abbr title="\CRM_Profile_Form_Search">CRM_Profile_Form_Search</abbr></a></dt><dd>This class generates form components generic to all the contact types.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Profile-Form.html"><abbr title="\CRM_Profile_Form">CRM_Profile_Form</abbr></a></dt><dd>This class generates form components for custom data</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Profile-Page-Dynamic.html"><abbr title="\CRM_Profile_Page_Dynamic">CRM_Profile_Page_Dynamic</abbr></a></dt><dd>Create a page for displaying CiviCRM Profile Fields.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Profile-Page-Listings.html"><abbr title="\CRM_Profile_Page_Listings">CRM_Profile_Page_Listings</abbr></a></dt><dd>This implements the profile page for all contacts. It uses a selector
object to do the actual display. The fields displayed are controlled by
the admin.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Profile-Page-MultipleRecordFieldsListing.html"><abbr title="\CRM_Profile_Page_MultipleRecordFieldsListing">CRM_Profile_Page_MultipleRecordFieldsListing</abbr></a></dt><dd>A Page is basically data in a nice pretty format.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Profile-Page-Router.html"><abbr title="\CRM_Profile_Page_Router">CRM_Profile_Page_Router</abbr></a></dt><dd>This is some kind of special-purpose router/front-controller for the various profile URLs.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Profile-Page-View.html"><abbr title="\CRM_Profile_Page_View">CRM_Profile_Page_View</abbr></a></dt><dd>Main page for viewing contact.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Profile-Selector-Listings.html"><abbr title="\CRM_Profile_Selector_Listings">CRM_Profile_Selector_Listings</abbr></a></dt><dd>This class is used to retrieve and display a range of
contacts that match the given criteria (specifically for
results of advanced search options.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Queue-BAO-Queue.html"><abbr title="\CRM_Queue_BAO_Queue">CRM_Queue_BAO_Queue</abbr></a></dt><dd>Track a list of known queues.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Queue-BAO-QueueItem.html"><abbr title="\CRM_Queue_BAO_QueueItem">CRM_Queue_BAO_QueueItem</abbr></a></dt><dd>Helpers for managing SQL-backed queue items</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Queue-DAO-Queue.html"><abbr title="\CRM_Queue_DAO_Queue">CRM_Queue_DAO_Queue</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Queue-DAO-QueueItem.html"><abbr title="\CRM_Queue_DAO_QueueItem">CRM_Queue_DAO_QueueItem</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Queue-ErrorPolicy.html"><abbr title="\CRM_Queue_ErrorPolicy">CRM_Queue_ErrorPolicy</abbr></a></dt><dd>To ensure that PHP errors or unhandled exceptions are reported in JSON
format, wrap this around your code. For example:</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Queue-Menu.html"><abbr title="\CRM_Queue_Menu">CRM_Queue_Menu</abbr></a></dt><dd>Class CRM_Queue_Menu</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Queue-Page-AJAX.html"><abbr title="\CRM_Queue_Page_AJAX">CRM_Queue_Page_AJAX</abbr></a></dt><dd>Class CRM_Queue_Page_AJAX</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Queue-Page-Monitor.html"><abbr title="\CRM_Queue_Page_Monitor">CRM_Queue_Page_Monitor</abbr></a></dt><dd>The queue-monitor page provides an interactive, web-based system
running the tasks in a queue and monitoring its progression.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Queue-Page-Runner.html"><abbr title="\CRM_Queue_Page_Runner">CRM_Queue_Page_Runner</abbr></a></dt><dd>The queue-runner page provides an interactive, web-based system
running the tasks in a queue and monitoring its progression.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Queue-Queue-Memory.html"><abbr title="\CRM_Queue_Queue_Memory">CRM_Queue_Queue_Memory</abbr></a></dt><dd>A queue implementation which stores items in the CiviCRM SQL database</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Queue-Queue-Sql.html"><abbr title="\CRM_Queue_Queue_Sql">CRM_Queue_Queue_Sql</abbr></a></dt><dd>A queue implementation which stores items in the CiviCRM SQL database</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Queue-Queue-SqlParallel.html"><abbr title="\CRM_Queue_Queue_SqlParallel">CRM_Queue_Queue_SqlParallel</abbr></a></dt><dd>A queue implementation which stores items in the CiviCRM SQL database</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Queue-Queue.html"><abbr title="\CRM_Queue_Queue">CRM_Queue_Queue</abbr></a></dt><dd>A queue is an object (usually backed by some persistent data store)
which stores a list of tasks or messages for use by other processes.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Queue-Runner.html"><abbr title="\CRM_Queue_Runner">CRM_Queue_Runner</abbr></a></dt><dd>`CRM_Queue_Runner` runs a list tasks from a queue. It originally supported the database-upgrade
queue. Consequently, this runner is optimal for queues which are:</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Queue-Service.html"><abbr title="\CRM_Queue_Service">CRM_Queue_Service</abbr></a></dt><dd>The queue service provides an interface for creating or locating
queues. Note that this approach hides the details of data-storage:
different queue-providers may store the queue content in different
ways (in memory, in SQL, or in an external service).</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Queue-Task.html"><abbr title="\CRM_Queue_Task">CRM_Queue_Task</abbr></a></dt><dd>A task is an item that can be enqueued and later executed</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Queue-TaskContext.html"><abbr title="\CRM_Queue_TaskContext">CRM_Queue_TaskContext</abbr></a></dt><dd>Describe the runtime environment in which a queue task executes</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Queue-TaskRunner.html"><abbr title="\CRM_Queue_TaskRunner">CRM_Queue_TaskRunner</abbr></a></dt><dd>`CRM_Queue_TaskRunner` a list tasks from a queue. It is designed to supported background
tasks which run automatically.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-BAO-Hook.html"><abbr title="\CRM_Report_BAO_Hook">CRM_Report_BAO_Hook</abbr></a></dt><dd>Report hooks that allow extending a particular report.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-BAO-HookInterface.html"><abbr title="\CRM_Report_BAO_HookInterface">CRM_Report_BAO_HookInterface</abbr></a></dt><dd>Interface class for Report hook query objects</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-BAO-ReportInstance.html"><abbr title="\CRM_Report_BAO_ReportInstance">CRM_Report_BAO_ReportInstance</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-DAO-ReportInstance.html"><abbr title="\CRM_Report_DAO_ReportInstance">CRM_Report_DAO_ReportInstance</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form-Activity.html"><abbr title="\CRM_Report_Form_Activity">CRM_Report_Form_Activity</abbr></a></dt><dd>Class CRM_Report_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form-ActivitySummary.html"><abbr title="\CRM_Report_Form_ActivitySummary">CRM_Report_Form_ActivitySummary</abbr></a></dt><dd>Class CRM_Report_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form-Campaign-SurveyDetails.html"><abbr title="\CRM_Report_Form_Campaign_SurveyDetails">CRM_Report_Form_Campaign_SurveyDetails</abbr></a></dt><dd>Class CRM_Report_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form-Case-Demographics.html"><abbr title="\CRM_Report_Form_Case_Demographics">CRM_Report_Form_Case_Demographics</abbr></a></dt><dd>Class CRM_Report_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form-Case-Detail.html"><abbr title="\CRM_Report_Form_Case_Detail">CRM_Report_Form_Case_Detail</abbr></a></dt><dd>Class CRM_Report_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form-Case-Summary.html"><abbr title="\CRM_Report_Form_Case_Summary">CRM_Report_Form_Case_Summary</abbr></a></dt><dd>Class CRM_Report_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form-Case-TimeSpent.html"><abbr title="\CRM_Report_Form_Case_TimeSpent">CRM_Report_Form_Case_TimeSpent</abbr></a></dt><dd>Class CRM_Report_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form-Contact-CurrentEmployer.html"><abbr title="\CRM_Report_Form_Contact_CurrentEmployer">CRM_Report_Form_Contact_CurrentEmployer</abbr></a></dt><dd>Class CRM_Report_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form-Contact-Detail.html"><abbr title="\CRM_Report_Form_Contact_Detail">CRM_Report_Form_Contact_Detail</abbr></a></dt><dd>Class CRM_Report_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form-Contact-Log.html"><abbr title="\CRM_Report_Form_Contact_Log">CRM_Report_Form_Contact_Log</abbr></a></dt><dd>Class CRM_Report_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form-Contact-LoggingDetail.html"><abbr title="\CRM_Report_Form_Contact_LoggingDetail">CRM_Report_Form_Contact_LoggingDetail</abbr></a></dt><dd>Class CRM_Report_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form-Contact-LoggingSummary.html"><abbr title="\CRM_Report_Form_Contact_LoggingSummary">CRM_Report_Form_Contact_LoggingSummary</abbr></a></dt><dd>Class CRM_Logging_ReportSummary</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form-Contact-Relationship.html"><abbr title="\CRM_Report_Form_Contact_Relationship">CRM_Report_Form_Contact_Relationship</abbr></a></dt><dd>Class CRM_Report_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form-Contact-Summary.html"><abbr title="\CRM_Report_Form_Contact_Summary">CRM_Report_Form_Contact_Summary</abbr></a></dt><dd>Class CRM_Report_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form-Contribute-Bookkeeping.html"><abbr title="\CRM_Report_Form_Contribute_Bookkeeping">CRM_Report_Form_Contribute_Bookkeeping</abbr></a></dt><dd>Class CRM_Report_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form-Contribute-DeferredRevenue.html"><abbr title="\CRM_Report_Form_Contribute_DeferredRevenue">CRM_Report_Form_Contribute_DeferredRevenue</abbr></a></dt><dd>Class CRM_Report_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form-Contribute-Detail.html"><abbr title="\CRM_Report_Form_Contribute_Detail">CRM_Report_Form_Contribute_Detail</abbr></a></dt><dd>Class CRM_Report_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form-Contribute-History.html"><abbr title="\CRM_Report_Form_Contribute_History">CRM_Report_Form_Contribute_History</abbr></a></dt><dd>Class CRM_Report_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form-Contribute-HouseholdSummary.html"><abbr title="\CRM_Report_Form_Contribute_HouseholdSummary">CRM_Report_Form_Contribute_HouseholdSummary</abbr></a></dt><dd>Class CRM_Report_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form-Contribute-Lybunt.html"><abbr title="\CRM_Report_Form_Contribute_Lybunt">CRM_Report_Form_Contribute_Lybunt</abbr></a></dt><dd>Class CRM_Report_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form-Contribute-OrganizationSummary.html"><abbr title="\CRM_Report_Form_Contribute_OrganizationSummary">CRM_Report_Form_Contribute_OrganizationSummary</abbr></a></dt><dd>Class CRM_Report_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form-Contribute-PCP.html"><abbr title="\CRM_Report_Form_Contribute_PCP">CRM_Report_Form_Contribute_PCP</abbr></a></dt><dd>Class CRM_Report_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form-Contribute-Recur.html"><abbr title="\CRM_Report_Form_Contribute_Recur">CRM_Report_Form_Contribute_Recur</abbr></a></dt><dd>Class CRM_Report_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form-Contribute-RecurSummary.html"><abbr title="\CRM_Report_Form_Contribute_RecurSummary">CRM_Report_Form_Contribute_RecurSummary</abbr></a></dt><dd>Class CRM_Report_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form-Contribute-Repeat.html"><abbr title="\CRM_Report_Form_Contribute_Repeat">CRM_Report_Form_Contribute_Repeat</abbr></a></dt><dd>Class CRM_Report_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form-Contribute-SoftCredit.html"><abbr title="\CRM_Report_Form_Contribute_SoftCredit">CRM_Report_Form_Contribute_SoftCredit</abbr></a></dt><dd>Class CRM_Report_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form-Contribute-Summary.html"><abbr title="\CRM_Report_Form_Contribute_Summary">CRM_Report_Form_Contribute_Summary</abbr></a></dt><dd>Class CRM_Report_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form-Contribute-Sybunt.html"><abbr title="\CRM_Report_Form_Contribute_Sybunt">CRM_Report_Form_Contribute_Sybunt</abbr></a></dt><dd>Class CRM_Report_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form-Contribute-TopDonor.html"><abbr title="\CRM_Report_Form_Contribute_TopDonor">CRM_Report_Form_Contribute_TopDonor</abbr></a></dt><dd>Class CRM_Report_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form-Event-Income.html"><abbr title="\CRM_Report_Form_Event_Income">CRM_Report_Form_Event_Income</abbr></a></dt><dd>Class CRM_Report_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form-Event-IncomeCountSummary.html"><abbr title="\CRM_Report_Form_Event_IncomeCountSummary">CRM_Report_Form_Event_IncomeCountSummary</abbr></a></dt><dd>Class CRM_Report_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form-Event-ParticipantListCount.html"><abbr title="\CRM_Report_Form_Event_ParticipantListCount">CRM_Report_Form_Event_ParticipantListCount</abbr></a></dt><dd>Class CRM_Report_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form-Event-ParticipantListing.html"><abbr title="\CRM_Report_Form_Event_ParticipantListing">CRM_Report_Form_Event_ParticipantListing</abbr></a></dt><dd>Class CRM_Report_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form-Event-Summary.html"><abbr title="\CRM_Report_Form_Event_Summary">CRM_Report_Form_Event_Summary</abbr></a></dt><dd>Class CRM_Report_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form-Instance.html"><abbr title="\CRM_Report_Form_Instance">CRM_Report_Form_Instance</abbr></a></dt><dd>Class CRM_Report_Form_Instance</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form-Mailing-Bounce.html"><abbr title="\CRM_Report_Form_Mailing_Bounce">CRM_Report_Form_Mailing_Bounce</abbr></a></dt><dd>Class CRM_Report_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form-Mailing-Clicks.html"><abbr title="\CRM_Report_Form_Mailing_Clicks">CRM_Report_Form_Mailing_Clicks</abbr></a></dt><dd>Class CRM_Report_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form-Mailing-Detail.html"><abbr title="\CRM_Report_Form_Mailing_Detail">CRM_Report_Form_Mailing_Detail</abbr></a></dt><dd>Class CRM_Report_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form-Mailing-Opened.html"><abbr title="\CRM_Report_Form_Mailing_Opened">CRM_Report_Form_Mailing_Opened</abbr></a></dt><dd>Class CRM_Report_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form-Mailing-Summary.html"><abbr title="\CRM_Report_Form_Mailing_Summary">CRM_Report_Form_Mailing_Summary</abbr></a></dt><dd>Class CRM_Report_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form-Member-ContributionDetail.html"><abbr title="\CRM_Report_Form_Member_ContributionDetail">CRM_Report_Form_Member_ContributionDetail</abbr></a></dt><dd>Class CRM_Report_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form-Member-Detail.html"><abbr title="\CRM_Report_Form_Member_Detail">CRM_Report_Form_Member_Detail</abbr></a></dt><dd>Class CRM_Report_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form-Member-Lapse.html"><abbr title="\CRM_Report_Form_Member_Lapse">CRM_Report_Form_Member_Lapse</abbr></a></dt><dd>Class CRM_Report_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form-Member-Summary.html"><abbr title="\CRM_Report_Form_Member_Summary">CRM_Report_Form_Member_Summary</abbr></a></dt><dd>Class CRM_Report_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form-Membership-Summary.html"><abbr title="\CRM_Report_Form_Membership_Summary">CRM_Report_Form_Membership_Summary</abbr></a></dt><dd>Class CRM_Report_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form-Pledge-Detail.html"><abbr title="\CRM_Report_Form_Pledge_Detail">CRM_Report_Form_Pledge_Detail</abbr></a></dt><dd>Class CRM_Report_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form-Pledge-Pbnp.html"><abbr title="\CRM_Report_Form_Pledge_Pbnp">CRM_Report_Form_Pledge_Pbnp</abbr></a></dt><dd>Class CRM_Report_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form-Pledge-Summary.html"><abbr title="\CRM_Report_Form_Pledge_Summary">CRM_Report_Form_Pledge_Summary</abbr></a></dt><dd>Class CRM_Report_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form-Register.html"><abbr title="\CRM_Report_Form_Register">CRM_Report_Form_Register</abbr></a></dt><dd>Class CRM_Core_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form-Walklist-Walklist.html"><abbr title="\CRM_Report_Form_Walklist_Walklist">CRM_Report_Form_Walklist_Walklist</abbr></a></dt><dd>Class CRM_Report_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form.html"><abbr title="\CRM_Report_Form">CRM_Report_Form</abbr></a></dt><dd>Class CRM_Report_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Info.html"><abbr title="\CRM_Report_Info">CRM_Report_Info</abbr></a></dt><dd>This class introduces component to the system and provides all the
information about it. It needs to extend CRM_Core_Component_Info
abstract class.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-OutputHandler-Csv.html"><abbr title="\CRM_Report_OutputHandler_Csv">CRM_Report_OutputHandler_Csv</abbr></a></dt><dd>CSV Report Output Handler</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-OutputHandler-Pdf.html"><abbr title="\CRM_Report_OutputHandler_Pdf">CRM_Report_OutputHandler_Pdf</abbr></a></dt><dd>PDF Report Output Handler</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-OutputHandler-Print.html"><abbr title="\CRM_Report_OutputHandler_Print">CRM_Report_OutputHandler_Print</abbr></a></dt><dd>CSV Report Output Handler</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Page-Instance.html"><abbr title="\CRM_Report_Page_Instance">CRM_Report_Page_Instance</abbr></a></dt><dd>Page for invoking report instances</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Page-InstanceList.html"><abbr title="\CRM_Report_Page_InstanceList">CRM_Report_Page_InstanceList</abbr></a></dt><dd>Page for invoking report instances.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Page-Options.html"><abbr title="\CRM_Report_Page_Options">CRM_Report_Page_Options</abbr></a></dt><dd>Page for displaying list of report options</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Page-Report.html"><abbr title="\CRM_Report_Page_Report">CRM_Report_Page_Report</abbr></a></dt><dd>Page for invoking report templates.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Page-TemplateList.html"><abbr title="\CRM_Report_Page_TemplateList">CRM_Report_Page_TemplateList</abbr></a></dt><dd>Page for displaying list of Report templates available.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Utils-Get.html"><abbr title="\CRM_Report_Utils_Get">CRM_Report_Utils_Get</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Utils-Report.html"><abbr title="\CRM_Report_Utils_Report">CRM_Report_Utils_Report</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-SMS-BAO-SmsProvider.html"><abbr title="\CRM_SMS_BAO_SmsProvider">CRM_SMS_BAO_SmsProvider</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-SMS-Controller-Send.html"><abbr title="\CRM_SMS_Controller_Send">CRM_SMS_Controller_Send</abbr></a></dt><dd>Class CRM_Core_Controller</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-SMS-DAO-SmsProvider.html"><abbr title="\CRM_SMS_DAO_SmsProvider">CRM_SMS_DAO_SmsProvider</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-SMS-Form-Group.html"><abbr title="\CRM_SMS_Form_Group">CRM_SMS_Form_Group</abbr></a></dt><dd>Choose include / exclude groups and mass sms.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-SMS-Form-Provider.html"><abbr title="\CRM_SMS_Form_Provider">CRM_SMS_Form_Provider</abbr></a></dt><dd>SMS Form.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-SMS-Form-Schedule.html"><abbr title="\CRM_SMS_Form_Schedule">CRM_SMS_Form_Schedule</abbr></a></dt><dd>Class CRM_Core_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-SMS-Form-Upload.html"><abbr title="\CRM_SMS_Form_Upload">CRM_SMS_Form_Upload</abbr></a></dt><dd>This file is used to build the form configuring mass sms details.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-SMS-Message.html"><abbr title="\CRM_SMS_Message">CRM_SMS_Message</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-SMS-Page-Callback.html"><abbr title="\CRM_SMS_Page_Callback">CRM_SMS_Page_Callback</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-SMS-Page-Provider.html"><abbr title="\CRM_SMS_Page_Provider">CRM_SMS_Page_Provider</abbr></a></dt><dd>Page for displaying list of Providers</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-SMS-Provider.html"><abbr title="\CRM_SMS_Provider">CRM_SMS_Provider</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-SMS-StateMachine-Send.html"><abbr title="\CRM_SMS_StateMachine_Send">CRM_SMS_StateMachine_Send</abbr></a></dt><dd>State machine for managing different states of the Import process.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Tag-Form-Edit.html"><abbr title="\CRM_Tag_Form_Edit">CRM_Tag_Form_Edit</abbr></a></dt><dd>This class generates form components for Tag.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Tag-Form-Merge.html"><abbr title="\CRM_Tag_Form_Merge">CRM_Tag_Form_Merge</abbr></a></dt><dd>Form for merging tags.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Tag-Form-Tag.html"><abbr title="\CRM_Tag_Form_Tag">CRM_Tag_Form_Tag</abbr></a></dt><dd>This class generates form components for tags</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Tag-Page-Tag.html"><abbr title="\CRM_Tag_Page_Tag">CRM_Tag_Page_Tag</abbr></a></dt><dd>Page for managing tags.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-UF-Form-AbstractPreview.html"><abbr title="\CRM_UF_Form_AbstractPreview">CRM_UF_Form_AbstractPreview</abbr></a></dt><dd>This class generates form components
for previewing Civicrm Profile Group</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-UF-Form-AdvanceSetting.html"><abbr title="\CRM_UF_Form_AdvanceSetting">CRM_UF_Form_AdvanceSetting</abbr></a></dt><dd>This class is for UF Group (Profile) configuration.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-UF-Form-Field.html"><abbr title="\CRM_UF_Form_Field">CRM_UF_Form_Field</abbr></a></dt><dd>Form to process actions on the field aspect of Custom.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-UF-Form-Group.html"><abbr title="\CRM_UF_Form_Group">CRM_UF_Form_Group</abbr></a></dt><dd>This class is for UF Group (Profile) configuration.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-UF-Form-Inline-Preview.html"><abbr title="\CRM_UF_Form_Inline_Preview">CRM_UF_Form_Inline_Preview</abbr></a></dt><dd>This class generates form components
for previewing Civicrm Profile Group</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-UF-Form-Inline-PreviewById.html"><abbr title="\CRM_UF_Form_Inline_PreviewById">CRM_UF_Form_Inline_PreviewById</abbr></a></dt><dd>This class generates form components
for previewing Civicrm Profile Group</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-UF-Form-Preview.html"><abbr title="\CRM_UF_Form_Preview">CRM_UF_Form_Preview</abbr></a></dt><dd>This class generates form components
for previewing Civicrm Profile Group</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-UF-Page-Field.html"><abbr title="\CRM_UF_Page_Field">CRM_UF_Page_Field</abbr></a></dt><dd>Create a page for displaying CiviCRM Profile Fields.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-UF-Page-Group.html"><abbr title="\CRM_UF_Page_Group">CRM_UF_Page_Group</abbr></a></dt><dd>Create a page for displaying UF Groups.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-UF-Page-ProfileEditor.html"><abbr title="\CRM_UF_Page_ProfileEditor">CRM_UF_Page_ProfileEditor</abbr></a></dt><dd>This class is not a real page -- it contains helpers for rendering the profile-selector and profile-editor
widgets</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Controller.html"><abbr title="\CRM_Upgrade_Controller">CRM_Upgrade_Controller</abbr></a></dt><dd>Class CRM_Core_Controller</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-DispatchPolicy.html"><abbr title="\CRM_Upgrade_DispatchPolicy">CRM_Upgrade_DispatchPolicy</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Form.html"><abbr title="\CRM_Upgrade_Form">CRM_Upgrade_Form</abbr></a></dt><dd>Class CRM_Upgrade_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Headless.html"><abbr title="\CRM_Upgrade_Headless">CRM_Upgrade_Headless</abbr></a></dt><dd>Perform an upgrade without using the web-frontend</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-Base.html"><abbr title="\CRM_Upgrade_Incremental_Base">CRM_Upgrade_Incremental_Base</abbr></a></dt><dd>Base class for incremental upgrades</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-General.html"><abbr title="\CRM_Upgrade_Incremental_General">CRM_Upgrade_Incremental_General</abbr></a></dt><dd>This class contains generic upgrade logic which runs regardless of version.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-MessageTemplates.html"><abbr title="\CRM_Upgrade_Incremental_MessageTemplates">CRM_Upgrade_Incremental_MessageTemplates</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveEight.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveEight">CRM_Upgrade_Incremental_php_FiveEight</abbr></a></dt><dd>Upgrade logic for FiveEight</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveEighteen.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveEighteen">CRM_Upgrade_Incremental_php_FiveEighteen</abbr></a></dt><dd>Upgrade logic for FiveEighteen</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveEighty.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveEighty">CRM_Upgrade_Incremental_php_FiveEighty</abbr></a></dt><dd>Upgrade logic for the 5.80.x series.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveEightyOne.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveEightyOne">CRM_Upgrade_Incremental_php_FiveEightyOne</abbr></a></dt><dd>Upgrade logic for the 5.81.x series.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveEleven.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveEleven">CRM_Upgrade_Incremental_php_FiveEleven</abbr></a></dt><dd>Upgrade logic for FiveEleven</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveFifteen.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveFifteen">CRM_Upgrade_Incremental_php_FiveFifteen</abbr></a></dt><dd>Upgrade logic for FiveFifteen</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveFifty.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveFifty">CRM_Upgrade_Incremental_php_FiveFifty</abbr></a></dt><dd>Upgrade logic for the 5.50.x series.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveFiftyEight.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveFiftyEight">CRM_Upgrade_Incremental_php_FiveFiftyEight</abbr></a></dt><dd>Upgrade logic for the 5.58.x series.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveFiftyFive.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveFiftyFive">CRM_Upgrade_Incremental_php_FiveFiftyFive</abbr></a></dt><dd>Upgrade logic for the 5.55.x series.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveFiftyFour.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveFiftyFour">CRM_Upgrade_Incremental_php_FiveFiftyFour</abbr></a></dt><dd>Upgrade logic for the 5.54.x series.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveFiftyNine.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveFiftyNine">CRM_Upgrade_Incremental_php_FiveFiftyNine</abbr></a></dt><dd>Upgrade logic for the 5.59.x series.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveFiftyOne.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveFiftyOne">CRM_Upgrade_Incremental_php_FiveFiftyOne</abbr></a></dt><dd>Upgrade logic for the 5.51.x series.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveFiftySeven.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveFiftySeven">CRM_Upgrade_Incremental_php_FiveFiftySeven</abbr></a></dt><dd>Upgrade logic for the 5.57.x series.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveFiftySix.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveFiftySix">CRM_Upgrade_Incremental_php_FiveFiftySix</abbr></a></dt><dd>Upgrade logic for the 5.56.x series.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveFiftyThree.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveFiftyThree">CRM_Upgrade_Incremental_php_FiveFiftyThree</abbr></a></dt><dd>Upgrade logic for the 5.53.x series.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveFiftyTwo.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveFiftyTwo">CRM_Upgrade_Incremental_php_FiveFiftyTwo</abbr></a></dt><dd>Upgrade logic for the 5.52.x series.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveFive.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveFive">CRM_Upgrade_Incremental_php_FiveFive</abbr></a></dt><dd>Upgrade logic for FiveFive</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveForty.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveForty">CRM_Upgrade_Incremental_php_FiveForty</abbr></a></dt><dd>Upgrade logic for FiveForty</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveFortyEight.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveFortyEight">CRM_Upgrade_Incremental_php_FiveFortyEight</abbr></a></dt><dd>Upgrade logic for the 5.48.x series.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveFortyFive.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveFortyFive">CRM_Upgrade_Incremental_php_FiveFortyFive</abbr></a></dt><dd>Upgrade logic for FiveFortyFive</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveFortyFour.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveFortyFour">CRM_Upgrade_Incremental_php_FiveFortyFour</abbr></a></dt><dd>Upgrade logic for FiveFortyFour</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveFortyNine.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveFortyNine">CRM_Upgrade_Incremental_php_FiveFortyNine</abbr></a></dt><dd>Upgrade logic for the 5.49.x series.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveFortyOne.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveFortyOne">CRM_Upgrade_Incremental_php_FiveFortyOne</abbr></a></dt><dd>Upgrade logic for FiveFortyOne</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveFortySeven.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveFortySeven">CRM_Upgrade_Incremental_php_FiveFortySeven</abbr></a></dt><dd>Upgrade logic for the 5.47.x series.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveFortySix.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveFortySix">CRM_Upgrade_Incremental_php_FiveFortySix</abbr></a></dt><dd>Upgrade logic for FiveFortySix</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveFortyThree.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveFortyThree">CRM_Upgrade_Incremental_php_FiveFortyThree</abbr></a></dt><dd>Upgrade logic for FiveFortyThree</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveFortyTwo.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveFortyTwo">CRM_Upgrade_Incremental_php_FiveFortyTwo</abbr></a></dt><dd>Upgrade logic for FiveFortyTwo</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveFour.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveFour">CRM_Upgrade_Incremental_php_FiveFour</abbr></a></dt><dd>Upgrade logic for FiveFour</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveFourteen.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveFourteen">CRM_Upgrade_Incremental_php_FiveFourteen</abbr></a></dt><dd>Upgrade logic for FiveFourteen</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveNine.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveNine">CRM_Upgrade_Incremental_php_FiveNine</abbr></a></dt><dd>Upgrade logic for FiveNine</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveNineteen.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveNineteen">CRM_Upgrade_Incremental_php_FiveNineteen</abbr></a></dt><dd>Upgrade logic for FiveNineteen</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveOne.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveOne">CRM_Upgrade_Incremental_php_FiveOne</abbr></a></dt><dd>Upgrade logic for FiveOne</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveSeven.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveSeven">CRM_Upgrade_Incremental_php_FiveSeven</abbr></a></dt><dd>Upgrade logic for FiveSeven</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveSeventeen.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveSeventeen">CRM_Upgrade_Incremental_php_FiveSeventeen</abbr></a></dt><dd>Upgrade logic for FiveSeventeen</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveSeventy.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveSeventy">CRM_Upgrade_Incremental_php_FiveSeventy</abbr></a></dt><dd>Upgrade logic for the 5.70.x series.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveSeventyEight.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveSeventyEight">CRM_Upgrade_Incremental_php_FiveSeventyEight</abbr></a></dt><dd>Upgrade logic for the 5.78.x series.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveSeventyFive.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveSeventyFive">CRM_Upgrade_Incremental_php_FiveSeventyFive</abbr></a></dt><dd>Upgrade logic for the 5.75.x series.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveSeventyFour.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveSeventyFour">CRM_Upgrade_Incremental_php_FiveSeventyFour</abbr></a></dt><dd>Upgrade logic for the 5.74.x series.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveSeventyNine.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveSeventyNine">CRM_Upgrade_Incremental_php_FiveSeventyNine</abbr></a></dt><dd>Upgrade logic for the 5.79.x series.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveSeventyOne.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveSeventyOne">CRM_Upgrade_Incremental_php_FiveSeventyOne</abbr></a></dt><dd>Upgrade logic for the 5.71.x series.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveSeventySeven.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveSeventySeven">CRM_Upgrade_Incremental_php_FiveSeventySeven</abbr></a></dt><dd>Upgrade logic for the 5.77.x series.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveSeventySix.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveSeventySix">CRM_Upgrade_Incremental_php_FiveSeventySix</abbr></a></dt><dd>Upgrade logic for the 5.76.x series.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveSeventyThree.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveSeventyThree">CRM_Upgrade_Incremental_php_FiveSeventyThree</abbr></a></dt><dd>Upgrade logic for the 5.73.x series.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveSeventyTwo.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveSeventyTwo">CRM_Upgrade_Incremental_php_FiveSeventyTwo</abbr></a></dt><dd>Upgrade logic for the 5.72.x series.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveSix.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveSix">CRM_Upgrade_Incremental_php_FiveSix</abbr></a></dt><dd>Upgrade logic for FiveSix</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveSixteen.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveSixteen">CRM_Upgrade_Incremental_php_FiveSixteen</abbr></a></dt><dd>Upgrade logic for FiveSixteen</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveSixty.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveSixty">CRM_Upgrade_Incremental_php_FiveSixty</abbr></a></dt><dd>Upgrade logic for the 5.60.x series.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveSixtyEight.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveSixtyEight">CRM_Upgrade_Incremental_php_FiveSixtyEight</abbr></a></dt><dd>Upgrade logic for the 5.68.x series.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveSixtyFive.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveSixtyFive">CRM_Upgrade_Incremental_php_FiveSixtyFive</abbr></a></dt><dd>Upgrade logic for the 5.65.x series.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveSixtyFour.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveSixtyFour">CRM_Upgrade_Incremental_php_FiveSixtyFour</abbr></a></dt><dd>Upgrade logic for the 5.64.x series.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveSixtyNine.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveSixtyNine">CRM_Upgrade_Incremental_php_FiveSixtyNine</abbr></a></dt><dd>Upgrade logic for the 5.69.x series.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveSixtyOne.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveSixtyOne">CRM_Upgrade_Incremental_php_FiveSixtyOne</abbr></a></dt><dd>Upgrade logic for the 5.61.x series.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveSixtySeven.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveSixtySeven">CRM_Upgrade_Incremental_php_FiveSixtySeven</abbr></a></dt><dd>Upgrade logic for the 5.67.x series.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveSixtySix.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveSixtySix">CRM_Upgrade_Incremental_php_FiveSixtySix</abbr></a></dt><dd>Upgrade logic for the 5.66.x series.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveSixtyThree.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveSixtyThree">CRM_Upgrade_Incremental_php_FiveSixtyThree</abbr></a></dt><dd>Upgrade logic for the 5.63.x series.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveSixtyTwo.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveSixtyTwo">CRM_Upgrade_Incremental_php_FiveSixtyTwo</abbr></a></dt><dd>Upgrade logic for the 5.62.x series.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveTen.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveTen">CRM_Upgrade_Incremental_php_FiveTen</abbr></a></dt><dd>Upgrade logic for FiveTen</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveThirteen.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveThirteen">CRM_Upgrade_Incremental_php_FiveThirteen</abbr></a></dt><dd>Upgrade logic for FiveThirteen</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveThirty.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveThirty">CRM_Upgrade_Incremental_php_FiveThirty</abbr></a></dt><dd>Upgrade logic for FiveThirty</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveThirtyEight.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveThirtyEight">CRM_Upgrade_Incremental_php_FiveThirtyEight</abbr></a></dt><dd>Upgrade logic for FiveThirtyEight</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveThirtyFive.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveThirtyFive">CRM_Upgrade_Incremental_php_FiveThirtyFive</abbr></a></dt><dd>Upgrade logic for FiveThirtyFive</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveThirtyFour.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveThirtyFour">CRM_Upgrade_Incremental_php_FiveThirtyFour</abbr></a></dt><dd>Upgrade logic for FiveThirtyFour</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveThirtyNine.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveThirtyNine">CRM_Upgrade_Incremental_php_FiveThirtyNine</abbr></a></dt><dd>Upgrade logic for FiveThirtyNine</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveThirtyOne.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveThirtyOne">CRM_Upgrade_Incremental_php_FiveThirtyOne</abbr></a></dt><dd>Upgrade logic for FiveThirtyOne</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveThirtySeven.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveThirtySeven">CRM_Upgrade_Incremental_php_FiveThirtySeven</abbr></a></dt><dd>Upgrade logic for FiveThirtySeven</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveThirtySix.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveThirtySix">CRM_Upgrade_Incremental_php_FiveThirtySix</abbr></a></dt><dd>Upgrade logic for FiveThirtySix</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveThirtyThree.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveThirtyThree">CRM_Upgrade_Incremental_php_FiveThirtyThree</abbr></a></dt><dd>Upgrade logic for FiveThirtyThree</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveThirtyTwo.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveThirtyTwo">CRM_Upgrade_Incremental_php_FiveThirtyTwo</abbr></a></dt><dd>Upgrade logic for FiveThirtyTwo</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveThree.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveThree">CRM_Upgrade_Incremental_php_FiveThree</abbr></a></dt><dd>Upgrade logic for FiveThree</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveTwelve.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveTwelve">CRM_Upgrade_Incremental_php_FiveTwelve</abbr></a></dt><dd>Upgrade logic for FiveTwelve</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveTwenty.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveTwenty">CRM_Upgrade_Incremental_php_FiveTwenty</abbr></a></dt><dd>Upgrade logic for FiveTwenty</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveTwentyEight.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveTwentyEight">CRM_Upgrade_Incremental_php_FiveTwentyEight</abbr></a></dt><dd>Upgrade logic for FiveTwentyEight</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveTwentyFive.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveTwentyFive">CRM_Upgrade_Incremental_php_FiveTwentyFive</abbr></a></dt><dd>Upgrade logic for FiveTwentyFive</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveTwentyFour.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveTwentyFour">CRM_Upgrade_Incremental_php_FiveTwentyFour</abbr></a></dt><dd>Upgrade logic for FiveTwentyFour</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveTwentyNine.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveTwentyNine">CRM_Upgrade_Incremental_php_FiveTwentyNine</abbr></a></dt><dd>Upgrade logic for FiveTwentyNine</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveTwentyOne.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveTwentyOne">CRM_Upgrade_Incremental_php_FiveTwentyOne</abbr></a></dt><dd>Upgrade logic for FiveTwentyOne</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveTwentySeven.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveTwentySeven">CRM_Upgrade_Incremental_php_FiveTwentySeven</abbr></a></dt><dd>Upgrade logic for FiveTwentySeven</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveTwentySix.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveTwentySix">CRM_Upgrade_Incremental_php_FiveTwentySix</abbr></a></dt><dd>Upgrade logic for FiveTwentySix</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveTwentyThree.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveTwentyThree">CRM_Upgrade_Incremental_php_FiveTwentyThree</abbr></a></dt><dd>Upgrade logic for FiveTwentyThree</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveTwentyTwo.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveTwentyTwo">CRM_Upgrade_Incremental_php_FiveTwentyTwo</abbr></a></dt><dd>Upgrade logic for FiveTwentyTwo</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveTwo.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveTwo">CRM_Upgrade_Incremental_php_FiveTwo</abbr></a></dt><dd>Upgrade logic for FiveTwo</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveZero.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveZero">CRM_Upgrade_Incremental_php_FiveZero</abbr></a></dt><dd>Upgrade logic for 5.0</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FourSeven.html"><abbr title="\CRM_Upgrade_Incremental_php_FourSeven">CRM_Upgrade_Incremental_php_FourSeven</abbr></a></dt><dd>Upgrade logic for 4.7</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-SmartGroups.html"><abbr title="\CRM_Upgrade_Incremental_SmartGroups">CRM_Upgrade_Incremental_SmartGroups</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Page-Upgrade.html"><abbr title="\CRM_Upgrade_Page_Upgrade">CRM_Upgrade_Page_Upgrade</abbr></a></dt><dd>A Page is basically data in a nice pretty format.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Snapshot.html"><abbr title="\CRM_Upgrade_Snapshot">CRM_Upgrade_Snapshot</abbr></a></dt><dd>Provide helpers for recording data snapshots during an upgrade.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-StateMachine.html"><abbr title="\CRM_Upgrade_StateMachine">CRM_Upgrade_StateMachine</abbr></a></dt><dd>State machine for managing different states of the upgrade process.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Address-BatchUpdate.html"><abbr title="\CRM_Utils_Address_BatchUpdate">CRM_Utils_Address_BatchUpdate</abbr></a></dt><dd>A PHP cron script to format all the addresses in the database. Currently
it only does geocoding if the geocode values are not set. At a later
stage we will also handle USPS address cleanup and other formatting
issues</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Address-USPS.html"><abbr title="\CRM_Utils_Address_USPS">CRM_Utils_Address_USPS</abbr></a></dt><dd>Address utilities.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Address.html"><abbr title="\CRM_Utils_Address">CRM_Utils_Address</abbr></a></dt><dd>Address Utilities</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-API-AbstractFieldCoder.html"><abbr title="\CRM_Utils_API_AbstractFieldCoder">CRM_Utils_API_AbstractFieldCoder</abbr></a></dt><dd>Class CRM_Utils_API_AbstractFieldCoder.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-API-HTMLInputCoder.html"><abbr title="\CRM_Utils_API_HTMLInputCoder">CRM_Utils_API_HTMLInputCoder</abbr></a></dt><dd>This class captures the encoding practices of CRM-5667 in a reusable
fashion. In this design, all submitted values are partially HTML-encoded
before saving to the database. If a DB reader needs to output in
non-HTML medium, then it should undo the partial HTML encoding.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-API-MatchOption.html"><abbr title="\CRM_Utils_API_MatchOption">CRM_Utils_API_MatchOption</abbr></a></dt><dd>Class CRM_Utils_API_MatchOption</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-API-NullOutputCoder.html"><abbr title="\CRM_Utils_API_NullOutputCoder">CRM_Utils_API_NullOutputCoder</abbr></a></dt><dd>Class CRM_Utils_API_NullOutputCoder</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-API-ReloadOption.html"><abbr title="\CRM_Utils_API_ReloadOption">CRM_Utils_API_ReloadOption</abbr></a></dt><dd>Class CRM_Utils_API_ReloadOption</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Array.html"><abbr title="\CRM_Utils_Array">CRM_Utils_Array</abbr></a></dt><dd>Provides a collection of static methods for array manipulation.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-AutoClean.html"><abbr title="\CRM_Utils_AutoClean">CRM_Utils_AutoClean</abbr></a></dt><dd>Class CRM_Utils_AutoClean</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Cache-APCcache.html"><abbr title="\CRM_Utils_Cache_APCcache">CRM_Utils_Cache_APCcache</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Cache-APCucache.html"><abbr title="\CRM_Utils_Cache_APCucache">CRM_Utils_Cache_APCucache</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Cache-ArrayCache.html"><abbr title="\CRM_Utils_Cache_ArrayCache">CRM_Utils_Cache_ArrayCache</abbr></a></dt><dd>Class CRM_Utils_Cache_ArrayCache</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Cache-ArrayDecorator.html"><abbr title="\CRM_Utils_Cache_ArrayDecorator">CRM_Utils_Cache_ArrayDecorator</abbr></a></dt><dd>Class CRM_Utils_Cache_ArrayDecorator</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Cache-CacheException.html"><abbr title="\CRM_Utils_Cache_CacheException">CRM_Utils_Cache_CacheException</abbr></a></dt><dd>Class CRM_Utils_Cache_CacheException</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Cache-CacheWrapper.html"><abbr title="\CRM_Utils_Cache_CacheWrapper">CRM_Utils_Cache_CacheWrapper</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Cache-FastArrayDecorator.html"><abbr title="\CRM_Utils_Cache_FastArrayDecorator">CRM_Utils_Cache_FastArrayDecorator</abbr></a></dt><dd>Class CRM_Utils_Cache_FastArrayDecorator</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Cache-InvalidArgumentException.html"><abbr title="\CRM_Utils_Cache_InvalidArgumentException">CRM_Utils_Cache_InvalidArgumentException</abbr></a></dt><dd>Class CRM_Utils_Cache_InvalidArgumentException</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Cache-Memcache.html"><abbr title="\CRM_Utils_Cache_Memcache">CRM_Utils_Cache_Memcache</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Cache-Memcached.html"><abbr title="\CRM_Utils_Cache_Memcached">CRM_Utils_Cache_Memcached</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Cache-NoCache.html"><abbr title="\CRM_Utils_Cache_NoCache">CRM_Utils_Cache_NoCache</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Cache-Redis.html"><abbr title="\CRM_Utils_Cache_Redis">CRM_Utils_Cache_Redis</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Cache-SqlGroup.html"><abbr title="\CRM_Utils_Cache_SqlGroup">CRM_Utils_Cache_SqlGroup</abbr></a></dt><dd>This caching provider stores all cached items as a "group" in the
"civicrm_cache" table. The entire 'group' may be prefetched when
instantiating the cache provider.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Cache-Tiered.html"><abbr title="\CRM_Utils_Cache_Tiered">CRM_Utils_Cache_Tiered</abbr></a></dt><dd>Class CRM_Utils_Cache_Tiered</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Cache.html"><abbr title="\CRM_Utils_Cache">CRM_Utils_Cache</abbr></a></dt><dd>Cache is an empty base object, we'll modify the scheme when we have different caching schemes</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Chart.html"><abbr title="\CRM_Utils_Chart">CRM_Utils_Chart</abbr></a></dt><dd>Build various graphs using the dc chart library.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Check-Component-AddressParsing.html"><abbr title="\CRM_Utils_Check_Component_AddressParsing">CRM_Utils_Check_Component_AddressParsing</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Check-Component-Case.html"><abbr title="\CRM_Utils_Check_Component_Case">CRM_Utils_Check_Component_Case</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Check-Component-Cms.html"><abbr title="\CRM_Utils_Check_Component_Cms">CRM_Utils_Check_Component_Cms</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Check-Component-ContactTypes.html"><abbr title="\CRM_Utils_Check_Component_ContactTypes">CRM_Utils_Check_Component_ContactTypes</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Check-Component-DedupeRules.html"><abbr title="\CRM_Utils_Check_Component_DedupeRules">CRM_Utils_Check_Component_DedupeRules</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Check-Component-Env.html"><abbr title="\CRM_Utils_Check_Component_Env">CRM_Utils_Check_Component_Env</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Check-Component-LocationTypes.html"><abbr title="\CRM_Utils_Check_Component_LocationTypes">CRM_Utils_Check_Component_LocationTypes</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Check-Component-Mailing.html"><abbr title="\CRM_Utils_Check_Component_Mailing">CRM_Utils_Check_Component_Mailing</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Check-Component-OptionGroups.html"><abbr title="\CRM_Utils_Check_Component_OptionGroups">CRM_Utils_Check_Component_OptionGroups</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Check-Component-PriceFields.html"><abbr title="\CRM_Utils_Check_Component_PriceFields">CRM_Utils_Check_Component_PriceFields</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Check-Component-Schema.html"><abbr title="\CRM_Utils_Check_Component_Schema">CRM_Utils_Check_Component_Schema</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Check-Component-Security.html"><abbr title="\CRM_Utils_Check_Component_Security">CRM_Utils_Check_Component_Security</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Check-Component-Smarty.html"><abbr title="\CRM_Utils_Check_Component_Smarty">CRM_Utils_Check_Component_Smarty</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Check-Component-Source.html"><abbr title="\CRM_Utils_Check_Component_Source">CRM_Utils_Check_Component_Source</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Check-Component-Timestamps.html"><abbr title="\CRM_Utils_Check_Component_Timestamps">CRM_Utils_Check_Component_Timestamps</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Check-Component-Tokens.html"><abbr title="\CRM_Utils_Check_Component_Tokens">CRM_Utils_Check_Component_Tokens</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Check-Component.html"><abbr title="\CRM_Utils_Check_Component">CRM_Utils_Check_Component</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Check-Message.html"><abbr title="\CRM_Utils_Check_Message">CRM_Utils_Check_Message</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Check.html"><abbr title="\CRM_Utils_Check">CRM_Utils_Check</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Color.html"><abbr title="\CRM_Utils_Color">CRM_Utils_Color</abbr></a></dt><dd>Static utility functions for working with colors</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-ConsoleTee.html"><abbr title="\CRM_Utils_ConsoleTee">CRM_Utils_ConsoleTee</abbr></a></dt><dd>Capture the output from the console, copy it to a file, and pass it on.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Constant.html"><abbr title="\CRM_Utils_Constant">CRM_Utils_Constant</abbr></a></dt><dd>Class CRM_Utils_Constant</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Crypt.html"><abbr title="\CRM_Utils_Crypt">CRM_Utils_Crypt</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Date.html"><abbr title="\CRM_Utils_Date">CRM_Utils_Date</abbr></a></dt><dd>Date utilties</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-EchoLogger.html"><abbr title="\CRM_Utils_EchoLogger">CRM_Utils_EchoLogger</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-EnglishNumber.html"><abbr title="\CRM_Utils_EnglishNumber">CRM_Utils_EnglishNumber</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-FakeObject.html"><abbr title="\CRM_Utils_FakeObject">CRM_Utils_FakeObject</abbr></a></dt><dd>This is a quick-and-dirty way to define a vaguely-class-ish structure. It's non-performant, abnormal,
and not a complete OOP system. Only use for testing/mocking.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-File.html"><abbr title="\CRM_Utils_File">CRM_Utils_File</abbr></a></dt><dd>class to provide simple static functions for file objects</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Geocode-Google.html"><abbr title="\CRM_Utils_Geocode_Google">CRM_Utils_Geocode_Google</abbr></a></dt><dd>Class that uses google geocoder</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-GeocodeProvider.html"><abbr title="\CRM_Utils_GeocodeProvider">CRM_Utils_GeocodeProvider</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-GlobalStack.html"><abbr title="\CRM_Utils_GlobalStack">CRM_Utils_GlobalStack</abbr></a></dt><dd>Temporarily change a global variable.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-GuzzleMiddleware.html"><abbr title="\CRM_Utils_GuzzleMiddleware">CRM_Utils_GuzzleMiddleware</abbr></a></dt><dd>Additional helpers/utilities for use as Guzzle middleware.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Hook-Backdrop.html"><abbr title="\CRM_Utils_Hook_Backdrop">CRM_Utils_Hook_Backdrop</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Hook-Drupal.html"><abbr title="\CRM_Utils_Hook_Drupal">CRM_Utils_Hook_Drupal</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Hook-Drupal8.html"><abbr title="\CRM_Utils_Hook_Drupal8">CRM_Utils_Hook_Drupal8</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Hook-DrupalBase.html"><abbr title="\CRM_Utils_Hook_DrupalBase">CRM_Utils_Hook_DrupalBase</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Hook-Joomla.html"><abbr title="\CRM_Utils_Hook_Joomla">CRM_Utils_Hook_Joomla</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Hook-Soap.html"><abbr title="\CRM_Utils_Hook_Soap">CRM_Utils_Hook_Soap</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Hook-Standalone.html"><abbr title="\CRM_Utils_Hook_Standalone">CRM_Utils_Hook_Standalone</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Hook-UnitTests.html"><abbr title="\CRM_Utils_Hook_UnitTests">CRM_Utils_Hook_UnitTests</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Hook-WordPress.html"><abbr title="\CRM_Utils_Hook_WordPress">CRM_Utils_Hook_WordPress</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Hook.html"><abbr title="\CRM_Utils_Hook">CRM_Utils_Hook</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Http.html"><abbr title="\CRM_Utils_Http">CRM_Utils_Http</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-HttpClient.html"><abbr title="\CRM_Utils_HttpClient">CRM_Utils_HttpClient</abbr></a></dt><dd>This class handles HTTP downloads</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-ICalendar.html"><abbr title="\CRM_Utils_ICalendar">CRM_Utils_ICalendar</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-JS.html"><abbr title="\CRM_Utils_JS">CRM_Utils_JS</abbr></a></dt><dd>Parse Javascript content and extract translatable strings.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-JSON.html"><abbr title="\CRM_Utils_JSON">CRM_Utils_JSON</abbr></a></dt><dd>Class handles functions for JSON format</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-LazyArray.html"><abbr title="\CRM_Utils_LazyArray">CRM_Utils_LazyArray</abbr></a></dt><dd>A lazy-array works much like a regular array or ArrayObject. However, it is
initially empty - and it is only populated if used.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Mail-CaseMail.html"><abbr title="\CRM_Utils_Mail_CaseMail">CRM_Utils_Mail_CaseMail</abbr></a></dt><dd>Class CRM_Utils_Mail_CaseMail.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Mail-EmailProcessor.html"><abbr title="\CRM_Utils_Mail_EmailProcessor">CRM_Utils_Mail_EmailProcessor</abbr></a></dt><dd>Class CRM_Utils_Mail_EmailProcessor.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Mail-FilteredPearMailer.html"><abbr title="\CRM_Utils_Mail_FilteredPearMailer">CRM_Utils_Mail_FilteredPearMailer</abbr></a></dt><dd>The filtered-mailer is a utility to wrap an existing PEAR Mail class
and apply extra filters. It is primarily intended for resolving
quirks in the standard implementations.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Mail-Incoming.html"><abbr title="\CRM_Utils_Mail_Incoming">CRM_Utils_Mail_Incoming</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Mail-Logger.html"><abbr title="\CRM_Utils_Mail_Logger">CRM_Utils_Mail_Logger</abbr></a></dt><dd>An attachment to PEAR Mail which logs emails to files based on
the CIVICRM_MAIL_LOG configuration.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Mail.html"><abbr title="\CRM_Utils_Mail">CRM_Utils_Mail</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Migrate-Export.html"><abbr title="\CRM_Utils_Migrate_Export">CRM_Utils_Migrate_Export</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Migrate-ExportJSON.html"><abbr title="\CRM_Utils_Migrate_ExportJSON">CRM_Utils_Migrate_ExportJSON</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Migrate-Import.html"><abbr title="\CRM_Utils_Migrate_Import">CRM_Utils_Migrate_Import</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Migrate-ImportJSON.html"><abbr title="\CRM_Utils_Migrate_ImportJSON">CRM_Utils_Migrate_ImportJSON</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Monaco.html"><abbr title="\CRM_Utils_Monaco">CRM_Utils_Monaco</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Money.html"><abbr title="\CRM_Utils_Money">CRM_Utils_Money</abbr></a></dt><dd>Money utilties</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Network.html"><abbr title="\CRM_Utils_Network">CRM_Utils_Network</abbr></a></dt><dd>Simple static helpers for network operations</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Number.html"><abbr title="\CRM_Utils_Number">CRM_Utils_Number</abbr></a></dt><dd>Class CRM_Utils_Number</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-OptionBag.html"><abbr title="\CRM_Utils_OptionBag">CRM_Utils_OptionBag</abbr></a></dt><dd>Class CRM_Utils_OptionBag.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Pager.html"><abbr title="\CRM_Utils_Pager">CRM_Utils_Pager</abbr></a></dt><dd>Class CRM_Utils_Pager</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-PagerAToZ.html"><abbr title="\CRM_Utils_PagerAToZ">CRM_Utils_PagerAToZ</abbr></a></dt><dd>This class is for displaying alphabetical bar</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-PDF-Document.html"><abbr title="\CRM_Utils_PDF_Document">CRM_Utils_PDF_Document</abbr></a></dt><dd>Class CRM_Utils_PDF_Document.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-PDF-Label.html"><abbr title="\CRM_Utils_PDF_Label">CRM_Utils_PDF_Label</abbr></a></dt><dd>Class CRM_Utils_PDF_Label</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-PDF-Utils.html"><abbr title="\CRM_Utils_PDF_Utils">CRM_Utils_PDF_Utils</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-PseudoConstant.html"><abbr title="\CRM_Utils_PseudoConstant">CRM_Utils_PseudoConstant</abbr></a></dt><dd>Utilities for manipulating/inspecting CRM_*_PseudoConstant classes.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Recent.html"><abbr title="\CRM_Utils_Recent">CRM_Utils_Recent</abbr></a></dt><dd>Recent items utility class.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Request.html"><abbr title="\CRM_Utils_Request">CRM_Utils_Request</abbr></a></dt><dd>Class for managing a http request</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-REST.html"><abbr title="\CRM_Utils_REST">CRM_Utils_REST</abbr></a></dt><dd>This class handles all REST client requests.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Rule.html"><abbr title="\CRM_Utils_Rule">CRM_Utils_Rule</abbr></a></dt><dd>Class CRM_Utils_Rule</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-SameSite.html"><abbr title="\CRM_Utils_SameSite">CRM_Utils_SameSite</abbr></a></dt><dd>SameSite Utility Class.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Schema.html"><abbr title="\CRM_Utils_Schema">CRM_Utils_Schema</abbr></a></dt><dd>Helper classes for parsing the xml schema files.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Signer.html"><abbr title="\CRM_Utils_Signer">CRM_Utils_Signer</abbr></a></dt><dd>A utility which signs and verifies a list of key-value pairs</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-SoapServer.html"><abbr title="\CRM_Utils_SoapServer">CRM_Utils_SoapServer</abbr></a></dt><dd>(OBSOLETE) This class previously handled SOAP requests.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Sort.html"><abbr title="\CRM_Utils_Sort">CRM_Utils_Sort</abbr></a></dt><dd>Base class to provide generic sort functionality.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-SQL-BaseParamQuery.html"><abbr title="\CRM_Utils_SQL_BaseParamQuery">CRM_Utils_SQL_BaseParamQuery</abbr></a></dt><dd>Class CRM_Utils_SQL_BaseParamQuery</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-SQL-Delete.html"><abbr title="\CRM_Utils_SQL_Delete">CRM_Utils_SQL_Delete</abbr></a></dt><dd>Object-oriented SQL builder for DELETE queries.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-SQL-Insert.html"><abbr title="\CRM_Utils_SQL_Insert">CRM_Utils_SQL_Insert</abbr></a></dt><dd>Object-oriented SQL builder for INSERT queries.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-SQL-Literal.html"><abbr title="\CRM_Utils_SQL_Literal">CRM_Utils_SQL_Literal</abbr></a></dt><dd>A literal fragment of SQL.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-SQL-Select.html"><abbr title="\CRM_Utils_SQL_Select">CRM_Utils_SQL_Select</abbr></a></dt><dd>Object-oriented SQL builder for SELECT queries.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-SQL-TempTable.html"><abbr title="\CRM_Utils_SQL_TempTable">CRM_Utils_SQL_TempTable</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-SQL.html"><abbr title="\CRM_Utils_SQL">CRM_Utils_SQL</abbr></a></dt><dd>Just another collection of static utils functions.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-String.html"><abbr title="\CRM_Utils_String">CRM_Utils_String</abbr></a></dt><dd>This class contains string functions.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-System-Backdrop.html"><abbr title="\CRM_Utils_System_Backdrop">CRM_Utils_System_Backdrop</abbr></a></dt><dd>Backdrop-specific logic that differs from Drupal.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-System-Base.html"><abbr title="\CRM_Utils_System_Base">CRM_Utils_System_Base</abbr></a></dt><dd>Base class for UF system integrations</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-System-Drupal.html"><abbr title="\CRM_Utils_System_Drupal">CRM_Utils_System_Drupal</abbr></a></dt><dd>Drupal specific stuff goes here</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-System-Drupal8.html"><abbr title="\CRM_Utils_System_Drupal8">CRM_Utils_System_Drupal8</abbr></a></dt><dd>Drupal specific stuff goes here.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-System-DrupalBase.html"><abbr title="\CRM_Utils_System_DrupalBase">CRM_Utils_System_DrupalBase</abbr></a></dt><dd>Drupal specific stuff goes here</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-System-Joomla.html"><abbr title="\CRM_Utils_System_Joomla">CRM_Utils_System_Joomla</abbr></a></dt><dd>Joomla specific stuff goes here.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-System-Soap.html"><abbr title="\CRM_Utils_System_Soap">CRM_Utils_System_Soap</abbr></a></dt><dd>Soap specific stuff goes here.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-System-Standalone.html"><abbr title="\CRM_Utils_System_Standalone">CRM_Utils_System_Standalone</abbr></a></dt><dd>Standalone specific stuff goes here.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-System-UnitTests.html"><abbr title="\CRM_Utils_System_UnitTests">CRM_Utils_System_UnitTests</abbr></a></dt><dd>Helper authentication class for unit tests</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-System-WordPress.html"><abbr title="\CRM_Utils_System_WordPress">CRM_Utils_System_WordPress</abbr></a></dt><dd>WordPress specific stuff goes here</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-System.html"><abbr title="\CRM_Utils_System">CRM_Utils_System</abbr></a></dt><dd>System wide utilities.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-SystemLogger.html"><abbr title="\CRM_Utils_SystemLogger">CRM_Utils_SystemLogger</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Time.html"><abbr title="\CRM_Utils_Time">CRM_Utils_Time</abbr></a></dt><dd>Date time utilties</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Token.html"><abbr title="\CRM_Utils_Token">CRM_Utils_Token</abbr></a></dt><dd>Class to abstract token replacement.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Type.html"><abbr title="\CRM_Utils_Type">CRM_Utils_Type</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Url.html"><abbr title="\CRM_Utils_Url">CRM_Utils_Url</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Verp.html"><abbr title="\CRM_Utils_Verp">CRM_Utils_Verp</abbr></a></dt><dd>Class to handle encoding and decoding Variable Enveleope Return Path (VERP)
headers.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-VersionCheck.html"><abbr title="\CRM_Utils_VersionCheck">CRM_Utils_VersionCheck</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Weight.html"><abbr title="\CRM_Utils_Weight">CRM_Utils_Weight</abbr></a></dt><dd>Class CRM_Utils_Weight</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Wrapper.html"><abbr title="\CRM_Utils_Wrapper">CRM_Utils_Wrapper</abbr></a></dt><dd>The Contact Wrapper is a wrapper class which is called by
contact.module after it parses the menu path.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-XML.html"><abbr title="\CRM_Utils_XML">CRM_Utils_XML</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Zip.html"><abbr title="\CRM_Utils_Zip">CRM_Utils_Zip</abbr></a></dt><dd>Utilities for working with zip files</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-AfformAdmin-ExtensionUtil.html"><abbr title="\CRM_AfformAdmin_ExtensionUtil">CRM_AfformAdmin_ExtensionUtil</abbr></a></dt><dd>The ExtensionUtil class provides small stubs for accessing resources of this
extension.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-AfformAdmin-Page-Base.html"><abbr title="\CRM_AfformAdmin_Page_Base">CRM_AfformAdmin_Page_Base</abbr></a></dt><dd>Base page for Afform admin</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-AfformAdmin-Upgrader.html"><abbr title="\CRM_AfformAdmin_Upgrader">CRM_AfformAdmin_Upgrader</abbr></a></dt><dd>Collection of upgrade steps.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Afform-ExtensionUtil.html"><abbr title="\CRM_Afform_ExtensionUtil">CRM_Afform_ExtensionUtil</abbr></a></dt><dd>The ExtensionUtil class provides small stubs for accessing resources of this
extension.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Afform-AfformScanner.html"><abbr title="\CRM_Afform_AfformScanner">CRM_Afform_AfformScanner</abbr></a></dt><dd>Class CRM_Afform_AfformScanner</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Afform-ArrayHtml.html"><abbr title="\CRM_Afform_ArrayHtml">CRM_Afform_ArrayHtml</abbr></a></dt><dd>Class CRM_Afform_ArrayHtml</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Afform-BAO-AfformSubmission.html"><abbr title="\CRM_Afform_BAO_AfformSubmission">CRM_Afform_BAO_AfformSubmission</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Afform-DAO-AfformSubmission.html"><abbr title="\CRM_Afform_DAO_AfformSubmission">CRM_Afform_DAO_AfformSubmission</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Afform-Page-AfformBase.html"><abbr title="\CRM_Afform_Page_AfformBase">CRM_Afform_Page_AfformBase</abbr></a></dt><dd>A Page is basically data in a nice pretty format.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Afform-Page-Verify.html"><abbr title="\CRM_Afform_Page_Verify">CRM_Afform_Page_Verify</abbr></a></dt><dd>A Page is basically data in a nice pretty format.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Afform-Upgrader.html"><abbr title="\CRM_Afform_Upgrader">CRM_Afform_Upgrader</abbr></a></dt><dd>Collection of upgrade steps.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Afform-PageTest.html"><abbr title="\CRM_Afform_PageTest">CRM_Afform_PageTest</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Afform-UtilTest.html"><abbr title="\CRM_Afform_UtilTest">CRM_Afform_UtilTest</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-AfformHtml-ExtensionUtil.html"><abbr title="\CRM_AfformHtml_ExtensionUtil">CRM_AfformHtml_ExtensionUtil</abbr></a></dt><dd>The ExtensionUtil class provides small stubs for accessing resources of this
extension.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-AfformLoginToken-ExtensionUtil.html"><abbr title="\CRM_AfformLoginToken_ExtensionUtil">CRM_AfformLoginToken_ExtensionUtil</abbr></a></dt><dd>The ExtensionUtil class provides small stubs for accessing resources of this
extension.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-AfformMock-ExtensionUtil.html"><abbr title="\CRM_AfformMock_ExtensionUtil">CRM_AfformMock_ExtensionUtil</abbr></a></dt><dd>The ExtensionUtil class provides small stubs for accessing resources of this
extension.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Authx-ExtensionUtil.html"><abbr title="\CRM_Authx_ExtensionUtil">CRM_Authx_ExtensionUtil</abbr></a></dt><dd>The ExtensionUtil class provides small stubs for accessing resources of this
extension.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Authx-Page-AJAX.html"><abbr title="\CRM_Authx_Page_AJAX">CRM_Authx_Page_AJAX</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-ChartKit-ExtensionUtil.html"><abbr title="\CRM_ChartKit_ExtensionUtil">CRM_ChartKit_ExtensionUtil</abbr></a></dt><dd>The ExtensionUtil class provides small stubs for accessing resources of this
extension.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Campaign-ExtensionUtil.html"><abbr title="\CRM_Campaign_ExtensionUtil">CRM_Campaign_ExtensionUtil</abbr></a></dt><dd>The ExtensionUtil class provides small stubs for accessing resources of this
extension.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-ExtensionUtil.html"><abbr title="\CRM_Case_ExtensionUtil">CRM_Case_ExtensionUtil</abbr></a></dt><dd>The ExtensionUtil class provides small stubs for accessing resources of this
extension.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-ExtensionUtil.html"><abbr title="\CRM_Contribute_ExtensionUtil">CRM_Contribute_ExtensionUtil</abbr></a></dt><dd>The ExtensionUtil class provides small stubs for accessing resources of this
extension.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-ExtensionUtil.html"><abbr title="\CRM_Event_ExtensionUtil">CRM_Event_ExtensionUtil</abbr></a></dt><dd>The ExtensionUtil class provides small stubs for accessing resources of this
extension.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-ExtensionUtil.html"><abbr title="\CRM_Mailing_ExtensionUtil">CRM_Mailing_ExtensionUtil</abbr></a></dt><dd>The ExtensionUtil class provides small stubs for accessing resources of this
extension.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-ExtensionUtil.html"><abbr title="\CRM_Member_ExtensionUtil">CRM_Member_ExtensionUtil</abbr></a></dt><dd>The ExtensionUtil class provides small stubs for accessing resources of this
extension.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Pledge-ExtensionUtil.html"><abbr title="\CRM_Pledge_ExtensionUtil">CRM_Pledge_ExtensionUtil</abbr></a></dt><dd>The ExtensionUtil class provides small stubs for accessing resources of this
extension.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-ExtensionUtil.html"><abbr title="\CRM_Report_ExtensionUtil">CRM_Report_ExtensionUtil</abbr></a></dt><dd>The ExtensionUtil class provides small stubs for accessing resources of this
extension.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/ReportTest.html"><abbr title="\ReportTest">ReportTest</abbr></a></dt><dd>Test CiviReport functionality.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-CivicrmAdminUi-ExtensionUtil.html"><abbr title="\CRM_CivicrmAdminUi_ExtensionUtil">CRM_CivicrmAdminUi_ExtensionUtil</abbr></a></dt><dd>The ExtensionUtil class provides small stubs for accessing resources of this
extension.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-CivicrmAdminUi-Upgrader.html"><abbr title="\CRM_CivicrmAdminUi_Upgrader">CRM_CivicrmAdminUi_Upgrader</abbr></a></dt><dd>Collection of upgrade steps.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/E2E-CivicrmAdminUi-ManageGroupsTest.html"><abbr title="\E2E_CivicrmAdminUi_ManageGroupsTest">E2E_CivicrmAdminUi_ManageGroupsTest</abbr></a></dt><dd>E2E Mink tests for Manage Groups screen.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-CivicrmSearchUi-ExtensionUtil.html"><abbr title="\CRM_CivicrmSearchUi_ExtensionUtil">CRM_CivicrmSearchUi_ExtensionUtil</abbr></a></dt><dd>The ExtensionUtil class provides small stubs for accessing resources of this
extension.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-CivicrmSearchUi-Upgrader.html"><abbr title="\CRM_CivicrmSearchUi_Upgrader">CRM_CivicrmSearchUi_Upgrader</abbr></a></dt><dd>Collection of upgrade steps.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Grant-ExtensionUtil.html"><abbr title="\CRM_Grant_ExtensionUtil">CRM_Grant_ExtensionUtil</abbr></a></dt><dd>The ExtensionUtil class provides small stubs for accessing resources of this
extension.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Grant-BAO-Grant.html"><abbr title="\CRM_Grant_BAO_Grant">CRM_Grant_BAO_Grant</abbr></a></dt><dd>Class CRM_Grant_BAO_Grant</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Grant-BAO-Query.html"><abbr title="\CRM_Grant_BAO_Query">CRM_Grant_BAO_Query</abbr></a></dt><dd>Class CRM_Grant_BAO_Query</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Grant-Controller-Search.html"><abbr title="\CRM_Grant_Controller_Search">CRM_Grant_Controller_Search</abbr></a></dt><dd>This class is used by the Search functionality.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Grant-DAO-Grant.html"><abbr title="\CRM_Grant_DAO_Grant">CRM_Grant_DAO_Grant</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Grant-Export-Form-Map.html"><abbr title="\CRM_Grant_Export_Form_Map">CRM_Grant_Export_Form_Map</abbr></a></dt><dd>This class gets the name of the file to upload</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Grant-Export-Form-Select.html"><abbr title="\CRM_Grant_Export_Form_Select">CRM_Grant_Export_Form_Select</abbr></a></dt><dd>This class gets the name of the file to upload</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Grant-Form-Grant.html"><abbr title="\CRM_Grant_Form_Grant">CRM_Grant_Form_Grant</abbr></a></dt><dd>This class generates form components for processing a case</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Grant-Form-GrantView.html"><abbr title="\CRM_Grant_Form_GrantView">CRM_Grant_Form_GrantView</abbr></a></dt><dd>Not a real form: displays a grant in view mode.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Grant-Form-Search.html"><abbr title="\CRM_Grant_Form_Search">CRM_Grant_Form_Search</abbr></a></dt><dd>This file is for CiviGrant search</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Grant-Form-Task-Delete.html"><abbr title="\CRM_Grant_Form_Task_Delete">CRM_Grant_Form_Task_Delete</abbr></a></dt><dd>This class provides the functionality to delete a group of
participations. This class provides functionality for the actual
deletion.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Grant-Form-Task-Print.html"><abbr title="\CRM_Grant_Form_Task_Print">CRM_Grant_Form_Task_Print</abbr></a></dt><dd>This class provides the functionality to grant list</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Grant-Form-Task-Result.html"><abbr title="\CRM_Grant_Form_Task_Result">CRM_Grant_Form_Task_Result</abbr></a></dt><dd>Used for displaying results</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Grant-Form-Task-Update.html"><abbr title="\CRM_Grant_Form_Task_Update">CRM_Grant_Form_Task_Update</abbr></a></dt><dd>This class provides the functionality to update a group of
grants. This class provides functionality for the actual
update.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Grant-Form-Task.html"><abbr title="\CRM_Grant_Form_Task">CRM_Grant_Form_Task</abbr></a></dt><dd>Class for grant form task actions.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Grant-Page-DashBoard.html"><abbr title="\CRM_Grant_Page_DashBoard">CRM_Grant_Page_DashBoard</abbr></a></dt><dd>This is page is for Grant Dashboard</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Grant-Selector-Search.html"><abbr title="\CRM_Grant_Selector_Search">CRM_Grant_Selector_Search</abbr></a></dt><dd>This class is used to retrieve and display a range of
contacts that match the given criteria (specifically for
results of advanced search options.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Grant-StateMachine-Search.html"><abbr title="\CRM_Grant_StateMachine_Search">CRM_Grant_StateMachine_Search</abbr></a></dt><dd>Core StateMachine.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Grant-Task.html"><abbr title="\CRM_Grant_Task">CRM_Grant_Task</abbr></a></dt><dd>class to represent the actions that can be performed on a group of contacts
used by the search forms</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Grant-Upgrader.html"><abbr title="\CRM_Grant_Upgrader">CRM_Grant_Upgrader</abbr></a></dt><dd>Collection of upgrade steps.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form-Grant-Detail.html"><abbr title="\CRM_Report_Form_Grant_Detail">CRM_Report_Form_Grant_Detail</abbr></a></dt><dd>Class CRM_Report_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form-Grant-Statistics.html"><abbr title="\CRM_Report_Form_Grant_Statistics">CRM_Report_Form_Grant_Statistics</abbr></a></dt><dd>Class CRM_Report_Form</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-GrantTest.html"><abbr title="\api_v3_GrantTest">api_v3_GrantTest</abbr></a></dt><dd>Test APIv3 civicrm_grant* functions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Civiimport-ExtensionUtil.html"><abbr title="\CRM_Civiimport_ExtensionUtil">CRM_Civiimport_ExtensionUtil</abbr></a></dt><dd>The ExtensionUtil class provides small stubs for accessing resources of this
extension.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CiviApiImportTest.html"><abbr title="\CiviApiImportTest">CiviApiImportTest</abbr></a></dt><dd>FIXME - Add test description.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Ckeditor4-ExtensionUtil.html"><abbr title="\CRM_Ckeditor4_ExtensionUtil">CRM_Ckeditor4_ExtensionUtil</abbr></a></dt><dd>The ExtensionUtil class provides small stubs for accessing resources of this
extension.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Ckeditor4-Form-CKEditorConfig.html"><abbr title="\CRM_Ckeditor4_Form_CKEditorConfig">CRM_Ckeditor4_Form_CKEditorConfig</abbr></a></dt><dd>Form for configuring CKEditor options.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Ckeditor4-Upgrader.html"><abbr title="\CRM_Ckeditor4_Upgrader">CRM_Ckeditor4_Upgrader</abbr></a></dt><dd>Collection of upgrade steps.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contributioncancelactions-ExtensionUtil.html"><abbr title="\CRM_Contributioncancelactions_ExtensionUtil">CRM_Contributioncancelactions_ExtensionUtil</abbr></a></dt><dd>The ExtensionUtil class provides small stubs for accessing resources of this
extension.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CancelTest.html"><abbr title="\CancelTest">CancelTest</abbr></a></dt><dd>FIXME - Add test description.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Payment-Elavon.html"><abbr title="\CRM_Core_Payment_Elavon">CRM_Core_Payment_Elavon</abbr></a></dt><dd>-----------------------------------------------------------------------------------------------
The basic functionality of this processor is that variables from the $params object are transformed
into xml. The xml is submitted to the processor's https site
using curl and the response is translated back into an array using the processor's function.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Elavon-ExtensionUtil.html"><abbr title="\CRM_Elavon_ExtensionUtil">CRM_Elavon_ExtensionUtil</abbr></a></dt><dd>The ExtensionUtil class provides small stubs for accessing resources of this
extension.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Payment-ElavonTest.html"><abbr title="\CRM_Core_Payment_ElavonTest">CRM_Core_Payment_ElavonTest</abbr></a></dt><dd>FIXME - Add test description.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Cart-BAO-Cart.html"><abbr title="\CRM_Event_Cart_BAO_Cart">CRM_Event_Cart_BAO_Cart</abbr></a></dt><dd>Class CRM_Event_Cart_BAO_Cart</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Cart-BAO-Conference.html"><abbr title="\CRM_Event_Cart_BAO_Conference">CRM_Event_Cart_BAO_Conference</abbr></a></dt><dd>Class CRM_Event_Cart_BAO_Conference</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Cart-BAO-EventInCart.html"><abbr title="\CRM_Event_Cart_BAO_EventInCart">CRM_Event_Cart_BAO_EventInCart</abbr></a></dt><dd>Class CRM_Event_Cart_BAO_EventInCart</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Cart-BAO-MerParticipant.html"><abbr title="\CRM_Event_Cart_BAO_MerParticipant">CRM_Event_Cart_BAO_MerParticipant</abbr></a></dt><dd>Class CRM_Event_Cart_BAO_MerParticipant</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Cart-Controller-Checkout.html"><abbr title="\CRM_Event_Cart_Controller_Checkout">CRM_Event_Cart_Controller_Checkout</abbr></a></dt><dd>Class CRM_Event_Cart_Controller_Checkout</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Cart-DAO-Cart.html"><abbr title="\CRM_Event_Cart_DAO_Cart">CRM_Event_Cart_DAO_Cart</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Cart-DAO-EventCartParticipant.html"><abbr title="\CRM_Event_Cart_DAO_EventCartParticipant">CRM_Event_Cart_DAO_EventCartParticipant</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Cart-DAO-EventInCart.html"><abbr title="\CRM_Event_Cart_DAO_EventInCart">CRM_Event_Cart_DAO_EventInCart</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Cart-Form-Cart.html"><abbr title="\CRM_Event_Cart_Form_Cart">CRM_Event_Cart_Form_Cart</abbr></a></dt><dd>Class CRM_Event_Cart_Form_Cart</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Cart-Form-Checkout-ConferenceEvents.html"><abbr title="\CRM_Event_Cart_Form_Checkout_ConferenceEvents">CRM_Event_Cart_Form_Checkout_ConferenceEvents</abbr></a></dt><dd>Class CRM_Event_Cart_Form_Checkout_ConferenceEvents</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Cart-Form-Checkout-ParticipantsAndPrices.html"><abbr title="\CRM_Event_Cart_Form_Checkout_ParticipantsAndPrices">CRM_Event_Cart_Form_Checkout_ParticipantsAndPrices</abbr></a></dt><dd>Class CRM_Event_Cart_Form_Checkout_ParticipantsAndPrices</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Cart-Form-Checkout-Payment.html"><abbr title="\CRM_Event_Cart_Form_Checkout_Payment">CRM_Event_Cart_Form_Checkout_Payment</abbr></a></dt><dd>Class CRM_Event_Cart_Form_Checkout_Payment</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Cart-Form-Checkout-ThankYou.html"><abbr title="\CRM_Event_Cart_Form_Checkout_ThankYou">CRM_Event_Cart_Form_Checkout_ThankYou</abbr></a></dt><dd>Class CRM_Event_Cart_Form_Checkout_ThankYou</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Cart-Form-MerParticipant.html"><abbr title="\CRM_Event_Cart_Form_MerParticipant">CRM_Event_Cart_Form_MerParticipant</abbr></a></dt><dd>Class CRM_Event_Cart_Form_MerParticipant</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Cart-Page-AddToCart.html"><abbr title="\CRM_Event_Cart_Page_AddToCart">CRM_Event_Cart_Page_AddToCart</abbr></a></dt><dd>Class CRM_Event_Cart_Page_AddToCart</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Cart-Page-CheckoutAJAX.html"><abbr title="\CRM_Event_Cart_Page_CheckoutAJAX">CRM_Event_Cart_Page_CheckoutAJAX</abbr></a></dt><dd>Class CRM_Event_Cart_Page_CheckoutAJAX</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Cart-Page-RemoveFromCart.html"><abbr title="\CRM_Event_Cart_Page_RemoveFromCart">CRM_Event_Cart_Page_RemoveFromCart</abbr></a></dt><dd>Class CRM_Event_Cart_Page_RemoveFromCart</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Cart-Page-ViewCart.html"><abbr title="\CRM_Event_Cart_Page_ViewCart">CRM_Event_Cart_Page_ViewCart</abbr></a></dt><dd>Class CRM_Event_Cart_Page_ViewCart</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Cart-PageCallback.html"><abbr title="\CRM_Event_Cart_PageCallback">CRM_Event_Cart_PageCallback</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Cart-StateMachine-Checkout.html"><abbr title="\CRM_Event_Cart_StateMachine_Checkout">CRM_Event_Cart_StateMachine_Checkout</abbr></a></dt><dd>Class CRM_Event_Cart_StateMachine_Checkout</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Cart-Upgrader.html"><abbr title="\CRM_Event_Cart_Upgrader">CRM_Event_Cart_Upgrader</abbr></a></dt><dd>Collection of upgrade steps.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Form-ManageEvent-Conference.html"><abbr title="\CRM_Event_Form_ManageEvent_Conference">CRM_Event_Form_ManageEvent_Conference</abbr></a></dt><dd>This class generates form components for Conference Slots.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Cart-ExtensionUtil.html"><abbr title="\CRM_Event_Cart_ExtensionUtil">CRM_Event_Cart_ExtensionUtil</abbr></a></dt><dd>The ExtensionUtil class provides small stubs for accessing resources of this
extension.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Payment-eWAY.html"><abbr title="\CRM_Core_Payment_eWAY">CRM_Core_Payment_eWAY</abbr></a></dt><dd>Class CRM_Core_Payment_eWAY.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Ewaysingle-ExtensionUtil.html"><abbr title="\CRM_Ewaysingle_ExtensionUtil">CRM_Ewaysingle_ExtensionUtil</abbr></a></dt><dd>The ExtensionUtil class provides small stubs for accessing resources of this
extension.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/GatewayRequest.html"><abbr title="\GatewayRequest">GatewayRequest</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/GatewayResponse.html"><abbr title="\GatewayResponse">GatewayResponse</abbr></a></dt><dd>Licensed to CiviCRM under the Academic Free License version 3.0
Written & Contributed by Dolphin Software P/L - March 2008</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Payment-EwayTest.html"><abbr title="\CRM_Core_Payment_EwayTest">CRM_Core_Payment_EwayTest</abbr></a></dt><dd>FIXME - Add test description.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Financialacls-ExtensionUtil.html"><abbr title="\CRM_Financialacls_ExtensionUtil">CRM_Financialacls_ExtensionUtil</abbr></a></dt><dd>The ExtensionUtil class provides small stubs for accessing resources of this
extension.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Flexmailer-ExtensionUtil.html"><abbr title="\CRM_Flexmailer_ExtensionUtil">CRM_Flexmailer_ExtensionUtil</abbr></a></dt><dd>The ExtensionUtil class provides small stubs for accessing resources of this
extension.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Greenwich-ExtensionUtil.html"><abbr title="\CRM_Greenwich_ExtensionUtil">CRM_Greenwich_ExtensionUtil</abbr></a></dt><dd>The ExtensionUtil class provides small stubs for accessing resources of this
extension.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Iframe-Page-InstallPage.html"><abbr title="\CRM_Iframe_Page_InstallPage">CRM_Iframe_Page_InstallPage</abbr></a></dt><dd>A Page is basically data in a nice pretty format.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Iframe-Utils.html"><abbr title="\CRM_Iframe_Utils">CRM_Iframe_Utils</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Iframe-ExtensionUtil.html"><abbr title="\CRM_Iframe_ExtensionUtil">CRM_Iframe_ExtensionUtil</abbr></a></dt><dd>The ExtensionUtil class provides small stubs for accessing resources of this
extension.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-BAO-SearchCustom.html"><abbr title="\CRM_Contact_BAO_SearchCustom">CRM_Contact_BAO_SearchCustom</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Search-Action-Export.html"><abbr title="\CRM_Contact_Form_Search_Action_Export">CRM_Contact_Form_Search_Action_Export</abbr></a></dt><dd>This is a shared parent class for form task actions.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Search-Custom-ActivitySearch.html"><abbr title="\CRM_Contact_Form_Search_Custom_ActivitySearch">CRM_Contact_Form_Search_Custom_ActivitySearch</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Search-Custom-Base.html"><abbr title="\CRM_Contact_Form_Search_Custom_Base">CRM_Contact_Form_Search_Custom_Base</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Search-Custom-Basic.html"><abbr title="\CRM_Contact_Form_Search_Custom_Basic">CRM_Contact_Form_Search_Custom_Basic</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Search-Custom-ContribSYBNT.html"><abbr title="\CRM_Contact_Form_Search_Custom_ContribSYBNT">CRM_Contact_Form_Search_Custom_ContribSYBNT</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Search-Custom-ContributionAggregate.html"><abbr title="\CRM_Contact_Form_Search_Custom_ContributionAggregate">CRM_Contact_Form_Search_Custom_ContributionAggregate</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Search-Custom-DateAdded.html"><abbr title="\CRM_Contact_Form_Search_Custom_DateAdded">CRM_Contact_Form_Search_Custom_DateAdded</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Search-Custom-EventAggregate.html"><abbr title="\CRM_Contact_Form_Search_Custom_EventAggregate">CRM_Contact_Form_Search_Custom_EventAggregate</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Search-Custom-FullText-AbstractPartialQuery.html"><abbr title="\CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery">CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Search-Custom-FullText-Activity.html"><abbr title="\CRM_Contact_Form_Search_Custom_FullText_Activity">CRM_Contact_Form_Search_Custom_FullText_Activity</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Search-Custom-FullText-Case.html"><abbr title="\CRM_Contact_Form_Search_Custom_FullText_Case">CRM_Contact_Form_Search_Custom_FullText_Case</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Search-Custom-FullText-Contact.html"><abbr title="\CRM_Contact_Form_Search_Custom_FullText_Contact">CRM_Contact_Form_Search_Custom_FullText_Contact</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Search-Custom-FullText-Contribution.html"><abbr title="\CRM_Contact_Form_Search_Custom_FullText_Contribution">CRM_Contact_Form_Search_Custom_FullText_Contribution</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Search-Custom-FullText-Membership.html"><abbr title="\CRM_Contact_Form_Search_Custom_FullText_Membership">CRM_Contact_Form_Search_Custom_FullText_Membership</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Search-Custom-FullText-Participant.html"><abbr title="\CRM_Contact_Form_Search_Custom_FullText_Participant">CRM_Contact_Form_Search_Custom_FullText_Participant</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Search-Custom-FullText.html"><abbr title="\CRM_Contact_Form_Search_Custom_FullText">CRM_Contact_Form_Search_Custom_FullText</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Search-Custom-Group.html"><abbr title="\CRM_Contact_Form_Search_Custom_Group">CRM_Contact_Form_Search_Custom_Group</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Search-Custom-MultipleValues.html"><abbr title="\CRM_Contact_Form_Search_Custom_MultipleValues">CRM_Contact_Form_Search_Custom_MultipleValues</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Search-Custom-PostalMailing.html"><abbr title="\CRM_Contact_Form_Search_Custom_PostalMailing">CRM_Contact_Form_Search_Custom_PostalMailing</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Search-Custom-PriceSet.html"><abbr title="\CRM_Contact_Form_Search_Custom_PriceSet">CRM_Contact_Form_Search_Custom_PriceSet</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Search-Custom-Proximity.html"><abbr title="\CRM_Contact_Form_Search_Custom_Proximity">CRM_Contact_Form_Search_Custom_Proximity</abbr></a></dt><dd>This search now functions as a subset of advanced search since at some point it
was added to advanced search.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Search-Custom-RandomSegment.html"><abbr title="\CRM_Contact_Form_Search_Custom_RandomSegment">CRM_Contact_Form_Search_Custom_RandomSegment</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Search-Custom-Sample.html"><abbr title="\CRM_Contact_Form_Search_Custom_Sample">CRM_Contact_Form_Search_Custom_Sample</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Search-Custom-TagContributions.html"><abbr title="\CRM_Contact_Form_Search_Custom_TagContributions">CRM_Contact_Form_Search_Custom_TagContributions</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Search-Custom-ZipCodeRange.html"><abbr title="\CRM_Contact_Form_Search_Custom_ZipCodeRange">CRM_Contact_Form_Search_Custom_ZipCodeRange</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Search-Custom.html"><abbr title="\CRM_Contact_Form_Search_Custom">CRM_Contact_Form_Search_Custom</abbr></a></dt><dd>Base Search / View form for *all* listing of multiple
contacts</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Page-CustomSearch.html"><abbr title="\CRM_Contact_Page_CustomSearch">CRM_Contact_Page_CustomSearch</abbr></a></dt><dd>Main page for viewing all Saved searches.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Selector-Custom.html"><abbr title="\CRM_Contact_Selector_Custom">CRM_Contact_Selector_Custom</abbr></a></dt><dd>This class is used to retrieve and display a range of
contacts that match the given criteria (specifically for
results of advanced search options.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-InnoDBIndexer.html"><abbr title="\CRM_Core_InnoDBIndexer">CRM_Core_InnoDBIndexer</abbr></a></dt><dd>The InnoDB indexer is responsible for creating and destroying
full-text indices on InnoDB classes.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Legacycustomsearches-Controller-Search.html"><abbr title="\CRM_Legacycustomsearches_Controller_Search">CRM_Legacycustomsearches_Controller_Search</abbr></a></dt><dd>This class is used by the Search functionality.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Legacycustomsearches-StateMachine-Search.html"><abbr title="\CRM_Legacycustomsearches_StateMachine_Search">CRM_Legacycustomsearches_StateMachine_Search</abbr></a></dt><dd>Core StateMachine.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-QueryFormatter.html"><abbr title="\CRM_Utils_QueryFormatter">CRM_Utils_QueryFormatter</abbr></a></dt><dd>Class CRM_Utils_QueryFormatter</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Legacycustomsearches-ExtensionUtil.html"><abbr title="\CRM_Legacycustomsearches_ExtensionUtil">CRM_Legacycustomsearches_ExtensionUtil</abbr></a></dt><dd>The ExtensionUtil class provides small stubs for accessing resources of this
extension.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Search-Custom-PriceSetTest.html"><abbr title="\CRM_Contact_Form_Search_Custom_PriceSetTest">CRM_Contact_Form_Search_Custom_PriceSetTest</abbr></a></dt><dd>Test contact custom search functions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-InnoDBIndexerTest.html"><abbr title="\CRM_Core_InnoDBIndexerTest">CRM_Core_InnoDBIndexerTest</abbr></a></dt><dd>Class CRM_Core_InnoDBIndexerTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-QueryFormatterTest.html"><abbr title="\CRM_Utils_QueryFormatterTest">CRM_Utils_QueryFormatterTest</abbr></a></dt><dd>FIXME - Add test description.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-MessageAdmin-Page-MsgtplBasePage.html"><abbr title="\CRM_MessageAdmin_Page_MsgtplBasePage">CRM_MessageAdmin_Page_MsgtplBasePage</abbr></a></dt><dd>A Page is basically data in a nice pretty format.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-MessageAdmin-Settings.html"><abbr title="\CRM_MessageAdmin_Settings">CRM_MessageAdmin_Settings</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-MessageAdmin-ExtensionUtil.html"><abbr title="\CRM_MessageAdmin_ExtensionUtil">CRM_MessageAdmin_ExtensionUtil</abbr></a></dt><dd>The ExtensionUtil class provides small stubs for accessing resources of this
extension.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-OAuth-Angular.html"><abbr title="\CRM_OAuth_Angular">CRM_OAuth_Angular</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-OAuth-BAO-OAuthClient.html"><abbr title="\CRM_OAuth_BAO_OAuthClient">CRM_OAuth_BAO_OAuthClient</abbr></a></dt><dd>Database access object for the OAuthClient entity.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-OAuth-BAO-OAuthContactToken.html"><abbr title="\CRM_OAuth_BAO_OAuthContactToken">CRM_OAuth_BAO_OAuthContactToken</abbr></a></dt><dd>Database access object for the OAuthContactToken entity.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-OAuth-BAO-OAuthSysToken.html"><abbr title="\CRM_OAuth_BAO_OAuthSysToken">CRM_OAuth_BAO_OAuthSysToken</abbr></a></dt><dd>Database access object for the OAuthSysToken entity.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-OAuth-ContactFromToken.html"><abbr title="\CRM_OAuth_ContactFromToken">CRM_OAuth_ContactFromToken</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-OAuth-DAO-OAuthClient.html"><abbr title="\CRM_OAuth_DAO_OAuthClient">CRM_OAuth_DAO_OAuthClient</abbr></a></dt><dd>Database access object for the OAuthClient entity.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-OAuth-DAO-OAuthContactToken.html"><abbr title="\CRM_OAuth_DAO_OAuthContactToken">CRM_OAuth_DAO_OAuthContactToken</abbr></a></dt><dd>Database access object for the OAuthContactToken entity.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-OAuth-DAO-OAuthSysToken.html"><abbr title="\CRM_OAuth_DAO_OAuthSysToken">CRM_OAuth_DAO_OAuthSysToken</abbr></a></dt><dd>Database access object for the OAuthSysToken entity.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-OAuth-MailSetup.html"><abbr title="\CRM_OAuth_MailSetup">CRM_OAuth_MailSetup</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-OAuth-Page-Return.html"><abbr title="\CRM_OAuth_Page_Return">CRM_OAuth_Page_Return</abbr></a></dt><dd>A Page is basically data in a nice pretty format.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-OAuth-Upgrader.html"><abbr title="\CRM_OAuth_Upgrader">CRM_OAuth_Upgrader</abbr></a></dt><dd>Collection of upgrade steps.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-OAuth-ExtensionUtil.html"><abbr title="\CRM_OAuth_ExtensionUtil">CRM_OAuth_ExtensionUtil</abbr></a></dt><dd>The ExtensionUtil class provides small stubs for accessing resources of this
extension.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v4-OAuthClientGrantTest.html"><abbr title="\api_v4_OAuthClientGrantTest">api_v4_OAuthClientGrantTest</abbr></a></dt><dd>Test the "grant" methods (authorizationCode, clientCredential, etc).</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v4-OAuthClientTest.html"><abbr title="\api_v4_OAuthClientTest">api_v4_OAuthClientTest</abbr></a></dt><dd>Create, read, and destroy OAuth clients.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v4-OAuthContactTokenTest.html"><abbr title="\api_v4_OAuthContactTokenTest">api_v4_OAuthContactTokenTest</abbr></a></dt><dd>Create, read, and destroy contact-specific OAuth tokens</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v4-OAuthProviderTest.html"><abbr title="\api_v4_OAuthProviderTest">api_v4_OAuthProviderTest</abbr></a></dt><dd>Read list of OAuth providers</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v4-OAuthSessionTokenTest.html"><abbr title="\api_v4_OAuthSessionTokenTest">api_v4_OAuthSessionTokenTest</abbr></a></dt><dd>Create and read session-specific OAuth tokens</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v4-OAuthSysTokenTest.html"><abbr title="\api_v4_OAuthSysTokenTest">api_v4_OAuthSysTokenTest</abbr></a></dt><dd>Create, read, and destroy OAuth tokens.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-OAuth-MailSetupTest.html"><abbr title="\CRM_OAuth_MailSetupTest">CRM_OAuth_MailSetupTest</abbr></a></dt><dd>Test helper functions in CRM_OAuth_MailSetup.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Oembed-Page-Oembed.html"><abbr title="\CRM_Oembed_Page_Oembed">CRM_Oembed_Page_Oembed</abbr></a></dt><dd>The `civicrm/oembed` route supports these modes:</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Oembed-Page-OembedShare.html"><abbr title="\CRM_Oembed_Page_OembedShare">CRM_Oembed_Page_OembedShare</abbr></a></dt><dd>The `civicrm/share?url=ABSOLUTE_URL` route defines a stub/placeholder.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Oembed-ExtensionUtil.html"><abbr title="\CRM_Oembed_ExtensionUtil">CRM_Oembed_ExtensionUtil</abbr></a></dt><dd>The ExtensionUtil class provides small stubs for accessing resources of this
extension.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Oembed-Page-OembedDiscoveryTest.html"><abbr title="\CRM_Oembed_Page_OembedDiscoveryTest">CRM_Oembed_Page_OembedDiscoveryTest</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Oembed-Page-OembedTest.html"><abbr title="\CRM_Oembed_Page_OembedTest">CRM_Oembed_Page_OembedTest</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Payment-PayflowPro.html"><abbr title="\CRM_Core_Payment_PayflowPro">CRM_Core_Payment_PayflowPro</abbr></a></dt><dd>Class CRM_Core_Payment_PayflowPro.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Payflowpro-ExtensionUtil.html"><abbr title="\CRM_Payflowpro_ExtensionUtil">CRM_Payflowpro_ExtensionUtil</abbr></a></dt><dd>The ExtensionUtil class provides small stubs for accessing resources of this
extension.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Payment-PayflowProTest.html"><abbr title="\CRM_Core_Payment_PayflowProTest">CRM_Core_Payment_PayflowProTest</abbr></a></dt><dd>FIXME - Add test description.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-ReCAPTCHA.html"><abbr title="\CRM_Utils_ReCAPTCHA">CRM_Utils_ReCAPTCHA</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/ReCaptchaResponse.html"><abbr title="\ReCaptchaResponse">ReCaptchaResponse</abbr></a></dt><dd>A ReCaptchaResponse is returned from recaptcha_check_answer()</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Recaptcha-ExtensionUtil.html"><abbr title="\CRM_Recaptcha_ExtensionUtil">CRM_Recaptcha_ExtensionUtil</abbr></a></dt><dd>The ExtensionUtil class provides small stubs for accessing resources of this
extension.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-ScheduledCommunications-ExtensionUtil.html"><abbr title="\CRM_ScheduledCommunications_ExtensionUtil">CRM_ScheduledCommunications_ExtensionUtil</abbr></a></dt><dd>The ExtensionUtil class provides small stubs for accessing resources of this
extension.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Search-BAO-SearchDisplay.html"><abbr title="\CRM_Search_BAO_SearchDisplay">CRM_Search_BAO_SearchDisplay</abbr></a></dt><dd>Search Display BAO</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Search-BAO-SearchSegment.html"><abbr title="\CRM_Search_BAO_SearchSegment">CRM_Search_BAO_SearchSegment</abbr></a></dt><dd>Search Segment BAO</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Search-DAO-SearchDisplay.html"><abbr title="\CRM_Search_DAO_SearchDisplay">CRM_Search_DAO_SearchDisplay</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Search-DAO-SearchSegment.html"><abbr title="\CRM_Search_DAO_SearchSegment">CRM_Search_DAO_SearchSegment</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Search-Page-Admin.html"><abbr title="\CRM_Search_Page_Admin">CRM_Search_Page_Admin</abbr></a></dt><dd>Angular base page for search admin</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Search-Page-AJAX.html"><abbr title="\CRM_Search_Page_AJAX">CRM_Search_Page_AJAX</abbr></a></dt><dd>Ajax callback used to reload admin settings when they may have changed.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Search-Page-Search.html"><abbr title="\CRM_Search_Page_Search">CRM_Search_Page_Search</abbr></a></dt><dd>Angular base page for search admin</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Search-Upgrader.html"><abbr title="\CRM_Search_Upgrader">CRM_Search_Upgrader</abbr></a></dt><dd>Collection of upgrade steps.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Search-ExtensionUtil.html"><abbr title="\CRM_Search_ExtensionUtil">CRM_Search_ExtensionUtil</abbr></a></dt><dd>The ExtensionUtil class provides small stubs for accessing resources of this
extension.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Sequentialcreditnotes-ExtensionUtil.html"><abbr title="\CRM_Sequentialcreditnotes_ExtensionUtil">CRM_Sequentialcreditnotes_ExtensionUtil</abbr></a></dt><dd>The ExtensionUtil class provides small stubs for accessing resources of this
extension.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/SequentialcreditnotesTest.html"><abbr title="\SequentialcreditnotesTest">SequentialcreditnotesTest</abbr></a></dt><dd>FIXME - Add test description.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Standaloneusers-BAO-Role.html"><abbr title="\CRM_Standaloneusers_BAO_Role">CRM_Standaloneusers_BAO_Role</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Standaloneusers-BAO-Session.html"><abbr title="\CRM_Standaloneusers_BAO_Session">CRM_Standaloneusers_BAO_Session</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Standaloneusers-BAO-Totp.html"><abbr title="\CRM_Standaloneusers_BAO_Totp">CRM_Standaloneusers_BAO_Totp</abbr></a></dt><dd>DAOs provide an OOP-style facade for reading and writing database records.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Standaloneusers-BAO-User.html"><abbr title="\CRM_Standaloneusers_BAO_User">CRM_Standaloneusers_BAO_User</abbr></a></dt><dd>Business access object for the User entity.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Standaloneusers-DAO-Role.html"><abbr title="\CRM_Standaloneusers_DAO_Role">CRM_Standaloneusers_DAO_Role</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Standaloneusers-DAO-Session.html"><abbr title="\CRM_Standaloneusers_DAO_Session">CRM_Standaloneusers_DAO_Session</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Standaloneusers-DAO-Totp.html"><abbr title="\CRM_Standaloneusers_DAO_Totp">CRM_Standaloneusers_DAO_Totp</abbr></a></dt><dd>DAOs provide an OOP-style facade for reading and writing database records.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Standaloneusers-DAO-User.html"><abbr title="\CRM_Standaloneusers_DAO_User">CRM_Standaloneusers_DAO_User</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Standaloneusers-DAO-UserRole.html"><abbr title="\CRM_Standaloneusers_DAO_UserRole">CRM_Standaloneusers_DAO_UserRole</abbr></a></dt><dd>Placeholder class retained for legacy compatibility.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Standaloneusers-Page-ChangePassword.html"><abbr title="\CRM_Standaloneusers_Page_ChangePassword">CRM_Standaloneusers_Page_ChangePassword</abbr></a></dt><dd>A Page is basically data in a nice pretty format.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Standaloneusers-Page-Login.html"><abbr title="\CRM_Standaloneusers_Page_Login">CRM_Standaloneusers_Page_Login</abbr></a></dt><dd>A Page is basically data in a nice pretty format.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Standaloneusers-Page-PermissionDenied.html"><abbr title="\CRM_Standaloneusers_Page_PermissionDenied">CRM_Standaloneusers_Page_PermissionDenied</abbr></a></dt><dd>Display an "Access Denied" screen.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Standaloneusers-Page-ResetPassword.html"><abbr title="\CRM_Standaloneusers_Page_ResetPassword">CRM_Standaloneusers_Page_ResetPassword</abbr></a></dt><dd>Provide the send password reset / reset password page.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Standaloneusers-Page-TOTP.html"><abbr title="\CRM_Standaloneusers_Page_TOTP">CRM_Standaloneusers_Page_TOTP</abbr></a></dt><dd>Page for /civicrm/mfa/totp</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Standaloneusers-Page-TOTPSetup.html"><abbr title="\CRM_Standaloneusers_Page_TOTPSetup">CRM_Standaloneusers_Page_TOTPSetup</abbr></a></dt><dd>Page for /civicrm/mfa/totp-setup</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Standaloneusers-Upgrader.html"><abbr title="\CRM_Standaloneusers_Upgrader">CRM_Standaloneusers_Upgrader</abbr></a></dt><dd>Collection of upgrade steps.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Standaloneusers-WorkflowMessage-PasswordReset.html"><abbr title="\CRM_Standaloneusers_WorkflowMessage_PasswordReset">CRM_Standaloneusers_WorkflowMessage_PasswordReset</abbr></a></dt><dd>Generic base-class for describing the inputs for a workflow email template.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Standaloneusers-ExtensionUtil.html"><abbr title="\CRM_Standaloneusers_ExtensionUtil">CRM_Standaloneusers_ExtensionUtil</abbr></a></dt><dd>The ExtensionUtil class provides small stubs for accessing resources of this
extension.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Friend-BAO-Friend.html"><abbr title="\CRM_Friend_BAO_Friend">CRM_Friend_BAO_Friend</abbr></a></dt><dd>This class contains the functions for Friend</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Friend-Form-Contribute.html"><abbr title="\CRM_Friend_Form_Contribute">CRM_Friend_Form_Contribute</abbr></a></dt><dd>This class generates form components for Tell A Friend</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Friend-Form-Event.html"><abbr title="\CRM_Friend_Form_Event">CRM_Friend_Form_Event</abbr></a></dt><dd>This class generates form components for Tell A Friend</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Friend-Form.html"><abbr title="\CRM_Friend_Form">CRM_Friend_Form</abbr></a></dt><dd>This class generates form components for Tell A Friend Form For End User</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Friend-ExtensionUtil.html"><abbr title="\CRM_Friend_ExtensionUtil">CRM_Friend_ExtensionUtil</abbr></a></dt><dd>The ExtensionUtil class provides small stubs for accessing resources of this
extension.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-UserDashboard-ExtensionUtil.html"><abbr title="\CRM_UserDashboard_ExtensionUtil">CRM_UserDashboard_ExtensionUtil</abbr></a></dt><dd>The ExtensionUtil class provides small stubs for accessing resources of this
extension.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Shimmy-DAO-ShimThing.html"><abbr title="\CRM_Shimmy_DAO_ShimThing">CRM_Shimmy_DAO_ShimThing</abbr></a></dt><dd>Database access object for the ShimThing entity.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Shimmy-Page-FooBar.html"><abbr title="\CRM_Shimmy_Page_FooBar">CRM_Shimmy_Page_FooBar</abbr></a></dt><dd>A Page is basically data in a nice pretty format.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Shimmy-ShimmyHookObject.html"><abbr title="\CRM_Shimmy_ShimmyHookObject">CRM_Shimmy_ShimmyHookObject</abbr></a></dt><dd>In this example, we use a non-static hook function.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Shimmy-ShimmyMessage.html"><abbr title="\CRM_Shimmy_ShimmyMessage">CRM_Shimmy_ShimmyMessage</abbr></a></dt><dd>Generic base-class for describing the inputs for a workflow email template.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Shimmy-Utils.html"><abbr title="\CRM_Shimmy_Utils">CRM_Shimmy_Utils</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/InstallSchemaPlugin.html"><abbr title="\InstallSchemaPlugin">InstallSchemaPlugin</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-GCD.html"><abbr title="\CRM_GCD">CRM_GCD</abbr></a></dt><dd>Class CRM_GCD</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Shimmy-ExtensionUtil.html"><abbr title="\CRM_Shimmy_ExtensionUtil">CRM_Shimmy_ExtensionUtil</abbr></a></dt><dd>The ExtensionUtil class provides small stubs for accessing resources of this
extension.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/E2E-Shimmy-LifecycleTest.html"><abbr title="\E2E_Shimmy_LifecycleTest">E2E_Shimmy_LifecycleTest</abbr></a></dt><dd>Enable, disable, and uninstall an extension. Ensure that various local example is enabled and disabled appropriately.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Moduleupgtest-Upgrader.html"><abbr title="\CRM_Moduleupgtest_Upgrader">CRM_Moduleupgtest_Upgrader</abbr></a></dt><dd>Base class which provides helpers to execute upgrade logic.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/test-extension-manager-paymenttest.html"><abbr title="\test_extension_manager_paymenttest">test_extension_manager_paymenttest</abbr></a></dt><dd>Class test_extension_manager_paymenttest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/test-extension-manager-reporttest.html"><abbr title="\test_extension_manager_reporttest">test_extension_manager_reporttest</abbr></a></dt><dd>Class test_extension_manager_reporttest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/test-extension-manager-searchtest.html"><abbr title="\test_extension_manager_searchtest">test_extension_manager_searchtest</abbr></a></dt><dd>Class test_extension_manager_searchtest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/AllTests.html"><abbr title="\AllTests">AllTests</abbr></a></dt><dd>Class containing all test suites</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-ACLCachingTest.html"><abbr title="\api_v3_ACLCachingTest">api_v3_ACLCachingTest</abbr></a></dt><dd>This class is intended to test ACL permission using the multisite module</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-ACLPermissionTest.html"><abbr title="\api_v3_ACLPermissionTest">api_v3_ACLPermissionTest</abbr></a></dt><dd>This class is intended to test ACL permission using the multisite module</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-ActionScheduleTest.html"><abbr title="\api_v3_ActionScheduleTest">api_v3_ActionScheduleTest</abbr></a></dt><dd>Test APIv3 civicrm_action_schedule functions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-ActivityCaseTest.html"><abbr title="\api_v3_ActivityCaseTest">api_v3_ActivityCaseTest</abbr></a></dt><dd>Test Activity.get API with the case_id field</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-ActivityContactTest.html"><abbr title="\api_v3_ActivityContactTest">api_v3_ActivityContactTest</abbr></a></dt><dd>Test APIv3 civicrm_activity_contact* functions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-ActivityTest.html"><abbr title="\api_v3_ActivityTest">api_v3_ActivityTest</abbr></a></dt><dd>Test APIv3 civicrm_activity_* functions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-ActivityTypeTest.html"><abbr title="\api_v3_ActivityTypeTest">api_v3_ActivityTypeTest</abbr></a></dt><dd>Test APIv3 civicrm_activity_* functions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-AddressTest.html"><abbr title="\api_v3_AddressTest">api_v3_AddressTest</abbr></a></dt><dd>Class api_v3_AddressTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-AllTests.html"><abbr title="\api_v3_AllTests">api_v3_AllTests</abbr></a></dt><dd>Class containing all API v3 test suites</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-APITest.html"><abbr title="\api_v3_APITest">api_v3_APITest</abbr></a></dt><dd>Test class for API functions.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-APIWrapperTest.html"><abbr title="\api_v3_APIWrapperTest">api_v3_APIWrapperTest</abbr></a></dt><dd>Test class for API functions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-APIWrapperTest-Impl.html"><abbr title="\api_v3_APIWrapperTest_Impl">api_v3_APIWrapperTest_Impl</abbr></a></dt><dd>Class api_v3_APIWrapperTest_Impl</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-AttachmentTest.html"><abbr title="\api_v3_AttachmentTest">api_v3_AttachmentTest</abbr></a></dt><dd>Test for the Attachment API</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-BatchTest.html"><abbr title="\api_v3_BatchTest">api_v3_BatchTest</abbr></a></dt><dd>Test class for Batch API - civicrm_batch_*</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-CampaignTest.html"><abbr title="\api_v3_CampaignTest">api_v3_CampaignTest</abbr></a></dt><dd>Class api_v3_CampaignTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-CaseContactTest.html"><abbr title="\api_v3_CaseContactTest">api_v3_CaseContactTest</abbr></a></dt><dd>Test APIv3 civicrm_case_* functions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-CaseTest.html"><abbr title="\api_v3_CaseTest">api_v3_CaseTest</abbr></a></dt><dd>Test APIv3 civicrm_case_* functions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-CaseTypeTest.html"><abbr title="\api_v3_CaseTypeTest">api_v3_CaseTypeTest</abbr></a></dt><dd>Class api_v3_CaseTypeTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/class-api-test.html"><abbr title="\class_api_test">class_api_test</abbr></a></dt><dd>Test class for class.api.php</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-ConstantTest.html"><abbr title="\api_v3_ConstantTest">api_v3_ConstantTest</abbr></a></dt><dd>Test APIv3 civicrm_activity_* functions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-ContactTest.html"><abbr title="\api_v3_ContactTest">api_v3_ContactTest</abbr></a></dt><dd>Test APIv3 civicrm_contact* functions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-ContactTypeTest.html"><abbr title="\api_v3_ContactTypeTest">api_v3_ContactTypeTest</abbr></a></dt><dd>Class api_v3_ContactTypeTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-ContributionPageTest.html"><abbr title="\api_v3_ContributionPageTest">api_v3_ContributionPageTest</abbr></a></dt><dd>Test APIv3 civicrm_contribution_page* functions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-ContributionRecurTest.html"><abbr title="\api_v3_ContributionRecurTest">api_v3_ContributionRecurTest</abbr></a></dt><dd>Test APIv3 civicrm_contribute_recur* functions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-ContributionSoftTest.html"><abbr title="\api_v3_ContributionSoftTest">api_v3_ContributionSoftTest</abbr></a></dt><dd>Test APIv3 civicrm_contribute_* functions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-ContributionTest.html"><abbr title="\api_v3_ContributionTest">api_v3_ContributionTest</abbr></a></dt><dd>Test APIv3 civicrm_contribute_* functions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-CountryTest.html"><abbr title="\api_v3_CountryTest">api_v3_CountryTest</abbr></a></dt><dd>Test APIv3 civicrm_country* functions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-CRM11793Test.html"><abbr title="\api_v3_CRM11793Test">api_v3_CRM11793Test</abbr></a></dt><dd>Test APIv3 civicrm_activity_* functions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Omnimail-DAO-MailingProviderData.html"><abbr title="\CRM_Omnimail_DAO_MailingProviderData">CRM_Omnimail_DAO_MailingProviderData</abbr></a></dt><dd>CRM_Omnimail_DAO_MailingProviderData constructor.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Omnimail-BAO-MailingProviderData.html"><abbr title="\CRM_Omnimail_BAO_MailingProviderData">CRM_Omnimail_BAO_MailingProviderData</abbr></a></dt><dd>CRM_Omnimail_BAO_MailingProviderData constructor.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-CustomApiTest.html"><abbr title="\api_v3_CustomApiTest">api_v3_CustomApiTest</abbr></a></dt><dd>Test class for API functions.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-CustomFieldTest.html"><abbr title="\api_v3_CustomFieldTest">api_v3_CustomFieldTest</abbr></a></dt><dd>Test APIv3 civicrm_create_custom_group</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-CustomGroupTest.html"><abbr title="\api_v3_CustomGroupTest">api_v3_CustomGroupTest</abbr></a></dt><dd>Test APIv3 civicrm_custom_group* functions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-CustomSearchTest.html"><abbr title="\api_v3_CustomSearchTest">api_v3_CustomSearchTest</abbr></a></dt><dd>Class api_v3_CustomSearchTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-CustomValueContactTypeTest.html"><abbr title="\api_v3_CustomValueContactTypeTest">api_v3_CustomValueContactTypeTest</abbr></a></dt><dd>Base class for CiviCRM unit tests</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-CustomValueTest.html"><abbr title="\api_v3_CustomValueTest">api_v3_CustomValueTest</abbr></a></dt><dd>Class api_v3_CustomValueTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-DashboardContactTest.html"><abbr title="\api_v3_DashboardContactTest">api_v3_DashboardContactTest</abbr></a></dt><dd>Test APIv3 civicrm_action_schedule functions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-DashboardTest.html"><abbr title="\api_v3_DashboardTest">api_v3_DashboardTest</abbr></a></dt><dd>Test APIv3 civicrm_action_schedule functions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-DomainTest.html"><abbr title="\api_v3_DomainTest">api_v3_DomainTest</abbr></a></dt><dd>Test class for Domain API - civicrm_domain_*</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-EmailTest.html"><abbr title="\api_v3_EmailTest">api_v3_EmailTest</abbr></a></dt><dd>Class api_v3_EmailTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-EntityBatchTest.html"><abbr title="\api_v3_EntityBatchTest">api_v3_EntityBatchTest</abbr></a></dt><dd>Test APIv3 civicrm_entity_batch_* functions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-EntityJoinTest.html"><abbr title="\api_v3_EntityJoinTest">api_v3_EntityJoinTest</abbr></a></dt><dd>Test APIv3 ability to join across multiple entities</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-EntityTagACLTest.html"><abbr title="\api_v3_EntityTagACLTest">api_v3_EntityTagACLTest</abbr></a></dt><dd>Class api_v3_EntityTagTest.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-EntityTagTest.html"><abbr title="\api_v3_EntityTagTest">api_v3_EntityTagTest</abbr></a></dt><dd>Class api_v3_EntityTagTest.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-EventTest.html"><abbr title="\api_v3_EventTest">api_v3_EventTest</abbr></a></dt><dd>Class api_v3_EventTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-ExceptionTest.html"><abbr title="\api_v3_ExceptionTest">api_v3_ExceptionTest</abbr></a></dt><dd>Test class for Dedupe exceptions.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-ExtensionTest.html"><abbr title="\api_v3_ExtensionTest">api_v3_ExtensionTest</abbr></a></dt><dd>Class api_v3_ExtensionTest.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-FinancialTypeACLTest.html"><abbr title="\api_v3_FinancialTypeACLTest">api_v3_FinancialTypeACLTest</abbr></a></dt><dd>Test APIv3 civicrm_contribute_* functions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-FinancialTypeTest.html"><abbr title="\api_v3_FinancialTypeTest">api_v3_FinancialTypeTest</abbr></a></dt><dd>Base class for CiviCRM unit tests</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-GroupContactTest.html"><abbr title="\api_v3_GroupContactTest">api_v3_GroupContactTest</abbr></a></dt><dd>Class api_v3_GroupContactTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-GroupNestingTest.html"><abbr title="\api_v3_GroupNestingTest">api_v3_GroupNestingTest</abbr></a></dt><dd>Test class for GroupNesting API - civicrm_group_nesting_*</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-GroupOrganizationTest.html"><abbr title="\api_v3_GroupOrganizationTest">api_v3_GroupOrganizationTest</abbr></a></dt><dd>Test class for GroupOrganization API - civicrm_group_organization_*</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-GroupTest.html"><abbr title="\api_v3_GroupTest">api_v3_GroupTest</abbr></a></dt><dd>Test class for Group API - civicrm_group_*</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-ImTest.html"><abbr title="\api_v3_ImTest">api_v3_ImTest</abbr></a></dt><dd>Test APIv3 civicrm_im_* functions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-JobProcessMailingTest.html"><abbr title="\api_v3_JobProcessMailingTest">api_v3_JobProcessMailingTest</abbr></a></dt><dd>Class api_v3_JobTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-JobProcessMembershipTest.html"><abbr title="\api_v3_JobProcessMembershipTest">api_v3_JobProcessMembershipTest</abbr></a></dt><dd>Class api_v3_JobProcessMembershipTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-JobTest.html"><abbr title="\api_v3_JobTest">api_v3_JobTest</abbr></a></dt><dd>Class api_v3_JobTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-JobTestCustomDataTest.html"><abbr title="\api_v3_JobTestCustomDataTest">api_v3_JobTestCustomDataTest</abbr></a></dt><dd>Tests for job api where custom data is involved.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-LineItemTest.html"><abbr title="\api_v3_LineItemTest">api_v3_LineItemTest</abbr></a></dt><dd>Class api_v3_LineItemTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-LocBlockTest.html"><abbr title="\api_v3_LocBlockTest">api_v3_LocBlockTest</abbr></a></dt><dd>Class api_v3_LocBlockTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-LoggingTest.html"><abbr title="\api_v3_LoggingTest">api_v3_LoggingTest</abbr></a></dt><dd>Test class for Logging API.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-MailingABTest.html"><abbr title="\api_v3_MailingABTest">api_v3_MailingABTest</abbr></a></dt><dd>Test APIv3 civicrm_mailingab_* functions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-MailingContactTest.html"><abbr title="\api_v3_MailingContactTest">api_v3_MailingContactTest</abbr></a></dt><dd>Class api_v3_MailingContactTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-MailingGroupTest.html"><abbr title="\api_v3_MailingGroupTest">api_v3_MailingGroupTest</abbr></a></dt><dd>Test APIv3 civicrm_mailing_group_* functions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-MailingTest.html"><abbr title="\api_v3_MailingTest">api_v3_MailingTest</abbr></a></dt><dd>Test APIv3 civicrm_mailing_* functions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-MailSettingsTest.html"><abbr title="\api_v3_MailSettingsTest">api_v3_MailSettingsTest</abbr></a></dt><dd>Class api_v3_MailSettingsTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-MappingFieldTest.html"><abbr title="\api_v3_MappingFieldTest">api_v3_MappingFieldTest</abbr></a></dt><dd>Test APIv3 civicrm_mapping_field_* functions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-MappingTest.html"><abbr title="\api_v3_MappingTest">api_v3_MappingTest</abbr></a></dt><dd>Test APIv3 civicrm_mapping_* functions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-MembershipPaymentTest.html"><abbr title="\api_v3_MembershipPaymentTest">api_v3_MembershipPaymentTest</abbr></a></dt><dd>Test APIv3 civicrm_membership_payment* functions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-MembershipStatusTest.html"><abbr title="\api_v3_MembershipStatusTest">api_v3_MembershipStatusTest</abbr></a></dt><dd>Class api_v3_MembershipStatusTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-MembershipTest.html"><abbr title="\api_v3_MembershipTest">api_v3_MembershipTest</abbr></a></dt><dd>Class api_v3_MembershipTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-MembershipTypeTest.html"><abbr title="\api_v3_MembershipTypeTest">api_v3_MembershipTypeTest</abbr></a></dt><dd>Class api_v3_MembershipTypeTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-MessageTemplateTest.html"><abbr title="\api_v3_MessageTemplateTest">api_v3_MessageTemplateTest</abbr></a></dt><dd>Test class for Template API - civicrm_msg_template*</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-MultilingualTest.html"><abbr title="\api_v3_MultilingualTest">api_v3_MultilingualTest</abbr></a></dt><dd>Test class for the option.language API parameter in multilingual.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-NavigationTest.html"><abbr title="\api_v3_NavigationTest">api_v3_NavigationTest</abbr></a></dt><dd>Class api_v3_NavigationTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-NoteTest.html"><abbr title="\api_v3_NoteTest">api_v3_NoteTest</abbr></a></dt><dd>Class contains api test cases for "civicrm_note"</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-OpenIDTest.html"><abbr title="\api_v3_OpenIDTest">api_v3_OpenIDTest</abbr></a></dt><dd>Test APIv3 civicrm_openid_* functions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-OptionGroupTest.html"><abbr title="\api_v3_OptionGroupTest">api_v3_OptionGroupTest</abbr></a></dt><dd>Class api_v3_OptionGroupTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-OptionValueTest.html"><abbr title="\api_v3_OptionValueTest">api_v3_OptionValueTest</abbr></a></dt><dd>Class api_v3_OptionValueTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-OrderTest.html"><abbr title="\api_v3_OrderTest">api_v3_OrderTest</abbr></a></dt><dd>Test APIv3 civicrm_contribute_* functions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-ParticipantPaymentTest.html"><abbr title="\api_v3_ParticipantPaymentTest">api_v3_ParticipantPaymentTest</abbr></a></dt><dd>Test APIv3 civicrm_participant_* functions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-ParticipantStatusTypeTest.html"><abbr title="\api_v3_ParticipantStatusTypeTest">api_v3_ParticipantStatusTypeTest</abbr></a></dt><dd>Class api_v3_ParticipantStatusTypeTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-ParticipantTest.html"><abbr title="\api_v3_ParticipantTest">api_v3_ParticipantTest</abbr></a></dt><dd>Class api_v3_ParticipantTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-PaymentProcessorTest.html"><abbr title="\api_v3_PaymentProcessorTest">api_v3_PaymentProcessorTest</abbr></a></dt><dd>Class contains api test cases for "civicrm_payment_processor"</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-PaymentProcessorTypeTest.html"><abbr title="\api_v3_PaymentProcessorTypeTest">api_v3_PaymentProcessorTypeTest</abbr></a></dt><dd>Class contains api test cases for "civicrm_payment_processor_type"</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-PaymentTest.html"><abbr title="\api_v3_PaymentTest">api_v3_PaymentTest</abbr></a></dt><dd>Test APIv3 civicrm_contribute_* functions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-PaymentTokenTest.html"><abbr title="\api_v3_PaymentTokenTest">api_v3_PaymentTokenTest</abbr></a></dt><dd>Class api_v3_PaymentTokenTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-PcpTest.html"><abbr title="\api_v3_PcpTest">api_v3_PcpTest</abbr></a></dt><dd>All API should contain at minimum a success test for each
function - in this case - create, get & delete
In addition any extra functionality should be tested & documented</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-PhoneTest.html"><abbr title="\api_v3_PhoneTest">api_v3_PhoneTest</abbr></a></dt><dd>Test APIv3 civicrm_phone* functions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-PledgePaymentTest.html"><abbr title="\api_v3_PledgePaymentTest">api_v3_PledgePaymentTest</abbr></a></dt><dd>Test class for Pledge API - civicrm_pledge_*</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-PledgeTest.html"><abbr title="\api_v3_PledgeTest">api_v3_PledgeTest</abbr></a></dt><dd>Test class for Pledge API - civicrm_pledge_*</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-PriceFieldTest.html"><abbr title="\api_v3_PriceFieldTest">api_v3_PriceFieldTest</abbr></a></dt><dd>Class api_v3_PriceFieldTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-PriceFieldValueTest.html"><abbr title="\api_v3_PriceFieldValueTest">api_v3_PriceFieldValueTest</abbr></a></dt><dd>Class api_v3_PriceFieldValueTest.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-PriceSetTest.html"><abbr title="\api_v3_PriceSetTest">api_v3_PriceSetTest</abbr></a></dt><dd>Class api_v3_PriceSetTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-ProductTest.html"><abbr title="\api_v3_ProductTest">api_v3_ProductTest</abbr></a></dt><dd>Class api_v3_ProductTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-ProfileTest.html"><abbr title="\api_v3_ProfileTest">api_v3_ProfileTest</abbr></a></dt><dd>Test APIv3 civicrm_profile_* functions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-RelationshipTest.html"><abbr title="\api_v3_RelationshipTest">api_v3_RelationshipTest</abbr></a></dt><dd>Class contains api test cases for "civicrm_relationship"</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-RelationshipTypeTest.html"><abbr title="\api_v3_RelationshipTypeTest">api_v3_RelationshipTypeTest</abbr></a></dt><dd>Class contains api test cases for "civicrm_relationship_type"</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-ReportTemplateTest.html"><abbr title="\api_v3_ReportTemplateTest">api_v3_ReportTemplateTest</abbr></a></dt><dd>Test APIv3 civicrm_report_instance_* functions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-SavedSearchTest.html"><abbr title="\api_v3_SavedSearchTest">api_v3_SavedSearchTest</abbr></a></dt><dd>Class api_v3_SavedSearchTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-SelectQueryTest.html"><abbr title="\api_v3_SelectQueryTest">api_v3_SelectQueryTest</abbr></a></dt><dd>Test APIv3 ability to join across multiple entities</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-SettingTest.html"><abbr title="\api_v3_SettingTest">api_v3_SettingTest</abbr></a></dt><dd>Class contains api test cases for civicrm settings</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-StateProvinceTest.html"><abbr title="\api_v3_StateProvinceTest">api_v3_StateProvinceTest</abbr></a></dt><dd>Test APIv3 civicrm_state_province* functions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-StatusPreferenceTest.html"><abbr title="\api_v3_StatusPreferenceTest">api_v3_StatusPreferenceTest</abbr></a></dt><dd>Class api_v3_StatusPreferenceTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-SurveyRespondantTest.html"><abbr title="\api_v3_SurveyRespondantTest">api_v3_SurveyRespondantTest</abbr></a></dt><dd>Class api_v3_SurveyRespondantTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-SurveyTest.html"><abbr title="\api_v3_SurveyTest">api_v3_SurveyTest</abbr></a></dt><dd>All API should contain at minimum a success test for each
function - in this case - create, get & delete
In addition any extra functionality should be tested & documented</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-SyntaxConformanceTest.html"><abbr title="\api_v3_SyntaxConformanceTest">api_v3_SyntaxConformanceTest</abbr></a></dt><dd>Test that the core actions for APIv3 entities comply with standard syntax+behavior.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-SystemCheckTest.html"><abbr title="\api_v3_SystemCheckTest">api_v3_SystemCheckTest</abbr></a></dt><dd>System.check API has many special test cases, so they have their own class.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-SystemTest.html"><abbr title="\api_v3_SystemTest">api_v3_SystemTest</abbr></a></dt><dd>Test class for System API - civicrm_system_*</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-TagTest.html"><abbr title="\api_v3_TagTest">api_v3_TagTest</abbr></a></dt><dd>Test APIv3 civicrm_tag_* functions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-TaxContributionPageTest.html"><abbr title="\api_v3_TaxContributionPageTest">api_v3_TaxContributionPageTest</abbr></a></dt><dd>Class api_v3_TaxContributionPageTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-UFFieldTest.html"><abbr title="\api_v3_UFFieldTest">api_v3_UFFieldTest</abbr></a></dt><dd>Test class for UFField API</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-UFGroupTest.html"><abbr title="\api_v3_UFGroupTest">api_v3_UFGroupTest</abbr></a></dt><dd>Test class for UFGroup API - civicrm_uf_*</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-UFJoinTest.html"><abbr title="\api_v3_UFJoinTest">api_v3_UFJoinTest</abbr></a></dt><dd>Test class for UFGroup API - civicrm_uf_*</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-UFMatchTest.html"><abbr title="\api_v3_UFMatchTest">api_v3_UFMatchTest</abbr></a></dt><dd>Test class for UFMatch api.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-UserTest.html"><abbr title="\api_v3_UserTest">api_v3_UserTest</abbr></a></dt><dd>Test APIv3 civicrm_user_* functions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-UtilsTest.html"><abbr title="\api_v3_UtilsTest">api_v3_UtilsTest</abbr></a></dt><dd>Test class for API utils</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-ValidateTest.html"><abbr title="\api_v3_ValidateTest">api_v3_ValidateTest</abbr></a></dt><dd>Tests for the generic validate API action.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v3-WebsiteTest.html"><abbr title="\api_v3_WebsiteTest">api_v3_WebsiteTest</abbr></a></dt><dd>Test APIv3 civicrm_website_* functions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/api-v4-AllTests.html"><abbr title="\api_v4_AllTests">api_v4_AllTests</abbr></a></dt><dd>Class containing the APIv4 test suite</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Civi-AllTests.html"><abbr title="\Civi_AllTests">Civi_AllTests</abbr></a></dt><dd>Class containing all CRM test suites</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CiviCaseTestCase.html"><abbr title="\CiviCaseTestCase">CiviCaseTestCase</abbr></a></dt><dd>Class CiviReportTestCase</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CiviDBAssert.html"><abbr title="\CiviDBAssert">CiviDBAssert</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CiviEndToEndTestCase.html"><abbr title="\CiviEndToEndTestCase">CiviEndToEndTestCase</abbr></a></dt><dd>Class CiviEndToEndTestCase</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CiviMailUtils.html"><abbr title="\CiviMailUtils">CiviMailUtils</abbr></a></dt><dd>Class CiviMailUtils</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CiviReportTestCase.html"><abbr title="\CiviReportTestCase">CiviReportTestCase</abbr></a></dt><dd>Class CiviReportTestCase</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CiviSimpleCacheTest.html"><abbr title="\CiviSimpleCacheTest">CiviSimpleCacheTest</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CiviTestSMSProvider.html"><abbr title="\CiviTestSMSProvider">CiviTestSMSProvider</abbr></a></dt><dd>Test SMS provider to allow for testing</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CiviTestSuite.html"><abbr title="\CiviTestSuite">CiviTestSuite</abbr></a></dt><dd>Parent class for test suites</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CiviUnitTestCase.html"><abbr title="\CiviUnitTestCase">CiviUnitTestCase</abbr></a></dt><dd>Base class for CiviCRM unit tests</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-ACL-ListTest.html"><abbr title="\CRM_ACL_ListTest">CRM_ACL_ListTest</abbr></a></dt><dd>Class CRM_ACL_Test</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Activity-ActionMappingTest.html"><abbr title="\CRM_Activity_ActionMappingTest">CRM_Activity_ActionMappingTest</abbr></a></dt><dd>Class CRM_Activity_ActionMappingTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Activity-AllTests.html"><abbr title="\CRM_Activity_AllTests">CRM_Activity_AllTests</abbr></a></dt><dd>Class containing all test suites</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Activity-BAO-ActivityAssignmentTest.html"><abbr title="\CRM_Activity_BAO_ActivityAssignmentTest">CRM_Activity_BAO_ActivityAssignmentTest</abbr></a></dt><dd>Test class for CRM_Activity_BAO_ActivityAssignment BAO</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Activity-BAO-ActivityTest.html"><abbr title="\CRM_Activity_BAO_ActivityTest">CRM_Activity_BAO_ActivityTest</abbr></a></dt><dd>Class CRM_Activity_BAO_ActivityTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Activity-BAO-ActivityTypeTest.html"><abbr title="\CRM_Activity_BAO_ActivityTypeTest">CRM_Activity_BAO_ActivityTypeTest</abbr></a></dt><dd>Base class for CiviCRM unit tests</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Activity-Form-ActivityTest.html"><abbr title="\CRM_Activity_Form_ActivityTest">CRM_Activity_Form_ActivityTest</abbr></a></dt><dd>Include dataProvider for tests</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Activity-Form-ActivityViewTest.html"><abbr title="\CRM_Activity_Form_ActivityViewTest">CRM_Activity_Form_ActivityViewTest</abbr></a></dt><dd>Base class for CiviCRM unit tests</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Activity-Form-SearchTest.html"><abbr title="\CRM_Activity_Form_SearchTest">CRM_Activity_Form_SearchTest</abbr></a></dt><dd>Include dataProvider for tests</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Activity-Form-Task-PDFTest.html"><abbr title="\CRM_Activity_Form_Task_PDFTest">CRM_Activity_Form_Task_PDFTest</abbr></a></dt><dd>Class CRM_Activity_Form_Task_PDFLetterCommonTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Activity-Import-Parser-ActivityTest.html"><abbr title="\CRM_Activity_Import_Parser_ActivityTest">CRM_Activity_Import_Parser_ActivityTest</abbr></a></dt><dd>Test Activity Import Parser functions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Activity-Page-AJAXTest.html"><abbr title="\CRM_Activity_Page_AJAXTest">CRM_Activity_Page_AJAXTest</abbr></a></dt><dd>Base class for CiviCRM unit tests</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Activity-Selector-SearchTest.html"><abbr title="\CRM_Activity_Selector_SearchTest">CRM_Activity_Selector_SearchTest</abbr></a></dt><dd>Class CRM_Activity_Selector_SearchTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Form-PaymentProcessorTest.html"><abbr title="\CRM_Admin_Form_PaymentProcessorTest">CRM_Admin_Form_PaymentProcessorTest</abbr></a></dt><dd>Base class for CiviCRM unit tests</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Admin-Form-Setting-LocalizationTest.html"><abbr title="\CRM_Admin_Form_Setting_LocalizationTest">CRM_Admin_Form_Setting_LocalizationTest</abbr></a></dt><dd>Base class for CiviCRM unit tests</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-AllTests.html"><abbr title="\CRM_AllTests">CRM_AllTests</abbr></a></dt><dd>Class containing all CRM test suites</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Batch-BAO-BatchTest.html"><abbr title="\CRM_Batch_BAO_BatchTest">CRM_Batch_BAO_BatchTest</abbr></a></dt><dd>Test CRM/Batch/BAO/Batch.php getBatchFinancialItems</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Batch-Form-EntryTest.html"><abbr title="\CRM_Batch_Form_EntryTest">CRM_Batch_Form_EntryTest</abbr></a></dt><dd>Base class for CiviCRM unit tests</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Bridge-OG-DrupalTest.html"><abbr title="\CRM_Bridge_OG_DrupalTest">CRM_Bridge_OG_DrupalTest</abbr></a></dt><dd>Test contact custom search functions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Campaign-BAO-PetitionTest.html"><abbr title="\CRM_Campaign_BAO_PetitionTest">CRM_Campaign_BAO_PetitionTest</abbr></a></dt><dd>Base class for CiviCRM unit tests</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Campaign-BAO-QueryTest.html"><abbr title="\CRM_Campaign_BAO_QueryTest">CRM_Campaign_BAO_QueryTest</abbr></a></dt><dd>Test APIv3 civicrm_contribute_* functions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Campaign-Form-CampaignTest.html"><abbr title="\CRM_Campaign_Form_CampaignTest">CRM_Campaign_Form_CampaignTest</abbr></a></dt><dd>Base class for CiviCRM unit tests</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-AllTests.html"><abbr title="\CRM_Case_AllTests">CRM_Case_AllTests</abbr></a></dt><dd>Class containing all test suites</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-BAO-CaseTest.html"><abbr title="\CRM_Case_BAO_CaseTest">CRM_Case_BAO_CaseTest</abbr></a></dt><dd>Class CRM_Case_BAO_CaseTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-BAO-CaseTypeForkTest.html"><abbr title="\CRM_Case_BAO_CaseTypeForkTest">CRM_Case_BAO_CaseTypeForkTest</abbr></a></dt><dd>Case Types support an optional forking mechanism wherein the local admin
creates a custom DB-based definition that deviates from the file-based definition.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-BAO-CaseTypeTest.html"><abbr title="\CRM_Case_BAO_CaseTypeTest">CRM_Case_BAO_CaseTypeTest</abbr></a></dt><dd>Class CRM_Case_BAO_CaseTypeTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-BAO-QueryTest.html"><abbr title="\CRM_Case_BAO_QueryTest">CRM_Case_BAO_QueryTest</abbr></a></dt><dd>Include dataProvider for tests</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-Form-CaseViewTest.html"><abbr title="\CRM_Case_Form_CaseViewTest">CRM_Case_Form_CaseViewTest</abbr></a></dt><dd>Class CRM_Case_Form_CaseViewTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-Form-ChangeStartDateTest.html"><abbr title="\CRM_Case_Form_ChangeStartDateTest">CRM_Case_Form_ChangeStartDateTest</abbr></a></dt><dd>Class CiviReportTestCase</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-Form-CustomDataTest.html"><abbr title="\CRM_Case_Form_CustomDataTest">CRM_Case_Form_CustomDataTest</abbr></a></dt><dd>Class CRM_Case_Form_CustomDataTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-Form-EmailTest.html"><abbr title="\CRM_Case_Form_EmailTest">CRM_Case_Form_EmailTest</abbr></a></dt><dd>Class CiviReportTestCase</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-Form-SearchTest.html"><abbr title="\CRM_Case_Form_SearchTest">CRM_Case_Form_SearchTest</abbr></a></dt><dd>Class CRM_Case_Form_SearchTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-Form-TaskTest.html"><abbr title="\CRM_Case_Form_TaskTest">CRM_Case_Form_TaskTest</abbr></a></dt><dd>Class CRM_Case_Form_TaskTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-PseudoConstantTest.html"><abbr title="\CRM_Case_PseudoConstantTest">CRM_Case_PseudoConstantTest</abbr></a></dt><dd>Class CRM_Case_PseudoConstantTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-WorkflowMessage-CaseActivityTest.html"><abbr title="\CRM_Case_WorkflowMessage_CaseActivityTest">CRM_Case_WorkflowMessage_CaseActivityTest</abbr></a></dt><dd>Class CRM_Case_WorkflowMessage_CaseActivityTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-WorkflowMessage-CaseActivityTestWorkflow-CaseAdhocExample.html"><abbr title="\CRM_Case_WorkflowMessage_CaseActivityTestWorkflow_CaseAdhocExample">CRM_Case_WorkflowMessage_CaseActivityTestWorkflow_CaseAdhocExample</abbr></a></dt><dd>Helper class for defining WorkflowMessage example-data.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-WorkflowMessage-CaseActivityTestWorkflow-CaseModelExample.html"><abbr title="\CRM_Case_WorkflowMessage_CaseActivityTestWorkflow_CaseModelExample">CRM_Case_WorkflowMessage_CaseActivityTestWorkflow_CaseModelExample</abbr></a></dt><dd>Helper class for defining WorkflowMessage example-data.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-WorkflowMessage-CaseActivityTestWorkflow.html"><abbr title="\CRM_Case_WorkflowMessage_CaseActivityTestWorkflow">CRM_Case_WorkflowMessage_CaseActivityTestWorkflow</abbr></a></dt><dd>Sample to test test model architecture.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-XMLProcessor-ProcessTest.html"><abbr title="\CRM_Case_XMLProcessor_ProcessTest">CRM_Case_XMLProcessor_ProcessTest</abbr></a></dt><dd>Class CRM_Case_PseudoConstantTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-XMLProcessor-ReportTest.html"><abbr title="\CRM_Case_XMLProcessor_ReportTest">CRM_Case_XMLProcessor_ReportTest</abbr></a></dt><dd>Class CRM_Case_XMLProcessor_ReportTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-XMLProcessorTest.html"><abbr title="\CRM_Case_XMLProcessorTest">CRM_Case_XMLProcessorTest</abbr></a></dt><dd>Class CRM_Case_XMLProcessorTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Case-XMLRepositoryTest.html"><abbr title="\CRM_Case_XMLRepositoryTest">CRM_Case_XMLRepositoryTest</abbr></a></dt><dd>Class CRM_Case_XMLRepositoryTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-AllTests.html"><abbr title="\CRM_Contact_AllTests">CRM_Contact_AllTests</abbr></a></dt><dd>Class containing all test suites</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-BAO-ActivitySearchTest.html"><abbr title="\CRM_Contact_BAO_ActivitySearchTest">CRM_Contact_BAO_ActivitySearchTest</abbr></a></dt><dd>Test APIv3 civicrm_activity_* functions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-BAO-ContactTest.html"><abbr title="\CRM_Contact_BAO_ContactTest">CRM_Contact_BAO_ContactTest</abbr></a></dt><dd>Class CRM_Contact_BAO_ContactTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-BAO-ContactType-ContactSearchTest.html"><abbr title="\CRM_Contact_BAO_ContactType_ContactSearchTest">CRM_Contact_BAO_ContactType_ContactSearchTest</abbr></a></dt><dd>Class CRM_Contact_BAO_ContactType_ContactSearchTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-BAO-ContactType-ContactTest.html"><abbr title="\CRM_Contact_BAO_ContactType_ContactTest">CRM_Contact_BAO_ContactType_ContactTest</abbr></a></dt><dd>Class CRM_Contact_BAO_ContactType_ContactTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-BAO-ContactType-ContactTypeTest.html"><abbr title="\CRM_Contact_BAO_ContactType_ContactTypeTest">CRM_Contact_BAO_ContactType_ContactTypeTest</abbr></a></dt><dd>Class CRM_Contact_BAO_ContactType_ContactTypeTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-BAO-ContactType-RelationshipTest.html"><abbr title="\CRM_Contact_BAO_ContactType_RelationshipTest">CRM_Contact_BAO_ContactType_RelationshipTest</abbr></a></dt><dd>Class CRM_Contact_BAO_ContactType_RelationshipTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-BAO-GroupContactCacheTest.html"><abbr title="\CRM_Contact_BAO_GroupContactCacheTest">CRM_Contact_BAO_GroupContactCacheTest</abbr></a></dt><dd>Test class for CRM_Contact_BAO_GroupContact BAO</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-BAO-GroupContactTest.html"><abbr title="\CRM_Contact_BAO_GroupContactTest">CRM_Contact_BAO_GroupContactTest</abbr></a></dt><dd>Test class for CRM_Contact_BAO_GroupContact BAO</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-BAO-GroupTest.html"><abbr title="\CRM_Contact_BAO_GroupTest">CRM_Contact_BAO_GroupTest</abbr></a></dt><dd>Test class for CRM_Contact_BAO_Group BAO</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-BAO-IndividualTest.html"><abbr title="\CRM_Contact_BAO_IndividualTest">CRM_Contact_BAO_IndividualTest</abbr></a></dt><dd>Class CRM_Contact_BAO_IndividualTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-BAO-QueryStateNameTest.html"><abbr title="\CRM_Contact_BAO_QueryStateNameTest">CRM_Contact_BAO_QueryStateNameTest</abbr></a></dt><dd>Class CRM_Contact_BAO_QueryStateNameTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-BAO-QueryTest.html"><abbr title="\CRM_Contact_BAO_QueryTest">CRM_Contact_BAO_QueryTest</abbr></a></dt><dd>Include dataProvider for tests</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-BAO-RelationshipCacheTest.html"><abbr title="\CRM_Contact_BAO_RelationshipCacheTest">CRM_Contact_BAO_RelationshipCacheTest</abbr></a></dt><dd>Test class for CRM_Contact_BAO_RelationshipCache</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-BAO-RelationshipTest.html"><abbr title="\CRM_Contact_BAO_RelationshipTest">CRM_Contact_BAO_RelationshipTest</abbr></a></dt><dd>Test class for CRM_Contact_BAO_Relationship</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-BAO-SavedSearchTest.html"><abbr title="\CRM_Contact_BAO_SavedSearchTest">CRM_Contact_BAO_SavedSearchTest</abbr></a></dt><dd>Test class for CRM_Contact_BAO_Group BAO</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-IndividualTest.html"><abbr title="\CRM_Contact_Form_IndividualTest">CRM_Contact_Form_IndividualTest</abbr></a></dt><dd>Class CRM_Contact_Form_IndividualTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Search-BasicTest.html"><abbr title="\CRM_Contact_Form_Search_BasicTest">CRM_Contact_Form_Search_BasicTest</abbr></a></dt><dd>Test class for CRM_Contact_Form_Basic</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Search-CriteriaTest.html"><abbr title="\CRM_Contact_Form_Search_CriteriaTest">CRM_Contact_Form_Search_CriteriaTest</abbr></a></dt><dd>Test class for CRM_Contact_Form_Search_Criteria</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Search-SearchContactTest.html"><abbr title="\CRM_Contact_Form_Search_SearchContactTest">CRM_Contact_Form_Search_SearchContactTest</abbr></a></dt><dd>Test class for CRM_Contact_BAO_Group BAO</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Task-AddToGroupTest.html"><abbr title="\CRM_Contact_Form_Task_AddToGroupTest">CRM_Contact_Form_Task_AddToGroupTest</abbr></a></dt><dd>Base class for CiviCRM unit tests</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Task-DeleteTest.html"><abbr title="\CRM_Contact_Form_Task_DeleteTest">CRM_Contact_Form_Task_DeleteTest</abbr></a></dt><dd>Base class for CiviCRM unit tests</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Task-EmailTest.html"><abbr title="\CRM_Contact_Form_Task_EmailTest">CRM_Contact_Form_Task_EmailTest</abbr></a></dt><dd>Test class for CRM_Contact_Form_Task_Email.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Task-PDFLetterCommonTest.html"><abbr title="\CRM_Contact_Form_Task_PDFLetterCommonTest">CRM_Contact_Form_Task_PDFLetterCommonTest</abbr></a></dt><dd>Test class for CRM_Contact_Form_Task_PDFLetterCommon.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Task-PrintDocumentTest.html"><abbr title="\CRM_Contact_Form_Task_PrintDocumentTest">CRM_Contact_Form_Task_PrintDocumentTest</abbr></a></dt><dd>Test class for CRM_Contact_Form_Task_PDF.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Task-PrintMailingLabelTest.html"><abbr title="\CRM_Contact_Form_Task_PrintMailingLabelTest">CRM_Contact_Form_Task_PrintMailingLabelTest</abbr></a></dt><dd>Test class for CRM_Contact_Form_Task_Label.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Task-SMSCommonTest.html"><abbr title="\CRM_Contact_Form_Task_SMSCommonTest">CRM_Contact_Form_Task_SMSCommonTest</abbr></a></dt><dd>Test class for CRM_Contact_Form_Task_SMSCommon.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Form-Task-UseraddTest.html"><abbr title="\CRM_Contact_Form_Task_UseraddTest">CRM_Contact_Form_Task_UseraddTest</abbr></a></dt><dd>Base class for CiviCRM unit tests</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Import-Form-DataSourceTest.html"><abbr title="\CRM_Contact_Import_Form_DataSourceTest">CRM_Contact_Import_Form_DataSourceTest</abbr></a></dt><dd>Test contact import datasource.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Import-Form-MapFieldTest.html"><abbr title="\CRM_Contact_Import_Form_MapFieldTest">CRM_Contact_Import_Form_MapFieldTest</abbr></a></dt><dd>Test contact import map field.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Import-Parser-ContactTest.html"><abbr title="\CRM_Contact_Import_Parser_ContactTest">CRM_Contact_Import_Parser_ContactTest</abbr></a></dt><dd>Test contact import parser.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Page-AjaxTest.html"><abbr title="\CRM_Contact_Page_AjaxTest">CRM_Contact_Page_AjaxTest</abbr></a></dt><dd>Base class for CiviCRM unit tests</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Page-DedupeExceptionTest.html"><abbr title="\CRM_Contact_Page_DedupeExceptionTest">CRM_Contact_Page_DedupeExceptionTest</abbr></a></dt><dd>Test class for CRM_Contact_Page_DedupeException BAO</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Page-View-UserDashboard-GroupContactTest.html"><abbr title="\CRM_Contact_Page_View_UserDashboard_GroupContactTest">CRM_Contact_Page_View_UserDashboard_GroupContactTest</abbr></a></dt><dd>Test class for CRM_Contact_BAO_GroupContact BAO</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-Page-View-UserDashBoardTest.html"><abbr title="\CRM_Contact_Page_View_UserDashBoardTest">CRM_Contact_Page_View_UserDashBoardTest</abbr></a></dt><dd>Test class for CRM_Contact_Page_View_UserDashBoard</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contact-SelectorTest.html"><abbr title="\CRM_Contact_SelectorTest">CRM_Contact_SelectorTest</abbr></a></dt><dd>Test contact custom search functions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-ActionMapping-ByTypeTest.html"><abbr title="\CRM_Contribute_ActionMapping_ByTypeTest">CRM_Contribute_ActionMapping_ByTypeTest</abbr></a></dt><dd>Class CRM_Contribute_ActionMapping_ByTypeTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-AllTests.html"><abbr title="\CRM_Contribute_AllTests">CRM_Contribute_AllTests</abbr></a></dt><dd>Class containing all test suites</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-BAO-ContributionPageTest.html"><abbr title="\CRM_Contribute_BAO_ContributionPageTest">CRM_Contribute_BAO_ContributionPageTest</abbr></a></dt><dd>Class CRM_Contribute_BAO_ContributionPageTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-BAO-ContributionRecurTest.html"><abbr title="\CRM_Contribute_BAO_ContributionRecurTest">CRM_Contribute_BAO_ContributionRecurTest</abbr></a></dt><dd>Class CRM_Contribute_BAO_ContributionRecurTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-BAO-ContributionTest.html"><abbr title="\CRM_Contribute_BAO_ContributionTest">CRM_Contribute_BAO_ContributionTest</abbr></a></dt><dd>Class CRM_Contribute_BAO_ContributionTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-BAO-ContributionTypeTest.html"><abbr title="\CRM_Contribute_BAO_ContributionTypeTest">CRM_Contribute_BAO_ContributionTypeTest</abbr></a></dt><dd>Class CRM_Contribute_BAO_ContributionTypeTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-BAO-ProductTest.html"><abbr title="\CRM_Contribute_BAO_ProductTest">CRM_Contribute_BAO_ProductTest</abbr></a></dt><dd>Class CRM_Contribute_BAO_ProductTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-BAO-QueryTest.html"><abbr title="\CRM_Contribute_BAO_QueryTest">CRM_Contribute_BAO_QueryTest</abbr></a></dt><dd>Include dataProvider for tests</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Form-AdditionalPaymentTest.html"><abbr title="\CRM_Contribute_Form_AdditionalPaymentTest">CRM_Contribute_Form_AdditionalPaymentTest</abbr></a></dt><dd>Test APIv3 civicrm_contribute_* functions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Form-CancelSubscriptionTest.html"><abbr title="\CRM_Contribute_Form_CancelSubscriptionTest">CRM_Contribute_Form_CancelSubscriptionTest</abbr></a></dt><dd>Class CRM_Contribute_Form_UpdateSubscriptionTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Form-Contribution-ConfirmTest.html"><abbr title="\CRM_Contribute_Form_Contribution_ConfirmTest">CRM_Contribute_Form_Contribution_ConfirmTest</abbr></a></dt><dd>Test APIv3 civicrm_contribute_* functions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Form-Contribution-MainTest.html"><abbr title="\CRM_Contribute_Form_Contribution_MainTest">CRM_Contribute_Form_Contribution_MainTest</abbr></a></dt><dd>Test APIv3 civicrm_contribute_* functions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Form-Contribution-ThankYouTest.html"><abbr title="\CRM_Contribute_Form_Contribution_ThankYouTest">CRM_Contribute_Form_Contribution_ThankYouTest</abbr></a></dt><dd>Test CRM_Contribute_Form_Contribution_ThankYou</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Form-ContributionPage-SettingsTest.html"><abbr title="\CRM_Contribute_Form_ContributionPage_SettingsTest">CRM_Contribute_Form_ContributionPage_SettingsTest</abbr></a></dt><dd>Base class for CiviCRM unit tests</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Form-ContributionPageTranslationTest.html"><abbr title="\CRM_Contribute_Form_ContributionPageTranslationTest">CRM_Contribute_Form_ContributionPageTranslationTest</abbr></a></dt><dd>Test ContributionPage translation features.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Form-ContributionTest.html"><abbr title="\CRM_Contribute_Form_ContributionTest">CRM_Contribute_Form_ContributionTest</abbr></a></dt><dd>Test APIv3 civicrm_contribute_* functions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Form-ContributionViewTest.html"><abbr title="\CRM_Contribute_Form_ContributionViewTest">CRM_Contribute_Form_ContributionViewTest</abbr></a></dt><dd>Base class for CiviCRM unit tests</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Form-SearchTest.html"><abbr title="\CRM_Contribute_Form_SearchTest">CRM_Contribute_Form_SearchTest</abbr></a></dt><dd>Test Contribution Search form filters</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Form-Task-BatchTest.html"><abbr title="\CRM_Contribute_Form_Task_BatchTest">CRM_Contribute_Form_Task_BatchTest</abbr></a></dt><dd>Base class for CiviCRM unit tests</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Form-Task-EmailTest.html"><abbr title="\CRM_Contribute_Form_Task_EmailTest">CRM_Contribute_Form_Task_EmailTest</abbr></a></dt><dd>Test Email task.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Form-Task-InvoiceTest.html"><abbr title="\CRM_Contribute_Form_Task_InvoiceTest">CRM_Contribute_Form_Task_InvoiceTest</abbr></a></dt><dd>Test APIv3 civicrm_contribute_* functions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Form-Task-PDFLetterCommonTest.html"><abbr title="\CRM_Contribute_Form_Task_PDFLetterCommonTest">CRM_Contribute_Form_Task_PDFLetterCommonTest</abbr></a></dt><dd>Test APIv3 civicrm_contribute_* functions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Form-Task-PDFTest.html"><abbr title="\CRM_Contribute_Form_Task_PDFTest">CRM_Contribute_Form_Task_PDFTest</abbr></a></dt><dd>Test Email task.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Form-Task-StatusTest.html"><abbr title="\CRM_Contribute_Form_Task_StatusTest">CRM_Contribute_Form_Task_StatusTest</abbr></a></dt><dd>Class CRM_Contribute_Form_Task_StatusTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Form-TaskTest.html"><abbr title="\CRM_Contribute_Form_TaskTest">CRM_Contribute_Form_TaskTest</abbr></a></dt><dd>Class CRM_Contribute_Form_TaskTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Form-UpdateSubscriptionTest.html"><abbr title="\CRM_Contribute_Form_UpdateSubscriptionTest">CRM_Contribute_Form_UpdateSubscriptionTest</abbr></a></dt><dd>Class CRM_Contribute_Form_UpdateSubscriptionTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Import-Parser-ContributionTest.html"><abbr title="\CRM_Contribute_Import_Parser_ContributionTest">CRM_Contribute_Import_Parser_ContributionTest</abbr></a></dt><dd>Test Contribution import parser.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Page-AjaxTest.html"><abbr title="\CRM_Contribute_Page_AjaxTest">CRM_Contribute_Page_AjaxTest</abbr></a></dt><dd>Class CRM_Contribute_Page_AjaxTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Page-TabTest.html"><abbr title="\CRM_Contribute_Page_TabTest">CRM_Contribute_Page_TabTest</abbr></a></dt><dd>Class CRM_Contribute_Page_AjaxTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-PseudoConstantTest.html"><abbr title="\CRM_Contribute_PseudoConstantTest">CRM_Contribute_PseudoConstantTest</abbr></a></dt><dd>CRM_Contribute_PseudoConstantTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Contribute-Selector-SearchTest.html"><abbr title="\CRM_Contribute_Selector_SearchTest">CRM_Contribute_Selector_SearchTest</abbr></a></dt><dd>Class CRM_Contribute_Selector_SearchTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-AllTests.html"><abbr title="\CRM_Core_AllTests">CRM_Core_AllTests</abbr></a></dt><dd>Class containing all test suites</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-ActionScheduleTest.html"><abbr title="\CRM_Core_BAO_ActionScheduleTest">CRM_Core_BAO_ActionScheduleTest</abbr></a></dt><dd>Class CRM_Core_BAO_ActionScheduleTest.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-AddressTest.html"><abbr title="\CRM_Core_BAO_AddressTest">CRM_Core_BAO_AddressTest</abbr></a></dt><dd>Class CRM_Core_BAO_AddressTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-CacheTest.html"><abbr title="\CRM_Core_BAO_CacheTest">CRM_Core_BAO_CacheTest</abbr></a></dt><dd>Class CRM_Core_BAO_CacheTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-ConfigSettingTest.html"><abbr title="\CRM_Core_BAO_ConfigSettingTest">CRM_Core_BAO_ConfigSettingTest</abbr></a></dt><dd>Class CiviReportTestCase</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-CustomFieldTest.html"><abbr title="\CRM_Core_BAO_CustomFieldTest">CRM_Core_BAO_CustomFieldTest</abbr></a></dt><dd>Class CRM_Core_BAO_CustomFieldTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-CustomGroupTest.html"><abbr title="\CRM_Core_BAO_CustomGroupTest">CRM_Core_BAO_CustomGroupTest</abbr></a></dt><dd>Class CRM_Core_BAO_CustomGroupTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-CustomQueryTest.html"><abbr title="\CRM_Core_BAO_CustomQueryTest">CRM_Core_BAO_CustomQueryTest</abbr></a></dt><dd>Include dataProvider for tests</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-CustomValueTableMultipleTest.html"><abbr title="\CRM_Core_BAO_CustomValueTableMultipleTest">CRM_Core_BAO_CustomValueTableMultipleTest</abbr></a></dt><dd>Class CRM_Core_BAO_CustomValueTableMultipleTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-CustomValueTableSetGetTest.html"><abbr title="\CRM_Core_BAO_CustomValueTableSetGetTest">CRM_Core_BAO_CustomValueTableSetGetTest</abbr></a></dt><dd>Class CRM_Core_BAO_CustomValueTableSetGetTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-CustomValueTableTest.html"><abbr title="\CRM_Core_BAO_CustomValueTableTest">CRM_Core_BAO_CustomValueTableTest</abbr></a></dt><dd>Class CRM_Core_BAO_CustomValueTableTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-CustomValueTest.html"><abbr title="\CRM_Core_BAO_CustomValueTest">CRM_Core_BAO_CustomValueTest</abbr></a></dt><dd>Class CRM_Core_BAO_CustomValueTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-DiscountTest.html"><abbr title="\CRM_Core_BAO_DiscountTest">CRM_Core_BAO_DiscountTest</abbr></a></dt><dd>Class CRM_Core_BAO_DiscountTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-EmailTest.html"><abbr title="\CRM_Core_BAO_EmailTest">CRM_Core_BAO_EmailTest</abbr></a></dt><dd>Class CRM_Core_BAO_EmailTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-FileTest.html"><abbr title="\CRM_Core_BAO_FileTest">CRM_Core_BAO_FileTest</abbr></a></dt><dd>Class CRM_Core_BAO_FileTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-FinancialTrxnTest.html"><abbr title="\CRM_Core_BAO_FinancialTrxnTest">CRM_Core_BAO_FinancialTrxnTest</abbr></a></dt><dd>Class CRM_Core_BAO_FinancialTrxnTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-IMTest.html"><abbr title="\CRM_Core_BAO_IMTest">CRM_Core_BAO_IMTest</abbr></a></dt><dd>Class CRM_Core_BAO_IMTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-LocationTest.html"><abbr title="\CRM_Core_BAO_LocationTest">CRM_Core_BAO_LocationTest</abbr></a></dt><dd>Class CRM_Core_BAO_LocationTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-MappingTest.html"><abbr title="\CRM_Core_BAO_MappingTest">CRM_Core_BAO_MappingTest</abbr></a></dt><dd>Class CRM_Core_BAO_MappingTest.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-MessageTemplateTest.html"><abbr title="\CRM_Core_BAO_MessageTemplateTest">CRM_Core_BAO_MessageTemplateTest</abbr></a></dt><dd>Class CRM_Core_BAO_MessageTemplateTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-NavigationTest.html"><abbr title="\CRM_Core_BAO_NavigationTest">CRM_Core_BAO_NavigationTest</abbr></a></dt><dd>Class CRM_Core_BAO_NavigationTest.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-OpenIDTest.html"><abbr title="\CRM_Core_BAO_OpenIDTest">CRM_Core_BAO_OpenIDTest</abbr></a></dt><dd>Class CRM_Core_BAO_OpenIDTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-OptionGroupTest.html"><abbr title="\CRM_Core_BAO_OptionGroupTest">CRM_Core_BAO_OptionGroupTest</abbr></a></dt><dd>Class CRM_Core_BAO_SchemaHandlerTest.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-OptionValueTest.html"><abbr title="\CRM_Core_BAO_OptionValueTest">CRM_Core_BAO_OptionValueTest</abbr></a></dt><dd>Class CRM_Core_BAO_SchemaHandlerTest.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-PhoneTest.html"><abbr title="\CRM_Core_BAO_PhoneTest">CRM_Core_BAO_PhoneTest</abbr></a></dt><dd>Class CRM_Core_BAO_PhoneTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-PreferencesTest.html"><abbr title="\CRM_Core_BAO_PreferencesTest">CRM_Core_BAO_PreferencesTest</abbr></a></dt><dd>Class CRM_Core_BAO_PreferencesTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-PrevNextCacheTest.html"><abbr title="\CRM_Core_BAO_PrevNextCacheTest">CRM_Core_BAO_PrevNextCacheTest</abbr></a></dt><dd>Class CRM_Core_BAO_PrevNextCacheTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-RecurringEntityTest.html"><abbr title="\CRM_Core_BAO_RecurringEntityTest">CRM_Core_BAO_RecurringEntityTest</abbr></a></dt><dd>Class CRM_Core_BAO_RecurringEntityTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-SchemaHandlerTest.html"><abbr title="\CRM_Core_BAO_SchemaHandlerTest">CRM_Core_BAO_SchemaHandlerTest</abbr></a></dt><dd>Class CRM_Core_BAO_SchemaHandlerTest.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-SettingTest.html"><abbr title="\CRM_Core_BAO_SettingTest">CRM_Core_BAO_SettingTest</abbr></a></dt><dd>Class CRM_Core_BAO_SettingTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-TagTest.html"><abbr title="\CRM_Core_BAO_TagTest">CRM_Core_BAO_TagTest</abbr></a></dt><dd>Class CRM_Core_BAO_TagTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-UFFieldTest.html"><abbr title="\CRM_Core_BAO_UFFieldTest">CRM_Core_BAO_UFFieldTest</abbr></a></dt><dd>Class CRM_Core_BAO_UFFieldTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-UFGroupTest.html"><abbr title="\CRM_Core_BAO_UFGroupTest">CRM_Core_BAO_UFGroupTest</abbr></a></dt><dd>Class CRM_Core_BAO_UFGroupTest.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-BAO-UFMatchTest.html"><abbr title="\CRM_Core_BAO_UFMatchTest">CRM_Core_BAO_UFMatchTest</abbr></a></dt><dd>Class CRM_Core_BAO_UFMatchTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-CommunityMessagesTest.html"><abbr title="\CRM_Core_CommunityMessagesTest">CRM_Core_CommunityMessagesTest</abbr></a></dt><dd>Class CRM_Core_CommunityMessagesTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-ComposerConfigTest.html"><abbr title="\CRM_Core_ComposerConfigTest">CRM_Core_ComposerConfigTest</abbr></a></dt><dd>Class CRM_Core_ComposerConfigTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Config-MagicMergeTest.html"><abbr title="\CRM_Core_Config_MagicMergeTest">CRM_Core_Config_MagicMergeTest</abbr></a></dt><dd>Class CRM_Core_Config_MagicMergeTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Config-MailerTest.html"><abbr title="\CRM_Core_Config_MailerTest">CRM_Core_Config_MailerTest</abbr></a></dt><dd>Class CRM_Core_Config_MailerTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-CopyTest.html"><abbr title="\CRM_Core_CopyTest">CRM_Core_CopyTest</abbr></a></dt><dd>Base class for CiviCRM unit tests</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAO-AllCoreTablesTest.html"><abbr title="\CRM_Core_DAO_AllCoreTablesTest">CRM_Core_DAO_AllCoreTablesTest</abbr></a></dt><dd>Class CRM_Core_DAO_AllCoreTablesTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAOConformanceTest.html"><abbr title="\CRM_Core_DAOConformanceTest">CRM_Core_DAOConformanceTest</abbr></a></dt><dd>Class for testing new DAO meet required standards.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-DAOTest.html"><abbr title="\CRM_Core_DAOTest">CRM_Core_DAOTest</abbr></a></dt><dd>Class CRM_Core_DAOTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-ErrorTest.html"><abbr title="\CRM_Core_ErrorTest">CRM_Core_ErrorTest</abbr></a></dt><dd>Tests for linking to resource files</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-FieldOptionsTest.html"><abbr title="\CRM_Core_FieldOptionsTest">CRM_Core_FieldOptionsTest</abbr></a></dt><dd>Tests for field options</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-FormTest.html"><abbr title="\CRM_Core_FormTest">CRM_Core_FormTest</abbr></a></dt><dd>Base class for CiviCRM unit tests</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-I18n-LocaleTest.html"><abbr title="\CRM_Core_I18n_LocaleTest">CRM_Core_I18n_LocaleTest</abbr></a></dt><dd>Class CRM_Core_I18n_LocaleTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-I18n-SchemaStructureTest.html"><abbr title="\CRM_Core_I18n_SchemaStructureTest">CRM_Core_I18n_SchemaStructureTest</abbr></a></dt><dd>Class CRM_Core_I18n_SchemaTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-I18n-SchemaTest.html"><abbr title="\CRM_Core_I18n_SchemaTest">CRM_Core_I18n_SchemaTest</abbr></a></dt><dd>Class CRM_Core_I18n_SchemaTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-InvokeTest.html"><abbr title="\CRM_Core_InvokeTest">CRM_Core_InvokeTest</abbr></a></dt><dd>Base class for CiviCRM unit tests</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-JobManagerTest.html"><abbr title="\CRM_Core_JobManagerTest">CRM_Core_JobManagerTest</abbr></a></dt><dd>Class CRM_Core_JobManagerTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-KeyTest.html"><abbr title="\CRM_Core_KeyTest">CRM_Core_KeyTest</abbr></a></dt><dd>Class CRM_Core_KeyTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-ManagedEntitiesTest.html"><abbr title="\CRM_Core_ManagedEntitiesTest">CRM_Core_ManagedEntitiesTest</abbr></a></dt><dd>Class CRM_Core_ManagedEntitiesTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-MenuTest.html"><abbr title="\CRM_Core_MenuTest">CRM_Core_MenuTest</abbr></a></dt><dd>Class CRM_Core_MenuTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-OptionGroupTest.html"><abbr title="\CRM_Core_OptionGroupTest">CRM_Core_OptionGroupTest</abbr></a></dt><dd>Tests for field options</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Page-AJAXTest.html"><abbr title="\CRM_Core_Page_AJAXTest">CRM_Core_Page_AJAXTest</abbr></a></dt><dd>Class CRM_Core_Page_AJAXTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Page-HookTest.html"><abbr title="\CRM_Core_Page_HookTest">CRM_Core_Page_HookTest</abbr></a></dt><dd>Test that page hooks only get invoked once per page run.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Page-Inline-HelpTest.html"><abbr title="\CRM_Core_Page_Inline_HelpTest">CRM_Core_Page_Inline_HelpTest</abbr></a></dt><dd>Class CRM_Core_Page_Inline_HelpTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Page-RedirectTest.html"><abbr title="\CRM_Core_Page_RedirectTest">CRM_Core_Page_RedirectTest</abbr></a></dt><dd>Class CRM_Core_Page_RedirectTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-PageTest.html"><abbr title="\CRM_Core_PageTest">CRM_Core_PageTest</abbr></a></dt><dd>Class CRM_Core_PageTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Payment-AuthorizeNetIPNTest.html"><abbr title="\CRM_Core_Payment_AuthorizeNetIPNTest">CRM_Core_Payment_AuthorizeNetIPNTest</abbr></a></dt><dd>Class CRM_Core_Payment_PayPalProIPNTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Payment-AuthorizeNetTest.html"><abbr title="\CRM_Core_Payment_AuthorizeNetTest">CRM_Core_Payment_AuthorizeNetTest</abbr></a></dt><dd>Class CRM_Core_Payment_AuthorizeNetTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Payment-BaseIPNTest.html"><abbr title="\CRM_Core_Payment_BaseIPNTest">CRM_Core_Payment_BaseIPNTest</abbr></a></dt><dd>Class CRM_Core_Payment_BaseIPNTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Payment-PayPalIPNTest.html"><abbr title="\CRM_Core_Payment_PayPalIPNTest">CRM_Core_Payment_PayPalIPNTest</abbr></a></dt><dd>Class CRM_Core_Payment_PayPalProIPNTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Payment-PayPalProIPNTest.html"><abbr title="\CRM_Core_Payment_PayPalProIPNTest">CRM_Core_Payment_PayPalProIPNTest</abbr></a></dt><dd>Class CRM_Core_Payment_PayPalProIPNTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Payment-PaypalProTest.html"><abbr title="\CRM_Core_Payment_PaypalProTest">CRM_Core_Payment_PaypalProTest</abbr></a></dt><dd>Class CRM_Core_Payment_PaypalPro</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Payment-PaypalStdTest.html"><abbr title="\CRM_Core_Payment_PaypalStdTest">CRM_Core_Payment_PaypalStdTest</abbr></a></dt><dd>Class CRM_Core_Payment_PaypalPro</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Payment-ProcessorFormTest.html"><abbr title="\CRM_Core_Payment_ProcessorFormTest">CRM_Core_Payment_ProcessorFormTest</abbr></a></dt><dd>Class CRM_Core_Payment_ProcessorFormTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/PaymentProcessorWithStandardBillingRequirements.html"><abbr title="\PaymentProcessorWithStandardBillingRequirements">PaymentProcessorWithStandardBillingRequirements</abbr></a></dt><dd>Class CRM_Core_Payment.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/PaymentProcessorWithCustomBillingRequirements.html"><abbr title="\PaymentProcessorWithCustomBillingRequirements">PaymentProcessorWithCustomBillingRequirements</abbr></a></dt><dd>Class CRM_Core_Payment.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-PaymentTest.html"><abbr title="\CRM_Core_PaymentTest">CRM_Core_PaymentTest</abbr></a></dt><dd>Class CRM_Core_PaymentTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Permission-BaseTest.html"><abbr title="\CRM_Core_Permission_BaseTest">CRM_Core_Permission_BaseTest</abbr></a></dt><dd>Class CRM_Core_Permission_BaseTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Permission-GenericTest.html"><abbr title="\CRM_Core_Permission_GenericTest">CRM_Core_Permission_GenericTest</abbr></a></dt><dd>Class CRM_Core_Permission_GenericTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Permission-JoomlaTest.html"><abbr title="\CRM_Core_Permission_JoomlaTest">CRM_Core_Permission_JoomlaTest</abbr></a></dt><dd>Class CRM_Core_Permission_JoomlaTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-PseudoConstantTest.html"><abbr title="\CRM_Core_PseudoConstantTest">CRM_Core_PseudoConstantTest</abbr></a></dt><dd>Tests for pseudoconstant retrieval</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-RegionTest.html"><abbr title="\CRM_Core_RegionTest">CRM_Core_RegionTest</abbr></a></dt><dd>Class CRM_Core_RegionTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Resources-BundleTest.html"><abbr title="\CRM_Core_Resources_BundleTest">CRM_Core_Resources_BundleTest</abbr></a></dt><dd>Tests for manipulating bundles</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Resources-StringsTest.html"><abbr title="\CRM_Core_Resources_StringsTest">CRM_Core_Resources_StringsTest</abbr></a></dt><dd>Tests for parsing translatable strings in HTML content.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-ResourcesTest.html"><abbr title="\CRM_Core_ResourcesTest">CRM_Core_ResourcesTest</abbr></a></dt><dd>Tests for linking to resource files</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-SessionTest.html"><abbr title="\CRM_Core_SessionTest">CRM_Core_SessionTest</abbr></a></dt><dd>Class CRM_Core_SessionTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Smarty-plugins-CrmMoneyTest.html"><abbr title="\CRM_Core_Smarty_plugins_CrmMoneyTest">CRM_Core_Smarty_plugins_CrmMoneyTest</abbr></a></dt><dd>Class CRM_Core_Smarty_plugins_CrmMoneyTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Smarty-plugins-CrmPermissionTest.html"><abbr title="\CRM_Core_Smarty_plugins_CrmPermissionTest">CRM_Core_Smarty_plugins_CrmPermissionTest</abbr></a></dt><dd>Class CRM_Core_Smarty_plugins_CrmMoneyTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Smarty-plugins-CrmRSSPubDateTest.html"><abbr title="\CRM_Core_Smarty_plugins_CrmRSSPubDateTest">CRM_Core_Smarty_plugins_CrmRSSPubDateTest</abbr></a></dt><dd>Class CRM_Core_Smarty_plugins_CrmRSSPubDateTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Smarty-plugins-CrmScopeTest.html"><abbr title="\CRM_Core_Smarty_plugins_CrmScopeTest">CRM_Core_Smarty_plugins_CrmScopeTest</abbr></a></dt><dd>Class CRM_Core_Smarty_plugins_CrmScopeTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Smarty-plugins-CrmUpperTest.html"><abbr title="\CRM_Core_Smarty_plugins_CrmUpperTest">CRM_Core_Smarty_plugins_CrmUpperTest</abbr></a></dt><dd>Class CRM_Core_Smarty_plugins_CrmUpperTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Smarty-plugins-HtxtTest.html"><abbr title="\CRM_Core_Smarty_plugins_HtxtTest">CRM_Core_Smarty_plugins_HtxtTest</abbr></a></dt><dd>Class CRM_Core_Smarty_plugins_CrmScopeTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-Smarty-plugins-UrlTest.html"><abbr title="\CRM_Core_Smarty_plugins_UrlTest">CRM_Core_Smarty_plugins_UrlTest</abbr></a></dt><dd>Class CRM_Core_Smarty_plugins_UrlTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-SmartyTest.html"><abbr title="\CRM_Core_SmartyTest">CRM_Core_SmartyTest</abbr></a></dt><dd>Class CRM_Core_SmartyTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-TokenSmartyTest.html"><abbr title="\CRM_Core_TokenSmartyTest">CRM_Core_TokenSmartyTest</abbr></a></dt><dd>The Token-Smarty template notation is a hybrid notation that combines `{entity.field}` tokens
and `{$smarty.expressions}`. At time of writing, this notation is commonly used with MessageTemplates.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Core-TransactionTest.html"><abbr title="\CRM_Core_TransactionTest">CRM_Core_TransactionTest</abbr></a></dt><dd>Class CRM_Core_TransactionTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Custom-Form-FieldTest.html"><abbr title="\CRM_Custom_Form_FieldTest">CRM_Custom_Form_FieldTest</abbr></a></dt><dd>Class CRM_Custom_Form_FieldTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Custom-Form-OptionTest.html"><abbr title="\CRM_Custom_Form_OptionTest">CRM_Custom_Form_OptionTest</abbr></a></dt><dd>Class CRM_Custom_Form_OptionTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Custom-Import-Parser-ApiTest.html"><abbr title="\CRM_Custom_Import_Parser_ApiTest">CRM_Custom_Import_Parser_ApiTest</abbr></a></dt><dd>Test Contribution import parser.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Custom-Page-AJAXTest.html"><abbr title="\CRM_Custom_Page_AJAXTest">CRM_Custom_Page_AJAXTest</abbr></a></dt><dd>Class CRM_Custom_Page_AJAXTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Dedupe-DAO-TestEntity.html"><abbr title="\CRM_Dedupe_DAO_TestEntity">CRM_Dedupe_DAO_TestEntity</abbr></a></dt><dd>Class CRM_Core_DAO</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Dedupe-BAO-RuleGroupTest.html"><abbr title="\CRM_Dedupe_BAO_RuleGroupTest">CRM_Dedupe_BAO_RuleGroupTest</abbr></a></dt><dd>Class CRM_Dedupe_BAO_RuleGroupTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Dedupe-DedupeFinderTest.html"><abbr title="\CRM_Dedupe_DedupeFinderTest">CRM_Dedupe_DedupeFinderTest</abbr></a></dt><dd>Class CRM_Dedupe_DedupeFinderTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Dedupe-MergerTest.html"><abbr title="\CRM_Dedupe_MergerTest">CRM_Dedupe_MergerTest</abbr></a></dt><dd>Class CRM_Dedupe_DedupeMergerTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-ActionMappingTest.html"><abbr title="\CRM_Event_ActionMappingTest">CRM_Event_ActionMappingTest</abbr></a></dt><dd>Class CRM_Event_ActionMappingTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-AllTests.html"><abbr title="\CRM_Event_AllTests">CRM_Event_AllTests</abbr></a></dt><dd>Class containing all test suites</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-BAO-AdditionalPaymentTest.html"><abbr title="\CRM_Event_BAO_AdditionalPaymentTest">CRM_Event_BAO_AdditionalPaymentTest</abbr></a></dt><dd>Class CRM_Event_BAO_AdditionalPaymentTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-BAO-ChangeFeeSelectionTest.html"><abbr title="\CRM_Event_BAO_ChangeFeeSelectionTest">CRM_Event_BAO_ChangeFeeSelectionTest</abbr></a></dt><dd>Class CRM_Event_BAO_AdditionalPaymentTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-BAO-EventPermissionsTest.html"><abbr title="\CRM_Event_BAO_EventPermissionsTest">CRM_Event_BAO_EventPermissionsTest</abbr></a></dt><dd>Class CRM_Event_BAO_EventPermissionsTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-BAO-ParticipantStatusTest.html"><abbr title="\CRM_Event_BAO_ParticipantStatusTest">CRM_Event_BAO_ParticipantStatusTest</abbr></a></dt><dd>Test class for CRM_Event_BAO_ParticipantStatus BAO</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-BAO-ParticipantTest.html"><abbr title="\CRM_Event_BAO_ParticipantTest">CRM_Event_BAO_ParticipantTest</abbr></a></dt><dd>Class CRM_Event_BAO_ParticipantTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-BAO-QueryTest.html"><abbr title="\CRM_Event_BAO_QueryTest">CRM_Event_BAO_QueryTest</abbr></a></dt><dd>Base class for CiviCRM unit tests</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Form-ManageEvent-EventInfoTest.html"><abbr title="\CRM_Event_Form_ManageEvent_EventInfoTest">CRM_Event_Form_ManageEvent_EventInfoTest</abbr></a></dt><dd>Base class for CiviCRM unit tests</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Form-ManageEvent-LocationTest.html"><abbr title="\CRM_Event_Form_ManageEvent_LocationTest">CRM_Event_Form_ManageEvent_LocationTest</abbr></a></dt><dd>Test CRM_Event_Form_Registration functions.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Form-ManageEvent-RegistrationTest.html"><abbr title="\CRM_Event_Form_ManageEvent_RegistrationTest">CRM_Event_Form_ManageEvent_RegistrationTest</abbr></a></dt><dd>Base class for CiviCRM unit tests</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Form-ParticipantTest.html"><abbr title="\CRM_Event_Form_ParticipantTest">CRM_Event_Form_ParticipantTest</abbr></a></dt><dd>Test CRM_Event_Form_Registration functions.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Form-Registration-ConfirmTest.html"><abbr title="\CRM_Event_Form_Registration_ConfirmTest">CRM_Event_Form_Registration_ConfirmTest</abbr></a></dt><dd>Test CRM_Event_Form_Registration functions.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Form-Registration-RegisterTest.html"><abbr title="\CRM_Event_Form_Registration_RegisterTest">CRM_Event_Form_Registration_RegisterTest</abbr></a></dt><dd>Class CRM_Event_Form_Registration_RegisterTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Form-SearchTest.html"><abbr title="\CRM_Event_Form_SearchTest">CRM_Event_Form_SearchTest</abbr></a></dt><dd>Base class for CiviCRM unit tests</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Form-SelfSvcTransferTest.html"><abbr title="\CRM_Event_Form_SelfSvcTransferTest">CRM_Event_Form_SelfSvcTransferTest</abbr></a></dt><dd>Test CRM_Event_Form_Registration functions.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Form-SelfSvcUpdateTest.html"><abbr title="\CRM_Event_Form_SelfSvcUpdateTest">CRM_Event_Form_SelfSvcUpdateTest</abbr></a></dt><dd>Test CRM_Event_Form_Registration functions.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Form-Task-BadgeTest.html"><abbr title="\CRM_Event_Form_Task_BadgeTest">CRM_Event_Form_Task_BadgeTest</abbr></a></dt><dd>Test CRM_Event_Form_Registration functions.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Form-Task-BatchTest.html"><abbr title="\CRM_Event_Form_Task_BatchTest">CRM_Event_Form_Task_BatchTest</abbr></a></dt><dd>Test CRM_Event_Form_Registration functions.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Form-Task-RegisterTest.html"><abbr title="\CRM_Event_Form_Task_RegisterTest">CRM_Event_Form_Task_RegisterTest</abbr></a></dt><dd>Test CRM_Event_Form_Registration functions.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Import-Parser-ParticipantTest.html"><abbr title="\CRM_Event_Import_Parser_ParticipantTest">CRM_Event_Import_Parser_ParticipantTest</abbr></a></dt><dd>Base class for CiviCRM unit tests</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Event-Page-EventInfoTest.html"><abbr title="\CRM_Event_Page_EventInfoTest">CRM_Event_Page_EventInfoTest</abbr></a></dt><dd>Base class for CiviCRM unit tests</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Export-BAO-ExportTest.html"><abbr title="\CRM_Export_BAO_ExportTest">CRM_Export_BAO_ExportTest</abbr></a></dt><dd>Class CRM_Core_DAOTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Extension-AllTests.html"><abbr title="\CRM_Extension_AllTests">CRM_Extension_AllTests</abbr></a></dt><dd>Class containing all test suites</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Extension-BrowserTest.html"><abbr title="\CRM_Extension_BrowserTest">CRM_Extension_BrowserTest</abbr></a></dt><dd>Class CRM_Extension_BrowserTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Extension-Container-AllTests.html"><abbr title="\CRM_Extension_Container_AllTests">CRM_Extension_Container_AllTests</abbr></a></dt><dd>Class containing all test suites</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Extension-Container-BasicTest.html"><abbr title="\CRM_Extension_Container_BasicTest">CRM_Extension_Container_BasicTest</abbr></a></dt><dd>Class CRM_Extension_Container_BasicTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Extension-Container-CollectionTest.html"><abbr title="\CRM_Extension_Container_CollectionTest">CRM_Extension_Container_CollectionTest</abbr></a></dt><dd>Class CRM_Extension_Container_CollectionTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Extension-Container-StaticTest.html"><abbr title="\CRM_Extension_Container_StaticTest">CRM_Extension_Container_StaticTest</abbr></a></dt><dd>Class CRM_Extension_Container_StaticTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Extension-InfoTest.html"><abbr title="\CRM_Extension_InfoTest">CRM_Extension_InfoTest</abbr></a></dt><dd>Class CRM_Extension_InfoTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Extension-Manager-AllTests.html"><abbr title="\CRM_Extension_Manager_AllTests">CRM_Extension_Manager_AllTests</abbr></a></dt><dd>Class containing all test suites</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Extension-Manager-ModuleTest.html"><abbr title="\CRM_Extension_Manager_ModuleTest">CRM_Extension_Manager_ModuleTest</abbr></a></dt><dd>Class CRM_Extension_Manager_ModuleTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Extension-Manager-ModuleUpgTest.html"><abbr title="\CRM_Extension_Manager_ModuleUpgTest">CRM_Extension_Manager_ModuleUpgTest</abbr></a></dt><dd>Class CRM_Extension_Manager_ModuleUpgTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Extension-Manager-PaymentTest.html"><abbr title="\CRM_Extension_Manager_PaymentTest">CRM_Extension_Manager_PaymentTest</abbr></a></dt><dd>Class CRM_Extension_Manager_PaymentTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Extension-Manager-ReportTest.html"><abbr title="\CRM_Extension_Manager_ReportTest">CRM_Extension_Manager_ReportTest</abbr></a></dt><dd>Class CRM_Extension_Manager_ReportTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Extension-Manager-SearchTest.html"><abbr title="\CRM_Extension_Manager_SearchTest">CRM_Extension_Manager_SearchTest</abbr></a></dt><dd>Class CRM_Extension_Manager_SearchTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Extension-ManagerTest.html"><abbr title="\CRM_Extension_ManagerTest">CRM_Extension_ManagerTest</abbr></a></dt><dd>Class CRM_Extension_ManagerTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Extension-MapperTest.html"><abbr title="\CRM_Extension_MapperTest">CRM_Extension_MapperTest</abbr></a></dt><dd>Class CRM_Extension_MapperTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Financial-BAO-FinancialAccountTest.html"><abbr title="\CRM_Financial_BAO_FinancialAccountTest">CRM_Financial_BAO_FinancialAccountTest</abbr></a></dt><dd>Class CRM_Financial_BAO_FinancialAccountTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Financial-BAO-FinancialItemTest.html"><abbr title="\CRM_Financial_BAO_FinancialItemTest">CRM_Financial_BAO_FinancialItemTest</abbr></a></dt><dd>Class CRM_Financial_BAO_FinancialItemTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Financial-BAO-FinancialTypeAccountTest.html"><abbr title="\CRM_Financial_BAO_FinancialTypeAccountTest">CRM_Financial_BAO_FinancialTypeAccountTest</abbr></a></dt><dd>Class CRM_Financial_BAO_FinancialTypeAccountTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Financial-BAO-FinancialTypeTest.html"><abbr title="\CRM_Financial_BAO_FinancialTypeTest">CRM_Financial_BAO_FinancialTypeTest</abbr></a></dt><dd>Class CRM_Financial_BAO_FinancialTypeTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Financial-BAO-OrderTest.html"><abbr title="\CRM_Financial_BAO_OrderTest">CRM_Financial_BAO_OrderTest</abbr></a></dt><dd>Class CRM_Financial_BAO_OrderTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Financial-BAO-PaymentProcessorTest.html"><abbr title="\CRM_Financial_BAO_PaymentProcessorTest">CRM_Financial_BAO_PaymentProcessorTest</abbr></a></dt><dd>Class CRM_Financial_BAO_PaymentProcessorTypeTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Financial-BAO-PaymentProcessorTypeTest.html"><abbr title="\CRM_Financial_BAO_PaymentProcessorTypeTest">CRM_Financial_BAO_PaymentProcessorTypeTest</abbr></a></dt><dd>Class CRM_Financial_BAO_PaymentProcessorTypeTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Financial-Form-PaymentEditTest.html"><abbr title="\CRM_Financial_Form_PaymentEditTest">CRM_Financial_Form_PaymentEditTest</abbr></a></dt><dd>Test PaymentEdit form submission</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Financial-Form-PaymentFormsTest.html"><abbr title="\CRM_Financial_Form_PaymentFormsTest">CRM_Financial_Form_PaymentFormsTest</abbr></a></dt><dd>Test various payment forms.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Financial-Page-AjaxBatchSummaryTest.html"><abbr title="\CRM_Financial_Page_AjaxBatchSummaryTest">CRM_Financial_Page_AjaxBatchSummaryTest</abbr></a></dt><dd>Test for CRM_Financial_Page_Ajax class.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Financial-Page-AjaxTest.html"><abbr title="\CRM_Financial_Page_AjaxTest">CRM_Financial_Page_AjaxTest</abbr></a></dt><dd>Test for CRM_Financial_Page_Ajax class.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Group-Page-AjaxTest.html"><abbr title="\CRM_Group_Page_AjaxTest">CRM_Group_Page_AjaxTest</abbr></a></dt><dd>Class CRM_Group_Page_AjaxTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Import-DataSource-CsvTest.html"><abbr title="\CRM_Import_DataSource_CsvTest">CRM_Import_DataSource_CsvTest</abbr></a></dt><dd>Tests for the CRM_Import_Datasource_Csv class.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Import-FormsTest.html"><abbr title="\CRM_Import_FormsTest">CRM_Import_FormsTest</abbr></a></dt><dd>Test various forms extending CRM_Import_Forms.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Logging-LoggingTest.html"><abbr title="\CRM_Logging_LoggingTest">CRM_Logging_LoggingTest</abbr></a></dt><dd>Class CRM_Core_DAOTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Logging-SchemaTest.html"><abbr title="\CRM_Logging_SchemaTest">CRM_Logging_SchemaTest</abbr></a></dt><dd>Class CRM_Logging_SchmeaTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-BAO-ConfirmTest.html"><abbr title="\CRM_Mailing_BAO_ConfirmTest">CRM_Mailing_BAO_ConfirmTest</abbr></a></dt><dd>Class CRM_Mailing_BAO_MailingTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-BAO-MailingJobTest.html"><abbr title="\CRM_Mailing_BAO_MailingJobTest">CRM_Mailing_BAO_MailingJobTest</abbr></a></dt><dd>Class CRM_Mailing_BAO_MailingTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-BAO-MailingTest.html"><abbr title="\CRM_Mailing_BAO_MailingTest">CRM_Mailing_BAO_MailingTest</abbr></a></dt><dd>Class CRM_Mailing_BAO_MailingTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-BAO-QueryTest.html"><abbr title="\CRM_Mailing_BAO_QueryTest">CRM_Mailing_BAO_QueryTest</abbr></a></dt><dd>Include dataProvider for tests</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-BAO-QueryTestDataProvider.html"><abbr title="\CRM_Mailing_BAO_QueryTestDataProvider">CRM_Mailing_BAO_QueryTestDataProvider</abbr></a></dt><dd>Provide data to the CRM_Mailing_BAO_QueryTest class</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-BAO-SpoolTest.html"><abbr title="\CRM_Mailing_BAO_SpoolTest">CRM_Mailing_BAO_SpoolTest</abbr></a></dt><dd>Class CRM_Mailing_BAO_SpoolTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-Form-Task-AdhocMailingTest.html"><abbr title="\CRM_Mailing_Form_Task_AdhocMailingTest">CRM_Mailing_Form_Task_AdhocMailingTest</abbr></a></dt><dd>Test class for CRM_Mailing_Form_Task_AdhocMailing.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-Form-UnsubscribeTest.html"><abbr title="\CRM_Mailing_Form_UnsubscribeTest">CRM_Mailing_Form_UnsubscribeTest</abbr></a></dt><dd>Test class for CRM_Mailing_Form_Unsubscribe.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-MailingSystemTest.html"><abbr title="\CRM_Mailing_MailingSystemTest">CRM_Mailing_MailingSystemTest</abbr></a></dt><dd>Class CRM_Mailing_MailingSystemTest.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-MailingSystemTestBase.html"><abbr title="\CRM_Mailing_MailingSystemTestBase">CRM_Mailing_MailingSystemTestBase</abbr></a></dt><dd>Class CRM_Mailing_MailingSystemTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-MailingUnsubscribeTest.html"><abbr title="\CRM_Mailing_MailingUnsubscribeTest">CRM_Mailing_MailingUnsubscribeTest</abbr></a></dt><dd>Class CRM_Mailing_MailingUnsubscribeTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-MailStoreTest.html"><abbr title="\CRM_Mailing_MailStoreTest">CRM_Mailing_MailStoreTest</abbr></a></dt><dd>Base class for CiviCRM unit tests</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-MultilingualSystemTest.html"><abbr title="\CRM_Mailing_MultilingualSystemTest">CRM_Mailing_MultilingualSystemTest</abbr></a></dt><dd>Base class for CiviCRM unit tests</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Mailing-TokensTest.html"><abbr title="\CRM_Mailing_TokensTest">CRM_Mailing_TokensTest</abbr></a></dt><dd>Base class for CiviCRM unit tests</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-AllTests.html"><abbr title="\CRM_Member_AllTests">CRM_Member_AllTests</abbr></a></dt><dd>Class containing all test suites</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-BAO-MembershipLogTest.html"><abbr title="\CRM_Member_BAO_MembershipLogTest">CRM_Member_BAO_MembershipLogTest</abbr></a></dt><dd>Test CRM/Member/BAO Membership Log add , delete functions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-BAO-MembershipStatusTest.html"><abbr title="\CRM_Member_BAO_MembershipStatusTest">CRM_Member_BAO_MembershipStatusTest</abbr></a></dt><dd>Class CRM_Member_BAO_MembershipStatusTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-BAO-MembershipTest.html"><abbr title="\CRM_Member_BAO_MembershipTest">CRM_Member_BAO_MembershipTest</abbr></a></dt><dd>Class CRM_Member_BAO_MembershipTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-BAO-MembershipTypeTest.html"><abbr title="\CRM_Member_BAO_MembershipTypeTest">CRM_Member_BAO_MembershipTypeTest</abbr></a></dt><dd>Class CRM_Member_BAO_MembershipTypeTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-BAO-QueryTest.html"><abbr title="\CRM_Member_BAO_QueryTest">CRM_Member_BAO_QueryTest</abbr></a></dt><dd>Include dataProvider for tests</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-Form-AllTests.html"><abbr title="\CRM_Member_Form_AllTests">CRM_Member_Form_AllTests</abbr></a></dt><dd>Class containing all test suites</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-Form-MembershipRenewalTest.html"><abbr title="\CRM_Member_Form_MembershipRenewalTest">CRM_Member_Form_MembershipRenewalTest</abbr></a></dt><dd>Test CRM_Member_Form_Membership functions.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-Form-MembershipTest.html"><abbr title="\CRM_Member_Form_MembershipTest">CRM_Member_Form_MembershipTest</abbr></a></dt><dd>Test CRM_Member_Form_Membership functions.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-Form-Task-BatchTest.html"><abbr title="\CRM_Member_Form_Task_BatchTest">CRM_Member_Form_Task_BatchTest</abbr></a></dt><dd>Base class for CiviCRM unit tests</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-Form-Task-LabelTest.html"><abbr title="\CRM_Member_Form_Task_LabelTest">CRM_Member_Form_Task_LabelTest</abbr></a></dt><dd>Base class for CiviCRM unit tests</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-Form-Task-PDFLetterTest.html"><abbr title="\CRM_Member_Form_Task_PDFLetterTest">CRM_Member_Form_Task_PDFLetterTest</abbr></a></dt><dd>Base class for CiviCRM unit tests</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-Import-Parser-MembershipTest.html"><abbr title="\CRM_Member_Import_Parser_MembershipTest">CRM_Member_Import_Parser_MembershipTest</abbr></a></dt><dd>Base class for CiviCRM unit tests</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-Page-MembershipTypeTest.html"><abbr title="\CRM_Member_Page_MembershipTypeTest">CRM_Member_Page_MembershipTypeTest</abbr></a></dt><dd>Test CRM_Member_Form_Membership functions.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-Selector-SearchTest.html"><abbr title="\CRM_Member_Selector_SearchTest">CRM_Member_Selector_SearchTest</abbr></a></dt><dd>Class CRM_Member_BAO_MembershipTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-StatusOverrideTypesTest.html"><abbr title="\CRM_Member_StatusOverrideTypesTest">CRM_Member_StatusOverrideTypesTest</abbr></a></dt><dd>Class CRM_Member_BAO_MembershipTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Member-TaskTest.html"><abbr title="\CRM_Member_TaskTest">CRM_Member_TaskTest</abbr></a></dt><dd>Class CRM_Member_BAO_MembershipTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-PCP-BAO-PCPTest.html"><abbr title="\CRM_PCP_BAO_PCPTest">CRM_PCP_BAO_PCPTest</abbr></a></dt><dd>Test class for CRM_PCP_BAO_PCPTest BAO</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Pledge-AllTests.html"><abbr title="\CRM_Pledge_AllTests">CRM_Pledge_AllTests</abbr></a></dt><dd>Class containing all test suites</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Pledge-BAO-PledgeBlockTest.html"><abbr title="\CRM_Pledge_BAO_PledgeBlockTest">CRM_Pledge_BAO_PledgeBlockTest</abbr></a></dt><dd>Test class for CRM_Pledge_BAO_PledgeBlock BAO</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Pledge-BAO-PledgePaymentTest.html"><abbr title="\CRM_Pledge_BAO_PledgePaymentTest">CRM_Pledge_BAO_PledgePaymentTest</abbr></a></dt><dd>Test class for CRM_Pledge_BAO_PledgePayment BAO</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Pledge-BAO-PledgeTest.html"><abbr title="\CRM_Pledge_BAO_PledgeTest">CRM_Pledge_BAO_PledgeTest</abbr></a></dt><dd>Test class for CRM_Pledge_BAO_Pledge BAO</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Pledge-Form-PledgeTest.html"><abbr title="\CRM_Pledge_Form_PledgeTest">CRM_Pledge_Form_PledgeTest</abbr></a></dt><dd>CRM_Pledge_Form_PledgeTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Pledge-Form-SearchTest.html"><abbr title="\CRM_Pledge_Form_SearchTest">CRM_Pledge_Form_SearchTest</abbr></a></dt><dd>Include dataProvider for tests</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Price-BAO-PriceFieldTest.html"><abbr title="\CRM_Price_BAO_PriceFieldTest">CRM_Price_BAO_PriceFieldTest</abbr></a></dt><dd>Test class for CRM_Price_BAO_PriceField.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Price-BAO-PriceFieldValueTest.html"><abbr title="\CRM_Price_BAO_PriceFieldValueTest">CRM_Price_BAO_PriceFieldValueTest</abbr></a></dt><dd>Test class for CRM_Price_BAO_PriceSet.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Price-BAO-PriceSetTest.html"><abbr title="\CRM_Price_BAO_PriceSetTest">CRM_Price_BAO_PriceSetTest</abbr></a></dt><dd>Test class for CRM_Price_BAO_PriceSet.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Price-Form-FieldTest.html"><abbr title="\CRM_Price_Form_FieldTest">CRM_Price_Form_FieldTest</abbr></a></dt><dd>Base class for CiviCRM unit tests</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Price-Form-OptionTest.html"><abbr title="\CRM_Price_Form_OptionTest">CRM_Price_Form_OptionTest</abbr></a></dt><dd>Base class for CiviCRM unit tests</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Profile-Form-EditTest.html"><abbr title="\CRM_Profile_Form_EditTest">CRM_Profile_Form_EditTest</abbr></a></dt><dd>Test class for CRM_Price_BAO_PriceSet.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Queue-AllTests.html"><abbr title="\CRM_Queue_AllTests">CRM_Queue_AllTests</abbr></a></dt><dd>Class containing all test suites</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Queue-Queue-AllTests.html"><abbr title="\CRM_Queue_Queue_AllTests">CRM_Queue_Queue_AllTests</abbr></a></dt><dd>Class containing all test suites</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Queue-Queue-SqlTest.html"><abbr title="\CRM_Queue_Queue_SqlTest">CRM_Queue_Queue_SqlTest</abbr></a></dt><dd>Ensure that the extended interface for SQL-backed queues
work. For example, the createItem() interface supports
priority-queueing.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Queue-QueueTest.html"><abbr title="\CRM_Queue_QueueTest">CRM_Queue_QueueTest</abbr></a></dt><dd>Ensure that various queue implementations comply with the interface</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Queue-RunnerTest.html"><abbr title="\CRM_Queue_RunnerTest">CRM_Queue_RunnerTest</abbr></a></dt><dd>Ensure that various queue implementations comply with the interface</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form-ActivityTest.html"><abbr title="\CRM_Report_Form_ActivityTest">CRM_Report_Form_ActivityTest</abbr></a></dt><dd>Test Activity report outcome</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form-Contact-LoggingDetailTest.html"><abbr title="\CRM_Report_Form_Contact_LoggingDetailTest">CRM_Report_Form_Contact_LoggingDetailTest</abbr></a></dt><dd>Test Activity report outcome</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form-ContactSummaryTest.html"><abbr title="\CRM_Report_Form_ContactSummaryTest">CRM_Report_Form_ContactSummaryTest</abbr></a></dt><dd>Test Contact Summary report outcome</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form-Contribute-DetailTest.html"><abbr title="\CRM_Report_Form_Contribute_DetailTest">CRM_Report_Form_Contribute_DetailTest</abbr></a></dt><dd>Test report outcome</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form-Member-DetailTest.html"><abbr title="\CRM_Report_Form_Member_DetailTest">CRM_Report_Form_Member_DetailTest</abbr></a></dt><dd>Test Activity report outcome</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form-SampleForm.html"><abbr title="\CRM_Report_Form_SampleForm">CRM_Report_Form_SampleForm</abbr></a></dt><dd>Helper class to simulate a report form but allow us access to some protected
fields for tests.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Form-TestCaseTest.html"><abbr title="\CRM_Report_Form_TestCaseTest">CRM_Report_Form_TestCaseTest</abbr></a></dt><dd>Verify that the CiviReportTestCase provides a working set of
primitives for tests. Do this by running various scenarios
that should yield positive and negative results.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-FormTest.html"><abbr title="\CRM_Report_FormTest">CRM_Report_FormTest</abbr></a></dt><dd>Test CRM_Report_Form functions.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Report-Utils-ReportTest.html"><abbr title="\CRM_Report_Utils_ReportTest">CRM_Report_Utils_ReportTest</abbr></a></dt><dd>Test CRM_Report_Utils_Report functions.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-SMS-BAO-ProviderTest.html"><abbr title="\CRM_SMS_BAO_ProviderTest">CRM_SMS_BAO_ProviderTest</abbr></a></dt><dd>Test CRM_SMS_BAO_SmsProvider functions</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-SMS-PreviewTest.html"><abbr title="\CRM_SMS_PreviewTest">CRM_SMS_PreviewTest</abbr></a></dt><dd>Test SMS Preview</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-SMS-ProviderTest.html"><abbr title="\CRM_SMS_ProviderTest">CRM_SMS_ProviderTest</abbr></a></dt><dd>Base class for CiviCRM unit tests</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-UF-Page-ProfileEditorTest.html"><abbr title="\CRM_UF_Page_ProfileEditorTest">CRM_UF_Page_ProfileEditorTest</abbr></a></dt><dd>Class CRM_UF_Page_ProfileEditorTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-FormTest.html"><abbr title="\CRM_Upgrade_FormTest">CRM_Upgrade_FormTest</abbr></a></dt><dd>Class CRM_Upgrade_FormTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-BaseTest.html"><abbr title="\CRM_Upgrade_Incremental_BaseTest">CRM_Upgrade_Incremental_BaseTest</abbr></a></dt><dd>Base class for CiviCRM unit tests</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveFiftyFiveTest.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveFiftyFiveTest">CRM_Upgrade_Incremental_php_FiveFiftyFiveTest</abbr></a></dt><dd>Class CRM_Upgrade_Incremental_php_FiveFiftyFiveTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveSixtyFourTest.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveSixtyFourTest">CRM_Upgrade_Incremental_php_FiveSixtyFourTest</abbr></a></dt><dd>Class CRM_Upgrade_Incremental_php_FiveSixtyFour</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-Incremental-php-FiveTwentyTest.html"><abbr title="\CRM_Upgrade_Incremental_php_FiveTwentyTest">CRM_Upgrade_Incremental_php_FiveTwentyTest</abbr></a></dt><dd>Class CRM_Upgrade_Incremental_php_FiveTwentyTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Upgrade-SnapshotTest.html"><abbr title="\CRM_Upgrade_SnapshotTest">CRM_Upgrade_SnapshotTest</abbr></a></dt><dd>Class CRM_Upgrade_SnapshotTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-AddressTest.html"><abbr title="\CRM_Utils_AddressTest">CRM_Utils_AddressTest</abbr></a></dt><dd>Class CRM_Utils_AddressTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-API-MatchOptionTest.html"><abbr title="\CRM_Utils_API_MatchOptionTest">CRM_Utils_API_MatchOptionTest</abbr></a></dt><dd>Test that the API accepts the 'match' and 'match-mandatory' options.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-API-ReloadOptionTest.html"><abbr title="\CRM_Utils_API_ReloadOptionTest">CRM_Utils_API_ReloadOptionTest</abbr></a></dt><dd>Test that the API accepts the 'reload' option.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-ArrayTest.html"><abbr title="\CRM_Utils_ArrayTest">CRM_Utils_ArrayTest</abbr></a></dt><dd>Class CRM_Utils_ArrayTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-AutoCleanTest.html"><abbr title="\CRM_Utils_AutoCleanTest">CRM_Utils_AutoCleanTest</abbr></a></dt><dd>Class CRM_Utils_AutoCleanTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Cache-AllTests.html"><abbr title="\CRM_Utils_Cache_AllTests">CRM_Utils_Cache_AllTests</abbr></a></dt><dd>Class containing all test suites.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Cache-SqlGroupTest.html"><abbr title="\CRM_Utils_Cache_SqlGroupTest">CRM_Utils_Cache_SqlGroupTest</abbr></a></dt><dd>Class CRM_Utils_Cache_SqlGroupTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-CacheTest.html"><abbr title="\CRM_Utils_CacheTest">CRM_Utils_CacheTest</abbr></a></dt><dd>Class CRM_Utils_CacheTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Check-Component-EnvTest.html"><abbr title="\CRM_Utils_Check_Component_EnvTest">CRM_Utils_Check_Component_EnvTest</abbr></a></dt><dd>Class CRM_Utils_Check_Component_EnvTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Check-Component-OptionGroupsTest.html"><abbr title="\CRM_Utils_Check_Component_OptionGroupsTest">CRM_Utils_Check_Component_OptionGroupsTest</abbr></a></dt><dd>Class CRM_Utils_TypeTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-ColorTest.html"><abbr title="\CRM_Utils_ColorTest">CRM_Utils_ColorTest</abbr></a></dt><dd>Class CRM_Utils_ColorTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-DateTest.html"><abbr title="\CRM_Utils_DateTest">CRM_Utils_DateTest</abbr></a></dt><dd>Test CRM_Utils_Date functions.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-EnglishNumberTest.html"><abbr title="\CRM_Utils_EnglishNumberTest">CRM_Utils_EnglishNumberTest</abbr></a></dt><dd>Class CRM_Utils_EnglishNumberTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-FileTest.html"><abbr title="\CRM_Utils_FileTest">CRM_Utils_FileTest</abbr></a></dt><dd>Class CRM_Utils_FileTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Geocode-TestProvider.html"><abbr title="\CRM_Utils_Geocode_TestProvider">CRM_Utils_Geocode_TestProvider</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-GlobalStackTest.html"><abbr title="\CRM_Utils_GlobalStackTest">CRM_Utils_GlobalStackTest</abbr></a></dt><dd>Class CRM_Utils_GlobalStackTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-HookTest.html"><abbr title="\CRM_Utils_HookTest">CRM_Utils_HookTest</abbr></a></dt><dd>Class CRM_Utils_HookTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-HTMLTest.html"><abbr title="\CRM_Utils_HTMLTest">CRM_Utils_HTMLTest</abbr></a></dt><dd>Tests for parsing translatable strings in HTML content.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-HtmlToTextTest.html"><abbr title="\CRM_Utils_HtmlToTextTest">CRM_Utils_HtmlToTextTest</abbr></a></dt><dd>Class CRM_Utils_HtmlToTextTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-HttpClientTest.html"><abbr title="\CRM_Utils_HttpClientTest">CRM_Utils_HttpClientTest</abbr></a></dt><dd>Class CRM_Utils_HttpClientTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-ICalendarTest.html"><abbr title="\CRM_Utils_ICalendarTest">CRM_Utils_ICalendarTest</abbr></a></dt><dd>Tests for linking to resource files</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-JSTest.html"><abbr title="\CRM_Utils_JSTest">CRM_Utils_JSTest</abbr></a></dt><dd>Tests for linking to resource files</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-LazyArrayTest.html"><abbr title="\CRM_Utils_LazyArrayTest">CRM_Utils_LazyArrayTest</abbr></a></dt><dd>Class CRM_Utils_LazyArrayTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Mail-EmailProcessorInboundTest.html"><abbr title="\CRM_Utils_Mail_EmailProcessorInboundTest">CRM_Utils_Mail_EmailProcessorInboundTest</abbr></a></dt><dd>Class CRM_Utils_Mail_EmailProcessorInboundTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Mail-EmailProcessorTest.html"><abbr title="\CRM_Utils_Mail_EmailProcessorTest">CRM_Utils_Mail_EmailProcessorTest</abbr></a></dt><dd>Class CRM_Utils_Mail_EmailProcessorTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Mail-FilteredPearMailerTest.html"><abbr title="\CRM_Utils_Mail_FilteredPearMailerTest">CRM_Utils_Mail_FilteredPearMailerTest</abbr></a></dt><dd>Class CRM_Utils_Mail_FilteredPearMailerTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Mail-IncomingTest.html"><abbr title="\CRM_Utils_Mail_IncomingTest">CRM_Utils_Mail_IncomingTest</abbr></a></dt><dd>Class for testing CRM_Utils_Mail_Incoming.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-MailTest.html"><abbr title="\CRM_Utils_MailTest">CRM_Utils_MailTest</abbr></a></dt><dd>Class CRM_Utils_MailTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-Migrate-ImportExportTest.html"><abbr title="\CRM_Utils_Migrate_ImportExportTest">CRM_Utils_Migrate_ImportExportTest</abbr></a></dt><dd>Class CRM_Utils_Migrate_ImportExportTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-MoneyTest.html"><abbr title="\CRM_Utils_MoneyTest">CRM_Utils_MoneyTest</abbr></a></dt><dd>Class CRM_Utils_RuleTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-NumberTest.html"><abbr title="\CRM_Utils_NumberTest">CRM_Utils_NumberTest</abbr></a></dt><dd>Class CRM_Utils_NumberTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-PDF-UtilsTest.html"><abbr title="\CRM_Utils_PDF_UtilsTest">CRM_Utils_PDF_UtilsTest</abbr></a></dt><dd>Class CRM_Utils_PDF_UtilsTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-RestTest.html"><abbr title="\CRM_Utils_RestTest">CRM_Utils_RestTest</abbr></a></dt><dd>Class CRM_Utils_RestTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-RuleTest.html"><abbr title="\CRM_Utils_RuleTest">CRM_Utils_RuleTest</abbr></a></dt><dd>Class CRM_Utils_RuleTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-SignerTest.html"><abbr title="\CRM_Utils_SignerTest">CRM_Utils_SignerTest</abbr></a></dt><dd>Class CRM_Utils_SignerTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-SQL-DeleteTest.html"><abbr title="\CRM_Utils_SQL_DeleteTest">CRM_Utils_SQL_DeleteTest</abbr></a></dt><dd>Class CRM_Utils_SQL_DeleteTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-SQL-InsertTest.html"><abbr title="\CRM_Utils_SQL_InsertTest">CRM_Utils_SQL_InsertTest</abbr></a></dt><dd>Class CRM_Utils_SQL_SelectTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-SQL-SelectTest.html"><abbr title="\CRM_Utils_SQL_SelectTest">CRM_Utils_SQL_SelectTest</abbr></a></dt><dd>Class CRM_Utils_SQL_SelectTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-SQLTest.html"><abbr title="\CRM_Utils_SQLTest">CRM_Utils_SQLTest</abbr></a></dt><dd>Class CRM_Utils_SQLTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-StringTest.html"><abbr title="\CRM_Utils_StringTest">CRM_Utils_StringTest</abbr></a></dt><dd>Class CRM_Utils_StringTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-SystemTest.html"><abbr title="\CRM_Utils_SystemTest">CRM_Utils_SystemTest</abbr></a></dt><dd>Class CRM_Utils_SystemTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-TimeTest.html"><abbr title="\CRM_Utils_TimeTest">CRM_Utils_TimeTest</abbr></a></dt><dd>Class CRM_Utils_TimeTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-TokenConsistencyTest.html"><abbr title="\CRM_Utils_TokenConsistencyTest">CRM_Utils_TokenConsistencyTest</abbr></a></dt><dd>CRM_Utils_TokenConsistencyTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-TokenTest.html"><abbr title="\CRM_Utils_TokenTest">CRM_Utils_TokenTest</abbr></a></dt><dd>Class CRM_Utils_TokenTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-TypeTest.html"><abbr title="\CRM_Utils_TypeTest">CRM_Utils_TypeTest</abbr></a></dt><dd>Class CRM_Utils_TypeTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-UrlTest.html"><abbr title="\CRM_Utils_UrlTest">CRM_Utils_UrlTest</abbr></a></dt><dd>Class CRM_Utils_UrlTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-versionCheckTest.html"><abbr title="\CRM_Utils_versionCheckTest">CRM_Utils_versionCheckTest</abbr></a></dt><dd>Class CRM_Utils_versionCheckTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-XMLTest.html"><abbr title="\CRM_Utils_XMLTest">CRM_Utils_XMLTest</abbr></a></dt><dd>Class CRM_Utils_XMLTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Utils-ZipTest.html"><abbr title="\CRM_Utils_ZipTest">CRM_Utils_ZipTest</abbr></a></dt><dd>Class CRM_Utils_ZipTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/E2E-AllTests.html"><abbr title="\E2E_AllTests">E2E_AllTests</abbr></a></dt><dd>Class containing all CRM test suites</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/E2E-Cache-APCcacheTest.html"><abbr title="\E2E_Cache_APCcacheTest">E2E_Cache_APCcacheTest</abbr></a></dt><dd>Verify that CRM_Utils_Cache_APCcache complies with PSR-16.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/E2E-Cache-APCucacheTest.html"><abbr title="\E2E_Cache_APCucacheTest">E2E_Cache_APCucacheTest</abbr></a></dt><dd>Verify that CRM_Utils_Cache_APCucache complies with PSR-16.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/E2E-Cache-ArrayCacheTest.html"><abbr title="\E2E_Cache_ArrayCacheTest">E2E_Cache_ArrayCacheTest</abbr></a></dt><dd>Verify that CRM_Utils_Cache_ArrayCache complies with PSR-16.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/E2E-Cache-ArrayDecoratorTest.html"><abbr title="\E2E_Cache_ArrayDecoratorTest">E2E_Cache_ArrayDecoratorTest</abbr></a></dt><dd>Verify that CRM_Utils_Cache_ArrayDecorator complies with PSR-16.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/E2E-Cache-CacheTestCase.html"><abbr title="\E2E_Cache_CacheTestCase">E2E_Cache_CacheTestCase</abbr></a></dt><dd>Verify that a cache service complies with PSR-16.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/E2E-Cache-ConfiguredMemoryTest.html"><abbr title="\E2E_Cache_ConfiguredMemoryTest">E2E_Cache_ConfiguredMemoryTest</abbr></a></dt><dd>Verify that CRM_Utils_Cache_{Redis,Memcache} complies with PSR-16.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/E2E-Cache-FastArrayDecoratorTest.html"><abbr title="\E2E_Cache_FastArrayDecoratorTest">E2E_Cache_FastArrayDecoratorTest</abbr></a></dt><dd>Verify that CRM_Utils_Cache_FastArrayDecorator complies with PSR-16.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/E2E-Cache-SqlGroupTest.html"><abbr title="\E2E_Cache_SqlGroupTest">E2E_Cache_SqlGroupTest</abbr></a></dt><dd>Verify that CRM_Utils_Cache_SqlGroup complies with PSR-16.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/E2E-Cache-TieredTest.html"><abbr title="\E2E_Cache_TieredTest">E2E_Cache_TieredTest</abbr></a></dt><dd>Verify that CRM_Utils_Cache_Tiered complies with PSR-16.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/E2E-Cache-TwoInstancesTest.html"><abbr title="\E2E_Cache_TwoInstancesTest">E2E_Cache_TwoInstancesTest</abbr></a></dt><dd>If you make two instances of a cache driver, do they coexist as you would expect?</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/E2E-Extern-AuthxRestTest.html"><abbr title="\E2E_Extern_AuthxRestTest">E2E_Extern_AuthxRestTest</abbr></a></dt><dd>Verify that the REST API bindings correctly parse and authenticate requests.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/E2E-Extern-BaseRestTest.html"><abbr title="\E2E_Extern_BaseRestTest">E2E_Extern_BaseRestTest</abbr></a></dt><dd>Verify that the REST API bindings correctly parse and authenticate requests.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/E2E-Extern-CliRunnerTest.html"><abbr title="\E2E_Extern_CliRunnerTest">E2E_Extern_CliRunnerTest</abbr></a></dt><dd>Check that various CLI runners are able to bootstrap an environment with
reasonable paths.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/E2E-Extern-LegacyRestTest.html"><abbr title="\E2E_Extern_LegacyRestTest">E2E_Extern_LegacyRestTest</abbr></a></dt><dd>Verify that the REST API bindings correctly parse and authenticate requests.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/E2E-Extern-WidgetTest.html"><abbr title="\E2E_Extern_WidgetTest">E2E_Extern_WidgetTest</abbr></a></dt><dd>Verify Contribution Page Widget endpoint works correctly.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/EnvTests.html"><abbr title="\EnvTests">EnvTests</abbr></a></dt><dd>The EnvTests suite allows you to specify an arbitrary mix of tests
using an environment variable. For example:</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/HelloTest.html"><abbr title="\HelloTest">HelloTest</abbr></a></dt><dd>Class HelloTest</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-EventCheck-ExtensionUtil.html"><abbr title="\CRM_EventCheck_ExtensionUtil">CRM_EventCheck_ExtensionUtil</abbr></a></dt><dd>The ExtensionUtil class provides small stubs for accessing resources of this
extension.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Demoqueue-Page-DemoQueue.html"><abbr title="\CRM_Demoqueue_Page_DemoQueue">CRM_Demoqueue_Page_DemoQueue</abbr></a></dt><dd>An example page which queues several tasks and then executes them</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-Demoqueue-Page-DemoQueueDone.html"><abbr title="\CRM_Demoqueue_Page_DemoQueueDone">CRM_Demoqueue_Page_DemoQueueDone</abbr></a></dt><dd>Class CRM_Demoqueue_Page_DemoQueueDone</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/CRM-PhpStorm-ExtensionUtil.html"><abbr title="\CRM_PhpStorm_ExtensionUtil">CRM_PhpStorm_ExtensionUtil</abbr></a></dt><dd>The ExtensionUtil class provides small stubs for accessing resources of this
extension.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Mixlib.html"><abbr title="\Mixlib">Mixlib</abbr></a></dt><dd>The Mixlib class is a utility for downloading/listing available mixins.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/StandaloneRouter.html"><abbr title="\StandaloneRouter">StandaloneRouter</abbr></a></dt><dd>The StandaloneRouter allows you to run CiviCRM's "Standalone" UF with the PHP built-in server.</dd> </dl>
<h4 id="toc-traits">
Traits
<a href="namespaces/default.html#toc-traits" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/CRM-Activity-Form-ActivityFormTrait.html"><abbr title="\CRM_Activity_Form_ActivityFormTrait">CRM_Activity_Form_ActivityFormTrait</abbr></a></dt><dd>Trait implements functions to retrieve activity related values.</dd> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/CRM-Admin-Form-SettingTrait.html"><abbr title="\CRM_Admin_Form_SettingTrait">CRM_Admin_Form_SettingTrait</abbr></a></dt><dd>This trait allows us to consolidate Preferences & Settings forms.</dd> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/CRM-Campaign-Form-CampaignFormTrait.html"><abbr title="\CRM_Campaign_Form_CampaignFormTrait">CRM_Campaign_Form_CampaignFormTrait</abbr></a></dt><dd>Trait implements functions to retrieve activity related values.</dd> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/CRM-Case-Form-CaseFormTrait.html"><abbr title="\CRM_Case_Form_CaseFormTrait">CRM_Case_Form_CaseFormTrait</abbr></a></dt><dd>Trait implements functions to retrieve activity related values.</dd> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/CRM-Contact-AccessTrait.html"><abbr title="\CRM_Contact_AccessTrait">CRM_Contact_AccessTrait</abbr></a></dt><dd>Trait shared with entities attached to the contact record.</dd> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/CRM-Contact-Form-ContactFormTrait.html"><abbr title="\CRM_Contact_Form_ContactFormTrait">CRM_Contact_Form_ContactFormTrait</abbr></a></dt><dd>Trait implements getContactValue + overridable getContactID functions.</dd> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/CRM-Contact-Form-Task-EmailTrait.html"><abbr title="\CRM_Contact_Form_Task_EmailTrait">CRM_Contact_Form_Task_EmailTrait</abbr></a></dt><dd>This class provides the common functionality for tasks that send emails.</dd> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/CRM-Contact-Form-Task-PDFTrait.html"><abbr title="\CRM_Contact_Form_Task_PDFTrait">CRM_Contact_Form_Task_PDFTrait</abbr></a></dt><dd>This class provides the common functionality for tasks that send emails.</dd> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/CRM-Contact-Form-Task-SMSTrait.html"><abbr title="\CRM_Contact_Form_Task_SMSTrait">CRM_Contact_Form_Task_SMSTrait</abbr></a></dt><dd>This trait provides the common functionality for tasks that send sms.</dd> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/CRM-Contact-Import-MetadataTrait.html"><abbr title="\CRM_Contact_Import_MetadataTrait">CRM_Contact_Import_MetadataTrait</abbr></a></dt><dd>Trait CRM_Contact_Import_MetadataTrait</dd> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/CRM-Contribute-Form-ContributeFormTrait.html"><abbr title="\CRM_Contribute_Form_ContributeFormTrait">CRM_Contribute_Form_ContributeFormTrait</abbr></a></dt><dd>Trait implements functions to retrieve contribution related values.</dd> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/CRM-Contribute-Form-Task-TaskTrait.html"><abbr title="\CRM_Contribute_Form_Task_TaskTrait">CRM_Contribute_Form_Task_TaskTrait</abbr></a></dt><dd>This class provides shared contribution task functionality.</dd> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/CRM-Contribute-WorkflowMessage-ContributionTrait.html"><abbr title="\CRM_Contribute_WorkflowMessage_ContributionTrait">CRM_Contribute_WorkflowMessage_ContributionTrait</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/CRM-Contribute-WorkflowMessage-RecurringTrait.html"><abbr title="\CRM_Contribute_WorkflowMessage_RecurringTrait">CRM_Contribute_WorkflowMessage_RecurringTrait</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/CRM-Core-DynamicFKAccessTrait.html"><abbr title="\CRM_Core_DynamicFKAccessTrait">CRM_Core_DynamicFKAccessTrait</abbr></a></dt><dd>Trait for with entities with an entity_table + entity_id dynamic FK.</dd> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/CRM-Core-Form-EntityFormTrait.html"><abbr title="\CRM_Core_Form_EntityFormTrait">CRM_Core_Form_EntityFormTrait</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/CRM-Core-Page-EntityPageTrait.html"><abbr title="\CRM_Core_Page_EntityPageTrait">CRM_Core_Page_EntityPageTrait</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/CRM-Core-Resources-CollectionAdderTrait.html"><abbr title="\CRM_Core_Resources_CollectionAdderTrait">CRM_Core_Resources_CollectionAdderTrait</abbr></a></dt><dd>Class CRM_Core_Resources_CollectionTrait</dd> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/CRM-Core-Resources-CollectionTrait.html"><abbr title="\CRM_Core_Resources_CollectionTrait">CRM_Core_Resources_CollectionTrait</abbr></a></dt><dd>Class CRM_Core_Resources_CollectionTrait</dd> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/CRM-Core-TokenTrait.html"><abbr title="\CRM_Core_TokenTrait">CRM_Core_TokenTrait</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/CRM-Core-WorkflowMessage-ProfileTrait.html"><abbr title="\CRM_Core_WorkflowMessage_ProfileTrait">CRM_Core_WorkflowMessage_ProfileTrait</abbr></a></dt><dd>Trait for participant workflow classes.</dd> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/CRM-Event-Form-EventFormTrait.html"><abbr title="\CRM_Event_Form_EventFormTrait">CRM_Event_Form_EventFormTrait</abbr></a></dt><dd>Trait implements getContactValue + overridable getContactID functions.</dd> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/CRM-Event-WorkflowMessage-ParticipantTrait.html"><abbr title="\CRM_Event_WorkflowMessage_ParticipantTrait">CRM_Event_WorkflowMessage_ParticipantTrait</abbr></a></dt><dd>Trait for participant workflow classes.</dd> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/CRM-Extension-Upgrader-IdentityTrait.html"><abbr title="\CRM_Extension_Upgrader_IdentityTrait">CRM_Extension_Upgrader_IdentityTrait</abbr></a></dt><dd>Track minimal information which identifies the target extension.</dd> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/CRM-Extension-Upgrader-QueueTrait.html"><abbr title="\CRM_Extension_Upgrader_QueueTrait">CRM_Extension_Upgrader_QueueTrait</abbr></a></dt><dd>The QueueTrait provides helper methods for adding new tasks to a queue.</dd> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/CRM-Extension-Upgrader-RevisionsTrait.html"><abbr title="\CRM_Extension_Upgrader_RevisionsTrait">CRM_Extension_Upgrader_RevisionsTrait</abbr></a></dt><dd>The revisions trait automatically enqueues any functions named 'upgrade_NNNN()'
(where NNNN is taken to be a revision number).</dd> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/CRM-Extension-Upgrader-SchemaTrait.html"><abbr title="\CRM_Extension_Upgrader_SchemaTrait">CRM_Extension_Upgrader_SchemaTrait</abbr></a></dt><dd>The SchemaTrait provides utilities for altering tables during an upgrade.</dd> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/CRM-Extension-Upgrader-TasksTrait.html"><abbr title="\CRM_Extension_Upgrader_TasksTrait">CRM_Extension_Upgrader_TasksTrait</abbr></a></dt><dd>The TasksTrait provides a library of tasks that are useful to run during an upgrade.</dd> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/CRM-Financial-Form-FrontEndPaymentFormTrait.html"><abbr title="\CRM_Financial_Form_FrontEndPaymentFormTrait">CRM_Financial_Form_FrontEndPaymentFormTrait</abbr></a></dt><dd>This class holds functionality shared between various front end forms.</dd> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/CRM-Financial-Form-PaymentProcessorFormTrait.html"><abbr title="\CRM_Financial_Form_PaymentProcessorFormTrait">CRM_Financial_Form_PaymentProcessorFormTrait</abbr></a></dt><dd>Trait implements functions to retrieve payment processor related values.</dd> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/CRM-Financial-Form-SalesTaxTrait.html"><abbr title="\CRM_Financial_Form_SalesTaxTrait">CRM_Financial_Form_SalesTaxTrait</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/CRM-Member-Form-MembershipFormTrait.html"><abbr title="\CRM_Member_Form_MembershipFormTrait">CRM_Member_Form_MembershipFormTrait</abbr></a></dt><dd>Trait implements functions to retrieve membership related values.</dd> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/CRM-Member-WorkflowMessage-MembershipTrait.html"><abbr title="\CRM_Member_WorkflowMessage_MembershipTrait">CRM_Member_WorkflowMessage_MembershipTrait</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/CRM-Pledge-Form-PledgeFormTrait.html"><abbr title="\CRM_Pledge_Form_PledgeFormTrait">CRM_Pledge_Form_PledgeFormTrait</abbr></a></dt><dd>Trait implements getContactValue + overridable getContactID functions.</dd> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/CRM-Queue-Queue-SqlTrait.html"><abbr title="\CRM_Queue_Queue_SqlTrait">CRM_Queue_Queue_SqlTrait</abbr></a></dt><dd>Trait defines methods that are commonly used to implement a SQL-backed queue.</dd> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/CRM-Upgrade-Incremental-php-TimezoneRevertTrait.html"><abbr title="\CRM_Upgrade_Incremental_php_TimezoneRevertTrait">CRM_Upgrade_Incremental_php_TimezoneRevertTrait</abbr></a></dt><dd>Circa v5.47.x-5.48.x, the `civicrm_event.event_tz` columns were introduced. But there were still
significant issues.</dd> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/CRM-Utils-Cache-NaiveHasTrait.html"><abbr title="\CRM_Utils_Cache_NaiveHasTrait">CRM_Utils_Cache_NaiveHasTrait</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/CRM-Utils-Cache-NaiveMultipleTrait.html"><abbr title="\CRM_Utils_Cache_NaiveMultipleTrait">CRM_Utils_Cache_NaiveMultipleTrait</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/CRM-Utils-SQL-EscapeStringTrait.html"><abbr title="\CRM_Utils_SQL_EscapeStringTrait">CRM_Utils_SQL_EscapeStringTrait</abbr></a></dt> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/CRM-Core-Payment-AuthorizeNetTrait.html"><abbr title="\CRM_Core_Payment_AuthorizeNetTrait">CRM_Core_Payment_AuthorizeNetTrait</abbr></a></dt><dd>Class CRM_Core_Payment_AuthorizeNetTest</dd> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/CRM-Core-Payment-PaypalProTrait.html"><abbr title="\CRM_Core_Payment_PaypalProTrait">CRM_Core_Payment_PaypalProTrait</abbr></a></dt><dd>Class CRM_Core_Payment_AuthorizeNetTest</dd> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/CRM-Core-Resources-CollectionTestTrait.html"><abbr title="\CRM_Core_Resources_CollectionTestTrait">CRM_Core_Resources_CollectionTestTrait</abbr></a></dt><dd>Class CRM_Core_Resources_CollectionTestTrait</dd> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/CRMTraits-Contribute-RecurFormsTrait.html"><abbr title="\CRMTraits_Contribute_RecurFormsTrait">CRMTraits_Contribute_RecurFormsTrait</abbr></a></dt><dd>Trait CRMTraits_Contribute_RecurFormsTrait</dd> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/CRMTraits-Custom-CustomDataTrait.html"><abbr title="\CRMTraits_Custom_CustomDataTrait">CRMTraits_Custom_CustomDataTrait</abbr></a></dt><dd>Trait Custom Data trait.</dd> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/CRMTraits-Event-ScenarioTrait.html"><abbr title="\CRMTraits_Event_ScenarioTrait">CRMTraits_Event_ScenarioTrait</abbr></a></dt><dd>Trait to do set up for event scenarios.</dd> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/CRMTraits-Financial-FinancialACLTrait.html"><abbr title="\CRMTraits_Financial_FinancialACLTrait">CRMTraits_Financial_FinancialACLTrait</abbr></a></dt><dd>Trait FinancialACLTrait</dd> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/CRMTraits-Financial-OrderTrait.html"><abbr title="\CRMTraits_Financial_OrderTrait">CRMTraits_Financial_OrderTrait</abbr></a></dt><dd>Trait OrderTrait</dd> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/CRMTraits-Financial-PriceSetTrait.html"><abbr title="\CRMTraits_Financial_PriceSetTrait">CRMTraits_Financial_PriceSetTrait</abbr></a></dt><dd>Trait PriceSetTrait</dd> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/CRMTraits-Financial-TaxTrait.html"><abbr title="\CRMTraits_Financial_TaxTrait">CRMTraits_Financial_TaxTrait</abbr></a></dt><dd>Trait TaxTrait</dd> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/CRMTraits-Import-ParserTrait.html"><abbr title="\CRMTraits_Import_ParserTrait">CRMTraits_Import_ParserTrait</abbr></a></dt><dd>Trait ParserTrait</dd> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/CRMTraits-Page-PageTestTrait.html"><abbr title="\CRMTraits_Page_PageTestTrait">CRMTraits_Page_PageTestTrait</abbr></a></dt><dd>Trait CRMTraits_Page_PageTestTrait</dd> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/CRMTraits-PCP-PCPTestTrait.html"><abbr title="\CRMTraits_PCP_PCPTestTrait">CRMTraits_PCP_PCPTestTrait</abbr></a></dt><dd>Trait CRMTraits_PCP_PCPTestTrait</dd> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/CRMTraits-Profile-ProfileTrait.html"><abbr title="\CRMTraits_Profile_ProfileTrait">CRMTraits_Profile_ProfileTrait</abbr></a></dt><dd>Trait PriceSetTrait</dd> </dl>
<h4 id="toc-constants">
Constants
<a href="namespaces/default.html#toc-constants" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="namespaces/default.html#constant__CIVICRM_FAKE_SESSION">_CIVICRM_FAKE_SESSION</a>
<span>
= TRUE </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="namespaces/default.html#constant__JEXEC">_JEXEC</a>
<span>
= 1 </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="namespaces/default.html#constant_AFFORM_HTML_MONACO">AFFORM_HTML_MONACO</a>
<span>
= 'bower_components/monaco-editor/min/vs' </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="namespaces/default.html#constant_API_LATEST_VERSION">API_LATEST_VERSION</a>
<span>
= 3 </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="namespaces/default.html#constant_API_V3_EXTENSION_DELIMITER">API_V3_EXTENSION_DELIMITER</a>
<span>
= ',' </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="namespaces/default.html#constant_BACKDROP_ROOT">BACKDROP_ROOT</a>
<span>
= $cmsPath </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="namespaces/default.html#constant_BACKDROP_ROOT">BACKDROP_ROOT</a>
<span>
= getcwd() </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="namespaces/default.html#constant_BLOCK_CACHE_GLOBAL">BLOCK_CACHE_GLOBAL</a>
<span>
= 0x8 </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="namespaces/default.html#constant_BLOCK_CACHE_PER_PAGE">BLOCK_CACHE_PER_PAGE</a>
<span>
= 0x4 </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="namespaces/default.html#constant_BLOCK_NO_CACHE">BLOCK_NO_CACHE</a>
<span>
= -1 </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="namespaces/default.html#constant_CHUNK_SIZE">CHUNK_SIZE</a>
<span>
= 128 </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="namespaces/default.html#constant_CHUNK_SIZE">CHUNK_SIZE</a>
<span>
= 128 </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="namespaces/default.html#constant_CHUNK_SIZE">CHUNK_SIZE</a>
<span>
= 128 </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="namespaces/default.html#constant_CIVI_SETUP">CIVI_SETUP</a>
<span>
= 1 </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="namespaces/default.html#constant_CIVICRM_CONTAINER_CACHE">CIVICRM_CONTAINER_CACHE</a>
<span>
= 'never' </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="namespaces/default.html#constant_CIVICRM_DSN">CIVICRM_DSN</a>
<span>
= $composedDsn </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="namespaces/default.html#constant_CIVICRM_HIBP_URL">CIVICRM_HIBP_URL</a>
<span>
= 'https://api.pwnedpasswords.com/range/' </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="namespaces/default.html#constant_CIVICRM_IFRAME">CIVICRM_IFRAME</a>
<span>
= 1 </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="namespaces/default.html#constant_CIVICRM_IFRAME">CIVICRM_IFRAME</a>
<span>
= 1 </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="namespaces/default.html#constant_CIVICRM_IFRAME">CIVICRM_IFRAME</a>
<span>
= 1 </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="namespaces/default.html#constant_CIVICRM_L10N_BASEDIR">CIVICRM_L10N_BASEDIR</a>
<span>
= \getenv('CIVICRM_L10N_BASEDIR') ? \getenv('CIVICRM_L10N_BASEDIR') : (__DIR__ . '/../l10n') </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="namespaces/default.html#constant_CIVICRM_L10N_BASEDIR">CIVICRM_L10N_BASEDIR</a>
<span>
= \getenv('CIVICRM_L10N_BASEDIR') ? \getenv('CIVICRM_L10N_BASEDIR') : (__DIR__ . '/../l10n') </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="namespaces/default.html#constant_CIVICRM_SETTINGS_PATH">CIVICRM_SETTINGS_PATH</a>
<span>
= $config['conf_path'] . '/civicrm.settings.php' </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="namespaces/default.html#constant_CIVICRM_SETTINGS_PATH">CIVICRM_SETTINGS_PATH</a>
<span>
= $settingsPath </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="namespaces/default.html#constant_CIVICRM_TEMPLATE_COMPILEDIR">CIVICRM_TEMPLATE_COMPILEDIR</a>
<span>
= $model->templateCompilePath </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="namespaces/default.html#constant_CIVICRM_TEST">CIVICRM_TEST</a>
<span>
= 1 </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="namespaces/default.html#constant_CIVICRM_TEST">CIVICRM_TEST</a>
<span>
= 1 </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="namespaces/default.html#constant_CIVICRM_TEST">CIVICRM_TEST</a>
<span>
= 1 </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="namespaces/default.html#constant_CIVICRM_UF">CIVICRM_UF</a>
<span>
= 'Joomla' </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="namespaces/default.html#constant_CIVICRM_UF">CIVICRM_UF</a>
<span>
= 'Drupal' </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="namespaces/default.html#constant_CIVICRM_UF">CIVICRM_UF</a>
<span>
= $model->cms </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="namespaces/default.html#constant_CIVICRM_UF">CIVICRM_UF</a>
<span>
= 'Drupal' </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="namespaces/default.html#constant_CIVICRM_UF_BASEURL">CIVICRM_UF_BASEURL</a>
<span>
= '/' </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="namespaces/default.html#constant_CIVICRM_UF_BASEURL">CIVICRM_UF_BASEURL</a>
<span>
= $model->cmsBaseUrl </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="namespaces/default.html#constant_CIVICRM_UF_BASEURL">CIVICRM_UF_BASEURL</a>
<span>
= '/' </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="namespaces/default.html#constant_DB_DSN_MODE">DB_DSN_MODE</a>
<span>
= 'auto' </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="namespaces/default.html#constant_DRUPAL_ROOT">DRUPAL_ROOT</a>
<span>
= $cmsPath </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="namespaces/default.html#constant_DRUPAL_ROOT">DRUPAL_ROOT</a>
<span>
= getcwd() </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="namespaces/default.html#constant_DS">DS</a>
<span>
= DIRECTORY_SEPARATOR </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="namespaces/default.html#constant_JDEBUG">JDEBUG</a>
<span>
= FALSE </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="namespaces/default.html#constant_JPATH_BASE">JPATH_BASE</a>
<span>
= $joomlaBase . DS . 'administrator' </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="namespaces/default.html#constant_JVERSION">JVERSION</a>
<span>
= $jversion->getShortVersion() </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="namespaces/default.html#constant_MAIL_BATCH_SIZE">MAIL_BATCH_SIZE</a>
<span>
= 50 </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="namespaces/default.html#constant_RECAPTCHA_API_SECURE_SERVER">RECAPTCHA_API_SECURE_SERVER</a>
<span>
= "https://www.google.com/recaptcha/api.js" </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="namespaces/default.html#constant_RECAPTCHA_API_SERVER">RECAPTCHA_API_SERVER</a>
<span>
= "http://www.google.com/recaptcha/api.js" </span>
</dt>
<dd>The reCAPTCHA server URL's</dd>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="namespaces/default.html#constant_RECAPTCHA_VERIFY_SERVER">RECAPTCHA_VERIFY_SERVER</a>
<span>
= "https://www.google.com" </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a class="" href="namespaces/default.html#constant_WP_USE_THEMES">WP_USE_THEMES</a>
<span>
= FALSE </span>
</dt>
</dl>
<h4 id="toc-functions">
Functions
<a href="namespaces/default.html#toc-functions" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="-deprecated" href="namespaces/default.html#function_civicrm_api">civicrm_api()</a>
<span>
: array<string|int, mixed>|int|<a href="classes/Civi-Api4-Generic-Result.html"><abbr title="\Civi\Api4\Generic\Result">Result</abbr></a> </span>
</dt>
<dd>The original API wrapper.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api4">civicrm_api4()</a>
<span>
: <a href="classes/Civi-Api4-Generic-Result.html"><abbr title="\Civi\Api4\Generic\Result">Result</abbr></a> </span>
</dt>
<dd>CiviCRM API version 4.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3">civicrm_api3()</a>
<span>
: array<string|int, mixed>|int </span>
</dt>
<dd>Version 3 wrapper for civicrm_api.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_api_getfields">_civicrm_api3_api_getfields()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Call getfields from api wrapper.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_error">civicrm_error()</a>
<span>
: bool </span>
</dt>
<dd>Check if the result is an error. Note that this function has been retained from
api v2 for convenience but the result is more standardised in v3 and param
'format.is_success' => 1
will result in a boolean success /fail being returned if that is what you need.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api_get_camel_name">_civicrm_api_get_camel_name()</a>
<span>
: string|null </span>
</dt>
<dd>Get camel case version of entity name.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api_replace_variables">_civicrm_api_replace_variables()</a>
<span>
: mixed </span>
</dt>
<dd>Swap out any $values vars.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api_replace_variable">_civicrm_api_replace_variable()</a>
<span>
: mixed|null </span>
</dt>
<dd>Swap out a $value.foo variable with the value from parent api results.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="-deprecated" href="namespaces/default.html#function__civicrm_api_get_entity_name_from_camel">_civicrm_api_get_entity_name_from_camel()</a>
<span>
: string </span>
</dt>
<dd>Convert possibly camel name to underscore separated entity name.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api_get_entity_name_from_dao">_civicrm_api_get_entity_name_from_dao()</a>
<span>
: string </span>
</dt>
<dd>Having a DAO object find the entity name.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_acl_create">civicrm_api3_acl_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Save an Acl.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_acl_create_spec">_civicrm_api3_acl_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Acl create metadata.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_acl_get">civicrm_api3_acl_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get an Acl.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_acl_delete">civicrm_api3_acl_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete an Acl.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_acl_role_create">civicrm_api3_acl_role_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Save an AclRole.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_acl_role_create_spec">_civicrm_api3_acl_role_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>AclRole create metadata.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_acl_role_get">civicrm_api3_acl_role_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get an AclRole.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_acl_role_delete">civicrm_api3_acl_role_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete an AclRole.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_action_schedule_get">civicrm_api3_action_schedule_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get CiviCRM ActionSchedule details.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_action_schedule_create">civicrm_api3_action_schedule_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Create a new ActionSchedule.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_action_schedule_create_spec">_civicrm_api3_action_schedule_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_action_schedule_delete">civicrm_api3_action_schedule_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete an existing ActionSchedule.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_activity_create">civicrm_api3_activity_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Creates or updates an Activity.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_activity_create_spec">_civicrm_api3_activity_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Specify Meta data for create.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_activity_get_spec">_civicrm_api3_activity_get_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Specify Metadata for get.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_activity_get">civicrm_api3_activity_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Gets a CiviCRM activity according to parameters.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_activity_get_handleSourceContactNameOrderBy">_civicrm_activity_get_handleSourceContactNameOrderBy()</a>
<span>
: mixed </span>
</dt>
<dd>Handle source_contact_name as a sort parameter.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_activity_get_extraFilters">_civicrm_api3_activity_get_extraFilters()</a>
<span>
: mixed </span>
</dt>
<dd>Support filters beyond what basic_get can do.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_activity_get_formatResult">_civicrm_api3_activity_get_formatResult()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Given a list of activities, append any extra data requested about the activities.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_activity_fill_activity_contact_names">_civicrm_api3_activity_fill_activity_contact_names()</a>
<span>
: mixed </span>
</dt>
<dd>Append activity contact details to activity results.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_activity_delete">civicrm_api3_activity_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete a specified Activity.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_activity_check_params">_civicrm_api3_activity_check_params()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Check for required params.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_activity_getlist_params">_civicrm_api3_activity_getlist_params()</a>
<span>
: mixed </span>
</dt>
<dd>Get parameters for activity list.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_activity_getlist_output">_civicrm_api3_activity_getlist_output()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get output for activity list.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_activity_contact_create">civicrm_api3_activity_contact_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Add a record relating a contact with an activity.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_activity_contact_create_spec">_civicrm_api3_activity_contact_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_activity_contact_delete">civicrm_api3_activity_contact_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete an existing ActivityContact record.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_activity_contact_get">civicrm_api3_activity_contact_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get a ActivityContact.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="-deprecated" href="namespaces/default.html#function__civicrm_api3_activity_type_deprecation">_civicrm_api3_activity_type_deprecation()</a>
<span>
: string </span>
</dt>
<dd>Notification of deprecated function.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="-deprecated" href="namespaces/default.html#function_civicrm_api3_activity_type_get">civicrm_api3_activity_type_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Retrieve activity types.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="-deprecated" href="namespaces/default.html#function_civicrm_api3_activity_type_create">civicrm_api3_activity_type_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Create activity type.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_activity_type_create_spec">_civicrm_api3_activity_type_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="-deprecated" href="namespaces/default.html#function_civicrm_api3_activity_type_delete">civicrm_api3_activity_type_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete ActivityType.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_address_create">civicrm_api3_address_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Add an Address for a contact.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_address_create_spec">_civicrm_api3_address_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_address_get_spec">_civicrm_api3_address_get_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Get action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_address_delete">civicrm_api3_address_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete an existing Address.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_address_get">civicrm_api3_address_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Retrieve one or more addresses.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_attachment_create_spec">_civicrm_api3_attachment_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust metadata for "create" action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_attachment_create">civicrm_api3_attachment_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Create an Attachment.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_attachment_get_spec">_civicrm_api3_attachment_get_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust metadata for get action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_attachment_get">civicrm_api3_attachment_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get Attachment.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_attachment_delete_spec">_civicrm_api3_attachment_delete_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust metadata for Attachment delete action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_attachment_delete">civicrm_api3_attachment_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete Attachment.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function___civicrm_api3_attachment_find">__civicrm_api3_attachment_find()</a>
<span>
: <a href="classes/CRM-Core-DAO.html"><abbr title="\CRM_Core_DAO">CRM_Core_DAO</abbr></a> </span>
</dt>
<dd>Attachment find helper.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_attachment_parse_params">_civicrm_api3_attachment_parse_params()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Attachment parsing helper.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_attachment_format_result">_civicrm_api3_attachment_format_result()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Attachment result formatting helper.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_attachment_getfields">_civicrm_api3_attachment_getfields()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Attachment getfields helper.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_batch_create">civicrm_api3_batch_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Save a Batch.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_batch_create_spec">_civicrm_api3_batch_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_batch_get">civicrm_api3_batch_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get a Batch.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_batch_delete">civicrm_api3_batch_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete a Batch.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_campaign_create">civicrm_api3_campaign_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Create/update Campaign.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_campaign_create_spec">_civicrm_api3_campaign_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_campaign_get">civicrm_api3_campaign_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Returns array of campaigns matching a set of one or more properties.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_campaign_delete">civicrm_api3_campaign_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete an existing campaign.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_campaign_getlist_params">_civicrm_api3_campaign_getlist_params()</a>
<span>
: mixed </span>
</dt>
<dd>Get campaign list parameters.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_campaign_getlist_output">_civicrm_api3_campaign_getlist_output()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get campaign list output.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_case_create">civicrm_api3_case_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Open a new case, add client and manager roles, and standard timeline.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_case_create_xmlProcessor">_civicrm_api3_case_create_xmlProcessor()</a>
<span>
: mixed </span>
</dt>
<dd>When creating a new case, run the xmlProcessor to get all necessary params/configuration
for the new case, as cases use an xml file to store their configuration.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_case_get_spec">_civicrm_api3_case_get_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Get Action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_case_create_spec">_civicrm_api3_case_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create Action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_case_update_spec">_civicrm_api3_case_update_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Update action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_case_delete_spec">_civicrm_api3_case_delete_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Delete action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_case_get">civicrm_api3_case_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get details of a particular case, or search for cases, depending on params.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_case_activity_create">civicrm_api3_case_activity_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Deprecated API.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_case_addtimeline">civicrm_api3_case_addtimeline()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Add a timeline to a case.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_case_addtimeline_spec">_civicrm_api3_case_addtimeline_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for addtimeline action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_case_merge">civicrm_api3_case_merge()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Merge 2 cases.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_case_merge_spec">_civicrm_api3_case_merge_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for merge action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="-deprecated" href="namespaces/default.html#function__civicrm_api3_case_deprecation">_civicrm_api3_case_deprecation()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Declare deprecated api functions.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="-deprecated" href="namespaces/default.html#function_civicrm_api3_case_update">civicrm_api3_case_update()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_case_delete">civicrm_api3_case_delete()</a>
<span>
: mixed </span>
</dt>
<dd>Delete a specified case.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_case_restore_spec">_civicrm_api3_case_restore_spec()</a>
<span>
: void </span>
</dt>
<dd>Case.restore API specification</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_case_restore">civicrm_api3_case_restore()</a>
<span>
: mixed </span>
</dt>
<dd>Restore a specified case from the trash.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_case_read">_civicrm_api3_case_read()</a>
<span>
: mixed </span>
</dt>
<dd>Augment case results with extra data.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_case_format_params">_civicrm_api3_case_format_params()</a>
<span>
: mixed </span>
</dt>
<dd>Internal function to format create params for processing.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_case_getList">civicrm_api3_case_getList()</a>
<span>
: mixed </span>
</dt>
<dd>It actually works a lot better to use the CaseContact api instead of the Case api
for entityRef fields so we can perform the necessary joins,
so we pass off getlist requests to the CaseContact api.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_case_getlist_spec">_civicrm_api3_case_getlist_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Needed due to the above override</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_case_getoptions">civicrm_api3_case_getoptions()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_case_contact_create">civicrm_api3_case_contact_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Save a CaseContact.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_case_contact_create_spec">_civicrm_api3_case_contact_create_spec()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_case_contact_get">civicrm_api3_case_contact_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get a CaseContact.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_case_contact_delete">civicrm_api3_case_contact_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete a CaseContact.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_case_contact_getlist_output">_civicrm_api3_case_contact_getlist_output()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Results formatting for Case entityRef lookups.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_case_type_create">civicrm_api3_case_type_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Create or update case type.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_case_type_get">civicrm_api3_case_type_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Retrieve case types.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_case_type_get_formatResult">_civicrm_api3_case_type_get_formatResult()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Format definition.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_case_type_delete">civicrm_api3_case_type_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Function to delete case type.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="-deprecated" href="namespaces/default.html#function__civicrm_api3_constant_deprecation">_civicrm_api3_constant_deprecation()</a>
<span>
: string </span>
</dt>
<dd>Declare deprecated api entity.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="-deprecated" href="namespaces/default.html#function_civicrm_api3_constant_get">civicrm_api3_constant_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get constant values (deprecated).</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_constant_get_spec">_civicrm_api3_constant_get_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust metadata for constant get action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_contact_create">civicrm_api3_contact_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Create or update a Contact.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_contact_create_spec">_civicrm_api3_contact_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_contact_get">civicrm_api3_contact_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Retrieve one or more contacts, given a set of search params.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_contact_getcount">civicrm_api3_contact_getcount()</a>
<span>
: int </span>
</dt>
<dd>Get number of contacts matching the supplied criteria.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_contact_get_spec">_civicrm_api3_contact_get_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Get action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_contact_get_supportanomalies">_civicrm_api3_contact_get_supportanomalies()</a>
<span>
: mixed </span>
</dt>
<dd>Support for historical oddities.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_contact_delete">civicrm_api3_contact_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete a Contact with given contact_id.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_contact_check_params">_civicrm_api3_contact_check_params()</a>
<span>
: null </span>
</dt>
<dd>Check parameters passed in.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_contact_update">_civicrm_api3_contact_update()</a>
<span>
: <a href="classes/CRM-Contact-BAO-Contact.html"><abbr title="\CRM_Contact_BAO_Contact">CRM_Contact_BAO_Contact</abbr></a>|<a href="classes/CRM-Core-Error.html"><abbr title="\CRM_Core_Error">CRM_Core_Error</abbr></a> </span>
</dt>
<dd>Helper function for Contact create.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_greeting_format_params">_civicrm_api3_greeting_format_params()</a>
<span>
: mixed </span>
</dt>
<dd>Validate the addressee or email or postal greetings.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_quicksearch_get_order_by">_civicrm_api3_quicksearch_get_order_by()</a>
<span>
: string </span>
</dt>
<dd>Get the order by string for the quicksearch query.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_contact_merge">civicrm_api3_contact_merge()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Merges given pair of duplicate contacts.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_contact_merge_spec">_civicrm_api3_contact_merge_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust metadata for contact_merge api function.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_contact_get_merge_conflicts">civicrm_api3_contact_get_merge_conflicts()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Determines if given pair of contaacts have conflicts that would affect merging them.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_contact_get_merge_conflicts_spec">_civicrm_api3_contact_get_merge_conflicts_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust metadata for contact_merge api function.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_contact_getmergedto">civicrm_api3_contact_getmergedto()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get the ultimate contact a contact was merged to.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_contact_getmergedto">_civicrm_api3_contact_getmergedto()</a>
<span>
: int|false </span>
</dt>
<dd>Get the contact our contact was finally merged to.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_contact_getmergedto_spec">_civicrm_api3_contact_getmergedto_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust metadata for contact_merge api function.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_contact_getmergedfrom">civicrm_api3_contact_getmergedfrom()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get the ultimate contact a contact was merged to.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_contact_getmergedfrom">_civicrm_api3_contact_getmergedfrom()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get all the contacts merged into our contact.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_contact_getmergedfrom_spec">_civicrm_api3_contact_getmergedfrom_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust metadata for contact_merge api function.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_contact_proximity_spec">_civicrm_api3_contact_proximity_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust metadata for contact_proximity api function.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_contact_proximity">civicrm_api3_contact_proximity()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get contacts by proximity.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_contact_getlist_params">_civicrm_api3_contact_getlist_params()</a>
<span>
: mixed </span>
</dt>
<dd>Get parameters for getlist function.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_contact_getlist_output">_civicrm_api3_contact_getlist_output()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get output for getlist function.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_contact_duplicatecheck">civicrm_api3_contact_duplicatecheck()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Check for duplicate contacts.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_contact_duplicatecheck_spec">_civicrm_api3_contact_duplicatecheck_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Declare metadata for contact dedupe function.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_contact_type_create">civicrm_api3_contact_type_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Create/update ContactType.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_contact_type_get">civicrm_api3_contact_type_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Returns array of contact_types matching a set of one or more properties.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_contact_type_delete">civicrm_api3_contact_type_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete an existing ContactType.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_contribution_transact_spec">_civicrm_api3_contribution_transact_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Transact action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="-deprecated" href="namespaces/default.html#function_civicrm_api3_contribution_transact">civicrm_api3_contribution_transact()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Process a transaction and record it against the contact.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_contribution_create">civicrm_api3_contribution_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Add or update a Contribution.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_contribution_create_spec">_civicrm_api3_contribution_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_contribution_create_legacy_support_45">_civicrm_api3_contribution_create_legacy_support_45()</a>
<span>
: mixed </span>
</dt>
<dd>Support for schema changes made in 4.5.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_contribution_delete">civicrm_api3_contribution_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete a Contribution.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_contribution_delete_spec">_civicrm_api3_contribution_delete_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Modify metadata for delete action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_contribution_get">civicrm_api3_contribution_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Retrieve a set of contributions.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_contribution_get_support_nonunique_returns">_civicrm_api3_contribution_get_support_nonunique_returns()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Fix the return values to reflect cases where the schema has been changed.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_contribution_add_supported_fields">_civicrm_api3_contribution_add_supported_fields()</a>
<span>
: mixed </span>
</dt>
<dd>Support for supported output variables.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_contribution_getcount">civicrm_api3_contribution_getcount()</a>
<span>
: int </span>
</dt>
<dd>Get number of contacts matching the supplied criteria.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_format_soft_credit">_civicrm_api3_format_soft_credit()</a>
<span>
: mixed </span>
</dt>
<dd>This function is used to format the soft credit for backward compatibility.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_contribution_get_spec">_civicrm_api3_contribution_get_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Get action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_contribute_format_params">_civicrm_api3_contribute_format_params()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Legacy handling for contribution parameters.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_contribution_sendconfirmation">civicrm_api3_contribution_sendconfirmation()</a>
<span>
: mixed </span>
</dt>
<dd>Send a contribution confirmation (receipt or invoice).</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_contribution_sendconfirmation_spec">_civicrm_api3_contribution_sendconfirmation_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for sendconfirmation action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_contribution_completetransaction">civicrm_api3_contribution_completetransaction()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Complete an existing (pending) transaction.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_contribution_completetransaction_spec">_civicrm_api3_contribution_completetransaction_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Provide function metadata.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_contribution_repeattransaction">civicrm_api3_contribution_repeattransaction()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Complete an existing (pending) transaction.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_contribution_repeattransaction_spec">_civicrm_api3_contribution_repeattransaction_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Provide function metadata.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_contribution_deprecation">_civicrm_api3_contribution_deprecation()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Declare deprecated functions.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_contribution_page_create">civicrm_api3_contribution_page_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Create or update a ContributionPage.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_contribution_page_create_spec">_civicrm_api3_contribution_page_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_contribution_page_get">civicrm_api3_contribution_page_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Returns array of ContributionPage(s) matching a set of one or more group properties.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_contribution_page_delete">civicrm_api3_contribution_page_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete an existing ContributionPage.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_contribution_page_submit">civicrm_api3_contribution_page_submit()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Submit a ContributionPage.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_contribution_page_validate">civicrm_api3_contribution_page_validate()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Validate ContributionPage submission parameters.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_contribution_page_validate_spec">_civicrm_api3_contribution_page_validate_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Metadata for validate action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_contribution_page_getlist_defaults">_civicrm_api3_contribution_page_getlist_defaults()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Set default getlist parameters.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_contribution_page_deprecation">_civicrm_api3_contribution_page_deprecation()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_contribution_product_create">civicrm_api3_contribution_product_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Save a contribution product.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_contribution_product_get">civicrm_api3_contribution_product_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get a contribution product.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_contribution_product_delete">civicrm_api3_contribution_product_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete a contribution product.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_contribution_recur_create">civicrm_api3_contribution_recur_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Create or update a ContributionRecur.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_contribution_recur_create_spec">_civicrm_api3_contribution_recur_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_contribution_recur_get">civicrm_api3_contribution_recur_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Returns array of contribution_recurs matching a set of one or more group properties.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_contribution_recur_cancel">civicrm_api3_contribution_recur_cancel()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Cancel a recurring contribution of existing ContributionRecur given its id.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_contribution_recur_cancel_spec">_civicrm_api3_contribution_recur_cancel_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Cancel action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_contribution_recur_delete">civicrm_api3_contribution_recur_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete an existing ContributionRecur.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_contribution_soft_create">civicrm_api3_contribution_soft_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Create or Update a Soft Credit.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_contribution_soft_create_spec">_civicrm_api3_contribution_soft_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_contribution_soft_delete">civicrm_api3_contribution_soft_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Deletes an existing Soft Credit.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_contribution_soft_get">civicrm_api3_contribution_soft_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Retrieve one or more Soft Credits.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_country_create">civicrm_api3_country_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Add an Country for a contact.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_country_create_spec">_civicrm_api3_country_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_country_delete">civicrm_api3_country_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Deletes an existing Country.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_country_get">civicrm_api3_country_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Retrieve one or more countryies.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_custom_field_create">civicrm_api3_custom_field_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Create a 'custom field' within a custom field group.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_custom_field_flush_static_caches">_civicrm_api3_custom_field_flush_static_caches()</a>
<span>
: mixed </span>
</dt>
<dd>Flush static caches in functions that might have stored available custom fields.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_custom_field_create_spec">_civicrm_api3_custom_field_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_custom_field_delete">civicrm_api3_custom_field_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Use this API to delete an existing custom field.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_custom_field_get">civicrm_api3_custom_field_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Use this API to get existing custom fields.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="-deprecated" href="namespaces/default.html#function__civicrm_api3_custom_field_validate_field">_civicrm_api3_custom_field_validate_field()</a>
<span>
: array<string|int, mixed>|null </span>
</dt>
<dd>Helper function to validate custom field value.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_custom_field_setvalue">civicrm_api3_custom_field_setvalue()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>CRM-15191 - Hack to ensure the cache gets cleared after updating a custom field.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_custom_field_getoptions">civicrm_api3_custom_field_getoptions()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_custom_group_create">civicrm_api3_custom_group_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>This entire function consists of legacy handling, probably for a form that no longer exists.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_custom_group_create_spec">_civicrm_api3_custom_group_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_custom_group_delete">civicrm_api3_custom_group_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Use this API to delete an existing group.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_custom_group_get">civicrm_api3_custom_group_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>API to get existing custom fields.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_custom_group_setvalue">civicrm_api3_custom_group_setvalue()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>CRM-15191 - Hack to ensure the cache gets cleared after updating a custom group.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_custom_group_getoptions">civicrm_api3_custom_group_getoptions()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_custom_search_get">civicrm_api3_custom_search_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Retrieve custom searches.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_custom_search_create">civicrm_api3_custom_search_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Add a CustomSearch.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_custom_search_create_spec">_civicrm_api3_custom_search_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_custom_search_delete">civicrm_api3_custom_search_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Deletes an existing CustomSearch.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_custom_value_create">civicrm_api3_custom_value_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Sets custom values for an entity.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_custom_value_create_spec">_civicrm_api3_custom_value_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_custom_value_get">civicrm_api3_custom_value_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Use this API to get existing custom values for an entity.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_custom_value_get_spec">_civicrm_api3_custom_value_get_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Get action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_custom_value_gettree_spec">_civicrm_api3_custom_value_gettree_spec()</a>
<span>
: mixed </span>
</dt>
<dd>CustomValue.gettree API specification</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_custom_value_gettree">civicrm_api3_custom_value_gettree()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>CustomValue.gettree API</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_custom_value_getdisplayvalue_spec">_civicrm_api3_custom_value_getdisplayvalue_spec()</a>
<span>
: mixed </span>
</dt>
<dd>CustomValue.getdisplayvalue API specification</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_custom_value_getdisplayvalue">civicrm_api3_custom_value_getdisplayvalue()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>CustomValue.getdisplayvalue API</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_cxn_register_spec">_civicrm_api3_cxn_register_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust metadata for "register" action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_cxn_register">civicrm_api3_cxn_register()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Register with a remote application and create a new connection.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_cxn_unregister_spec">_civicrm_api3_cxn_unregister_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust metadata for cxn unregister.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_cxn_unregister">civicrm_api3_cxn_unregister()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Unregister with a remote application; destroy an existing connection.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_cxn_parseCxnId">_civicrm_api3_cxn_parseCxnId()</a>
<span>
: string </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_cxn_get_spec">_civicrm_api3_cxn_get_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust metadata for cxn get action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_cxn_get">civicrm_api3_cxn_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Returns an array of Cxn records.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_cxn_getlink_spec">_civicrm_api3_cxn_getlink_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust metadata for "getlink" action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_cxn_getlink">civicrm_api3_cxn_getlink()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_cxn_getcfg">civicrm_api3_cxn_getcfg()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_cxn_create">civicrm_api3_cxn_create()</a>
<span>
: <abbr title="\page">page</abbr> </span>
</dt>
<dd>Creates or modifies a Cxn row.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_cxn_app_get_spec">_civicrm_api3_cxn_app_get_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust metadata for "register" action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_cxn_app_get">civicrm_api3_cxn_app_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get a list of applications available for connections.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_dashboard_create">civicrm_api3_dashboard_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Creates or updates an Dashlet.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_dashboard_create_spec">_civicrm_api3_dashboard_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Specify Meta data for create.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_dashboard_get">civicrm_api3_dashboard_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Gets a CiviCRM Dashlets according to parameters.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_dashboard_delete">civicrm_api3_dashboard_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete a specified Dashlet.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_dashboard_contact_create">civicrm_api3_dashboard_contact_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Creates/Updates a new Dashboard Contact Entry.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_dashboard_contact_get">civicrm_api3_dashboard_contact_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Gets a CiviCRM Dashlets of Contacts according to parameters.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_dashboard_contact_create_spec">_civicrm_api3_dashboard_contact_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_dashboard_contact_delete">civicrm_api3_dashboard_contact_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete an existing dashboard-contact.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_dedupe_get">civicrm_api3_dedupe_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get rows for any cached attempted merges on the passed criteria.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_dedupe_get_spec">_civicrm_api3_dedupe_get_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Get rows for getting dedupe cache records.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_dedupe_delete">civicrm_api3_dedupe_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete rows for any cached attempted merges on the passed criteria.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_dedupe_create">civicrm_api3_dedupe_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get the statistics for any cached attempted merges on the passed criteria.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_dedupe_getstatistics">civicrm_api3_dedupe_getstatistics()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get the statistics for any cached attempted merges on the passed criteria.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_dedupe_getstatistics_spec">_civicrm_api3_dedupe_getstatistics_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_dedupe_getduplicates">civicrm_api3_dedupe_getduplicates()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get the duplicate contacts for the supplied parameters.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_dedupe_getduplicates_spec">_civicrm_api3_dedupe_getduplicates_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for getduplicates action..
The metadata is used for setting defaults, documentation & validation.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_domain_get">civicrm_api3_domain_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get CiviCRM Domain details.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_domain_get_spec">_civicrm_api3_domain_get_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Get action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_domain_create">civicrm_api3_domain_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Create a new Domain.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_domain_create_spec">_civicrm_api3_domain_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_email_create">civicrm_api3_email_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Add an Email for a contact.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_email_create_spec">_civicrm_api3_email_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_email_delete">civicrm_api3_email_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Deletes an existing Email.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_email_get">civicrm_api3_email_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Retrieve one or more emails.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_email_getlist_defaults">_civicrm_api3_email_getlist_defaults()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Set default getlist parameters.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_entity_deprecation">_civicrm_api3_entity_deprecation()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get list of deprecated entities.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_entity_create">civicrm_api3_entity_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Placeholder function.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_entity_delete">civicrm_api3_entity_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Placeholder function.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_entity_getfields">civicrm_api3_entity_getfields()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Placeholder function.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_entity_batch_get">civicrm_api3_entity_batch_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get entity batches.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_entity_batch_create_spec">_civicrm_api3_entity_batch_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_entity_batch_create">civicrm_api3_entity_batch_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Create an entity batch.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_entity_batch_delete">civicrm_api3_entity_batch_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Mark entity batch as removed.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_entity_financial_account_create">civicrm_api3_entity_financial_account_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Save an Entity Financial Account record.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_entity_financial_account_create_spec">_civicrm_api3_entity_financial_account_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Save an Entity Financial Account record.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_entity_financial_account_get">civicrm_api3_entity_financial_account_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get an Entity Financial Account record.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_entity_financial_account_delete">civicrm_api3_entity_financial_account_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete an Entity Financial Account record.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_entity_financial_trxn_create">civicrm_api3_entity_financial_trxn_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Save a Entity Financial Trxn.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_entity_financial_trxn_get">civicrm_api3_entity_financial_trxn_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get a Entity Financial Trxn.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_entity_financial_trxn_delete">civicrm_api3_entity_financial_trxn_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete a Entity Financial Trxn.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_entity_financial_trxn_create_spec">_civicrm_api3_entity_financial_trxn_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_entity_tag_get">civicrm_api3_entity_tag_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get entity tags.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_entity_tag_get_spec">_civicrm_api3_entity_tag_get_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Get action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_entity_tag_create">civicrm_api3_entity_tag_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Create an entity tag.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_entity_tag_delete">civicrm_api3_entity_tag_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Mark entity tag as removed.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_entity_tag_delete_spec">_civicrm_api3_entity_tag_delete_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Modify metadata.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_entity_tag_common">_civicrm_api3_entity_tag_common()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Helper function for formatting tags (part of api v2 legacy).</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_entity_tag_replace">civicrm_api3_entity_tag_replace()</a>
<span>
: mixed </span>
</dt>
<dd>Replace tags for an entity</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_event_create">civicrm_api3_event_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Create a Event.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_event_create_spec">_civicrm_api3_event_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_event_create_legacy_support_42">_civicrm_api3_event_create_legacy_support_42()</a>
<span>
: mixed </span>
</dt>
<dd>Support for schema changes made in 4.2.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_event_get">civicrm_api3_event_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get Event record.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_event_get_spec">_civicrm_api3_event_get_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Get action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_event_get_legacy_support_42">_civicrm_api3_event_get_legacy_support_42()</a>
<span>
: mixed </span>
</dt>
<dd>Support for schema changes made in 4.2.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_event_delete">civicrm_api3_event_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete an existing Event.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_event_getisfull">_civicrm_api3_event_getisfull()</a>
<span>
: mixed </span>
</dt>
<dd>Add 'is_full' & 'available_seats' to the return array.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_event_getlist_params">_civicrm_api3_event_getlist_params()</a>
<span>
: mixed </span>
</dt>
<dd>Get event list parameters.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_event_getlist_output">_civicrm_api3_event_getlist_output()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get event list output.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_exception_get">civicrm_api3_exception_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get a Dedupe Exception.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_exception_create">civicrm_api3_exception_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Create or update an dedupe exception.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_exception_delete">civicrm_api3_exception_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete an existing Exception.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_extension_install">civicrm_api3_extension_install()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Install an extension.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_extension_install_spec">_civicrm_api3_extension_install_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Spec function for getfields</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_extension_upgrade">civicrm_api3_extension_upgrade()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Upgrade an extension - runs upgrade_N hooks and system.flush.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_extension_enable">civicrm_api3_extension_enable()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Enable an extension.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_extension_enable_spec">_civicrm_api3_extension_enable_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Spec function for getfields</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_extension_disable">civicrm_api3_extension_disable()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Disable an extension.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_extension_disable_spec">_civicrm_api3_extension_disable_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Spec function for getfields</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_extension_uninstall">civicrm_api3_extension_uninstall()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Uninstall an extension.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_extension_uninstall_spec">_civicrm_api3_extension_uninstall_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Spec function for getfields</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_extension_download">civicrm_api3_extension_download()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Download and install an extension.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_extension_download_spec">_civicrm_api3_extension_download_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Spec function for getfields</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_extension_refresh">civicrm_api3_extension_refresh()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Download and install an extension.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_extension_refresh_spec">_civicrm_api3_extension_refresh_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Spec function for getfields</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_extension_get">civicrm_api3_extension_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get a list of available extensions.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_extension_getremote">civicrm_api3_extension_getremote()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get a list of remotely available extensions.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_getKeys">_civicrm_api3_getKeys()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Determine the list of extension keys.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_file_create">civicrm_api3_file_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Create a file record.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_file_get">civicrm_api3_file_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get a File.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_file_update">civicrm_api3_file_update()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Update an existing File.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_file_delete">civicrm_api3_file_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete an existing File.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_financial_account_create">civicrm_api3_financial_account_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Save a FinancialAccount.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_financial_account_get">civicrm_api3_financial_account_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get a FinancialAccount.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_financial_account_delete">civicrm_api3_financial_account_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete a FinancialAccount.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_financial_item_create">civicrm_api3_financial_item_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Save a Financial Item.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_financial_item_get">civicrm_api3_financial_item_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get a FinancialItem.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_financial_item_delete">civicrm_api3_financial_item_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete a Financial Item.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_financial_trxn_create">civicrm_api3_financial_trxn_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Save a Financial Item.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_financial_trxn_get">civicrm_api3_financial_trxn_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get a Financialtrxn.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_financial_trxn_delete">civicrm_api3_financial_trxn_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete a Financial trxn.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_financial_trxn_create_spec">_civicrm_api3_financial_trxn_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_financial_type_create">civicrm_api3_financial_type_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Save a FinancialType.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_financial_type_create_spec">_civicrm_api3_financial_type_create_spec()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_financial_type_get">civicrm_api3_financial_type_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get a FinancialType.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_financial_type_delete">civicrm_api3_financial_type_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete a FinancialType.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_generic_getActions">civicrm_api3_generic_getActions()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get available api actions.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_generic_getList">civicrm_api3_generic_getList()</a>
<span>
: mixed </span>
</dt>
<dd>Generic api wrapper used for quicksearch and autocomplete.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_generic_getlist_get_result">_civicrm_api3_generic_getlist_get_result()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_generic_getList_defaults">_civicrm_api3_generic_getList_defaults()</a>
<span>
: void </span>
</dt>
<dd>Set defaults for api.getlist.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_generic_getlist_params">_civicrm_api3_generic_getlist_params()</a>
<span>
: mixed </span>
</dt>
<dd>Fallback implementation of getlist_params. May be overridden by individual apis.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_generic_getlist_output">_civicrm_api3_generic_getlist_output()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Fallback implementation of getlist_output. May be overridden by individual api functions.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_generic_getlist_postprocess">_civicrm_api3_generic_getlist_postprocess()</a>
<span>
: mixed </span>
</dt>
<dd>Common postprocess for getlist output</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_generic_getlist_spec">_civicrm_api3_generic_getlist_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Provide metadata for this api</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_generic_getunique">civicrm_api3_generic_getunique()</a>
<span>
: mixed </span>
</dt>
<dd>Generic api wrapper used to get all unique fields for a given entity.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_generic_setValue">civicrm_api3_generic_setValue()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Set a single value using the api.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="-deprecated" href="namespaces/default.html#function_civicrm_api3_generic_update">civicrm_api3_generic_update()</a>
<span>
: array<string|int, mixed>|int|mixed </span>
</dt>
<dd>Update function is basically a hack.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_generic_validate_spec">_civicrm_api3_generic_validate_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Provide meta-data for this api.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_generic_validate">civicrm_api3_generic_validate()</a>
<span>
: mixed </span>
</dt>
<dd>Generic api wrapper used for validation of entity-action pair.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_generic_getfields">civicrm_api3_generic_getfields()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get information about fields for a given api request.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_generic_getfield">civicrm_api3_generic_getfield()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get metadata for a field</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_generic_getfield_spec">_civicrm_api3_generic_getfield_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Get metadata for getfield action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_generic_getcount">civicrm_api3_generic_getcount()</a>
<span>
: int </span>
</dt>
<dd>API return function to reformat results as count.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_generic_getsingle">civicrm_api3_generic_getsingle()</a>
<span>
: int </span>
</dt>
<dd>API return function to reformat results as single result.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_generic_getvalue">civicrm_api3_generic_getvalue()</a>
<span>
: int </span>
</dt>
<dd>API return function to reformat results as single value.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_generic_getrefcount_spec">_civicrm_api3_generic_getrefcount_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Get count of contact references.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_generic_getrefcount">civicrm_api3_generic_getrefcount()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>API to determine if a record is in-use.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_generic_replace">civicrm_api3_generic_replace()</a>
<span>
: int </span>
</dt>
<dd>API wrapper for replace function.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_generic_getoptions">civicrm_api3_generic_getoptions()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>API wrapper for getoptions function.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_generic_getoptions_spec">_civicrm_api3_generic_getoptions_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Provide metadata for this generic action</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_generic_get_metadata_options">_civicrm_api3_generic_get_metadata_options()</a>
<span>
: mixed </span>
</dt>
<dd>Get metadata.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_group_create">civicrm_api3_group_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Create/update group.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_group_create_spec">_civicrm_api3_group_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_group_get">civicrm_api3_group_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Returns array of groups matching a set of one or more Group properties.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_group_delete">civicrm_api3_group_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete an existing Group.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_group_contact_get">civicrm_api3_group_contact_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Fetch a list of groups for a contact, or contacts for a group.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_group_contact_create_spec">_civicrm_api3_group_contact_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_group_contact_create">civicrm_api3_group_contact_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Add contact(s) to group(s).</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="-deprecated" href="namespaces/default.html#function_civicrm_api3_group_contact_delete">civicrm_api3_group_contact_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete group contact record.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_group_contact_delete_spec">_civicrm_api3_group_contact_delete_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust metadata.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="-deprecated" href="namespaces/default.html#function_civicrm_api3_group_contact_pending">civicrm_api3_group_contact_pending()</a>
<span>
: array<string|int, mixed>|int </span>
</dt>
<dd>Get pending group contacts.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_group_contact_common">_civicrm_api3_group_contact_common()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Group contact helper function.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="-deprecated" href="namespaces/default.html#function_civicrm_api3_group_contact_update_status">civicrm_api3_group_contact_update_status()</a>
<span>
: bool </span>
</dt>
<dd>Update group contact status.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="-deprecated" href="namespaces/default.html#function__civicrm_api3_group_contact_deprecation">_civicrm_api3_group_contact_deprecation()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Deprecated function notices.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_group_nesting_get">civicrm_api3_group_nesting_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Provides group nesting record(s) given parent and/or child id.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_group_nesting_create">civicrm_api3_group_nesting_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Creates group nesting record for given parent and child id.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_group_nesting_create_spec">_civicrm_api3_group_nesting_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_group_nesting_delete">civicrm_api3_group_nesting_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Removes specific nesting records.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_group_organization_get">civicrm_api3_group_organization_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get group organization record/s.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_group_organization_create">civicrm_api3_group_organization_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Create group organization record.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_group_organization_create_spec">_civicrm_api3_group_organization_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_group_organization_delete">civicrm_api3_group_organization_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Deletes an existing Group Organization.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_im_create">civicrm_api3_im_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Add an IM for a contact.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_im_create_spec">_civicrm_api3_im_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_im_delete">civicrm_api3_im_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Deletes an existing IM.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_im_get">civicrm_api3_im_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Retrieve one or more IM.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_job_create_spec">_civicrm_api3_job_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust metadata for "Create" action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_job_create">civicrm_api3_job_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Create scheduled job.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_job_clone_spec">_civicrm_api3_job_clone_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust metadata for clone spec action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_job_clone">civicrm_api3_job_clone()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Clone Job.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_job_get">civicrm_api3_job_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Retrieve one or more job.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_job_delete">civicrm_api3_job_delete()</a>
<span>
: mixed </span>
</dt>
<dd>Delete a job.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_job_execute">civicrm_api3_job_execute()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Dumb wrapper to execute scheduled jobs.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_job_execute_spec">_civicrm_api3_job_execute_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Execute action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_job_geocode">civicrm_api3_job_geocode()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Geocode group of contacts based on given params.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_job_geocode_spec">_civicrm_api3_job_geocode_spec()</a>
<span>
: mixed </span>
</dt>
<dd>First check on Code documentation.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_job_send_reminder">civicrm_api3_job_send_reminder()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Send the scheduled reminders as configured.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_job_send_reminder">_civicrm_api3_job_send_reminder()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust metadata for "send_reminder" action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_job_mail_report">civicrm_api3_job_mail_report()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Execute a specific report instance and send the output via email.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_job_update_greeting">civicrm_api3_job_update_greeting()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>This method allows to update Email Greetings, Postal Greetings and Addressee for a specific contact type.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_job_update_greeting_spec">_civicrm_api3_job_update_greeting_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Get action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_job_process_pledge">civicrm_api3_job_process_pledge()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Mass update pledge statuses.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_job_process_mailing">civicrm_api3_job_process_mailing()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Process mail queue.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_job_process_sms">civicrm_api3_job_process_sms()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Process sms queue.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_job_fetch_bounces">civicrm_api3_job_fetch_bounces()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Job to get mail responses from civiMailing.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_job_fetch_bounces_spec">_civicrm_api3_job_fetch_bounces_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Metadata for bounce function.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_job_fetch_activities">civicrm_api3_job_fetch_activities()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Job to get mail and create activities.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_job_process_participant">civicrm_api3_job_process_participant()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Process participant statuses.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_job_process_membership">civicrm_api3_job_process_membership()</a>
<span>
: bool </span>
</dt>
<dd>This api checks and updates the status of all membership records for a given domain.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_job_process_membership_spec">_civicrm_api3_job_process_membership_spec()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_job_process_respondent">civicrm_api3_job_process_respondent()</a>
<span>
: bool </span>
</dt>
<dd>This api checks and updates the status of all survey respondents.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_job_process_batch_merge">civicrm_api3_job_process_batch_merge()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Merges given pair of duplicate contacts.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_job_process_batch_merge_spec">_civicrm_api3_job_process_batch_merge_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Metadata for batch merge function.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_job_run_payment_cron">civicrm_api3_job_run_payment_cron()</a>
<span>
: mixed </span>
</dt>
<dd>Runs handlePaymentCron method in the specified payment processor.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_job_cleanup">civicrm_api3_job_cleanup()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>This api cleans up all the old session entries and temp tables.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_job_disable_expired_relationships">civicrm_api3_job_disable_expired_relationships()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Set expired relationships to disabled.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_job_group_rebuild">civicrm_api3_job_group_rebuild()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>This api reloads all the smart groups.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_job_group_cache_flush">civicrm_api3_job_group_cache_flush()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Flush smart groups caches.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_job_acl_cache_flush">civicrm_api3_job_acl_cache_flush()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Flush acl caches.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_job_version_check">civicrm_api3_job_version_check()</a>
<span>
: mixed </span>
</dt>
<dd>Check for CiviCRM software updates.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_job_log_get">civicrm_api3_job_log_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Retrieve one or more job log record.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_job_log_create">civicrm_api3_job_log_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Create one or more job log record.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_job_log_delete">civicrm_api3_job_log_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete one or more job log record.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_line_item_create">civicrm_api3_line_item_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Create or update a line_item.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_line_item_create_spec">_civicrm_api3_line_item_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_line_item_get">civicrm_api3_line_item_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Returns array of line_items matching a set of one or more group properties.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_line_item_delete">civicrm_api3_line_item_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete an existing LineItem.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_location_type_create">civicrm_api3_location_type_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Add a LocationType.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_location_type_create_spec">_civicrm_api3_location_type_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_location_type_delete">civicrm_api3_location_type_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Deletes an existing LocationType.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_location_type_get">civicrm_api3_location_type_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Retrieve one or more LocationTypes.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_loc_block_create">civicrm_api3_loc_block_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Create or update a LocBlock.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_loc_block_get">civicrm_api3_loc_block_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Returns array of loc_blocks matching a set of one or more properties.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_loc_block_delete">civicrm_api3_loc_block_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete an existing LocBlock.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_logging_revert">civicrm_api3_logging_revert()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Revert a log change.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_logging_revert_spec">_civicrm_api3_logging_revert_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Get a log change.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_logging_get">civicrm_api3_logging_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get a log change.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_logging_get_spec">_civicrm_api3_logging_get_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Get a log change.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_mailing_create">civicrm_api3_mailing_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Handle a create event.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_mailing_gettokens">civicrm_api3_mailing_gettokens()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get tokens for one or more entity type</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_mailing_gettokens_spec">_civicrm_api3_mailing_gettokens_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_mailing_create_spec">_civicrm_api3_mailing_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_mailing_clone_spec">_civicrm_api3_mailing_clone_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust metadata for clone spec action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_mailing_clone">civicrm_api3_mailing_clone()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Clone mailing.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_mailing_delete">civicrm_api3_mailing_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Handle a delete event.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_mailing_get">civicrm_api3_mailing_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Handle a get event.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_mailing_get_formatResult">_civicrm_api3_mailing_get_formatResult()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Format definition.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_mailing_submit_spec">_civicrm_api3_mailing_submit_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust metadata for mailing submit api function.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_mailing_submit">civicrm_api3_mailing_submit()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Mailing submit.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_mailing_event_bounce">civicrm_api3_mailing_event_bounce()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Process a bounce event by passing through to the BAOs.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_mailing_event_bounce_spec">_civicrm_api3_mailing_event_bounce_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for bounce_spec action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="-deprecated" href="namespaces/default.html#function_civicrm_api3_mailing_event_confirm">civicrm_api3_mailing_event_confirm()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Handle a confirm event.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="-deprecated" href="namespaces/default.html#function__civicrm_api3_mailing_deprecation">_civicrm_api3_mailing_deprecation()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Declare deprecated functions.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_mailing_event_reply">civicrm_api3_mailing_event_reply()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Handle a reply event.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_mailing_event_reply_spec">_civicrm_api3_mailing_event_reply_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for event_reply action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="-deprecated" href="namespaces/default.html#function_civicrm_api3_mailing_event_forward">civicrm_api3_mailing_event_forward()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Handle a forward event.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_mailing_event_forward_spec">_civicrm_api3_mailing_event_forward_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for event_forward action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_mailing_event_click">civicrm_api3_mailing_event_click()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Handle a click event.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_mailing_event_open">civicrm_api3_mailing_event_open()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Handle an open event.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_mailing_preview">civicrm_api3_mailing_preview()</a>
<span>
: mixed </span>
</dt>
<dd>Preview mailing.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_mailing_send_test_spec">_civicrm_api3_mailing_send_test_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust metadata for send test function.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_mailing_send_test">civicrm_api3_mailing_send_test()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Send test mailing.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_mailing_stats_spec">_civicrm_api3_mailing_stats_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for send_mail action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_mailing_stats">civicrm_api3_mailing_stats()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Function which needs to be explained.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_mailing_update_email_resetdate_spec">_civicrm_api3_mailing_update_email_resetdate_spec()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_mailing_update_email_resetdate">civicrm_api3_mailing_update_email_resetdate()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Fix the reset dates on the email record based on when a mail was last delivered.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_mailing_a_b_create_spec">_civicrm_api3_mailing_a_b_create_spec()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_mailing_a_b_create">civicrm_api3_mailing_a_b_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Handle a create mailing ab testing.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_mailing_a_b_delete">civicrm_api3_mailing_a_b_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Handle a delete event.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_mailing_a_b_get">civicrm_api3_mailing_a_b_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Handle a get event.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_mailing_a_b_submit_spec">_civicrm_api3_mailing_a_b_submit_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for submit action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_mailing_a_b_submit">civicrm_api3_mailing_a_b_submit()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Send A/B mail to A/B recipients respectively.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_mailing_a_b_fill_winner">_civicrm_api3_mailing_a_b_fill_winner()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_mailing_a_b_graph_stats_spec">_civicrm_api3_mailing_a_b_graph_stats_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for graph_stats action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_mailing_a_b_graph_stats">civicrm_api3_mailing_a_b_graph_stats()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Send graph detail for A/B tests mail.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_mailing_component_create">civicrm_api3_mailing_component_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Save a MailingComponent.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_mailing_component_create_spec">_civicrm_api3_mailing_component_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_mailing_component_get">civicrm_api3_mailing_component_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get a MailingComponent.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_mailing_component_get_spec">_civicrm_api3_mailing_component_get_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust metadata for get.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_mailing_component_delete">civicrm_api3_mailing_component_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete a MailingComponent.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_mailing_contact_get">civicrm_api3_mailing_contact_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get all the mailings and details that a contact was involved with.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_mailing_contact_getresults">_civicrm_api3_mailing_contact_getresults()</a>
<span>
: mixed </span>
</dt>
<dd>This is a wrapper for the functions that return the results from the 'quasi-entity' mailing contact.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_mailing_contact_get_spec">_civicrm_api3_mailing_contact_get_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Get action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_mailing_contact_query">_civicrm_api3_mailing_contact_query()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Helper function for mailing contact queries.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_mailing_contact_get_delivered">_civicrm_api3_mailing_contact_get_delivered()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get delivered mailing contacts.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_mailing_contact_get_bounced">_civicrm_api3_mailing_contact_get_bounced()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get bounced mailing contact records.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_mailing_contact_getcount">civicrm_api3_mailing_contact_getcount()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get count of all the mailings that a contact was involved with.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_mailing_event_confirm_get">civicrm_api3_mailing_event_confirm_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get mailing event confirm record.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_mailing_event_confirm_create">civicrm_api3_mailing_event_confirm_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Handle a confirm event.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_mailing_event_confirm_create_spec">_civicrm_api3_mailing_event_confirm_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_mailing_event_queue_create">civicrm_api3_mailing_event_queue_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Handle a queue event.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_mailing_event_queue_get">civicrm_api3_mailing_event_queue_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get mailing event queue record.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_mailing_event_queue_delete">civicrm_api3_mailing_event_queue_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete mailing event queue record.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_mailing_event_queue_create_spec">_civicrm_api3_mailing_event_queue_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_mailing_event_resubscribe_create">civicrm_api3_mailing_event_resubscribe_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Subscribe from mailing group.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_mailing_event_resubscribe_create_spec">_civicrm_api3_mailing_event_resubscribe_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_mailing_event_subscribe_get">civicrm_api3_mailing_event_subscribe_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get mailing event subscribe record.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_mailing_event_subscribe_create">civicrm_api3_mailing_event_subscribe_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Subscribe from mailing group.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_mailing_event_subscribe_create_spec">_civicrm_api3_mailing_event_subscribe_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_mailing_event_unsubscribe_get">civicrm_api3_mailing_event_unsubscribe_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get mailing event unsubscribe record.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_mailing_event_unsubscribe_create">civicrm_api3_mailing_event_unsubscribe_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Unsubscribe from mailing group.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_mailing_event_unsubscribe_create_spec">_civicrm_api3_mailing_event_unsubscribe_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="-deprecated" href="namespaces/default.html#function__civicrm_api3_mailing_group_deprecation">_civicrm_api3_mailing_group_deprecation()</a>
<span>
: string </span>
</dt>
<dd>Declare deprecated functions.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="-deprecated" href="namespaces/default.html#function_civicrm_api3_mailing_group_event_unsubscribe">civicrm_api3_mailing_group_event_unsubscribe()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Handle an unsubscribe event.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="-deprecated" href="namespaces/default.html#function_civicrm_api3_mailing_group_event_domain_unsubscribe">civicrm_api3_mailing_group_event_domain_unsubscribe()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Handle a site-level unsubscribe event.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="-deprecated" href="namespaces/default.html#function_civicrm_api3_mailing_group_event_resubscribe">civicrm_api3_mailing_group_event_resubscribe()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Handle a re-subscription event.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="-deprecated" href="namespaces/default.html#function_civicrm_api3_mailing_group_event_subscribe">civicrm_api3_mailing_group_event_subscribe()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Handle a subscription event.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_mailing_group_create">civicrm_api3_mailing_group_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Create mailing group.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_mailing_group_get">civicrm_api3_mailing_group_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get mailing group.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_mailing_group_delete">civicrm_api3_mailing_group_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete mailing group.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_mailing_job_create">civicrm_api3_mailing_job_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Handle creation of a MailingJob for a Mailing.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_mailing_job_create_spec">_civicrm_api3_mailing_job_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_mailing_job_get">civicrm_api3_mailing_job_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Returns array of Mailing Jobs matching a set of one or more group properties.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_mailing_job_delete">civicrm_api3_mailing_job_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Handle deletion of a Mailing Job for a Mailing.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_mailing_recipients_get">civicrm_api3_mailing_recipients_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Returns array of MailingRecipients.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_mail_settings_create">civicrm_api3_mail_settings_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Create or update a MailSettings.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_mail_settings_create_spec">_civicrm_api3_mail_settings_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_mail_settings_get">civicrm_api3_mail_settings_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Returns array of MailSettings matching a set of one or more properties.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_mail_settings_delete">civicrm_api3_mail_settings_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete an existing MailSettings.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_mapping_create">civicrm_api3_mapping_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Add a Mapping.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_mapping_create_spec">_civicrm_api3_mapping_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_mapping_delete">civicrm_api3_mapping_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Deletes an existing Mapping.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_mapping_get">civicrm_api3_mapping_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Retrieve one or more Mappings.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_mapping_field_create">civicrm_api3_mapping_field_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Add a Mapping Field.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_mapping_field_create_spec">_civicrm_api3_mapping_field_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_mapping_field_delete">civicrm_api3_mapping_field_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Deletes an existing Mapping Field.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_mapping_field_get">civicrm_api3_mapping_field_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Retrieve one or more Mapping Fields.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_membership_delete_spec">_civicrm_api3_membership_delete_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Delete action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_membership_delete">civicrm_api3_membership_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Deletes an existing contact Membership.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_membership_create">civicrm_api3_membership_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Create a Contact Membership.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_membership_create_spec">_civicrm_api3_membership_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_membership_get_spec">_civicrm_api3_membership_get_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Get action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_membership_get">civicrm_api3_membership_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get contact Membership record.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_membership_relationsship_get_customv2behaviour">_civicrm_api3_membership_relationsship_get_customv2behaviour()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Non-standard behaviour inherited from v2.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_membership_block_create">civicrm_api3_membership_block_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>API to Create or update a MembershipBlock.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_membership_block_create_spec">_civicrm_api3_membership_block_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_membership_block_get">civicrm_api3_membership_block_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get a Membership Block.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_membership_block_delete">civicrm_api3_membership_block_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Deletes an existing membership block.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_membership_log_create">civicrm_api3_membership_log_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>API to Create or update a MembershipLog.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_membership_log_create_spec">_civicrm_api3_membership_log_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_membership_log_get">civicrm_api3_membership_log_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get a Membership Log.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_membership_log_delete">civicrm_api3_membership_log_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Deletes an existing membership log.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_membership_payment_create">civicrm_api3_membership_payment_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Add or update a link between contribution and membership.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_membership_payment_create_spec">_civicrm_api3_membership_payment_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_membership_payment_get">civicrm_api3_membership_payment_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Retrieve one or more membership payment records.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_membership_status_create">civicrm_api3_membership_status_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Create a Membership Status.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_membership_status_create_spec">_civicrm_api3_membership_status_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_membership_status_get">civicrm_api3_membership_status_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get a membership status.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="-deprecated" href="namespaces/default.html#function_civicrm_api3_membership_status_update">civicrm_api3_membership_status_update()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Update an existing membership status.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_membership_status_delete">civicrm_api3_membership_status_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Deletes an existing membership status.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_membership_status_calc">civicrm_api3_membership_status_calc()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Derives the Membership Status of a given Membership Record.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_membership_status_calc_spec">_civicrm_api3_membership_status_calc_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Calc action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_membership_type_create">civicrm_api3_membership_type_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>API to Create or update a Membership Type.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_membership_type_create_spec">_civicrm_api3_membership_type_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_membership_type_get">civicrm_api3_membership_type_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get a Membership Type.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_membership_type_get_spec">_civicrm_api3_membership_type_get_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Get action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_membership_type_getlist_params">_civicrm_api3_membership_type_getlist_params()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust input for getlist action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_membership_type_delete">civicrm_api3_membership_type_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Deletes an existing membership type.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_message_template_create">civicrm_api3_message_template_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Create message template.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_message_template_create_spec">_civicrm_api3_message_template_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_message_template_delete">civicrm_api3_message_template_delete()</a>
<span>
: bool </span>
</dt>
<dd>Delete message template.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_message_template_get_spec">_civicrm_api3_message_template_get_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust metadata for message_template get action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_message_template_get">civicrm_api3_message_template_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Retrieve one or more message_template.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_message_template_send">civicrm_api3_message_template_send()</a>
<span>
: mixed </span>
</dt>
<dd>Sends a template.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_message_template_send_spec">_civicrm_api3_message_template_send_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_navigation_reset_spec">_civicrm_api3_navigation_reset_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust metadata for navigation reset action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_navigation_reset">civicrm_api3_navigation_reset()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Reset navigation.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_navigation_get_spec">_civicrm_api3_navigation_get_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust metadata for navigation get action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_navigation_get">civicrm_api3_navigation_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Reset navigation.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_navigation_create">civicrm_api3_navigation_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Create navigation item.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_navigation_create_spec">_civicrm_api3_navigation_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust metadata for navigation create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_navigation_delete">civicrm_api3_navigation_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete navigation item.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_note_create">civicrm_api3_note_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Create Note.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_note_create_spec">_civicrm_api3_note_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_note_delete">civicrm_api3_note_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Deletes an existing note.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_note_get">civicrm_api3_note_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Retrieve a specific note or notes, given a set of input params.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_note_get_spec">_civicrm_api3_note_get_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Get action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="-deprecated" href="namespaces/default.html#function_civicrm_api3_note_tree_get">civicrm_api3_note_tree_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get all descendants of given note.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_note_deprecation">_civicrm_api3_note_deprecation()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Declare deprecated api functions.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_open_i_d_create">civicrm_api3_open_i_d_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Add an OpenID for a contact.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_open_i_d_create_spec">_civicrm_api3_open_i_d_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_open_i_d_delete">civicrm_api3_open_i_d_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Deletes an existing OpenID.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_open_i_d_get">civicrm_api3_open_i_d_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Retrieve one or more OpenID.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_option_group_get">civicrm_api3_option_group_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get option groups.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_option_group_create">civicrm_api3_option_group_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Create/update option group.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_option_group_create_spec">_civicrm_api3_option_group_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_option_group_delete">civicrm_api3_option_group_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete an existing Option Group.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_option_value_get">civicrm_api3_option_value_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Retrieve one or more option values.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_option_value_get_spec">_civicrm_api3_option_value_get_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for get action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_option_value_create">civicrm_api3_option_value_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Add an OptionValue.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_option_value_create_spec">_civicrm_api3_option_value_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_option_value_delete">civicrm_api3_option_value_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Deletes an existing option value.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_order_get">civicrm_api3_order_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Retrieve a set of Order.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_order_get_spec">_civicrm_api3_order_get_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Get action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_order_create">civicrm_api3_order_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Add or update a Order.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_order_delete">civicrm_api3_order_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete a Order.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_order_cancel">civicrm_api3_order_cancel()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Cancel an Order.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_order_cancel_spec">_civicrm_api3_order_cancel_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Cancel action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_order_create_spec">_civicrm_api3_order_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_order_delete_spec">_civicrm_api3_order_delete_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Delete action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__order_create_wrangle_membership_params">_order_create_wrangle_membership_params()</a>
<span>
: mixed </span>
</dt>
<dd>Handle possibility of v3 style params.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_participant_create">civicrm_api3_participant_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Create an Event Participant.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_participant_createlineitem">_civicrm_api3_participant_createlineitem()</a>
<span>
: mixed </span>
</dt>
<dd>Create a default participant line item.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_participant_create_spec">_civicrm_api3_participant_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_participant_get">civicrm_api3_participant_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Retrieve a specific participant, given a set of input params.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_participant_get_spec">_civicrm_api3_participant_get_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Get action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_participant_delete">civicrm_api3_participant_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Deletes an existing contact participant.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_participant_payment_create">civicrm_api3_participant_payment_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Create a Event Participant Payment.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_participant_payment_create_spec">_civicrm_api3_participant_payment_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_participant_payment_delete">civicrm_api3_participant_payment_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Deletes an existing Participant Payment.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_participant_payment_get">civicrm_api3_participant_payment_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Retrieve one or more participant payment records.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_participant_status_type_create">civicrm_api3_participant_status_type_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Create/update participant_status.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_participant_status_type_get">civicrm_api3_participant_status_type_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Returns array of participant_statuses matching a set of one or more group properties.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_participant_status_type_delete">civicrm_api3_participant_status_type_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete an existing participant_status.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_payment_get">civicrm_api3_payment_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Retrieve a set of financial transactions which are payments.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_payment_delete">civicrm_api3_payment_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete a payment.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_payment_cancel">civicrm_api3_payment_cancel()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Cancel/Refund a payment for a Contribution.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_payment_create">civicrm_api3_payment_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Add a payment for a Contribution.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_payment_create_spec">_civicrm_api3_payment_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_payment_get_spec">_civicrm_api3_payment_get_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Get action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_payment_delete_spec">_civicrm_api3_payment_delete_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Delete action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_payment_cancel_spec">_civicrm_api3_payment_cancel_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Cancel action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_payment_sendconfirmation">civicrm_api3_payment_sendconfirmation()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Send a payment confirmation.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_payment_sendconfirmation_spec">_civicrm_api3_payment_sendconfirmation_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for sendconfirmation action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_payment_processor_create">civicrm_api3_payment_processor_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Add/Update a PaymentProcessor.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_payment_processor_create_spec">_civicrm_api3_payment_processor_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_payment_processor_delete">civicrm_api3_payment_processor_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Deletes an existing PaymentProcessor.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_payment_processor_get">civicrm_api3_payment_processor_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Retrieve one or more PaymentProcessor.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_payment_processor_getlist_defaults">_civicrm_api3_payment_processor_getlist_defaults()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Set default getlist parameters.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_payment_processor_pay">civicrm_api3_payment_processor_pay()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Action payment.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_payment_processor_pay_spec">_civicrm_api3_payment_processor_pay_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Action payment.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_payment_processor_refund">civicrm_api3_payment_processor_refund()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Action refund.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_payment_processor_refund_spec">_civicrm_api3_payment_processor_refund_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Action Refund.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_payment_processor_type_create">civicrm_api3_payment_processor_type_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Create payment_processor type.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_payment_processor_type_create_spec">_civicrm_api3_payment_processor_type_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_payment_processor_type_get">civicrm_api3_payment_processor_type_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get all payment_processor types.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_payment_processor_type_delete">civicrm_api3_payment_processor_type_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete a payment_processor type delete.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_payment_token_create">civicrm_api3_payment_token_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Create/update Payment Token.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_payment_token_create_spec">_civicrm_api3_payment_token_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_payment_token_get">civicrm_api3_payment_token_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Returns array of campaigns matching a set of one or more properties.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_payment_token_delete">civicrm_api3_payment_token_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete an existing payment token.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_pcp_create">civicrm_api3_pcp_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Create or update a survey.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_pcp_create_spec">_civicrm_api3_pcp_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_pcp_get">civicrm_api3_pcp_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Returns array of pcps matching a set of one or more properties.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_pcp_delete">civicrm_api3_pcp_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete an existing PCP.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_phone_get">civicrm_api3_phone_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Retrieve one or more phones.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_phone_create">civicrm_api3_phone_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Add an Phone for a contact.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_phone_create_spec">_civicrm_api3_phone_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_phone_delete">civicrm_api3_phone_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete an existing Phone.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_pledge_create">civicrm_api3_pledge_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Create or updates an Pledge.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_pledge_delete">civicrm_api3_pledge_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete a pledge.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_pledge_delete_spec">_civicrm_api3_pledge_delete_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust metadata for pledge delete action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_pledge_get_spec">_civicrm_api3_pledge_get_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust field specification specific to get requests.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_pledge_create_spec">_civicrm_api3_pledge_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust field specification specific to get requests.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_pledge_get">civicrm_api3_pledge_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Retrieve a set of pledges, given a set of input params.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_pledge_get_defaults">_civicrm_api3_pledge_get_defaults()</a>
<span>
: mixed </span>
</dt>
<dd>Set default to not return test params.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_pledge_format_params">_civicrm_api3_pledge_format_params()</a>
<span>
: mixed </span>
</dt>
<dd>Legacy function to format pledge parameters.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_pledge_payment_create">civicrm_api3_pledge_payment_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Add or update a pledge payment.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_pledge_payment_create_spec">_civicrm_api3_pledge_payment_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_pledge_payment_delete">civicrm_api3_pledge_payment_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete a pledge Payment - Note this deletes the contribution not just the
link.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_pledge_payment_get">civicrm_api3_pledge_payment_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Retrieve a set of pledges, given a set of input params.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_premium_create">civicrm_api3_premium_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Save a premium.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_premium_get">civicrm_api3_premium_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get a premium.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_premium_delete">civicrm_api3_premium_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete a premium.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_premium_get_spec">_civicrm_api3_premium_get_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Return field specification specific to get requests.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_premium_create_spec">_civicrm_api3_premium_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Return field specification specific to create requests.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_price_field_create">civicrm_api3_price_field_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Create or update a price_field.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_price_field_create_spec">_civicrm_api3_price_field_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_price_field_get">civicrm_api3_price_field_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Returns array of price_fields matching a set of one or more group properties.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_price_field_delete">civicrm_api3_price_field_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete an existing price_field.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_price_field_value_create">civicrm_api3_price_field_value_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Create or update a PriceFieldValue.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_price_field_value_create_spec">_civicrm_api3_price_field_value_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_price_field_value_get">civicrm_api3_price_field_value_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Returns array of PriceFieldValues matching a set of one or more group properties.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_price_field_value_delete">civicrm_api3_price_field_value_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete an existing PriceFieldValue.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_price_set_create">civicrm_api3_price_set_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Create or update a PriceSet.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_price_set_create_spec">_civicrm_api3_price_set_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_price_set_get">civicrm_api3_price_set_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Returns array of price_sets matching a set of one or more group properties.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_price_set_delete">civicrm_api3_price_set_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete an existing PriceSet.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_print_label_create">civicrm_api3_print_label_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Save a PrintLabel.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_print_label_create_spec">_civicrm_api3_print_label_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust metadata for navigation create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_print_label_get">civicrm_api3_print_label_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get a PrintLabel.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_print_label_delete">civicrm_api3_print_label_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete a PrintLabel.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_product_create">civicrm_api3_product_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Save a product.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_product_create_spec">_civicrm_api3_product_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_product_get">civicrm_api3_product_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get a product.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_product_delete">civicrm_api3_product_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete a product.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_profile_get">civicrm_api3_profile_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Retrieve Profile field values.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_profile_get_spec">_civicrm_api3_profile_get_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust profile get function metadata.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_profile_submit">civicrm_api3_profile_submit()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Submit a set of fields against a profile.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_profile_translate_fieldnames_for_bao">_civicrm_api3_profile_translate_fieldnames_for_bao()</a>
<span>
: string </span>
</dt>
<dd>Translate field names for BAO.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_profile_submit_spec">_civicrm_api3_profile_submit_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Metadata for submit action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="-deprecated" href="namespaces/default.html#function_civicrm_api3_profile_set">civicrm_api3_profile_set()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Update Profile field values.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="-deprecated" href="namespaces/default.html#function_civicrm_api3_profile_apply">civicrm_api3_profile_apply()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Apply profile.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_profile_apply_spec">_civicrm_api3_profile_apply_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Apply action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_profile_getbillingpseudoprofile">_civicrm_api3_profile_getbillingpseudoprofile()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get pseudo profile 'billing'.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_buildprofile_submitfields">_civicrm_api3_buildprofile_submitfields()</a>
<span>
: array<string|int, mixed>|void </span>
</dt>
<dd>Here we will build up getfields type data for all the fields in the profile.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_order_by_weight">_civicrm_api3_order_by_weight()</a>
<span>
: bool </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_map_profile_fields_to_entity">_civicrm_api3_map_profile_fields_to_entity()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Here we map the profile fields as stored in the uf_field table to their 'real entity'
we also return the profile fieldname</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_profile_getProfileID">_civicrm_api3_profile_getProfileID()</a>
<span>
: int|string </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_profile_appendaliases">_civicrm_api3_profile_appendaliases()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>helper function to add all aliases as keys to getfields response so we can look for keys within it
since the relationship between profile fields & api / metadata based fields is a bit inconsistent</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="-deprecated" href="namespaces/default.html#function__civicrm_api3_profile_deprecation">_civicrm_api3_profile_deprecation()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_recurring_entity_get">civicrm_api3_recurring_entity_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Retrieve a recurring entity.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_recurring_entity_get_spec">_civicrm_api3_recurring_entity_get_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Get action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_recurring_entity_create">civicrm_api3_recurring_entity_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Add or update a recurring entity.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_recurring_entity_create_spec">_civicrm_api3_recurring_entity_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_recurring_entity_delete">civicrm_api3_recurring_entity_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Deletes an existing ReportInstance.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_relationship_create">civicrm_api3_relationship_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Add or update a relationship.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_relationship_create_spec">_civicrm_api3_relationship_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_relationship_delete">civicrm_api3_relationship_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete a relationship.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_relationship_get">civicrm_api3_relationship_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get one or more relationship/s.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_handle_relationship_type">_civicrm_api3_handle_relationship_type()</a>
<span>
: mixed </span>
</dt>
<dd>Legacy handling for relationship_type parameter.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_relationship_setvalue">civicrm_api3_relationship_setvalue()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Hack to ensure inherited membership got created/deleted on
relationship add/delete respectively.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_relationship_getoptions_spec">_civicrm_api3_relationship_getoptions_spec()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_relationship_type_create">civicrm_api3_relationship_type_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Create relationship type.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_relationship_type_create_spec">_civicrm_api3_relationship_type_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_relationship_type_get">civicrm_api3_relationship_type_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get all relationship types.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_relationship_type_delete">civicrm_api3_relationship_type_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete a relationship type.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_relationship_type_getlist_defaults">_civicrm_api3_relationship_type_getlist_defaults()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get list defaults for relationship types.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_report_instance_get">civicrm_api3_report_instance_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Retrieve a report instance.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_report_instance_create">civicrm_api3_report_instance_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Add or update a report instance.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_report_instance_create_spec">_civicrm_api3_report_instance_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_report_instance_delete">civicrm_api3_report_instance_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Deletes an existing ReportInstance.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_report_template_get">civicrm_api3_report_template_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Retrieve a report template.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_report_template_create">civicrm_api3_report_template_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Add a Report Template.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_report_template_create_spec">_civicrm_api3_report_template_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_report_template_delete">civicrm_api3_report_template_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Deletes an existing ReportTemplate.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_report_template_getrows">civicrm_api3_report_template_getrows()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Retrieve rows from a report template.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_report_template_getrows">_civicrm_api3_report_template_getrows()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get report template rows.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_report_template_getstatistics">civicrm_api3_report_template_getstatistics()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get statistics from a given report.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_report_template_getrows_spec">_civicrm_api3_report_template_getrows_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust metadata for template getrows action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_rule_create">civicrm_api3_rule_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Create or update a rule.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_rule_create_spec">_civicrm_api3_rule_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Specify Meta data for create.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_rule_delete">civicrm_api3_rule_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete an existing Rule.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_rule_get">civicrm_api3_rule_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get a Rule.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_rule_group_create">civicrm_api3_rule_group_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Create or update a rule_group.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_rule_group_create_spec">_civicrm_api3_rule_group_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Specify Meta data for create.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_rule_group_delete">civicrm_api3_rule_group_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete an existing RuleGroup.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_rule_group_get">civicrm_api3_rule_group_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get a RuleGroup.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_saved_search_create">civicrm_api3_saved_search_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Create or update a saved search.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_saved_search_create_spec">_civicrm_api3_saved_search_create_spec()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_saved_search_delete">civicrm_api3_saved_search_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete an existing saved search.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_saved_search_get">civicrm_api3_saved_search_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Retrieve one or more saved search(es).</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_saved_search_result_cleanup">_civicrm_api3_saved_search_result_cleanup()</a>
<span>
: mixed </span>
</dt>
<dd>Unserialize the form_values field in SavedSearch API results.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_setting_getfields">civicrm_api3_setting_getfields()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get fields for setting api calls.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_setting_getfields_spec">_civicrm_api3_setting_getfields_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Alter metadata for getfields functions.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_setting_getdefaults">civicrm_api3_setting_getdefaults()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Return default values for settings.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_setting_getdefaults_spec">_civicrm_api3_setting_getdefaults_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Metadata for Setting create function.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_setting_getoptions">civicrm_api3_setting_getoptions()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get options for settings.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_setting_revert">civicrm_api3_setting_revert()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Revert settings to defaults.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_setting_revert_spec">_civicrm_api3_setting_revert_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Alter metadata for getfields functions.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="-deprecated" href="namespaces/default.html#function_civicrm_api3_setting_fill">civicrm_api3_setting_fill()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Revert settings to defaults.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_setting_fill_spec">_civicrm_api3_setting_fill_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Alter metadata for getfields functions.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_setting_deprecation">_civicrm_api3_setting_deprecation()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Declare deprecated api functions.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_setting_create">civicrm_api3_setting_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Create or update a setting.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_setting_create_spec">_civicrm_api3_setting_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Metadata for setting create function.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_setting_get">civicrm_api3_setting_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Returns array of settings matching input parameters.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_setting_get_spec">_civicrm_api3_setting_get_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Metadata for setting create function.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_setting_getvalue">civicrm_api3_setting_getvalue()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Returns value for specific parameter.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_setting_getvalue_spec">_civicrm_api3_setting_getvalue_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Metadata for setting create function.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_setting_getDomainArray">_civicrm_api3_setting_getDomainArray()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Converts domain input into an array.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_sms_provider_create">civicrm_api3_sms_provider_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Save an sms_provider.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_sms_provider_create_spec">_civicrm_api3_sms_provider_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_sms_provider_get">civicrm_api3_sms_provider_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get an sms_provider.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_sms_provider_delete">civicrm_api3_sms_provider_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete an sms_provider.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_state_province_create">civicrm_api3_state_province_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Add a state/province.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_state_province_create_spec">_civicrm_api3_state_province_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_state_province_delete">civicrm_api3_state_province_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Deletes an existing state/province.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_state_province_get">civicrm_api3_state_province_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Retrieve one or more states/provinces.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_status_preference_create">civicrm_api3_status_preference_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Save a Status Preference.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_status_preference_get">civicrm_api3_status_preference_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get an Acl.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_status_preference_delete">civicrm_api3_status_preference_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete an Acl.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_status_preference_create_spec">_civicrm_api3_status_preference_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_survey_create">civicrm_api3_survey_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Create or update a survey.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_survey_create_spec">_civicrm_api3_survey_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_survey_get">civicrm_api3_survey_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Returns array of surveys matching a set of one or more group properties.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_survey_delete">civicrm_api3_survey_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete an existing survey.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_survey_getlist_defaults">_civicrm_api3_survey_getlist_defaults()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Set default getlist parameters.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="-deprecated" href="namespaces/default.html#function__civicrm_api3_survey_respondant_deprecation">_civicrm_api3_survey_respondant_deprecation()</a>
<span>
: string </span>
</dt>
<dd>Notify caller of deprecated function.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="-deprecated" href="namespaces/default.html#function_civicrm_api3_survey_respondant_get">civicrm_api3_survey_respondant_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get the list of signatories.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="-deprecated" href="namespaces/default.html#function_civicrm_api3_survey_respondant_count">civicrm_api3_survey_respondant_count()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Count survey respondents.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_system_flush">civicrm_api3_system_flush()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Flush all system caches.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_system_flush_spec">_civicrm_api3_system_flush_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Flush action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_system_check_spec">_civicrm_api3_system_check_spec()</a>
<span>
: mixed </span>
</dt>
<dd>System.Check API specification (optional).</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_system_check">civicrm_api3_system_check()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>System Check API.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_system_log">civicrm_api3_system_log()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Log entry to system log table.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_system_log_spec">_civicrm_api3_system_log_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Metadata for log function.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_system_get">civicrm_api3_system_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>System.Get API.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_system_get_redacted_ini">_civicrm_api3_system_get_redacted_ini()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Generate a sanitized/anonymized/redacted dump of the PHP configuration.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_system_get_redacted_mysql">_civicrm_api3_system_get_redacted_mysql()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Generate ae sanitized/anonymized/redacted dump of MySQL configuration.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_system_get_redacted_settings">_civicrm_api3_system_get_redacted_settings()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get redacted settings.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_system_get_whitelist">_civicrm_api3_system_get_whitelist()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Read a whitelist.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_system_updatelogtables">civicrm_api3_system_updatelogtables()</a>
<span>
: mixed </span>
</dt>
<dd>Update log table structures.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_system_utf8conversion">civicrm_api3_system_utf8conversion()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Update log table structures.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_system_utf8conversion_spec">_civicrm_api3_system_utf8conversion_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Metadata for conversion function.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_system_updatelogtables_spec">_civicrm_api3_system_updatelogtables_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Flush action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_system_updateindexes">civicrm_api3_system_updateindexes()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Update indexes.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_system_updateindexes_spec">_civicrm_api3_system_updateindexes_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Declare metadata for api System.getmissingindices</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_system_getmissingindices">civicrm_api3_system_getmissingindices()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get an array of indices that should be defined but are not.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_system_getmissingindices_spec">_civicrm_api3_system_getmissingindices_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Declare metadata for api System.getmissingindices</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_system_createmissinglogtables">civicrm_api3_system_createmissinglogtables()</a>
<span>
: mixed </span>
</dt>
<dd>Creates missing log tables.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_system_rebuildmultilingualschema">civicrm_api3_system_rebuildmultilingualschema()</a>
<span>
: mixed </span>
</dt>
<dd>Rebuild Multilingual Schema</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_system_log_delete">civicrm_api3_system_log_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete system log record.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_system_log_create">civicrm_api3_system_log_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Create system log record.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_system_log_create_spec">_civicrm_api3_system_log_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust system log create metadata.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_system_log_get">civicrm_api3_system_log_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get system log record.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_tag_create">civicrm_api3_tag_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Create or update a tag.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_tag_create_spec">_civicrm_api3_tag_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Specify Meta data for create.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_tag_delete">civicrm_api3_tag_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete an existing Tag.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_tag_get">civicrm_api3_tag_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get a Tag.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_uf_field_create">civicrm_api3_uf_field_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Defines 'uf field' within a group.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_uf_field_create_spec">_civicrm_api3_uf_field_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust metadata for civicrm_uf_field create.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_uf_field_get">civicrm_api3_uf_field_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Returns array of uf groups (profiles) matching a set of one or more group properties.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_uf_field_delete">civicrm_api3_uf_field_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete uf field.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_uf_field_delete_spec">_civicrm_api3_uf_field_delete_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Field id accepted for backward compatibility - unset required on id.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_uf_group_create_spec">_civicrm_api3_uf_group_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust metadata for create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_uf_group_create">civicrm_api3_uf_group_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Use this API to create a new group.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_uf_group_get">civicrm_api3_uf_group_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Returns array of uf groups (profiles) matching a set of one or more group properties.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_uf_group_delete">civicrm_api3_uf_group_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete uf group.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_uf_group_getlist_defaults">_civicrm_api3_uf_group_getlist_defaults()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Set default getlist parameters.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_uf_group_getlist_output">_civicrm_api3_uf_group_getlist_output()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Format getlist output</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_uf_join_create">civicrm_api3_uf_join_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Takes an associative array and creates a uf join in the database.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_uf_join_create_spec">_civicrm_api3_uf_join_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_uf_join_get">civicrm_api3_uf_join_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get CiviCRM UF_Joins (ie joins between CMS user records & CiviCRM user record.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_uf_join_delete">civicrm_api3_uf_join_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete a CiviCRM UF_Join.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_uf_match_get">civicrm_api3_uf_match_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get the contact_id given a uf_id or vice versa.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_uf_match_create">civicrm_api3_uf_match_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Create or update a UF Match record.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_uf_match_create_spec">_civicrm_api3_uf_match_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_uf_match_delete">civicrm_api3_uf_match_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete a UF Match record.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_user_get">civicrm_api3_user_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get details about the CMS User entity.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_user_get_spec">_civicrm_api3_user_get_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Get action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_initialize">_civicrm_api3_initialize()</a>
<span>
: mixed </span>
</dt>
<dd>Initialize CiviCRM - should be run at the start of each API function.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_verify_one_mandatory">civicrm_api3_verify_one_mandatory()</a>
<span>
: mixed </span>
</dt>
<dd>Wrapper Function for civicrm_verify_mandatory to make it simple to pass either / or fields for checking.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_verify_mandatory">civicrm_api3_verify_mandatory()</a>
<span>
: mixed </span>
</dt>
<dd>Check mandatory fields are included.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_create_error">civicrm_api3_create_error()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Create error array.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_create_success">civicrm_api3_create_success()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Format array in result output style.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_load_DAO">_civicrm_api3_load_DAO()</a>
<span>
: bool </span>
</dt>
<dd>Load the DAO of the entity.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_get_DAO">_civicrm_api3_get_DAO()</a>
<span>
: <a href="classes/CRM-Core-DAO.html"><abbr title="\CRM_Core_DAO">CRM_Core_DAO</abbr></a>|string </span>
</dt>
<dd>Return the DAO of the function or Entity.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_get_BAO">_civicrm_api3_get_BAO()</a>
<span>
: string|null </span>
</dt>
<dd>Return the BAO name of the function or Entity.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_separate_values">_civicrm_api3_separate_values()</a>
<span>
: mixed </span>
</dt>
<dd>Recursive function to explode value-separated strings into arrays.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_filter_fields_for_bao">_civicrm_api3_filter_fields_for_bao()</a>
<span>
: mixed </span>
</dt>
<dd>This is a legacy wrapper for api_store_values.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_store_values">_civicrm_api3_store_values()</a>
<span>
: bool </span>
</dt>
<dd>Copy values (other than id) from params to values if they exist in fields.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_get_using_query_object">_civicrm_api3_get_using_query_object()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get function for query object api.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_get_query_object">_civicrm_api3_get_query_object()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get dao query object based on input params.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="-deprecated" href="namespaces/default.html#function__civicrm_api3_dao_set_filter">_civicrm_api3_dao_set_filter()</a>
<span>
: mixed </span>
</dt>
<dd>Function transfers the filters being passed into the DAO onto the params object.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_apply_filters_to_dao">_civicrm_api3_apply_filters_to_dao()</a>
<span>
: mixed </span>
</dt>
<dd>Apply filters (e.g. high, low) to DAO object (prior to find).</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_get_options_from_params">_civicrm_api3_get_options_from_params()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get sort, limit etc options from the params - supporting old & new formats.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_apply_options_to_dao">_civicrm_api3_apply_options_to_dao()</a>
<span>
: mixed </span>
</dt>
<dd>Apply options (e.g. sort, limit, order by) to DAO object (prior to find).</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_build_fields_array">_civicrm_api3_build_fields_array()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Build fields array.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_get_unique_name_array">_civicrm_api3_get_unique_name_array()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Build fields array.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="-deprecated" href="namespaces/default.html#function__civicrm_api3_dao_to_array">_civicrm_api3_dao_to_array()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Converts an DAO object to an array.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_custom_fields_are_required">_civicrm_api3_custom_fields_are_required()</a>
<span>
: bool </span>
</dt>
<dd>Determine if custom fields need to be retrieved.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_object_to_array">_civicrm_api3_object_to_array()</a>
<span>
: mixed </span>
</dt>
<dd>Converts an object to an array.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_object_to_array_unique_fields">_civicrm_api3_object_to_array_unique_fields()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Wrapper for _civicrm_object_to_array when api supports unique fields.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_custom_format_params">_civicrm_api3_custom_format_params()</a>
<span>
: mixed </span>
</dt>
<dd>Format custom parameters.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_format_params_for_create">_civicrm_api3_format_params_for_create()</a>
<span>
: mixed </span>
</dt>
<dd>Format parameters for create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_formatCheckBoxField">formatCheckBoxField()</a>
<span>
: mixed </span>
</dt>
<dd>We can't rely on downstream to add separators to checkboxes so we'll check here.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_basic_get">_civicrm_api3_basic_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Function to do a 'standard' api get - when the api is only doing a $bao->find then use this.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_basic_create">_civicrm_api3_basic_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Function to do a 'standard' api create - when the api is only doing a $bao::create then use this.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_basic_create_fallback">_civicrm_api3_basic_create_fallback()</a>
<span>
: <a href="classes/CRM-Core-DAO.html"><abbr title="\CRM_Core_DAO">CRM_Core_DAO</abbr></a>|null </span>
</dt>
<dd>For BAO's which don't have a create() or add() functions, use this fallback implementation.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_basic_delete">_civicrm_api3_basic_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Function to do a 'standard' api del.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_custom_data_get">_civicrm_api3_custom_data_get()</a>
<span>
: mixed </span>
</dt>
<dd>Get custom data for the given entity & Add it to the returnArray.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_validate">_civicrm_api3_validate()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Used by the Validate API.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_validate_switch_cases">_civicrm_api3_validate_switch_cases()</a>
<span>
: mixed </span>
</dt>
<dd>Used by the Validate API.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_validate_fields">_civicrm_api3_validate_fields()</a>
<span>
: mixed </span>
</dt>
<dd>Validate fields being passed into API.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_validate_foreign_keys">_civicrm_api3_validate_foreign_keys()</a>
<span>
: mixed </span>
</dt>
<dd>Validate foreign key values of fields being passed into API.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_validate_date">_civicrm_api3_validate_date()</a>
<span>
: mixed </span>
</dt>
<dd>Validate date fields being passed into API.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_getValidDate">_civicrm_api3_getValidDate()</a>
<span>
: mixed </span>
</dt>
<dd>Convert date into BAO friendly date.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_validate_constraint">_civicrm_api3_validate_constraint()</a>
<span>
: mixed </span>
</dt>
<dd>Validate foreign constraint fields being passed into API.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_validate_unique_key">_civicrm_api3_validate_unique_key()</a>
<span>
: mixed </span>
</dt>
<dd>Validate foreign constraint fields being passed into API.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_generic_replace">_civicrm_api3_generic_replace()</a>
<span>
: array<string|int, mixed>|int </span>
</dt>
<dd>Generic implementation of the "replace" action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_generic_replace_base_params">_civicrm_api3_generic_replace_base_params()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Replace base parameters.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api_get_fields">_civicrm_api_get_fields()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Returns fields allowable by api.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api_get_custom_fields">_civicrm_api_get_custom_fields()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Return an array of fields for a given entity.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_swap_out_aliases">_civicrm_api3_swap_out_aliases()</a>
<span>
: mixed </span>
</dt>
<dd>Fill params array with alternate (alias) values where a field has an alias and that is filled & the main field isn't.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_validate_integer">_civicrm_api3_validate_integer()</a>
<span>
: mixed </span>
</dt>
<dd>Validate integer fields being passed into API.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_resolve_country_id">_civicrm_api3_resolve_country_id()</a>
<span>
: int|null </span>
</dt>
<dd>Helper function to determine country_id given the myriad of values for country_id or country that are supported</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_resolve_contactID">_civicrm_api3_resolve_contactID()</a>
<span>
: int|null|"unknown-user" </span>
</dt>
<dd>Determine a contact ID using a string expression.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_validate_html">_civicrm_api3_validate_html()</a>
<span>
: mixed </span>
</dt>
<dd>Validate html (check for scripting attack).</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_validate_string">_civicrm_api3_validate_string()</a>
<span>
: mixed </span>
</dt>
<dd>Validate string fields being passed into API.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_api_match_pseudoconstant">_civicrm_api3_api_match_pseudoconstant()</a>
<span>
: mixed </span>
</dt>
<dd>Validate & swap out any pseudoconstants / options.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_api_match_pseudoconstant_value">_civicrm_api3_api_match_pseudoconstant_value()</a>
<span>
: mixed </span>
</dt>
<dd>Validate & swap a single option value for a field.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_api_resolve_alias">_civicrm_api3_api_resolve_alias()</a>
<span>
: bool|string </span>
</dt>
<dd>Returns the canonical name of a field.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_deprecation_check">_civicrm_api3_deprecation_check()</a>
<span>
: string|array<string|int, mixed>|null </span>
</dt>
<dd>Check if the function is deprecated.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_field_value_check">_civicrm_api3_field_value_check()</a>
<span>
: mixed </span>
</dt>
<dd>Get the actual field value.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_basic_array_get">_civicrm_api3_basic_array_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>A generic "get" API based on simple array data. This is comparable to
_civicrm_api3_basic_get but does not use DAO/BAO. This is useful for
small/mid-size data loaded from external JSON or XML documents.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_check_edit_permissions">_civicrm_api3_check_edit_permissions()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_compare_timestamps">_civicrm_api3_compare_timestamps()</a>
<span>
: bool </span>
</dt>
<dd>Check if an entity has been modified since the last known modified_date</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_website_create">civicrm_api3_website_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Add an Website for a contact.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_website_create_spec">_civicrm_api3_website_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_website_delete">civicrm_api3_website_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Deletes an existing Website.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_website_get">civicrm_api3_website_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Retrieve one or more websites.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_word_replacement_get">civicrm_api3_word_replacement_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get CiviCRM Word Replacement details.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_word_replacement_create">civicrm_api3_word_replacement_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Create a new Word Replacement.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_word_replacement_create_spec">_civicrm_api3_word_replacement_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_word_replacement_delete">civicrm_api3_word_replacement_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Delete an existing WordReplacement.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_run">run()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_run">run()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_run">run()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_run">run()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_run">run()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_permissions">_civicrm_api3_permissions()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Decide what permissions to check for an api call</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_smarty_block_crmButton">smarty_block_crmButton()</a>
<span>
: string|null </span>
</dt>
<dd>Generate the html for a button-style link</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_smarty_block_crmPermission">smarty_block_crmPermission()</a>
<span>
: string </span>
</dt>
<dd>Show block conditionally, based on the permission</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_smarty_block_crmRegion">smarty_block_crmRegion()</a>
<span>
: string </span>
</dt>
<dd>Smarty block function for defining content-regions which can be dynamically-altered</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_smarty_block_crmScope">smarty_block_crmScope()</a>
<span>
: string </span>
</dt>
<dd>Smarty block function to temporarily define variables.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_smarty_block_crmUpgradeSnapshot">smarty_block_crmUpgradeSnapshot()</a>
<span>
: string|null </span>
</dt>
<dd>Generate a pre-upgrade data-snapshot -- if the local policy supports them.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_smarty_block_edit">smarty_block_edit()</a>
<span>
: string|null </span>
</dt>
<dd>Smarty block function providing edit-only display support</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_smarty_block_htxt">smarty_block_htxt()</a>
<span>
: string|null </span>
</dt>
<dd>Smarty block function providing support for
CiviCRM's helptext mechanism</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_smarty_block_icon">smarty_block_icon()</a>
<span>
: string|null </span>
</dt>
<dd>Display an icon with some alternative text.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_smarty_block_localize">smarty_block_localize()</a>
<span>
: string </span>
</dt>
<dd>Smarty block function for multilingualizing upgrade SQL queries.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_smarty_block_ts">smarty_block_ts()</a>
<span>
: string|null </span>
</dt>
<dd>Smarty block function providing gettext support</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_smarty_block_url">smarty_block_url()</a>
<span>
: string </span>
</dt>
<dd>Generate a URL. This is thin wrapper for the Civi::url() helper.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_smarty_compiler_continue">smarty_compiler_continue()</a>
<span>
: string </span>
</dt>
<dd>Skip remaining logic in the current iteration of a loop.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_smarty_function_copyIcon">smarty_function_copyIcon()</a>
<span>
: string </span>
</dt>
<dd>Display a copy icon that copies the first row's values down.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_smarty_function_crmAPI">smarty_function_crmAPI()</a>
<span>
: string|void </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_smarty_function_crmAttributes">smarty_function_crmAttributes()</a>
<span>
: string </span>
</dt>
<dd>Formats an array of attributes as html</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_smarty_function_crmCrudLink">smarty_function_crmCrudLink()</a>
<span>
: string </span>
</dt>
<dd>Dynamically construct a link based on an entity-type and entity-id.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_smarty_function_crmGetAttribute">smarty_function_crmGetAttribute()</a>
<span>
: string </span>
</dt>
<dd>Fetch an attribute from html</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_smarty_function_crmKey">smarty_function_crmKey()</a>
<span>
: string </span>
</dt>
<dd>Generate a CRM_Core_Key of a given name</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_smarty_function_crmResPath">smarty_function_crmResPath()</a>
<span>
: string </span>
</dt>
<dd>Determine the path of a resource file</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_smarty_function_crmResURL">smarty_function_crmResURL()</a>
<span>
: string </span>
</dt>
<dd>Determine the URL of a resource file</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_smarty_function_crmScript">smarty_function_crmScript()</a>
<span>
: mixed </span>
</dt>
<dd>Add a Javascript file to a specific part of the page</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_smarty_function_crmSetting">smarty_function_crmSetting()</a>
<span>
: int|string|null </span>
</dt>
<dd>Retrieve CiviCRM settings from the api for use in templates.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_smarty_function_crmSigner">smarty_function_crmSigner()</a>
<span>
: mixed </span>
</dt>
<dd>Generate a secure signature</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_smarty_function_crmStyle">smarty_function_crmStyle()</a>
<span>
: mixed </span>
</dt>
<dd>Add a stylesheet <LINK> to a specific part of the page</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_smarty_function_crmURL">smarty_function_crmURL()</a>
<span>
: string </span>
</dt>
<dd>Generate a URL.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_smarty_function_crmVersion">smarty_function_crmVersion()</a>
<span>
: string </span>
</dt>
<dd>Display the CiviCRM version</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_smarty_function_docURL">smarty_function_docURL()</a>
<span>
: string|null </span>
</dt>
<dd>Given one of: ( page, title, text ) parameters, generates
an HTML link to documentation.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_smarty_function_help">smarty_function_help()</a>
<span>
: string </span>
</dt>
<dd>Adds inline help.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_smarty_function_isValueChange">smarty_function_isValueChange()</a>
<span>
: null </span>
</dt>
<dd>Smarty function for checking change in a property's value, for example
when looping through an array.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_smarty_function_privacyFlag">smarty_function_privacyFlag()</a>
<span>
: string </span>
</dt>
<dd>Display a banned icon to flag privacy preferences</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="-deprecated" href="namespaces/default.html#function_smarty_function_sectionTotal">smarty_function_sectionTotal()</a>
<span>
: string </span>
</dt>
<dd>Smarty block function for printing the correct report section total</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_smarty_function_simpleActivityContacts">smarty_function_simpleActivityContacts()</a>
<span>
: string </span>
</dt>
<dd>Get details for the target and assignee contact of an activity.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_smarty_modifier_colorContrast">smarty_modifier_colorContrast()</a>
<span>
: string </span>
</dt>
<dd>Wrapper around CRM_Utils_Color::getContrast</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_smarty_modifier_crmAddClass">smarty_modifier_crmAddClass()</a>
<span>
: string </span>
</dt>
<dd>Add a class to an html element</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_smarty_modifier_crmBtnType">smarty_modifier_crmBtnType()</a>
<span>
: string </span>
</dt>
<dd>Grab the button type from a passed button element 'name' by checking for reserved QF button type strings</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_smarty_modifier_crmCountCharacters">smarty_modifier_crmCountCharacters()</a>
<span>
: int </span>
</dt>
<dd>Smarty count_characters modifier plugin</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_smarty_modifier_crmDate">smarty_modifier_crmDate()</a>
<span>
: string </span>
</dt>
<dd>Convert the date string "YYYY-MM-DD" to "MM<long> DD, YYYY".</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_smarty_modifier_crmDelete">smarty_modifier_crmDelete()</a>
<span>
: string </span>
</dt>
<dd>Replace the value of an attribute in the input string. Assume
the the attribute is well formed, of the type name="value". If
no replacement is mentioned the value is inserted at the end of
the form element</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_smarty_modifier_crmFirstWord">smarty_modifier_crmFirstWord()</a>
<span>
: string </span>
</dt>
<dd>Replace a string with the first word in the string</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_smarty_modifier_crmICalDate">smarty_modifier_crmICalDate()</a>
<span>
: string </span>
</dt>
<dd>Format the given text in an ical suitable format</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_smarty_modifier_crmICalText">smarty_modifier_crmICalText()</a>
<span>
: string </span>
</dt>
<dd>Format the given text in an ical suitable format</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_smarty_modifier_crmInsert">smarty_modifier_crmInsert()</a>
<span>
: string </span>
</dt>
<dd>Replace the value of an attribute in the input string. Assume
the the attribute is well formed, of the type name="value". If
no replacement is mentioned the value is inserted at the end of
the form element</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_smarty_modifier_crmMoney">smarty_modifier_crmMoney()</a>
<span>
: string </span>
</dt>
<dd>Format the given monetary amount (and currency) for display</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_smarty_modifier_crmNumberFormat">smarty_modifier_crmNumberFormat()</a>
<span>
: string </span>
</dt>
<dd>Add thousands separator to numeric strings using
PHP number_format() function.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_smarty_modifier_crmReplace">smarty_modifier_crmReplace()</a>
<span>
: string </span>
</dt>
<dd>Replace the value of an attribute in the input string. Assume
the the attribute is well formed, of the type name="value". If
no replacement is mentioned the value is inserted at the end of
the form element</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_smarty_modifier_crmRSSPubDate">smarty_modifier_crmRSSPubDate()</a>
<span>
: string </span>
</dt>
<dd>Format the given date to RSS pubDate RFC822 format,
http://www.w3.org/Protocols/rfc822/#z28</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_smarty_modifier_crmStripAlternatives">smarty_modifier_crmStripAlternatives()</a>
<span>
: string </span>
</dt>
<dd>Given an ezComponents-parsed representation of
a text with alternatives return only the first one</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_smarty_modifier_crmUpper">smarty_modifier_crmUpper()</a>
<span>
: string </span>
</dt>
<dd>Upper case a string but use the multibyte strtoupper function to better handle accents / umlaut</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_smarty_modifier_htmlize">smarty_modifier_htmlize()</a>
<span>
: string </span>
</dt>
<dd>Convert a given text part a better HTML representation (add paragraphs and make URLs clickable)</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_smarty_modifier_json">smarty_modifier_json()</a>
<span>
: string </span>
</dt>
<dd>Convert the data to a JSON string</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_smarty_modifier_mb_truncate">smarty_modifier_mb_truncate()</a>
<span>
: string </span>
</dt>
<dd>Smarty mb_truncate modifier plugin</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_smarty_modifier_nl2brIfNotHTML">smarty_modifier_nl2brIfNotHTML()</a>
<span>
: string </span>
</dt>
<dd>If the given string looks like HTML, do nothing and return it.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_smarty_modifier_print_array">smarty_modifier_print_array()</a>
<span>
: string </span>
</dt>
<dd>Smarty print_array modifier plugin</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_smarty_modifier_purify">smarty_modifier_purify()</a>
<span>
: string </span>
</dt>
<dd>Purify HTML to mitigate against XSS attacks</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_smarty_modifier_smarty">smarty_modifier_smarty()</a>
<span>
: string </span>
</dt>
<dd>Implement smarty:nodefaults for Smarty3.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_smarty_modifier_substring">smarty_modifier_substring()</a>
<span>
: string </span>
</dt>
<dd>Smarty plugin
Type: modifier
Name: substring
Version: 0.1
Date: 2006-16-02
Author: Thorsten Albrecht <thor_REMOVE.THIS_@wolke7.net>
Purpose: "substring" allows you to retrieve a small part (substring) of a string.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_smarty_prefilter_htxtFilter">smarty_prefilter_htxtFilter()</a>
<span>
: string </span>
</dt>
<dd>The content of an "{htxt}" block should not be evaluated unless
the active request is relevant. Otherwise, it will try to
evaluate unassigned variables.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_smarty_prefilter_resetExtScope">smarty_prefilter_resetExtScope()</a>
<span>
: string </span>
</dt>
<dd>Wrap every Smarty template in a {crmScope} tag that sets the
variable "extensionKey" to blank.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_smarty_resource_string_get_template">civicrm_smarty_resource_string_get_template()</a>
<span>
: bool </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_smarty_resource_string_get_timestamp">civicrm_smarty_resource_string_get_timestamp()</a>
<span>
: bool </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_smarty_resource_string_get_secure">civicrm_smarty_resource_string_get_secure()</a>
<span>
: bool </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_smarty_resource_string_get_trusted">civicrm_smarty_resource_string_get_trusted()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_smarty_register_string_resource">civicrm_smarty_register_string_resource()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_crm_smarty_compatibility_get_path">crm_smarty_compatibility_get_path()</a>
<span>
: string|null </span>
</dt>
<dd>Get the path to load Smarty.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_generateJoomlaConfig">generateJoomlaConfig()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_repo">repo()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Make a small report about the git content in a given folder+branch.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__afform_admin_civix_civicrm_config">_afform_admin_civix_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__afform_admin_civix_civicrm_install">_afform_admin_civix_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__afform_admin_civix_civicrm_enable">_afform_admin_civix_civicrm_enable()</a>
<span>
: void </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__afform_admin_civix_insert_navigation_menu">_afform_admin_civix_insert_navigation_menu()</a>
<span>
: bool </span>
</dt>
<dd>Inserts a navigation menu item at a given place in the hierarchy.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__afform_admin_civix_navigationMenu">_afform_admin_civix_navigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_navigationMenu().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__afform_admin_civix_fixNavigationMenu">_afform_admin_civix_fixNavigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>Given a navigation menu, generate navIDs for any items which are
missing them.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__afform_admin_civix_fixNavigationMenuItems">_afform_admin_civix_fixNavigationMenuItems()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_afform_admin_civicrm_config">afform_admin_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_afform_admin_civicrm_install">afform_admin_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_afform_admin_civicrm_enable">afform_admin_civicrm_enable()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__afform_civix_class_loader">_afform_civix_class_loader()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__afform_civix_civicrm_config">_afform_civix_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__afform_civix_civicrm_install">_afform_civix_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__afform_civix_civicrm_enable">_afform_civix_civicrm_enable()</a>
<span>
: void </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__afform_civix_insert_navigation_menu">_afform_civix_insert_navigation_menu()</a>
<span>
: bool </span>
</dt>
<dd>Inserts a navigation menu item at a given place in the hierarchy.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__afform_civix_navigationMenu">_afform_civix_navigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_navigationMenu().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__afform_civix_fixNavigationMenu">_afform_civix_fixNavigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>Given a navigation menu, generate navIDs for any items which are
missing them.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__afform_civix_fixNavigationMenuItems">_afform_civix_fixNavigationMenuItems()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__afform_fields_filter">_afform_fields_filter()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Filter the content of $params to only have supported afform fields.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_afform_civicrm_config">afform_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_afform_civicrm_install">afform_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_afform_civicrm_enable">afform_civicrm_enable()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_afform_civicrm_managed">afform_civicrm_managed()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_managed().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_afform_civicrm_tabset">afform_civicrm_tabset()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_tabset().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_afform_civicrm_pageRun">afform_civicrm_pageRun()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_pageRun().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_afform_civicrm_contactSummaryBlocks">afform_civicrm_contactSummaryBlocks()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_contactSummaryBlocks().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__afform_get_contact_types">_afform_get_contact_types()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Resolve a mixed list of contact types and sub-types into just top-level contact types (Individual, Organization, Household)</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__afform_hook_civicrm_angularModules">_afform_hook_civicrm_angularModules()</a>
<span>
: mixed </span>
</dt>
<dd>Late-listener for Angular modules: adds all Afforms and their dependencies.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__afform_get_partials">_afform_get_partials()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Callback to retrieve partials for a given afform/angular module.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_afform_civicrm_buildAsset">afform_civicrm_buildAsset()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_buildAsset().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_afform_civicrm_alterMenu">afform_civicrm_alterMenu()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_alterMenu().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_afform_civicrm_permission">afform_civicrm_permission()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_permission().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_afform_civicrm_permission_check">afform_civicrm_permission_check()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_permission_check().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_afform_civicrm_permissionList">afform_civicrm_permissionList()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_permissionList().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__afform_clear">_afform_clear()</a>
<span>
: mixed </span>
</dt>
<dd>Clear any local/in-memory caches based on afform data.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__afform_angular_module_name">_afform_angular_module_name()</a>
<span>
: string </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_afform_civicrm_preProcess">afform_civicrm_preProcess()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_preProcess().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_afform_civicrm_pre">afform_civicrm_pre()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_pre().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_afform_civicrm_referenceCounts">afform_civicrm_referenceCounts()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_referenceCounts().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_afform_shortcode_content">afform_shortcode_content()</a>
<span>
: string </span>
</dt>
<dd>Wordpress only: Render Afform content for shortcodes.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_afform_civicrm_searchKitTasks">afform_civicrm_searchKitTasks()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_searchKitTasks().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_afform_get">civicrm_api3_afform_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get a list of afforms.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_afform_get_spec">_civicrm_api3_afform_get_spec()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_afform_getlist_params">_civicrm_api3_afform_getlist_params()</a>
<span>
: mixed </span>
</dt>
<dd>Augment parameters for Afform entityRef list.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_afform_getlist_output">_civicrm_api3_afform_getlist_output()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Format output for Afform entityRef list.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_cv">cv()</a>
<span>
: string </span>
</dt>
<dd>Call the "cv" command.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__afform_html_civix_civicrm_config">_afform_html_civix_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__afform_html_civix_civicrm_install">_afform_html_civix_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__afform_html_civix_civicrm_enable">_afform_html_civix_civicrm_enable()</a>
<span>
: void </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__afform_html_civix_insert_navigation_menu">_afform_html_civix_insert_navigation_menu()</a>
<span>
: bool </span>
</dt>
<dd>Inserts a navigation menu item at a given place in the hierarchy.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__afform_html_civix_navigationMenu">_afform_html_civix_navigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_navigationMenu().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__afform_html_civix_fixNavigationMenu">_afform_html_civix_fixNavigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>Given a navigation menu, generate navIDs for any items which are
missing them.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__afform_html_civix_fixNavigationMenuItems">_afform_html_civix_fixNavigationMenuItems()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_afform_html_civicrm_config">afform_html_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_afform_html_civicrm_install">afform_html_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_afform_html_civicrm_enable">afform_html_civicrm_enable()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__afform_login_token_civix_civicrm_config">_afform_login_token_civix_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__afform_login_token_civix_civicrm_install">_afform_login_token_civix_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__afform_login_token_civix_civicrm_enable">_afform_login_token_civix_civicrm_enable()</a>
<span>
: void </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__afform_login_token_civix_insert_navigation_menu">_afform_login_token_civix_insert_navigation_menu()</a>
<span>
: bool </span>
</dt>
<dd>Inserts a navigation menu item at a given place in the hierarchy.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__afform_login_token_civix_navigationMenu">_afform_login_token_civix_navigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_navigationMenu().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__afform_login_token_civix_fixNavigationMenu">_afform_login_token_civix_fixNavigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>Given a navigation menu, generate navIDs for any items which are
missing them.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__afform_login_token_civix_fixNavigationMenuItems">_afform_login_token_civix_fixNavigationMenuItems()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_afform_login_token_civicrm_config">afform_login_token_civicrm_config()</a>
<span>
: void </span>
</dt>
<dd>Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_afform_login_token_civicrm_install">afform_login_token_civicrm_install()</a>
<span>
: void </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_afform_login_token_civicrm_enable">afform_login_token_civicrm_enable()</a>
<span>
: void </span>
</dt>
<dd>Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__afform_mock_civix_civicrm_config">_afform_mock_civix_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__afform_mock_civix_civicrm_install">_afform_mock_civix_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__afform_mock_civix_civicrm_enable">_afform_mock_civix_civicrm_enable()</a>
<span>
: void </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__afform_mock_civix_insert_navigation_menu">_afform_mock_civix_insert_navigation_menu()</a>
<span>
: bool </span>
</dt>
<dd>Inserts a navigation menu item at a given place in the hierarchy.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__afform_mock_civix_navigationMenu">_afform_mock_civix_navigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_navigationMenu().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__afform_mock_civix_fixNavigationMenu">_afform_mock_civix_fixNavigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>Given a navigation menu, generate navIDs for any items which are
missing them.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__afform_mock_civix_fixNavigationMenuItems">_afform_mock_civix_fixNavigationMenuItems()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_afform_mock_civicrm_config">afform_mock_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_afform_mock_civicrm_install">afform_mock_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_afform_mock_civicrm_enable">afform_mock_civicrm_enable()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_cv">cv()</a>
<span>
: mixed </span>
</dt>
<dd>Call the "cv" command.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__authx_civix_civicrm_config">_authx_civix_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__authx_civix_civicrm_install">_authx_civix_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__authx_civix_civicrm_enable">_authx_civix_civicrm_enable()</a>
<span>
: void </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__authx_civix_insert_navigation_menu">_authx_civix_insert_navigation_menu()</a>
<span>
: bool </span>
</dt>
<dd>Inserts a navigation menu item at a given place in the hierarchy.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__authx_civix_navigationMenu">_authx_civix_navigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_navigationMenu().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__authx_civix_fixNavigationMenu">_authx_civix_fixNavigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>Given a navigation menu, generate navIDs for any items which are
missing them.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__authx_civix_fixNavigationMenuItems">_authx_civix_fixNavigationMenuItems()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_authx_login">authx_login()</a>
<span>
: array{contactId: int, userId: ?int, flow: string, credType: string, useSession: bool} </span>
</dt>
<dd>Perform a system login.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__authx_uf">_authx_uf()</a>
<span>
: <a href="classes/Civi-Authx-AuthxInterface.html"><abbr title="\Civi\Authx\AuthxInterface">AuthxInterface</abbr></a> </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__authx_redact">_authx_redact()</a>
<span>
: mixed </span>
</dt>
<dd>For parameter-based authentication, this option will hide parameters.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__authx_reload">_authx_reload()</a>
<span>
: mixed </span>
</dt>
<dd>Reload the current page-view.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_authx_civicrm_config">authx_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_authx_civicrm_install">authx_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_authx_civicrm_enable">authx_civicrm_enable()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_authx_civicrm_permission">authx_civicrm_permission()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_permission().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_cv">cv()</a>
<span>
: string </span>
</dt>
<dd>Call the "cv" command.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__chart_kit_civix_civicrm_config">_chart_kit_civix_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__chart_kit_civix_civicrm_install">_chart_kit_civix_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__chart_kit_civix_civicrm_enable">_chart_kit_civix_civicrm_enable()</a>
<span>
: void </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__chart_kit_civix_insert_navigation_menu">_chart_kit_civix_insert_navigation_menu()</a>
<span>
: bool </span>
</dt>
<dd>Inserts a navigation menu item at a given place in the hierarchy.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__chart_kit_civix_navigationMenu">_chart_kit_civix_navigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_navigationMenu().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__chart_kit_civix_fixNavigationMenu">_chart_kit_civix_fixNavigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>Given a navigation menu, generate navIDs for any items which are
missing them.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__chart_kit_civix_fixNavigationMenuItems">_chart_kit_civix_fixNavigationMenuItems()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_chart_kit_civicrm_config">chart_kit_civicrm_config()</a>
<span>
: void </span>
</dt>
<dd>Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_chart_kit_civicrm_install">chart_kit_civicrm_install()</a>
<span>
: void </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_chart_kit_civicrm_enable">chart_kit_civicrm_enable()</a>
<span>
: void </span>
</dt>
<dd>Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civi_campaign_civix_civicrm_config">_civi_campaign_civix_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civi_campaign_civix_civicrm_install">_civi_campaign_civix_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civi_campaign_civix_civicrm_enable">_civi_campaign_civix_civicrm_enable()</a>
<span>
: void </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civi_campaign_civix_insert_navigation_menu">_civi_campaign_civix_insert_navigation_menu()</a>
<span>
: bool </span>
</dt>
<dd>Inserts a navigation menu item at a given place in the hierarchy.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civi_campaign_civix_navigationMenu">_civi_campaign_civix_navigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_navigationMenu().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civi_campaign_civix_fixNavigationMenu">_civi_campaign_civix_fixNavigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>Given a navigation menu, generate navIDs for any items which are
missing them.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civi_campaign_civix_fixNavigationMenuItems">_civi_campaign_civix_fixNavigationMenuItems()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civi_case_civix_civicrm_config">_civi_case_civix_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civi_case_civix_civicrm_install">_civi_case_civix_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civi_case_civix_civicrm_enable">_civi_case_civix_civicrm_enable()</a>
<span>
: void </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civi_case_civix_insert_navigation_menu">_civi_case_civix_insert_navigation_menu()</a>
<span>
: bool </span>
</dt>
<dd>Inserts a navigation menu item at a given place in the hierarchy.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civi_case_civix_navigationMenu">_civi_case_civix_navigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_navigationMenu().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civi_case_civix_fixNavigationMenu">_civi_case_civix_fixNavigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>Given a navigation menu, generate navIDs for any items which are
missing them.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civi_case_civix_fixNavigationMenuItems">_civi_case_civix_fixNavigationMenuItems()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civi_case_civicrm_managed">civi_case_civicrm_managed()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_managed().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civi_case_civicrm_selectWhereClause">civi_case_civicrm_selectWhereClause()</a>
<span>
: mixed </span>
</dt>
<dd>Applies Case permissions to Activities</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civi_contribute_civix_civicrm_config">_civi_contribute_civix_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civi_contribute_civix_civicrm_install">_civi_contribute_civix_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civi_contribute_civix_civicrm_enable">_civi_contribute_civix_civicrm_enable()</a>
<span>
: void </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civi_contribute_civix_insert_navigation_menu">_civi_contribute_civix_insert_navigation_menu()</a>
<span>
: bool </span>
</dt>
<dd>Inserts a navigation menu item at a given place in the hierarchy.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civi_contribute_civix_navigationMenu">_civi_contribute_civix_navigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_navigationMenu().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civi_contribute_civix_fixNavigationMenu">_civi_contribute_civix_fixNavigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>Given a navigation menu, generate navIDs for any items which are
missing them.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civi_contribute_civix_fixNavigationMenuItems">_civi_contribute_civix_fixNavigationMenuItems()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_cv">cv()</a>
<span>
: mixed </span>
</dt>
<dd>Call the "cv" command.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civi_event_civix_civicrm_config">_civi_event_civix_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civi_event_civix_civicrm_install">_civi_event_civix_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civi_event_civix_civicrm_enable">_civi_event_civix_civicrm_enable()</a>
<span>
: void </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civi_event_civix_insert_navigation_menu">_civi_event_civix_insert_navigation_menu()</a>
<span>
: bool </span>
</dt>
<dd>Inserts a navigation menu item at a given place in the hierarchy.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civi_event_civix_navigationMenu">_civi_event_civix_navigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_navigationMenu().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civi_event_civix_fixNavigationMenu">_civi_event_civix_fixNavigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>Given a navigation menu, generate navIDs for any items which are
missing them.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civi_event_civix_fixNavigationMenuItems">_civi_event_civix_fixNavigationMenuItems()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civi_mail_civix_civicrm_config">_civi_mail_civix_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civi_mail_civix_civicrm_install">_civi_mail_civix_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civi_mail_civix_civicrm_enable">_civi_mail_civix_civicrm_enable()</a>
<span>
: void </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civi_mail_civix_insert_navigation_menu">_civi_mail_civix_insert_navigation_menu()</a>
<span>
: bool </span>
</dt>
<dd>Inserts a navigation menu item at a given place in the hierarchy.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civi_mail_civix_navigationMenu">_civi_mail_civix_navigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_navigationMenu().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civi_mail_civix_fixNavigationMenu">_civi_mail_civix_fixNavigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>Given a navigation menu, generate navIDs for any items which are
missing them.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civi_mail_civix_fixNavigationMenuItems">_civi_mail_civix_fixNavigationMenuItems()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civi_member_civix_civicrm_config">_civi_member_civix_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civi_member_civix_civicrm_install">_civi_member_civix_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civi_member_civix_civicrm_enable">_civi_member_civix_civicrm_enable()</a>
<span>
: void </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civi_member_civix_insert_navigation_menu">_civi_member_civix_insert_navigation_menu()</a>
<span>
: bool </span>
</dt>
<dd>Inserts a navigation menu item at a given place in the hierarchy.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civi_member_civix_navigationMenu">_civi_member_civix_navigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_navigationMenu().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civi_member_civix_fixNavigationMenu">_civi_member_civix_fixNavigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>Given a navigation menu, generate navIDs for any items which are
missing them.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civi_member_civix_fixNavigationMenuItems">_civi_member_civix_fixNavigationMenuItems()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civi_pledge_civix_civicrm_config">_civi_pledge_civix_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civi_pledge_civix_civicrm_install">_civi_pledge_civix_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civi_pledge_civix_civicrm_enable">_civi_pledge_civix_civicrm_enable()</a>
<span>
: void </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civi_pledge_civix_insert_navigation_menu">_civi_pledge_civix_insert_navigation_menu()</a>
<span>
: bool </span>
</dt>
<dd>Inserts a navigation menu item at a given place in the hierarchy.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civi_pledge_civix_navigationMenu">_civi_pledge_civix_navigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_navigationMenu().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civi_pledge_civix_fixNavigationMenu">_civi_pledge_civix_fixNavigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>Given a navigation menu, generate navIDs for any items which are
missing them.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civi_pledge_civix_fixNavigationMenuItems">_civi_pledge_civix_fixNavigationMenuItems()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civi_report_civix_civicrm_config">_civi_report_civix_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civi_report_civix_civicrm_install">_civi_report_civix_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civi_report_civix_civicrm_enable">_civi_report_civix_civicrm_enable()</a>
<span>
: void </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civi_report_civix_insert_navigation_menu">_civi_report_civix_insert_navigation_menu()</a>
<span>
: bool </span>
</dt>
<dd>Inserts a navigation menu item at a given place in the hierarchy.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civi_report_civix_navigationMenu">_civi_report_civix_navigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_navigationMenu().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civi_report_civix_fixNavigationMenu">_civi_report_civix_fixNavigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>Given a navigation menu, generate navIDs for any items which are
missing them.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civi_report_civix_fixNavigationMenuItems">_civi_report_civix_fixNavigationMenuItems()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_cv">cv()</a>
<span>
: mixed </span>
</dt>
<dd>Call the "cv" command.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_admin_ui_civix_civicrm_config">_civicrm_admin_ui_civix_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_admin_ui_civix_civicrm_install">_civicrm_admin_ui_civix_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_admin_ui_civix_civicrm_enable">_civicrm_admin_ui_civix_civicrm_enable()</a>
<span>
: void </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_admin_ui_civix_insert_navigation_menu">_civicrm_admin_ui_civix_insert_navigation_menu()</a>
<span>
: bool </span>
</dt>
<dd>Inserts a navigation menu item at a given place in the hierarchy.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_admin_ui_civix_navigationMenu">_civicrm_admin_ui_civix_navigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_navigationMenu().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_admin_ui_civix_fixNavigationMenu">_civicrm_admin_ui_civix_fixNavigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>Given a navigation menu, generate navIDs for any items which are
missing them.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_admin_ui_civix_fixNavigationMenuItems">_civicrm_admin_ui_civix_fixNavigationMenuItems()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_admin_ui_civicrm_config">civicrm_admin_ui_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_admin_ui_civicrm_postProcess">civicrm_admin_ui_civicrm_postProcess()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_postProcess().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_cv">cv()</a>
<span>
: mixed </span>
</dt>
<dd>Call the "cv" command.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_search_ui_civix_civicrm_config">_civicrm_search_ui_civix_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_search_ui_civix_civicrm_install">_civicrm_search_ui_civix_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_search_ui_civix_civicrm_enable">_civicrm_search_ui_civix_civicrm_enable()</a>
<span>
: void </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_search_ui_civix_insert_navigation_menu">_civicrm_search_ui_civix_insert_navigation_menu()</a>
<span>
: bool </span>
</dt>
<dd>Inserts a navigation menu item at a given place in the hierarchy.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_search_ui_civix_navigationMenu">_civicrm_search_ui_civix_navigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_navigationMenu().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_search_ui_civix_fixNavigationMenu">_civicrm_search_ui_civix_fixNavigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>Given a navigation menu, generate navIDs for any items which are
missing them.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_search_ui_civix_fixNavigationMenuItems">_civicrm_search_ui_civix_fixNavigationMenuItems()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_search_ui_civicrm_config">civicrm_search_ui_civicrm_config()</a>
<span>
: void </span>
</dt>
<dd>Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_search_ui_civicrm_install">civicrm_search_ui_civicrm_install()</a>
<span>
: void </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_search_ui_civicrm_enable">civicrm_search_ui_civicrm_enable()</a>
<span>
: void </span>
</dt>
<dd>Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_grant_create">civicrm_api3_grant_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Create/update Grant.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_grant_create_spec">_civicrm_api3_grant_create_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Adjust Metadata for Create action.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_grant_get">civicrm_api3_grant_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Returns array of grants matching a set of one or more properties.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_grant_delete">civicrm_api3_grant_delete()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>This method is used to delete an existing Grant.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civigrant_civix_class_loader">_civigrant_civix_class_loader()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civigrant_civix_civicrm_config">_civigrant_civix_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civigrant_civix_civicrm_install">_civigrant_civix_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civigrant_civix_civicrm_enable">_civigrant_civix_civicrm_enable()</a>
<span>
: void </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civigrant_civix_insert_navigation_menu">_civigrant_civix_insert_navigation_menu()</a>
<span>
: bool </span>
</dt>
<dd>Inserts a navigation menu item at a given place in the hierarchy.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civigrant_civix_navigationMenu">_civigrant_civix_navigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_navigationMenu().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civigrant_civix_fixNavigationMenu">_civigrant_civix_fixNavigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>Given a navigation menu, generate navIDs for any items which are
missing them.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civigrant_civix_fixNavigationMenuItems">_civigrant_civix_fixNavigationMenuItems()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civigrant_civicrm_config">civigrant_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civigrant_civicrm_links">civigrant_civicrm_links()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_links().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civigrant_civicrm_summaryActions">civigrant_civicrm_summaryActions()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_summaryActions().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civigrant_civicrm_permission">civigrant_civicrm_permission()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_permission().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civigrant_civicrm_alterAPIPermissions">civigrant_civicrm_alterAPIPermissions()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_alterAPIPermissions().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civigrant_civicrm_queryObjects">civigrant_civicrm_queryObjects()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_queryObjects().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_cv">cv()</a>
<span>
: mixed </span>
</dt>
<dd>Call the "cv" command.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civiimport_civix_civicrm_config">_civiimport_civix_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civiimport_civix_civicrm_install">_civiimport_civix_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civiimport_civix_civicrm_enable">_civiimport_civix_civicrm_enable()</a>
<span>
: void </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civiimport_civix_insert_navigation_menu">_civiimport_civix_insert_navigation_menu()</a>
<span>
: bool </span>
</dt>
<dd>Inserts a navigation menu item at a given place in the hierarchy.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civiimport_civix_navigationMenu">_civiimport_civix_navigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_navigationMenu().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civiimport_civix_fixNavigationMenu">_civiimport_civix_fixNavigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>Given a navigation menu, generate navIDs for any items which are
missing them.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civiimport_civix_fixNavigationMenuItems">_civiimport_civix_fixNavigationMenuItems()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civiimport_civicrm_config">civiimport_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civiimport_civicrm_install">civiimport_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civiimport_civicrm_enable">civiimport_civicrm_enable()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civiimport_civicrm_entityTypes">civiimport_civicrm_entityTypes()</a>
<span>
: void </span>
</dt>
<dd>Implements hook_civicrm_entityTypes().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civiimport_civicrm_get_import_tables">_civiimport_civicrm_get_import_tables()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Get the available import tables.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civiimport_civicrm_alterTemplateFile">civiimport_civicrm_alterTemplateFile()</a>
<span>
: void </span>
</dt>
<dd>Alter the template for the contribution import mapping to use angular form.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civiimport_civicrm_searchKitTasks">civiimport_civicrm_searchKitTasks()</a>
<span>
: mixed </span>
</dt>
<dd>Implements search tasks hook to add the `validate` and `import` actions.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civiimport_civicrm_buildForm">civiimport_civicrm_buildForm()</a>
<span>
: mixed </span>
</dt>
<dd>Load the angular app for our form.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_cv">cv()</a>
<span>
: mixed </span>
</dt>
<dd>Call the "cv" command.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__ckeditor4_civix_civicrm_config">_ckeditor4_civix_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__ckeditor4_civix_civicrm_install">_ckeditor4_civix_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__ckeditor4_civix_civicrm_enable">_ckeditor4_civix_civicrm_enable()</a>
<span>
: void </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__ckeditor4_civix_insert_navigation_menu">_ckeditor4_civix_insert_navigation_menu()</a>
<span>
: bool </span>
</dt>
<dd>Inserts a navigation menu item at a given place in the hierarchy.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__ckeditor4_civix_navigationMenu">_ckeditor4_civix_navigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_navigationMenu().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__ckeditor4_civix_fixNavigationMenu">_ckeditor4_civix_fixNavigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>Given a navigation menu, generate navIDs for any items which are
missing them.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__ckeditor4_civix_fixNavigationMenuItems">_ckeditor4_civix_fixNavigationMenuItems()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_ckeditor4_civicrm_config">ckeditor4_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_ckeditor4_civicrm_install">ckeditor4_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_ckeditor4_civicrm_enable">ckeditor4_civicrm_enable()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_ckeditor4_civicrm_buildForm">ckeditor4_civicrm_buildForm()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_ckeditor4_civicrm_coreResourceList">ckeditor4_civicrm_coreResourceList()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__contributioncancelactions_civix_civicrm_config">_contributioncancelactions_civix_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__contributioncancelactions_civix_civicrm_install">_contributioncancelactions_civix_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__contributioncancelactions_civix_civicrm_enable">_contributioncancelactions_civix_civicrm_enable()</a>
<span>
: void </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__contributioncancelactions_civix_insert_navigation_menu">_contributioncancelactions_civix_insert_navigation_menu()</a>
<span>
: bool </span>
</dt>
<dd>Inserts a navigation menu item at a given place in the hierarchy.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__contributioncancelactions_civix_navigationMenu">_contributioncancelactions_civix_navigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_navigationMenu().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__contributioncancelactions_civix_fixNavigationMenu">_contributioncancelactions_civix_fixNavigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>Given a navigation menu, generate navIDs for any items which are
missing them.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__contributioncancelactions_civix_fixNavigationMenuItems">_contributioncancelactions_civix_fixNavigationMenuItems()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_contributioncancelactions_civicrm_post">contributioncancelactions_civicrm_post()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_preProcess().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_contributioncancelactions_cancel_related_pending_participant_records">contributioncancelactions_cancel_related_pending_participant_records()</a>
<span>
: void </span>
</dt>
<dd>Find and cancel any pending participant records.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_contributioncancelactions_cancel_related_pending_memberships">contributioncancelactions_cancel_related_pending_memberships()</a>
<span>
: void </span>
</dt>
<dd>Find and cancel any pending memberships.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_cv">cv()</a>
<span>
: string </span>
</dt>
<dd>Call the "cv" command.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__elavon_civix_civicrm_config">_elavon_civix_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__elavon_civix_civicrm_install">_elavon_civix_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__elavon_civix_civicrm_enable">_elavon_civix_civicrm_enable()</a>
<span>
: void </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__elavon_civix_insert_navigation_menu">_elavon_civix_insert_navigation_menu()</a>
<span>
: bool </span>
</dt>
<dd>Inserts a navigation menu item at a given place in the hierarchy.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__elavon_civix_navigationMenu">_elavon_civix_navigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_navigationMenu().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__elavon_civix_fixNavigationMenu">_elavon_civix_fixNavigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>Given a navigation menu, generate navIDs for any items which are
missing them.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__elavon_civix_fixNavigationMenuItems">_elavon_civix_fixNavigationMenuItems()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_elavon_civicrm_config">elavon_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_elavon_civicrm_install">elavon_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_elavon_civicrm_enable">elavon_civicrm_enable()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_cv">cv()</a>
<span>
: mixed </span>
</dt>
<dd>Call the "cv" command.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__eventcart_civix_class_loader">_eventcart_civix_class_loader()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__eventcart_civix_civicrm_config">_eventcart_civix_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__eventcart_civix_civicrm_install">_eventcart_civix_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__eventcart_civix_civicrm_enable">_eventcart_civix_civicrm_enable()</a>
<span>
: void </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__eventcart_civix_insert_navigation_menu">_eventcart_civix_insert_navigation_menu()</a>
<span>
: bool </span>
</dt>
<dd>Inserts a navigation menu item at a given place in the hierarchy.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__eventcart_civix_navigationMenu">_eventcart_civix_navigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_navigationMenu().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__eventcart_civix_fixNavigationMenu">_eventcart_civix_fixNavigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>Given a navigation menu, generate navIDs for any items which are
missing them.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__eventcart_civix_fixNavigationMenuItems">_eventcart_civix_fixNavigationMenuItems()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_eventcart_civicrm_config">eventcart_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_eventcart_civicrm_install">eventcart_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_eventcart_civicrm_alterMailParams">eventcart_civicrm_alterMailParams()</a>
<span>
: mixed </span>
</dt>
<dd>Add the conference session variable to the template.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_eventcart_civicrm_enable">eventcart_civicrm_enable()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_eventcart_civicrm_tabset">eventcart_civicrm_tabset()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__ewaysingle_civix_civicrm_config">_ewaysingle_civix_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__ewaysingle_civix_civicrm_install">_ewaysingle_civix_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__ewaysingle_civix_civicrm_enable">_ewaysingle_civix_civicrm_enable()</a>
<span>
: void </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__ewaysingle_civix_insert_navigation_menu">_ewaysingle_civix_insert_navigation_menu()</a>
<span>
: bool </span>
</dt>
<dd>Inserts a navigation menu item at a given place in the hierarchy.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__ewaysingle_civix_navigationMenu">_ewaysingle_civix_navigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_navigationMenu().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__ewaysingle_civix_fixNavigationMenu">_ewaysingle_civix_fixNavigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>Given a navigation menu, generate navIDs for any items which are
missing them.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__ewaysingle_civix_fixNavigationMenuItems">_ewaysingle_civix_fixNavigationMenuItems()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_ewaysingle_civicrm_config">ewaysingle_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_ewaysingle_civicrm_install">ewaysingle_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_ewaysingle_civicrm_enable">ewaysingle_civicrm_enable()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_cv">cv()</a>
<span>
: string </span>
</dt>
<dd>Call the "cv" command.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__financialacls_civix_civicrm_config">_financialacls_civix_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__financialacls_civix_civicrm_install">_financialacls_civix_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__financialacls_civix_civicrm_enable">_financialacls_civix_civicrm_enable()</a>
<span>
: void </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__financialacls_civix_insert_navigation_menu">_financialacls_civix_insert_navigation_menu()</a>
<span>
: bool </span>
</dt>
<dd>Inserts a navigation menu item at a given place in the hierarchy.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__financialacls_civix_navigationMenu">_financialacls_civix_navigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_navigationMenu().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__financialacls_civix_fixNavigationMenu">_financialacls_civix_fixNavigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>Given a navigation menu, generate navIDs for any items which are
missing them.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__financialacls_civix_fixNavigationMenuItems">_financialacls_civix_fixNavigationMenuItems()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_financialacls_civicrm_config">financialacls_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_financialacls_civicrm_container">financialacls_civicrm_container()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_financialacls_civicrm_install">financialacls_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_financialacls_civicrm_enable">financialacls_civicrm_enable()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_financialacls_civicrm_pre">financialacls_civicrm_pre()</a>
<span>
: mixed </span>
</dt>
<dd>Intervene to prevent deletion, where permissions block it.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_financialacls_civicrm_selectWhereClause">financialacls_civicrm_selectWhereClause()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_selectWhereClause().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__financialacls_civicrm_get_accounts_clause">_financialacls_civicrm_get_accounts_clause()</a>
<span>
: string </span>
</dt>
<dd>Get the clause to limit available types.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__financialacls_civicrm_get_type_clause">_financialacls_civicrm_get_type_clause()</a>
<span>
: string </span>
</dt>
<dd>Get the clause to limit available types.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__financialacls_civicrm_get_accessible_financial_types">_financialacls_civicrm_get_accessible_financial_types()</a>
<span>
: array<string|int, int> </span>
</dt>
<dd>Get an array of the ids of accessible financial types.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__financialacls_civicrm_get_inaccessible_financial_types">_financialacls_civicrm_get_inaccessible_financial_types()</a>
<span>
: array<string|int, int> </span>
</dt>
<dd>Get an array of the ids of accessible financial types.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__financialacls_civicrm_get_membership_type_clause">_financialacls_civicrm_get_membership_type_clause()</a>
<span>
: string </span>
</dt>
<dd>Get the clause to limit available membership types.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_financialacls_civicrm_buildAmount">financialacls_civicrm_buildAmount()</a>
<span>
: mixed </span>
</dt>
<dd>Remove unpermitted options.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_financialacls_civicrm_membershipTypeValues">financialacls_civicrm_membershipTypeValues()</a>
<span>
: mixed </span>
</dt>
<dd>Remove unpermitted membership types from selection availability.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_financialacls_civicrm_permission">financialacls_civicrm_permission()</a>
<span>
: mixed </span>
</dt>
<dd>Add permissions.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__financialacls_civi_api4_authorizeContribution">_financialacls_civi_api4_authorizeContribution()</a>
<span>
: mixed </span>
</dt>
<dd>Listener for 'civi.api4.authorizeRecord::Contribution'</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_financial_acls_check_permissioned_line_items">_civicrm_financial_acls_check_permissioned_line_items()</a>
<span>
: bool </span>
</dt>
<dd>Function to check if lineitems present in a contribution have permissioned FTs.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__financialacls_getRequiredPermission">_financialacls_getRequiredPermission()</a>
<span>
: string </span>
</dt>
<dd>Get the permission required to perform this action on this financial type.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_financialacls_civicrm_fieldOptions">financialacls_civicrm_fieldOptions()</a>
<span>
: mixed </span>
</dt>
<dd>Remove unpermitted financial types from field Options in search context.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_financialacls_is_acl_limiting_enabled">financialacls_is_acl_limiting_enabled()</a>
<span>
: bool </span>
</dt>
<dd>Is financial acl limiting enabled.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_financialacls_toggle">financialacls_toggle()</a>
<span>
: mixed </span>
</dt>
<dd>Clear the statics cache when the setting is enabled or disabled.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_financialacls_civicrm_alterMenu">financialacls_civicrm_alterMenu()</a>
<span>
: void </span>
</dt>
<dd>Require financial acl permissions for financial screens.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_financialacls_civicrm_preProcess">financialacls_civicrm_preProcess()</a>
<span>
: void </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_financialacls_civicrm_links">financialacls_civicrm_links()</a>
<span>
: mixed </span>
</dt>
<dd>Hide edit/enable/disable links for memberships of a given Financial Type
Note: The $objectID param can be an int, string or null, hence not typed</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_cv">cv()</a>
<span>
: string </span>
</dt>
<dd>Call the "cv" command.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__flexmailer_civix_civicrm_config">_flexmailer_civix_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__flexmailer_civix_civicrm_install">_flexmailer_civix_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__flexmailer_civix_civicrm_enable">_flexmailer_civix_civicrm_enable()</a>
<span>
: void </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__flexmailer_civix_insert_navigation_menu">_flexmailer_civix_insert_navigation_menu()</a>
<span>
: bool </span>
</dt>
<dd>Inserts a navigation menu item at a given place in the hierarchy.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__flexmailer_civix_navigationMenu">_flexmailer_civix_navigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_navigationMenu().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__flexmailer_civix_fixNavigationMenu">_flexmailer_civix_fixNavigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>Given a navigation menu, generate navIDs for any items which are
missing them.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__flexmailer_civix_fixNavigationMenuItems">_flexmailer_civix_fixNavigationMenuItems()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_flexmailer_civicrm_config">flexmailer_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_flexmailer_civicrm_install">flexmailer_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_flexmailer_civicrm_enable">flexmailer_civicrm_enable()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_flexmailer_civicrm_container">flexmailer_civicrm_container()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_container().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_flexmailer_civicrm_scanClasses">flexmailer_civicrm_scanClasses()</a>
<span>
: void </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_cv">cv()</a>
<span>
: string </span>
</dt>
<dd>Call the "cv" command.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__greenwich_civix_civicrm_config">_greenwich_civix_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__greenwich_civix_civicrm_install">_greenwich_civix_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__greenwich_civix_civicrm_enable">_greenwich_civix_civicrm_enable()</a>
<span>
: void </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__greenwich_civix_insert_navigation_menu">_greenwich_civix_insert_navigation_menu()</a>
<span>
: bool </span>
</dt>
<dd>Inserts a navigation menu item at a given place in the hierarchy.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__greenwich_civix_navigationMenu">_greenwich_civix_navigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_navigationMenu().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__greenwich_civix_fixNavigationMenu">_greenwich_civix_fixNavigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>Given a navigation menu, generate navIDs for any items which are
missing them.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__greenwich_civix_fixNavigationMenuItems">_greenwich_civix_fixNavigationMenuItems()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_greenwich_civicrm_config">greenwich_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_greenwich_civicrm_themes">greenwich_civicrm_themes()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_themes().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_greenwich_civicrm_alterBundle">greenwich_civicrm_alterBundle()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_alterBundle().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__iframe_civix_civicrm_config">_iframe_civix_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__iframe_civix_civicrm_install">_iframe_civix_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__iframe_civix_civicrm_enable">_iframe_civix_civicrm_enable()</a>
<span>
: void </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__iframe_civix_insert_navigation_menu">_iframe_civix_insert_navigation_menu()</a>
<span>
: bool </span>
</dt>
<dd>Inserts a navigation menu item at a given place in the hierarchy.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__iframe_civix_navigationMenu">_iframe_civix_navigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_navigationMenu().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__iframe_civix_fixNavigationMenu">_iframe_civix_fixNavigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>Given a navigation menu, generate navIDs for any items which are
missing them.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__iframe_civix_fixNavigationMenuItems">_iframe_civix_fixNavigationMenuItems()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_iframe_civicrm_config">iframe_civicrm_config()</a>
<span>
: void </span>
</dt>
<dd>Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_iframe_civicrm_install">iframe_civicrm_install()</a>
<span>
: void </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_iframe_civicrm_enable">iframe_civicrm_enable()</a>
<span>
: void </span>
</dt>
<dd>Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__legacycustomsearches_civix_civicrm_config">_legacycustomsearches_civix_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__legacycustomsearches_civix_civicrm_install">_legacycustomsearches_civix_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__legacycustomsearches_civix_civicrm_enable">_legacycustomsearches_civix_civicrm_enable()</a>
<span>
: void </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__legacycustomsearches_civix_insert_navigation_menu">_legacycustomsearches_civix_insert_navigation_menu()</a>
<span>
: bool </span>
</dt>
<dd>Inserts a navigation menu item at a given place in the hierarchy.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__legacycustomsearches_civix_navigationMenu">_legacycustomsearches_civix_navigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_navigationMenu().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__legacycustomsearches_civix_fixNavigationMenu">_legacycustomsearches_civix_fixNavigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>Given a navigation menu, generate navIDs for any items which are
missing them.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__legacycustomsearches_civix_fixNavigationMenuItems">_legacycustomsearches_civix_fixNavigationMenuItems()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_legacycustomsearches_civicrm_config">legacycustomsearches_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_legacycustomsearches_civicrm_install">legacycustomsearches_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_legacycustomsearches_civicrm_enable">legacycustomsearches_civicrm_enable()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_legacycustomsearches_civicrm_buildGroupContactCache">legacycustomsearches_civicrm_buildGroupContactCache()</a>
<span>
: void </span>
</dt>
<dd>Determine the sql</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_cv">cv()</a>
<span>
: mixed </span>
</dt>
<dd>Call the "cv" command.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__message_admin_civix_civicrm_config">_message_admin_civix_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__message_admin_civix_civicrm_install">_message_admin_civix_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__message_admin_civix_civicrm_enable">_message_admin_civix_civicrm_enable()</a>
<span>
: void </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__message_admin_civix_insert_navigation_menu">_message_admin_civix_insert_navigation_menu()</a>
<span>
: bool </span>
</dt>
<dd>Inserts a navigation menu item at a given place in the hierarchy.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__message_admin_civix_navigationMenu">_message_admin_civix_navigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_navigationMenu().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__message_admin_civix_fixNavigationMenu">_message_admin_civix_fixNavigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>Given a navigation menu, generate navIDs for any items which are
missing them.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__message_admin_civix_fixNavigationMenuItems">_message_admin_civix_fixNavigationMenuItems()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_message_admin_civicrm_config">message_admin_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_message_admin_civicrm_install">message_admin_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_message_admin_civicrm_enable">message_admin_civicrm_enable()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_buildInputUrl">buildInputUrl()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_buildRedirectUrl">buildRedirectUrl()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__oauth_client_civix_civicrm_config">_oauth_client_civix_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__oauth_client_civix_civicrm_install">_oauth_client_civix_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__oauth_client_civix_civicrm_enable">_oauth_client_civix_civicrm_enable()</a>
<span>
: void </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__oauth_client_civix_insert_navigation_menu">_oauth_client_civix_insert_navigation_menu()</a>
<span>
: bool </span>
</dt>
<dd>Inserts a navigation menu item at a given place in the hierarchy.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__oauth_client_civix_navigationMenu">_oauth_client_civix_navigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_navigationMenu().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__oauth_client_civix_fixNavigationMenu">_oauth_client_civix_fixNavigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>Given a navigation menu, generate navIDs for any items which are
missing them.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__oauth_client_civix_fixNavigationMenuItems">_oauth_client_civix_fixNavigationMenuItems()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_oauth_client_civicrm_config">oauth_client_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_oauth_client_civicrm_permission">oauth_client_civicrm_permission()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_permission().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_oauth_client_civicrm_container">oauth_client_civicrm_container()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_oauth_client_civicrm_oauthProviders">oauth_client_civicrm_oauthProviders()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_oauthProviders().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_oauth_client_civicrm_mailSetupActions">oauth_client_civicrm_mailSetupActions()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_mailSetupActions().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_oauth_client_civicrm_oauthReturn">oauth_client_civicrm_oauthReturn()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_oauthReturn().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_oauth_client_civicrm_alterMailStore">oauth_client_civicrm_alterMailStore()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_alterMailStore().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_cv">cv()</a>
<span>
: string </span>
</dt>
<dd>Call the "cv" command.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__oembed_civix_civicrm_config">_oembed_civix_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__oembed_civix_civicrm_install">_oembed_civix_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__oembed_civix_civicrm_enable">_oembed_civix_civicrm_enable()</a>
<span>
: void </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__oembed_civix_insert_navigation_menu">_oembed_civix_insert_navigation_menu()</a>
<span>
: bool </span>
</dt>
<dd>Inserts a navigation menu item at a given place in the hierarchy.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__oembed_civix_navigationMenu">_oembed_civix_navigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_navigationMenu().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__oembed_civix_fixNavigationMenu">_oembed_civix_fixNavigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>Given a navigation menu, generate navIDs for any items which are
missing them.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__oembed_civix_fixNavigationMenuItems">_oembed_civix_fixNavigationMenuItems()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_oembed_civicrm_config">oembed_civicrm_config()</a>
<span>
: void </span>
</dt>
<dd>Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_oembed_civicrm_install">oembed_civicrm_install()</a>
<span>
: void </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_oembed_civicrm_enable">oembed_civicrm_enable()</a>
<span>
: void </span>
</dt>
<dd>Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_cv">cv()</a>
<span>
: mixed </span>
</dt>
<dd>Call the "cv" command.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__payflowpro_civix_civicrm_config">_payflowpro_civix_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__payflowpro_civix_civicrm_install">_payflowpro_civix_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__payflowpro_civix_civicrm_enable">_payflowpro_civix_civicrm_enable()</a>
<span>
: void </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__payflowpro_civix_insert_navigation_menu">_payflowpro_civix_insert_navigation_menu()</a>
<span>
: bool </span>
</dt>
<dd>Inserts a navigation menu item at a given place in the hierarchy.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__payflowpro_civix_navigationMenu">_payflowpro_civix_navigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_navigationMenu().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__payflowpro_civix_fixNavigationMenu">_payflowpro_civix_fixNavigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>Given a navigation menu, generate navIDs for any items which are
missing them.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__payflowpro_civix_fixNavigationMenuItems">_payflowpro_civix_fixNavigationMenuItems()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_payflowpro_civicrm_config">payflowpro_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_payflowpro_civicrm_install">payflowpro_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_payflowpro_civicrm_enable">payflowpro_civicrm_enable()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_cv">cv()</a>
<span>
: string </span>
</dt>
<dd>Call the "cv" command.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__recaptcha_qsencode">_recaptcha_qsencode()</a>
<span>
: string </span>
</dt>
<dd>Encodes the given data into a query string format</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__recaptcha_http_post">_recaptcha_http_post()</a>
<span>
: string </span>
</dt>
<dd>Submits an HTTP POST to a reCAPTCHA server</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_recaptcha_get_html">recaptcha_get_html()</a>
<span>
: string </span>
</dt>
<dd>Gets the challenge HTML (javascript and non-javascript version).</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_recaptcha_check_answer">recaptcha_check_answer()</a>
<span>
: <a href="classes/ReCaptchaResponse.html"><abbr title="\ReCaptchaResponse">ReCaptchaResponse</abbr></a> </span>
</dt>
<dd>Calls an HTTP POST function to verify if the user's guess was correct</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_recaptcha_get_signup_url">recaptcha_get_signup_url()</a>
<span>
: mixed </span>
</dt>
<dd>gets a URL where the user can sign up for reCAPTCHA. If your application
has a configuration page where you enter a key, you should provide a link
using this function.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__recaptcha_aes_pad">_recaptcha_aes_pad()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__recaptcha_aes_encrypt">_recaptcha_aes_encrypt()</a>
<span>
: mixed </span>
</dt>
<dd>Mailhide related code</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__recaptcha_mailhide_urlbase64">_recaptcha_mailhide_urlbase64()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_recaptcha_mailhide_url">recaptcha_mailhide_url()</a>
<span>
: mixed </span>
</dt>
<dd>gets the reCAPTCHA Mailhide url for a given email, public key and private key</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__recaptcha_mailhide_email_parts">_recaptcha_mailhide_email_parts()</a>
<span>
: mixed </span>
</dt>
<dd>gets the parts of the email to expose to the user.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_recaptcha_mailhide_html">recaptcha_mailhide_html()</a>
<span>
: mixed </span>
</dt>
<dd>Gets html to display an email address given a public an private key.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__recaptcha_civix_civicrm_config">_recaptcha_civix_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__recaptcha_civix_civicrm_install">_recaptcha_civix_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__recaptcha_civix_civicrm_enable">_recaptcha_civix_civicrm_enable()</a>
<span>
: void </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__recaptcha_civix_insert_navigation_menu">_recaptcha_civix_insert_navigation_menu()</a>
<span>
: bool </span>
</dt>
<dd>Inserts a navigation menu item at a given place in the hierarchy.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__recaptcha_civix_navigationMenu">_recaptcha_civix_navigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_navigationMenu().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__recaptcha_civix_fixNavigationMenu">_recaptcha_civix_fixNavigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>Given a navigation menu, generate navIDs for any items which are
missing them.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__recaptcha_civix_fixNavigationMenuItems">_recaptcha_civix_fixNavigationMenuItems()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_recaptcha_civicrm_config">recaptcha_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_recaptcha_civicrm_install">recaptcha_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_recaptcha_civicrm_enable">recaptcha_civicrm_enable()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_recaptcha_civicrm_buildForm">recaptcha_civicrm_buildForm()</a>
<span>
: mixed </span>
</dt>
<dd>Intercept form functions</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__scheduled_communications_civix_civicrm_config">_scheduled_communications_civix_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__scheduled_communications_civix_civicrm_install">_scheduled_communications_civix_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__scheduled_communications_civix_civicrm_enable">_scheduled_communications_civix_civicrm_enable()</a>
<span>
: void </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__scheduled_communications_civix_insert_navigation_menu">_scheduled_communications_civix_insert_navigation_menu()</a>
<span>
: bool </span>
</dt>
<dd>Inserts a navigation menu item at a given place in the hierarchy.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__scheduled_communications_civix_navigationMenu">_scheduled_communications_civix_navigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_navigationMenu().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__scheduled_communications_civix_fixNavigationMenu">_scheduled_communications_civix_fixNavigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>Given a navigation menu, generate navIDs for any items which are
missing them.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__scheduled_communications_civix_fixNavigationMenuItems">_scheduled_communications_civix_fixNavigationMenuItems()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_scheduled_communications_civicrm_config">scheduled_communications_civicrm_config()</a>
<span>
: void </span>
</dt>
<dd>Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_scheduled_communications_civicrm_install">scheduled_communications_civicrm_install()</a>
<span>
: void </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_scheduled_communications_civicrm_enable">scheduled_communications_civicrm_enable()</a>
<span>
: void </span>
</dt>
<dd>Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_scheduled_communications_civicrm_permission">scheduled_communications_civicrm_permission()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_scheduled_communications_civicrm_pre">scheduled_communications_civicrm_pre()</a>
<span>
: void </span>
</dt>
<dd>Implements hook_civicrm_pre().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_scheduled_communications_civicrm_post">scheduled_communications_civicrm_post()</a>
<span>
: void </span>
</dt>
<dd>Implements hook_civicrm_post().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_cv">cv()</a>
<span>
: mixed </span>
</dt>
<dd>Call the "cv" command.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__search_kit_civix_class_loader">_search_kit_civix_class_loader()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__search_kit_civix_civicrm_config">_search_kit_civix_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__search_kit_civix_civicrm_install">_search_kit_civix_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__search_kit_civix_civicrm_enable">_search_kit_civix_civicrm_enable()</a>
<span>
: void </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__search_kit_civix_insert_navigation_menu">_search_kit_civix_insert_navigation_menu()</a>
<span>
: bool </span>
</dt>
<dd>Inserts a navigation menu item at a given place in the hierarchy.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__search_kit_civix_navigationMenu">_search_kit_civix_navigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_navigationMenu().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__search_kit_civix_fixNavigationMenu">_search_kit_civix_fixNavigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>Given a navigation menu, generate navIDs for any items which are
missing them.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__search_kit_civix_fixNavigationMenuItems">_search_kit_civix_fixNavigationMenuItems()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_search_kit_civicrm_config">search_kit_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_search_kit_civicrm_permission">search_kit_civicrm_permission()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_permission().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_search_kit_civicrm_angularModules">search_kit_civicrm_angularModules()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_angularModules().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_search_kit_civicrm_pre">search_kit_civicrm_pre()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_pre().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_search_kit_civicrm_post">search_kit_civicrm_post()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_post().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_search_kit_civicrm_entityTypes">search_kit_civicrm_entityTypes()</a>
<span>
: void </span>
</dt>
<dd>Implements hook_civicrm_entityTypes().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__getSearchKitDisplayTableName">_getSearchKitDisplayTableName()</a>
<span>
: string </span>
</dt>
<dd>Returns a SQL-safe table name for a display (for use with displays of type "entity")</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__getSearchKitEntityDisplays">_getSearchKitEntityDisplays()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Uncached function to fetch displays of type "entity" to be used by boot-level code</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_cv">cv()</a>
<span>
: string </span>
</dt>
<dd>Call the "cv" command.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__sequentialcreditnotes_civix_civicrm_config">_sequentialcreditnotes_civix_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__sequentialcreditnotes_civix_civicrm_install">_sequentialcreditnotes_civix_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__sequentialcreditnotes_civix_civicrm_enable">_sequentialcreditnotes_civix_civicrm_enable()</a>
<span>
: void </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__sequentialcreditnotes_civix_insert_navigation_menu">_sequentialcreditnotes_civix_insert_navigation_menu()</a>
<span>
: bool </span>
</dt>
<dd>Inserts a navigation menu item at a given place in the hierarchy.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__sequentialcreditnotes_civix_navigationMenu">_sequentialcreditnotes_civix_navigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_navigationMenu().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__sequentialcreditnotes_civix_fixNavigationMenu">_sequentialcreditnotes_civix_fixNavigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>Given a navigation menu, generate navIDs for any items which are
missing them.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__sequentialcreditnotes_civix_fixNavigationMenuItems">_sequentialcreditnotes_civix_fixNavigationMenuItems()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_sequentialcreditnotes_civicrm_pre">sequentialcreditnotes_civicrm_pre()</a>
<span>
: mixed </span>
</dt>
<dd>Add a creditnote_id if appropriate.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_sequentialcreditnotes_create_credit_note_id">sequentialcreditnotes_create_credit_note_id()</a>
<span>
: string </span>
</dt>
<dd>Generate credit note id with next available number</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_cv">cv()</a>
<span>
: string </span>
</dt>
<dd>Call the "cv" command.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__standaloneusers_civix_class_loader">_standaloneusers_civix_class_loader()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__standaloneusers_civix_civicrm_config">_standaloneusers_civix_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__standaloneusers_civix_civicrm_install">_standaloneusers_civix_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__standaloneusers_civix_civicrm_enable">_standaloneusers_civix_civicrm_enable()</a>
<span>
: void </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__standaloneusers_civix_insert_navigation_menu">_standaloneusers_civix_insert_navigation_menu()</a>
<span>
: bool </span>
</dt>
<dd>Inserts a navigation menu item at a given place in the hierarchy.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__standaloneusers_civix_navigationMenu">_standaloneusers_civix_navigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_navigationMenu().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__standaloneusers_civix_fixNavigationMenu">_standaloneusers_civix_fixNavigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>Given a navigation menu, generate navIDs for any items which are
missing them.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__standaloneusers_civix_fixNavigationMenuItems">_standaloneusers_civix_fixNavigationMenuItems()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_standaloneusers_civicrm_alterBundle">standaloneusers_civicrm_alterBundle()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_standaloneusers_civicrm_buildForm">standaloneusers_civicrm_buildForm()</a>
<span>
: mixed </span>
</dt>
<dd>Hide the inherit CMS language on the Settings - Localization form.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_standaloneusers_civicrm_config">standaloneusers_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_standaloneusers_civicrm_install">standaloneusers_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_standaloneusers_civicrm_enable">standaloneusers_civicrm_enable()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_standaloneusers_civicrm_permission">standaloneusers_civicrm_permission()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_permission().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_standaloneusers_civicrm_navigationMenu">standaloneusers_civicrm_navigationMenu()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_cv">cv()</a>
<span>
: mixed </span>
</dt>
<dd>Call the "cv" command.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__tellafriend_civix_civicrm_config">_tellafriend_civix_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__tellafriend_civix_civicrm_install">_tellafriend_civix_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__tellafriend_civix_civicrm_enable">_tellafriend_civix_civicrm_enable()</a>
<span>
: void </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__tellafriend_civix_insert_navigation_menu">_tellafriend_civix_insert_navigation_menu()</a>
<span>
: bool </span>
</dt>
<dd>Inserts a navigation menu item at a given place in the hierarchy.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__tellafriend_civix_navigationMenu">_tellafriend_civix_navigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_navigationMenu().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__tellafriend_civix_fixNavigationMenu">_tellafriend_civix_fixNavigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>Given a navigation menu, generate navIDs for any items which are
missing them.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__tellafriend_civix_fixNavigationMenuItems">_tellafriend_civix_fixNavigationMenuItems()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_tellafriend_civicrm_config">tellafriend_civicrm_config()</a>
<span>
: void </span>
</dt>
<dd>Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_tellafriend_civicrm_install">tellafriend_civicrm_install()</a>
<span>
: void </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_tellafriend_civicrm_enable">tellafriend_civicrm_enable()</a>
<span>
: void </span>
</dt>
<dd>Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_tellafriend_civicrm_tabset">tellafriend_civicrm_tabset()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_tabset().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_tellafriend_civicrm_check">tellafriend_civicrm_check()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_check().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__user_dashboard_civix_civicrm_config">_user_dashboard_civix_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__user_dashboard_civix_civicrm_install">_user_dashboard_civix_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__user_dashboard_civix_civicrm_enable">_user_dashboard_civix_civicrm_enable()</a>
<span>
: void </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__user_dashboard_civix_insert_navigation_menu">_user_dashboard_civix_insert_navigation_menu()</a>
<span>
: bool </span>
</dt>
<dd>Inserts a navigation menu item at a given place in the hierarchy.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__user_dashboard_civix_navigationMenu">_user_dashboard_civix_navigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_navigationMenu().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__user_dashboard_civix_fixNavigationMenu">_user_dashboard_civix_fixNavigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>Given a navigation menu, generate navIDs for any items which are
missing them.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__user_dashboard_civix_fixNavigationMenuItems">_user_dashboard_civix_fixNavigationMenuItems()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_user_dashboard_civicrm_config">user_dashboard_civicrm_config()</a>
<span>
: void </span>
</dt>
<dd>Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_user_dashboard_civicrm_install">user_dashboard_civicrm_install()</a>
<span>
: void </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_user_dashboard_civicrm_enable">user_dashboard_civicrm_enable()</a>
<span>
: void </span>
</dt>
<dd>Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_user_dashboard_civicrm_post">user_dashboard_civicrm_post()</a>
<span>
: mixed </span>
</dt>
<dd>Tag SavedSearches with the "UserDashboard" tag.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_ts">ts()</a>
<span>
: string </span>
</dt>
<dd>Short-named function for string translation, defined in global scope so it's available everywhere.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_makeDAOs">makeDAOs()</a>
<span>
: void </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__corereqadapter_addMessages">_corereqadapter_addMessages()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__backdrop_civisetup_getPublicFiles">_backdrop_civisetup_getPublicFiles()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__backdrop_civisetup_getPrivateFiles">_backdrop_civisetup_getPrivateFiles()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__drupal_civisetup_getPublicFiles">_drupal_civisetup_getPublicFiles()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__drupal_civisetup_getPrivateFiles">_drupal_civisetup_getPrivateFiles()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__drupal8_civisetup_getPublicFiles">_drupal8_civisetup_getPublicFiles()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__drupal8_civisetup_getPrivateFiles">_drupal8_civisetup_getPrivateFiles()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__standalone_setup_scheme">_standalone_setup_scheme()</a>
<span>
: string </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_wordpress_plugin_file">_civicrm_wordpress_plugin_file()</a>
<span>
: string </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_install_set_backdrop_perms">civicrm_install_set_backdrop_perms()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_install_set_drupal_perms">civicrm_install_set_drupal_perms()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_install_set_drupal8_perms">civicrm_install_set_drupal8_perms()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_generateRandomDate">generateRandomDate()</a>
<span>
: string </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_user_access">user_access()</a>
<span>
: bool </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_module_list">module_list()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__shimmy_civix_mixin_polyfill">_shimmy_civix_mixin_polyfill()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__shimmy_civix_civicrm_config">_shimmy_civix_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__shimmy_civix_civicrm_install">_shimmy_civix_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__shimmy_civix_civicrm_postInstall">_shimmy_civix_civicrm_postInstall()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_postInstall().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__shimmy_civix_civicrm_uninstall">_shimmy_civix_civicrm_uninstall()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_uninstall().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__shimmy_civix_civicrm_enable">_shimmy_civix_civicrm_enable()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__shimmy_civix_civicrm_disable">_shimmy_civix_civicrm_disable()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_disable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__shimmy_civix_civicrm_upgrade">_shimmy_civix_civicrm_upgrade()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_upgrade().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__shimmy_civix_upgrader">_shimmy_civix_upgrader()</a>
<span>
: <abbr title="\CRM_Shimmy_Upgrader">CRM_Shimmy_Upgrader</abbr> </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__shimmy_civix_insert_navigation_menu">_shimmy_civix_insert_navigation_menu()</a>
<span>
: bool </span>
</dt>
<dd>Inserts a navigation menu item at a given place in the hierarchy.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__shimmy_civix_navigationMenu">_shimmy_civix_navigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_navigationMenu().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__shimmy_civix_fixNavigationMenu">_shimmy_civix_fixNavigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>Given a navigation menu, generate navIDs for any items which are
missing them.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__shimmy_civix_fixNavigationMenuItems">_shimmy_civix_fixNavigationMenuItems()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__shimmy_civix_civicrm_entityTypes">_shimmy_civix_civicrm_entityTypes()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_entityTypes().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_shimmy_civicrm_config">shimmy_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_shimmy_civicrm_install">shimmy_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_shimmy_civicrm_postInstall">shimmy_civicrm_postInstall()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_postInstall().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_shimmy_civicrm_uninstall">shimmy_civicrm_uninstall()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_uninstall().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_shimmy_civicrm_enable">shimmy_civicrm_enable()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_shimmy_civicrm_disable">shimmy_civicrm_disable()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_disable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_shimmy_civicrm_upgrade">shimmy_civicrm_upgrade()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_upgrade().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_shimmy_civicrm_entityTypes">shimmy_civicrm_entityTypes()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_entityTypes().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__shimmy_assert_service_object">_shimmy_assert_service_object()</a>
<span>
: mixed </span>
</dt>
<dd>Assert that there is a service with a given name+type.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_cv">cv()</a>
<span>
: mixed </span>
</dt>
<dd>Call the "cv" command.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_moduletest_civicrm_install">moduletest_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements civicrm_install</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_moduletest_civicrm_postInstall">moduletest_civicrm_postInstall()</a>
<span>
: mixed </span>
</dt>
<dd>Implements civicrm_postInstall</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_moduletest_civicrm_uninstall">moduletest_civicrm_uninstall()</a>
<span>
: mixed </span>
</dt>
<dd>Implements civicrm_uninstall</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_moduletest_civicrm_enable">moduletest_civicrm_enable()</a>
<span>
: mixed </span>
</dt>
<dd>Implements civicrm_enable</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_moduletest_civicrm_disable">moduletest_civicrm_disable()</a>
<span>
: mixed </span>
</dt>
<dd>Implements civicrm_disable</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_mailing_provider_data_get">civicrm_api3_mailing_provider_data_get()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>MailingProviderData.get API</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__civicrm_api3_mailing_provider_data_get_spec">_civicrm_api3_mailing_provider_data_get_spec()</a>
<span>
: mixed </span>
</dt>
<dd>Metadata for MailingProviderData.get API</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_mailing_provider_data_create">civicrm_api3_mailing_provider_data_create()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>MailingProviderData.create API</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_contact_example_action2">civicrm_api3_contact_example_action2()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_generic_example_action1">civicrm_api3_generic_example_action1()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_generic_example_action2">civicrm_api3_generic_example_action2()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Example result for API Test.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civicrm_api3_test_entity_example_action3">civicrm_api3_test_entity_example_action3()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Example result for API Test.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_civitest_civicrm_scanClasses">civitest_civicrm_scanClasses()</a>
<span>
: void </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__phpunit_mockoloader">_phpunit_mockoloader()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_cv">cv()</a>
<span>
: string </span>
</dt>
<dd>Call the "cv" command.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_hooktesta_civicrm_testRunHooks_outer">hooktesta_civicrm_testRunHooks_outer()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_testRunHooks_outer().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_hooktestb_civicrm_testRunHooks_outer">hooktestb_civicrm_testRunHooks_outer()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_hooktestc_civicrm_testRunHooks_outer">hooktestc_civicrm_testRunHooks_outer()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_hooktesta_civicrm_testRunHooks_inner">hooktesta_civicrm_testRunHooks_inner()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_hooktestb_civicrm_testRunHooks_inner">hooktestb_civicrm_testRunHooks_inner()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_hooktesta_civicrm_testRunHooks_merge">hooktesta_civicrm_testRunHooks_merge()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_hooktestc_civicrm_testRunHooks_merge">hooktestc_civicrm_testRunHooks_merge()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_testRunHooks_merge().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_hooktestd_civicrm_testRunHooks_merge">hooktestd_civicrm_testRunHooks_merge()</a>
<span>
: null </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_hookteste_civicrm_testRunHooks_merge">hookteste_civicrm_testRunHooks_merge()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_updateFile">updateFile()</a>
<span>
: mixed </span>
</dt>
<dd>Update the content of a file.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_updateXmlFile">updateXmlFile()</a>
<span>
: mixed </span>
</dt>
<dd>Update the content of an XML file</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_initFile">initFile()</a>
<span>
: mixed </span>
</dt>
<dd>Initialize a file (if it doesn't already exist).</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_makeVerName">makeVerName()</a>
<span>
: string </span>
</dt>
<dd>Render a pretty string for a major/minor version number.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_isVersionValid">isVersionValid()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_fatal">fatal()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_parseArgs">parseArgs()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__event_check_civix_civicrm_config">_event_check_civix_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__event_check_civix_civicrm_install">_event_check_civix_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__event_check_civix_civicrm_enable">_event_check_civix_civicrm_enable()</a>
<span>
: void </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__event_check_civix_insert_navigation_menu">_event_check_civix_insert_navigation_menu()</a>
<span>
: bool </span>
</dt>
<dd>Inserts a navigation menu item at a given place in the hierarchy.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__event_check_civix_navigationMenu">_event_check_civix_navigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_navigationMenu().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__event_check_civix_fixNavigationMenu">_event_check_civix_fixNavigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>Given a navigation menu, generate navIDs for any items which are
missing them.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__event_check_civix_fixNavigationMenuItems">_event_check_civix_fixNavigationMenuItems()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_event_check_civicrm_config">event_check_civicrm_config()</a>
<span>
: void </span>
</dt>
<dd>Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__demoqueue_civix_civicrm_config">_demoqueue_civix_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implementation of hook_civicrm_config</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__demoqueue_civix_civicrm_xmlMenu">_demoqueue_civix_civicrm_xmlMenu()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implementation of hook_civicrm_xmlMenu</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_demoqueue_civicrm_config">demoqueue_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>Implementation of hook_civicrm_config</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_demoqueue_civicrm_xmlMenu">demoqueue_civicrm_xmlMenu()</a>
<span>
: mixed </span>
</dt>
<dd>Implementation of hook_civicrm_xmlMenu</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__phpstorm_civix_civicrm_config">_phpstorm_civix_civicrm_config()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__phpstorm_civix_civicrm_install">_phpstorm_civix_civicrm_install()</a>
<span>
: mixed </span>
</dt>
<dd>Implements hook_civicrm_install().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__phpstorm_civix_civicrm_enable">_phpstorm_civix_civicrm_enable()</a>
<span>
: void </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_enable().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__phpstorm_civix_insert_navigation_menu">_phpstorm_civix_insert_navigation_menu()</a>
<span>
: bool </span>
</dt>
<dd>Inserts a navigation menu item at a given place in the hierarchy.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__phpstorm_civix_navigationMenu">_phpstorm_civix_navigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>(Delegated) Implements hook_civicrm_navigationMenu().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__phpstorm_civix_fixNavigationMenu">_phpstorm_civix_fixNavigationMenu()</a>
<span>
: mixed </span>
</dt>
<dd>Given a navigation menu, generate navIDs for any items which are
missing them.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__phpstorm_civix_fixNavigationMenuItems">_phpstorm_civix_fixNavigationMenuItems()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_phpstorm_metadata_dir">phpstorm_metadata_dir()</a>
<span>
: string </span>
</dt>
<dd>Determine the folder where we will store PhpStorm metadata files.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__phpstorm_metadata_dirs">_phpstorm_metadata_dirs()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_phpstorm_civicrm_config">phpstorm_civicrm_config()</a>
<span>
: void </span>
</dt>
<dd>Implements hook_civicrm_config().</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_phpstorm_civicrm_container">phpstorm_civicrm_container()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_phpstorm_civicrm_managed">phpstorm_civicrm_managed()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_phpstorm_civicrm_enable">phpstorm_civicrm_enable()</a>
<span>
: void </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_phpstorm_civicrm_uninstall">phpstorm_civicrm_uninstall()</a>
<span>
: void </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function__phpstorm_cleanup">_phpstorm_cleanup()</a>
<span>
: void </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_compareFile">compareFile()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_parseLog">parseLog()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_splitContactIDs">splitContactIDs()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Split a large array of contactIDs into more manageable smaller chunks</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_generateSolrJSON">generateSolrJSON()</a>
<span>
: string </span>
</dt>
<dd>Given an array of values, generate the JSON in the Solr format</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_escapeJsonString">escapeJsonString()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_getValues">getValues()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Given a set of contact IDs get the values</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_getTableInfo">getTableInfo()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_getContactInfo">getContactInfo()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_getNoteInfo">getNoteInfo()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_getPhoneInfo">getPhoneInfo()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_getEmailInfo">getEmailInfo()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_getAddressInfo">getAddressInfo()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_appendValue">appendValue()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_run">run()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_splitContactIDs">splitContactIDs()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Split a large array of contactIDs into more manageable smaller chunks</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_generateSolrXML">generateSolrXML()</a>
<span>
: string </span>
</dt>
<dd>Given an array of values, generate the XML in the Solr format</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_getValues">getValues()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Given a set of contact IDs get the values</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_getTableInfo">getTableInfo()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_getContactInfo">getContactInfo()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_getLocationInfo">getLocationInfo()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_run">run()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_splitContactIDs">splitContactIDs()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Split a large array of contactIDs into more manageable smaller chunks</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_getValues">getValues()</a>
<span>
: array<string|int, mixed> </span>
</dt>
<dd>Given a set of contact IDs get the values</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_getTableInfo">getTableInfo()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_getContactInfo">getContactInfo()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_getNoteInfo">getNoteInfo()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_getPhoneInfo">getPhoneInfo()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_getEmailInfo">getEmailInfo()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_getAddressInfo">getAddressInfo()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_getRelationshipInfo">getRelationshipInfo()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_getActivityInfo">getActivityInfo()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_appendValue">appendValue()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_getDBFields">getDBFields()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_addAdditionalContacts">addAdditionalContacts()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_run">run()</a>
<span>
: mixed </span>
</dt>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a class="" href="namespaces/default.html#function_smarty_block_ts">smarty_block_ts()</a>
<span>
: string </span>
</dt>
</dl>
<section class="phpdocumentor-constants">
<h3 class="phpdocumentor-elements__header" id="constants">
Constants
<a href="namespaces/default.html#constants" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant__CIVICRM_FAKE_SESSION">
_CIVICRM_FAKE_SESSION
<a href="namespaces/default.html#constant__CIVICRM_FAKE_SESSION" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Session.php"><a href="files/crm-core-session.html"><abbr title="CRM/Core/Session.php">Session.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">110</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">_CIVICRM_FAKE_SESSION</span>
= <span class="phpdocumentor-signature__default-value">TRUE</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant__JEXEC">
_JEXEC
<a href="namespaces/default.html#constant__JEXEC" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Utils/System/Joomla.php"><a href="files/crm-utils-system-joomla.html"><abbr title="CRM/Utils/System/Joomla.php">Joomla.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">607</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">_JEXEC</span>
= <span class="phpdocumentor-signature__default-value">1</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_AFFORM_HTML_MONACO">
AFFORM_HTML_MONACO
<a href="namespaces/default.html#constant_AFFORM_HTML_MONACO" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/html/afform_html.php"><a href="files/ext-afform-html-afform-html.html"><abbr title="ext/afform/html/afform_html.php">afform_html.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">7</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">AFFORM_HTML_MONACO</span>
= <span class="phpdocumentor-signature__default-value">'bower_components/monaco-editor/min/vs'</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_API_LATEST_VERSION">
API_LATEST_VERSION
<a href="namespaces/default.html#constant_API_LATEST_VERSION" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tests/phpunit/CiviTest/CiviUnitTestCase.php"><a href="files/tests-phpunit-civitest-civiunittestcase.html"><abbr title="tests/phpunit/CiviTest/CiviUnitTestCase.php">CiviUnitTestCase.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">65</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">API_LATEST_VERSION</span>
= <span class="phpdocumentor-signature__default-value">3</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_API_V3_EXTENSION_DELIMITER">
API_V3_EXTENSION_DELIMITER
<a href="namespaces/default.html#constant_API_V3_EXTENSION_DELIMITER" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Extension.php"><a href="files/api-v3-extension.html"><abbr title="api/v3/Extension.php">Extension.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">12</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">API_V3_EXTENSION_DELIMITER</span>
= <span class="phpdocumentor-signature__default-value">','</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_BACKDROP_ROOT">
BACKDROP_ROOT
<a href="namespaces/default.html#constant_BACKDROP_ROOT" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Utils/System/Backdrop.php"><a href="files/crm-utils-system-backdrop.html"><abbr title="CRM/Utils/System/Backdrop.php">Backdrop.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">566</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">BACKDROP_ROOT</span>
= <span class="phpdocumentor-signature__default-value">$cmsPath</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_BACKDROP_ROOT">
BACKDROP_ROOT
<a href="namespaces/default.html#constant_BACKDROP_ROOT" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/iframe/Civi/Iframe/EntryPoint/Backdrop.php"><a href="files/ext-iframe-civi-iframe-entrypoint-backdrop.html"><abbr title="ext/iframe/Civi/Iframe/EntryPoint/Backdrop.php">Backdrop.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">15</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">BACKDROP_ROOT</span>
= <span class="phpdocumentor-signature__default-value">getcwd()</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_BLOCK_CACHE_GLOBAL">
BLOCK_CACHE_GLOBAL
<a href="namespaces/default.html#constant_BLOCK_CACHE_GLOBAL" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Block.php"><a href="files/crm-core-block.html"><abbr title="CRM/Core/Block.php">Block.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">56</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">BLOCK_CACHE_GLOBAL</span>
= <span class="phpdocumentor-signature__default-value">0x8</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_BLOCK_CACHE_PER_PAGE">
BLOCK_CACHE_PER_PAGE
<a href="namespaces/default.html#constant_BLOCK_CACHE_PER_PAGE" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Block.php"><a href="files/crm-core-block.html"><abbr title="CRM/Core/Block.php">Block.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">60</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">BLOCK_CACHE_PER_PAGE</span>
= <span class="phpdocumentor-signature__default-value">0x4</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_BLOCK_NO_CACHE">
BLOCK_NO_CACHE
<a href="namespaces/default.html#constant_BLOCK_NO_CACHE" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Block.php"><a href="files/crm-core-block.html"><abbr title="CRM/Core/Block.php">Block.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">64</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">BLOCK_NO_CACHE</span>
= <span class="phpdocumentor-signature__default-value">-1</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_CHUNK_SIZE">
CHUNK_SIZE
<a href="namespaces/default.html#constant_CHUNK_SIZE" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/scripts/solr/createSolrJSON.php"><a href="files/tools-scripts-solr-createsolrjson.html"><abbr title="tools/scripts/solr/createSolrJSON.php">createSolrJSON.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">20</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">CHUNK_SIZE</span>
= <span class="phpdocumentor-signature__default-value">128</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_CHUNK_SIZE">
CHUNK_SIZE
<a href="namespaces/default.html#constant_CHUNK_SIZE" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/scripts/solr/createSolrXML.php"><a href="files/tools-scripts-solr-createsolrxml.html"><abbr title="tools/scripts/solr/createSolrXML.php">createSolrXML.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">20</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">CHUNK_SIZE</span>
= <span class="phpdocumentor-signature__default-value">128</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_CHUNK_SIZE">
CHUNK_SIZE
<a href="namespaces/default.html#constant_CHUNK_SIZE" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/scripts/solr/createSyncJSON.php"><a href="files/tools-scripts-solr-createsyncjson.html"><abbr title="tools/scripts/solr/createSyncJSON.php">createSyncJSON.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">20</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">CHUNK_SIZE</span>
= <span class="phpdocumentor-signature__default-value">128</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_CIVI_SETUP">
CIVI_SETUP
<a href="namespaces/default.html#constant_CIVI_SETUP" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="setup/src/Setup.php"><a href="files/setup-src-setup.html"><abbr title="setup/src/Setup.php">Setup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">68</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">CIVI_SETUP</span>
= <span class="phpdocumentor-signature__default-value">1</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_CIVICRM_CONTAINER_CACHE">
CIVICRM_CONTAINER_CACHE
<a href="namespaces/default.html#constant_CIVICRM_CONTAINER_CACHE" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/flexmailer/tests/phpunit/bootstrap.php"><a href="files/ext-flexmailer-tests-phpunit-bootstrap.html"><abbr title="ext/flexmailer/tests/phpunit/bootstrap.php">bootstrap.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">10</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">CIVICRM_CONTAINER_CACHE</span>
= <span class="phpdocumentor-signature__default-value">'never'</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_CIVICRM_DSN">
CIVICRM_DSN
<a href="namespaces/default.html#constant_CIVICRM_DSN" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="Civi/Core/SettingsManager.php"><a href="files/civi-core-settingsmanager.html"><abbr title="Civi/Core/SettingsManager.php">SettingsManager.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">467</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">CIVICRM_DSN</span>
= <span class="phpdocumentor-signature__default-value">$composedDsn</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_CIVICRM_HIBP_URL">
CIVICRM_HIBP_URL
<a href="namespaces/default.html#constant_CIVICRM_HIBP_URL" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/standaloneusers/standaloneusers.php"><a href="files/ext-standaloneusers-standaloneusers.html"><abbr title="ext/standaloneusers/standaloneusers.php">standaloneusers.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">5</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">CIVICRM_HIBP_URL</span>
= <span class="phpdocumentor-signature__default-value">'https://api.pwnedpasswords.com/range/'</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_CIVICRM_IFRAME">
CIVICRM_IFRAME
<a href="namespaces/default.html#constant_CIVICRM_IFRAME" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/iframe/Civi/Iframe/EntryPoint/Backdrop.php"><a href="files/ext-iframe-civi-iframe-entrypoint-backdrop.html"><abbr title="ext/iframe/Civi/Iframe/EntryPoint/Backdrop.php">Backdrop.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">14</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">CIVICRM_IFRAME</span>
= <span class="phpdocumentor-signature__default-value">1</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_CIVICRM_IFRAME">
CIVICRM_IFRAME
<a href="namespaces/default.html#constant_CIVICRM_IFRAME" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/iframe/Civi/Iframe/EntryPoint/Drupal.php"><a href="files/ext-iframe-civi-iframe-entrypoint-drupal.html"><abbr title="ext/iframe/Civi/Iframe/EntryPoint/Drupal.php">Drupal.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">14</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">CIVICRM_IFRAME</span>
= <span class="phpdocumentor-signature__default-value">1</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_CIVICRM_IFRAME">
CIVICRM_IFRAME
<a href="namespaces/default.html#constant_CIVICRM_IFRAME" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/iframe/Civi/Iframe/EntryPoint/Drupal8.php"><a href="files/ext-iframe-civi-iframe-entrypoint-drupal8.html"><abbr title="ext/iframe/Civi/Iframe/EntryPoint/Drupal8.php">Drupal8.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">17</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">CIVICRM_IFRAME</span>
= <span class="phpdocumentor-signature__default-value">1</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_CIVICRM_L10N_BASEDIR">
CIVICRM_L10N_BASEDIR
<a href="namespaces/default.html#constant_CIVICRM_L10N_BASEDIR" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="mixin/entity-types-php@1/example/make-dao.php"><a href="files/mixin-entity-types-php-1-example-make-dao.html"><abbr title="mixin/entity-types-php@1/example/make-dao.php">make-dao.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">18</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">CIVICRM_L10N_BASEDIR</span>
= <span class="phpdocumentor-signature__default-value">\getenv('CIVICRM_L10N_BASEDIR') ? \getenv('CIVICRM_L10N_BASEDIR') : (__DIR__ . '/../l10n')</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_CIVICRM_L10N_BASEDIR">
CIVICRM_L10N_BASEDIR
<a href="namespaces/default.html#constant_CIVICRM_L10N_BASEDIR" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="xml/GenCode.php"><a href="files/xml-gencode.html"><abbr title="xml/GenCode.php">GenCode.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">31</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">CIVICRM_L10N_BASEDIR</span>
= <span class="phpdocumentor-signature__default-value">\getenv('CIVICRM_L10N_BASEDIR') ? \getenv('CIVICRM_L10N_BASEDIR') : (__DIR__ . '/../l10n')</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_CIVICRM_SETTINGS_PATH">
CIVICRM_SETTINGS_PATH
<a href="namespaces/default.html#constant_CIVICRM_SETTINGS_PATH" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/class.api.php"><a href="files/api-class-api.html"><abbr title="api/class.api.php">class.api.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">212</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">CIVICRM_SETTINGS_PATH</span>
= <span class="phpdocumentor-signature__default-value">$config['conf_path'] . '/civicrm.settings.php'</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_CIVICRM_SETTINGS_PATH">
CIVICRM_SETTINGS_PATH
<a href="namespaces/default.html#constant_CIVICRM_SETTINGS_PATH" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="Civi/Core/SettingsManager.php"><a href="files/civi-core-settingsmanager.html"><abbr title="Civi/Core/SettingsManager.php">SettingsManager.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">473</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">CIVICRM_SETTINGS_PATH</span>
= <span class="phpdocumentor-signature__default-value">$settingsPath</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_CIVICRM_TEMPLATE_COMPILEDIR">
CIVICRM_TEMPLATE_COMPILEDIR
<a href="namespaces/default.html#constant_CIVICRM_TEMPLATE_COMPILEDIR" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="setup/src/Setup/UI/SetupController.php"><a href="files/setup-src-setup-ui-setupcontroller.html"><abbr title="setup/src/Setup/UI/SetupController.php">SetupController.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">131</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">CIVICRM_TEMPLATE_COMPILEDIR</span>
= <span class="phpdocumentor-signature__default-value">$model->templateCompilePath</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_CIVICRM_TEST">
CIVICRM_TEST
<a href="namespaces/default.html#constant_CIVICRM_TEST" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/flexmailer/tests/phpunit/bootstrap.php"><a href="files/ext-flexmailer-tests-phpunit-bootstrap.html"><abbr title="ext/flexmailer/tests/phpunit/bootstrap.php">bootstrap.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">11</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">CIVICRM_TEST</span>
= <span class="phpdocumentor-signature__default-value">1</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_CIVICRM_TEST">
CIVICRM_TEST
<a href="namespaces/default.html#constant_CIVICRM_TEST" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/oauth-client/tests/phpunit/bootstrap.php"><a href="files/ext-oauth-client-tests-phpunit-bootstrap.html"><abbr title="ext/oauth-client/tests/phpunit/bootstrap.php">bootstrap.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">4</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">CIVICRM_TEST</span>
= <span class="phpdocumentor-signature__default-value">1</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_CIVICRM_TEST">
CIVICRM_TEST
<a href="namespaces/default.html#constant_CIVICRM_TEST" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tests/phpunit/CiviTest/bootstrap.php"><a href="files/tests-phpunit-civitest-bootstrap.html"><abbr title="tests/phpunit/CiviTest/bootstrap.php">bootstrap.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">28</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">CIVICRM_TEST</span>
= <span class="phpdocumentor-signature__default-value">1</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_CIVICRM_UF">
CIVICRM_UF
<a href="namespaces/default.html#constant_CIVICRM_UF" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="distmaker/utils/joomlaxml.php"><a href="files/distmaker-utils-joomlaxml.html"><abbr title="distmaker/utils/joomlaxml.php">joomlaxml.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">12</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">CIVICRM_UF</span>
= <span class="phpdocumentor-signature__default-value">'Joomla'</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_CIVICRM_UF">
CIVICRM_UF
<a href="namespaces/default.html#constant_CIVICRM_UF" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="mixin/entity-types-php@1/example/make-dao.php"><a href="files/mixin-entity-types-php-1-example-make-dao.html"><abbr title="mixin/entity-types-php@1/example/make-dao.php">make-dao.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">16</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">CIVICRM_UF</span>
= <span class="phpdocumentor-signature__default-value">'Drupal'</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_CIVICRM_UF">
CIVICRM_UF
<a href="namespaces/default.html#constant_CIVICRM_UF" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="setup/src/Setup/UI/SetupController.php"><a href="files/setup-src-setup-ui-setupcontroller.html"><abbr title="setup/src/Setup/UI/SetupController.php">SetupController.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">130</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">CIVICRM_UF</span>
= <span class="phpdocumentor-signature__default-value">$model->cms</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_CIVICRM_UF">
CIVICRM_UF
<a href="namespaces/default.html#constant_CIVICRM_UF" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="xml/GenCode.php"><a href="files/xml-gencode.html"><abbr title="xml/GenCode.php">GenCode.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">29</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">CIVICRM_UF</span>
= <span class="phpdocumentor-signature__default-value">'Drupal'</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_CIVICRM_UF_BASEURL">
CIVICRM_UF_BASEURL
<a href="namespaces/default.html#constant_CIVICRM_UF_BASEURL" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="mixin/entity-types-php@1/example/make-dao.php"><a href="files/mixin-entity-types-php-1-example-make-dao.html"><abbr title="mixin/entity-types-php@1/example/make-dao.php">make-dao.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">17</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">CIVICRM_UF_BASEURL</span>
= <span class="phpdocumentor-signature__default-value">'/'</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_CIVICRM_UF_BASEURL">
CIVICRM_UF_BASEURL
<a href="namespaces/default.html#constant_CIVICRM_UF_BASEURL" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="setup/src/Setup/UI/SetupController.php"><a href="files/setup-src-setup-ui-setupcontroller.html"><abbr title="setup/src/Setup/UI/SetupController.php">SetupController.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">132</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">CIVICRM_UF_BASEURL</span>
= <span class="phpdocumentor-signature__default-value">$model->cmsBaseUrl</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_CIVICRM_UF_BASEURL">
CIVICRM_UF_BASEURL
<a href="namespaces/default.html#constant_CIVICRM_UF_BASEURL" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="xml/GenCode.php"><a href="files/xml-gencode.html"><abbr title="xml/GenCode.php">GenCode.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">30</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">CIVICRM_UF_BASEURL</span>
= <span class="phpdocumentor-signature__default-value">'/'</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_DB_DSN_MODE">
DB_DSN_MODE
<a href="namespaces/default.html#constant_DB_DSN_MODE" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/DAO.php"><a href="files/crm-core-dao.html"><abbr title="CRM/Core/DAO.php">DAO.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">25</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">DB_DSN_MODE</span>
= <span class="phpdocumentor-signature__default-value">'auto'</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_DRUPAL_ROOT">
DRUPAL_ROOT
<a href="namespaces/default.html#constant_DRUPAL_ROOT" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Utils/System/Drupal.php"><a href="files/crm-utils-system-drupal.html"><abbr title="CRM/Utils/System/Drupal.php">Drupal.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">479</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">DRUPAL_ROOT</span>
= <span class="phpdocumentor-signature__default-value">$cmsPath</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_DRUPAL_ROOT">
DRUPAL_ROOT
<a href="namespaces/default.html#constant_DRUPAL_ROOT" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/iframe/Civi/Iframe/EntryPoint/Drupal.php"><a href="files/ext-iframe-civi-iframe-entrypoint-drupal.html"><abbr title="ext/iframe/Civi/Iframe/EntryPoint/Drupal.php">Drupal.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">15</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">DRUPAL_ROOT</span>
= <span class="phpdocumentor-signature__default-value">getcwd()</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_DS">
DS
<a href="namespaces/default.html#constant_DS" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Utils/System/Joomla.php"><a href="files/crm-utils-system-joomla.html"><abbr title="CRM/Utils/System/Joomla.php">Joomla.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">608</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">DS</span>
= <span class="phpdocumentor-signature__default-value">DIRECTORY_SEPARATOR</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_JDEBUG">
JDEBUG
<a href="namespaces/default.html#constant_JDEBUG" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Utils/System/Joomla.php"><a href="files/crm-utils-system-joomla.html"><abbr title="CRM/Utils/System/Joomla.php">Joomla.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">647</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">JDEBUG</span>
= <span class="phpdocumentor-signature__default-value">FALSE</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_JPATH_BASE">
JPATH_BASE
<a href="namespaces/default.html#constant_JPATH_BASE" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Utils/System/Joomla.php"><a href="files/crm-utils-system-joomla.html"><abbr title="CRM/Utils/System/Joomla.php">Joomla.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">609</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">JPATH_BASE</span>
= <span class="phpdocumentor-signature__default-value">$joomlaBase . DS . 'administrator'</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_JVERSION">
JVERSION
<a href="namespaces/default.html#constant_JVERSION" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Utils/System/Joomla.php"><a href="files/crm-utils-system-joomla.html"><abbr title="CRM/Utils/System/Joomla.php">Joomla.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">572</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">JVERSION</span>
= <span class="phpdocumentor-signature__default-value">$jversion->getShortVersion()</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_MAIL_BATCH_SIZE">
MAIL_BATCH_SIZE
<a href="namespaces/default.html#constant_MAIL_BATCH_SIZE" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Utils/Mail/EmailProcessor.php"><a href="files/crm-utils-mail-emailprocessor.html"><abbr title="CRM/Utils/Mail/EmailProcessor.php">EmailProcessor.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">21</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">MAIL_BATCH_SIZE</span>
= <span class="phpdocumentor-signature__default-value">50</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_RECAPTCHA_API_SECURE_SERVER">
RECAPTCHA_API_SECURE_SERVER
<a href="namespaces/default.html#constant_RECAPTCHA_API_SECURE_SERVER" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/recaptcha/lib/recaptcha/recaptchalib.php"><a href="files/ext-recaptcha-lib-recaptcha-recaptchalib.html"><abbr title="ext/recaptcha/lib/recaptcha/recaptchalib.php">recaptchalib.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">39</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">RECAPTCHA_API_SECURE_SERVER</span>
= <span class="phpdocumentor-signature__default-value">"https://www.google.com/recaptcha/api.js"</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_RECAPTCHA_API_SERVER">
RECAPTCHA_API_SERVER
<a href="namespaces/default.html#constant_RECAPTCHA_API_SERVER" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/recaptcha/lib/recaptcha/recaptchalib.php"><a href="files/ext-recaptcha-lib-recaptcha-recaptchalib.html"><abbr title="ext/recaptcha/lib/recaptcha/recaptchalib.php">recaptchalib.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">38</span>
</aside>
<p class="phpdocumentor-summary">The reCAPTCHA server URL's</p>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">RECAPTCHA_API_SERVER</span>
= <span class="phpdocumentor-signature__default-value">"http://www.google.com/recaptcha/api.js"</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_RECAPTCHA_VERIFY_SERVER">
RECAPTCHA_VERIFY_SERVER
<a href="namespaces/default.html#constant_RECAPTCHA_VERIFY_SERVER" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/recaptcha/lib/recaptcha/recaptchalib.php"><a href="files/ext-recaptcha-lib-recaptcha-recaptchalib.html"><abbr title="ext/recaptcha/lib/recaptcha/recaptchalib.php">recaptchalib.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">40</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">RECAPTCHA_VERIFY_SERVER</span>
= <span class="phpdocumentor-signature__default-value">"https://www.google.com"</span>
</code>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_WP_USE_THEMES">
WP_USE_THEMES
<a href="namespaces/default.html#constant_WP_USE_THEMES" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Utils/System/WordPress.php"><a href="files/crm-utils-system-wordpress.html"><abbr title="CRM/Utils/System/WordPress.php">WordPress.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">709</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">WP_USE_THEMES</span>
= <span class="phpdocumentor-signature__default-value">FALSE</span>
</code>
</article>
</section>
<section class="phpdocumentor-functions">
<h3 class="phpdocumentor-elements__header" id="functions">
Functions
<a href="namespaces/default.html#functions" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article class="phpdocumentor-element -function - -deprecated">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api">
civicrm_api()
<a href="namespaces/default.html#function_civicrm_api" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/api.php"><a href="files/api-api.html"><abbr title="api/api.php">api.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">27</span>
</aside>
<p class="phpdocumentor-summary">The original API wrapper.</p>
<div class="phpdocumentor-admonition">
<svg class="phpdocumentor-admonition__icon" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-3L13.732 4c-.77-1.333-2.694-1.333-3.464 0L3.34 16c-.77 1.333.192 3 1.732 3z"></path></svg>
<article>
<p>Not recommended for new code but ok for existing code to continue using.</p>
<p>Calling <code class="prettyprint">civicrm_api()</code> is functionally identical to <code class="prettyprint">civicrm_api3()</code> or <code class="prettyprint">civicrm_api4()</code> except:</p>
<ol>
<li>It requires <code class="prettyprint">$params['version']</code>.</li>
<li>It catches exceptions and returns an array like <code class="prettyprint">['is_error' => 1, 'error_message' => ...]</code>.
This is disfavored for typical business-logic/hooks/forms/etc.
However, if an existing caller handles <code class="prettyprint">civicrm_api()</code>-style errors, then there is no functional benefit to reworking it.</li>
</ol>
</article>
</div>
<code class="phpdocumentor-code phpdocumentor-signature -deprecated">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$entity</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$action</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed>|int|<a href="classes/Civi-Api4-Generic-Result.html"><abbr title="\Civi\Api4\Generic\Result">Result</abbr></a></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entity</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$action</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed>|int|<a href="classes/Civi-Api4-Generic-Result.html"><abbr title="\Civi\Api4\Generic\Result">Result</abbr></a></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api4">
civicrm_api4()
<a href="namespaces/default.html#function_civicrm_api4" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/api.php"><a href="files/api-api.html"><abbr title="api/api.php">api.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">79</span>
</aside>
<p class="phpdocumentor-summary">CiviCRM API version 4.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api4</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$entity</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$action</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string|int|array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$index</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/Civi-Api4-Generic-Result.html"><abbr title="\Civi\Api4\Generic\Result">Result</abbr></a></span></code>
<section class="phpdocumentor-description"><p>This API (Application Programming Interface) is used to access and manage data in CiviCRM.</p>
<p>APIv4 is the latest stable version.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entity</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Name of the CiviCRM entity to access.
All entity names are capitalized CamelCase, e.g. <code class="prettyprint">ContributionPage</code>.
Most entities correspond to a database table (e.g. <code class="prettyprint">Contact</code> is the table <code class="prettyprint">civicrm_contact</code>).
For a complete list of available entities, call <code class="prettyprint">civicrm_api4('Entity', 'get');</code></p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$action</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The "verb" of the api call.
For a complete list of actions for a given entity (e.g. <code class="prettyprint">Contact</code>), call <code class="prettyprint">civicrm_api4('Contact', 'getActions');</code></p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
= <span class="phpdocumentor-signature__argument__default-value">[]</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>An array of API input keyed by parameter name.
The easiest way to discover all available parameters is to visit the API Explorer on your CiviCRM site.
The API Explorer is listed in the CiviCRM menu under Support -> Developer.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$index</span>
: <span class="phpdocumentor-signature__argument__return-type">string|int|array<string|int, mixed></span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Controls the Result array format.
By default the api Result contains a non-associative array of data. Passing an $index tells the api to
automatically reformat the array, depending on the variable type passed:</p>
<ul>
<li>
<p><strong>Integer:</strong> return a single result array;
e.g. <code class="prettyprint">$index = 0</code> will return the first result, 1 will return the second, and -1 will return the last.</p>
<p>For APIv4 Explorer, use e.g. <code class="prettyprint">0</code> in the Index box.</p>
</li>
<li>
<p><strong>String:</strong> index the results by a field value;
e.g. <code class="prettyprint">$index = "name"</code> will return an associative array with the field 'name' as keys.</p>
<p>For APIv4 Explorer, use e.g. <code class="prettyprint">name</code> in the Index box.</p>
</li>
<li>
<p><strong>Non-associative array:</strong> return a single value from each result;
e.g. <code class="prettyprint">$index = ['title']</code> will return a non-associative array of strings - the 'title' field from each result.</p>
<p>For APIv4 Explorer, use e.g. <code class="prettyprint">[title]</code> in the Index box.</p>
</li>
<li>
<p><strong>Associative array:</strong> a combination of the previous two modes;
e.g. <code class="prettyprint">$index = ['name' => 'title']</code> will return an array of strings - the 'title' field keyed by the 'name' field.</p>
<p>For APIv4 Explorer, use e.g. <code class="prettyprint">{name: title}</code> in the Index box.</p>
</li>
</ul>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api4#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="https://docs.civicrm.org/dev/en/latest/api/v4/usage/">https://docs.civicrm.org/dev/en/latest/api/v4/usage/</a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/Civi-API-Exception-NotImplementedException.html"><abbr title="\Civi\API\Exception\NotImplementedException">NotImplementedException</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/Civi-Api4-Generic-Result.html"><abbr title="\Civi\Api4\Generic\Result">Result</abbr></a></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3">
civicrm_api3()
<a href="namespaces/default.html#function_civicrm_api3" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/api.php"><a href="files/api-api.html"><abbr title="api/api.php">api.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">145</span>
</aside>
<p class="phpdocumentor-summary">Version 3 wrapper for civicrm_api.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$entity</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$action</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed>|int</span></code>
<section class="phpdocumentor-description"><p>Throws exception.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entity</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$action</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
= <span class="phpdocumentor-signature__argument__default-value">[]</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed>|int</span>
—
<section class="phpdocumentor-description"><p>Dependent on the $action</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_api_getfields">
_civicrm_api3_api_getfields()
<a href="namespaces/default.html#function__civicrm_api3_api_getfields" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/api.php"><a href="files/api-api.html"><abbr title="api/api.php">api.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">172</span>
</aside>
<p class="phpdocumentor-summary">Call getfields from api wrapper.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_api_getfields</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$apiRequest</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>This function ensures that settings that
could alter getfields output (e.g. action for all api & profile_id for
profile api ) are consistently passed in.</p>
<p>We check whether the api call is 'getfields' because if getfields is
being called we return an empty array as no alias swapping, validation or
default filling is done on getfields & we want to avoid a loop</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$apiRequest</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_api_getfields#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>other output modifiers include contact_type</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>getfields output</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_error">
civicrm_error()
<a href="namespaces/default.html#function_civicrm_error" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/api.php"><a href="files/api-api.html"><abbr title="api/api.php">api.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">198</span>
</aside>
<p class="phpdocumentor-summary">Check if the result is an error. Note that this function has been retained from
api v2 for convenience but the result is more standardised in v3 and param
'format.is_success' => 1
will result in a boolean success /fail being returned if that is what you need.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_error</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$result</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$result</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
—
<section class="phpdocumentor-description"><p>true if error, false otherwise</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api_get_camel_name">
_civicrm_api_get_camel_name()
<a href="namespaces/default.html#function__civicrm_api_get_camel_name" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/api.php"><a href="files/api-api.html"><abbr title="api/api.php">api.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">209</span>
</aside>
<p class="phpdocumentor-summary">Get camel case version of entity name.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api_get_camel_name</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string|null </span><span class="phpdocumentor-signature__argument__name">$entity</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string|null</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entity</span>
: <span class="phpdocumentor-signature__argument__return-type">string|null</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string|null</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api_replace_variables">
_civicrm_api_replace_variables()
<a href="namespaces/default.html#function__civicrm_api_replace_variables" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/api.php"><a href="files/api-api.html"><abbr title="api/api.php">api.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">225</span>
</aside>
<p class="phpdocumentor-summary">Swap out any $values vars.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api_replace_variables</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$parentResult</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$separator</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">'.'</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>Ie. the value after $value is swapped for the parent $result
'activity_type_id' => '$value.testfield',
'tag_id' => '$value.api.tag.create.id',
'tag1_id' => '$value.api.entity.create.0.id'</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$parentResult</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$separator</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">'.'</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api_replace_variable">
_civicrm_api_replace_variable()
<a href="namespaces/default.html#function__civicrm_api_replace_variable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/api.php"><a href="files/api-api.html"><abbr title="api/api.php">api.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">256</span>
</aside>
<p class="phpdocumentor-summary">Swap out a $value.foo variable with the value from parent api results.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api_replace_variable</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$value</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$parentResult</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$separator</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed|null</span></code>
<section class="phpdocumentor-description"><p>Called by _civicrm_api_replace_variables to do the substitution.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$value</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$parentResult</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$separator</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed|null</span>
</section>
</article>
<article class="phpdocumentor-element -function - -deprecated">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api_get_entity_name_from_camel">
_civicrm_api_get_entity_name_from_camel()
<a href="namespaces/default.html#function__civicrm_api_get_entity_name_from_camel" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/api.php"><a href="files/api-api.html"><abbr title="api/api.php">api.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">299</span>
</aside>
<p class="phpdocumentor-summary">Convert possibly camel name to underscore separated entity name.</p>
<div class="phpdocumentor-admonition">
<svg class="phpdocumentor-admonition__icon" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-3L13.732 4c-.77-1.333-2.694-1.333-3.464 0L3.34 16c-.77 1.333.192 3 1.732 3z"></path></svg>
<article>
</article>
</div>
<code class="phpdocumentor-code phpdocumentor-signature -deprecated">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api_get_entity_name_from_camel</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$entity</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entity</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Entity name in various formats e.g. Contribution, contribution,
OptionValue, option_value, UFJoin, uf_join.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
—
<section class="phpdocumentor-description"><p>Entity name in underscore separated format.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api_get_entity_name_from_dao">
_civicrm_api_get_entity_name_from_dao()
<a href="namespaces/default.html#function__civicrm_api_get_entity_name_from_dao" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/api.php"><a href="files/api-api.html"><abbr title="api/api.php">api.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">315</span>
</aside>
<p class="phpdocumentor-summary">Having a DAO object find the entity name.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api_get_entity_name_from_dao</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-DAO.html"><abbr title="\CRM_Core_DAO">CRM_Core_DAO</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$bao</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$bao</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-DAO.html"><abbr title="\CRM_Core_DAO">CRM_Core_DAO</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>DAO being passed in.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_acl_create">
civicrm_api3_acl_create()
<a href="namespaces/default.html#function_civicrm_api3_acl_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Acl.php"><a href="files/api-v3-acl.html"><abbr title="api/v3/Acl.php">Acl.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">26</span>
</aside>
<p class="phpdocumentor-summary">Save an Acl.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_acl_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_acl_create_spec">
_civicrm_api3_acl_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_acl_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Acl.php"><a href="files/api-v3-acl.html"><abbr title="api/v3/Acl.php">Acl.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">35</span>
</aside>
<p class="phpdocumentor-summary">Acl create metadata.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_acl_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_acl_get">
civicrm_api3_acl_get()
<a href="namespaces/default.html#function_civicrm_api3_acl_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Acl.php"><a href="files/api-v3-acl.html"><abbr title="api/v3/Acl.php">Acl.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">48</span>
</aside>
<p class="phpdocumentor-summary">Get an Acl.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_acl_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_acl_delete">
civicrm_api3_acl_delete()
<a href="namespaces/default.html#function_civicrm_api3_acl_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Acl.php"><a href="files/api-v3-acl.html"><abbr title="api/v3/Acl.php">Acl.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">60</span>
</aside>
<p class="phpdocumentor-summary">Delete an Acl.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_acl_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_acl_role_create">
civicrm_api3_acl_role_create()
<a href="namespaces/default.html#function_civicrm_api3_acl_role_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/AclRole.php"><a href="files/api-v3-aclrole.html"><abbr title="api/v3/AclRole.php">AclRole.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">26</span>
</aside>
<p class="phpdocumentor-summary">Save an AclRole.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_acl_role_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_acl_role_create_spec">
_civicrm_api3_acl_role_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_acl_role_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/AclRole.php"><a href="files/api-v3-aclrole.html"><abbr title="api/v3/AclRole.php">AclRole.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">35</span>
</aside>
<p class="phpdocumentor-summary">AclRole create metadata.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_acl_role_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_acl_role_get">
civicrm_api3_acl_role_get()
<a href="namespaces/default.html#function_civicrm_api3_acl_role_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/AclRole.php"><a href="files/api-v3-aclrole.html"><abbr title="api/v3/AclRole.php">AclRole.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">47</span>
</aside>
<p class="phpdocumentor-summary">Get an AclRole.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_acl_role_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_acl_role_delete">
civicrm_api3_acl_role_delete()
<a href="namespaces/default.html#function_civicrm_api3_acl_role_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/AclRole.php"><a href="files/api-v3-aclrole.html"><abbr title="api/v3/AclRole.php">AclRole.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">59</span>
</aside>
<p class="phpdocumentor-summary">Delete an AclRole.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_acl_role_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_action_schedule_get">
civicrm_api3_action_schedule_get()
<a href="namespaces/default.html#function_civicrm_api3_action_schedule_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/ActionSchedule.php"><a href="files/api-v3-actionschedule.html"><abbr title="api/v3/ActionSchedule.php">ActionSchedule.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">26</span>
</aside>
<p class="phpdocumentor-summary">Get CiviCRM ActionSchedule details.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_action_schedule_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_action_schedule_create">
civicrm_api3_action_schedule_create()
<a href="namespaces/default.html#function_civicrm_api3_action_schedule_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/ActionSchedule.php"><a href="files/api-v3-actionschedule.html"><abbr title="api/v3/ActionSchedule.php">ActionSchedule.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">37</span>
</aside>
<p class="phpdocumentor-summary">Create a new ActionSchedule.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_action_schedule_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_action_schedule_create_spec">
_civicrm_api3_action_schedule_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_action_schedule_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/ActionSchedule.php"><a href="files/api-v3-actionschedule.html"><abbr title="api/v3/ActionSchedule.php">ActionSchedule.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">50</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_action_schedule_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_action_schedule_delete">
civicrm_api3_action_schedule_delete()
<a href="namespaces/default.html#function_civicrm_api3_action_schedule_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/ActionSchedule.php"><a href="files/api-v3-actionschedule.html"><abbr title="api/v3/ActionSchedule.php">ActionSchedule.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">76</span>
</aside>
<p class="phpdocumentor-summary">Delete an existing ActionSchedule.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_action_schedule_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array containing id of the action_schedule to be deleted.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_activity_create">
civicrm_api3_activity_create()
<a href="namespaces/default.html#function_civicrm_api3_activity_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Activity.php"><a href="files/api-v3-activity.html"><abbr title="api/v3/Activity.php">Activity.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">28</span>
</aside>
<p class="phpdocumentor-summary">Creates or updates an Activity.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_activity_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields documentation.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_activity_create#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_activity_create_spec">
_civicrm_api3_activity_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_activity_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Activity.php"><a href="files/api-v3-activity.html"><abbr title="api/v3/Activity.php">Activity.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">89</span>
</aside>
<p class="phpdocumentor-summary">Specify Meta data for create.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_activity_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>Note that this data is retrievable via the getfields function and is used for pre-filling defaults and
ensuring mandatory requirements are met.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_activity_get_spec">
_civicrm_api3_activity_get_spec()
<a href="namespaces/default.html#function__civicrm_api3_activity_get_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Activity.php"><a href="files/api-v3-activity.html"><abbr title="api/v3/Activity.php">Activity.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">139</span>
</aside>
<p class="phpdocumentor-summary">Specify Metadata for get.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_activity_get_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_activity_get">
civicrm_api3_activity_get()
<a href="namespaces/default.html#function_civicrm_api3_activity_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Activity.php"><a href="files/api-v3-activity.html"><abbr title="api/v3/Activity.php">Activity.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">210</span>
</aside>
<p class="phpdocumentor-summary">Gets a CiviCRM activity according to parameters.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_activity_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields documentation.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_activity_get#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/Civi-API-Exception-UnauthorizedException.html"><abbr title="\Civi\API\Exception\UnauthorizedException">UnauthorizedException</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_activity_get_handleSourceContactNameOrderBy">
_civicrm_activity_get_handleSourceContactNameOrderBy()
<a href="namespaces/default.html#function__civicrm_activity_get_handleSourceContactNameOrderBy" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Activity.php"><a href="files/api-v3-activity.html"><abbr title="api/v3/Activity.php">Activity.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">265</span>
</aside>
<p class="phpdocumentor-summary">Handle source_contact_name as a sort parameter.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_activity_get_handleSourceContactNameOrderBy</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$options</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Utils-SQL-Select.html"><abbr title="\CRM_Utils_SQL_Select">CRM_Utils_SQL_Select</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$sql</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>This is passed from the activity selector - e.g search results or contact tab.</p>
<p>It's a non-standard handling but this api already handles variations on handling source_contact
as a filter & as a field so it's in keeping with that. Source contact has a one-one relationship
with activity table.</p>
<p>Test coverage in CRM_Activity_BAO_ActivtiyTest::testGetActivitiesforContactSummaryWithSortOptions</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$options</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$sql</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Utils-SQL-Select.html"><abbr title="\CRM_Utils_SQL_Select">CRM_Utils_SQL_Select</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_activity_get_extraFilters">
_civicrm_api3_activity_get_extraFilters()
<a href="namespaces/default.html#function__civicrm_api3_activity_get_extraFilters" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Activity.php"><a href="files/api-v3-activity.html"><abbr title="api/v3/Activity.php">Activity.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">290</span>
</aside>
<p class="phpdocumentor-summary">Support filters beyond what basic_get can do.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_activity_get_extraFilters</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Utils-SQL-Select.html"><abbr title="\CRM_Utils_SQL_Select">CRM_Utils_SQL_Select</abbr></a> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$sql</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$sql</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Utils-SQL-Select.html"><abbr title="\CRM_Utils_SQL_Select">CRM_Utils_SQL_Select</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_activity_get_extraFilters#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\Exception">Exception</abbr></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_activity_get_formatResult">
_civicrm_api3_activity_get_formatResult()
<a href="namespaces/default.html#function__civicrm_api3_activity_get_formatResult" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Activity.php"><a href="files/api-v3-activity.html"><abbr title="api/v3/Activity.php">Activity.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">386</span>
</aside>
<p class="phpdocumentor-summary">Given a list of activities, append any extra data requested about the activities.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_activity_get_formatResult</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$activities</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$options</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>API request parameters.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$activities</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$options</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Options array (pre-processed to extract 'return' from params).</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_activity_get_formatResult#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">note</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Called by civicrm-core and CiviHR</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>new activities list</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_activity_fill_activity_contact_names">
_civicrm_api3_activity_fill_activity_contact_names()
<a href="namespaces/default.html#function__civicrm_api3_activity_fill_activity_contact_names" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Activity.php"><a href="files/api-v3-activity.html"><abbr title="api/v3/Activity.php">Activity.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">531</span>
</aside>
<p class="phpdocumentor-summary">Append activity contact details to activity results.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_activity_fill_activity_contact_names</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$activities</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$returns</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>Adds id & name of activity contacts to results array if check_permissions
does not block access to them.</p>
<p>For historical reasons source_contact_id is always added & is not an array.
The others are added depending on requested return params.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$activities</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$returns</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_activity_delete">
civicrm_api3_activity_delete()
<a href="namespaces/default.html#function_civicrm_api3_activity_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Activity.php"><a href="files/api-v3-activity.html"><abbr title="api/v3/Activity.php">Activity.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">593</span>
</aside>
<p class="phpdocumentor-summary">Delete a specified Activity.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_activity_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array holding 'id' of activity to be deleted.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_activity_delete#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_activity_check_params">
_civicrm_api3_activity_check_params()
<a href="namespaces/default.html#function__civicrm_api3_activity_check_params" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Activity.php"><a href="files/api-v3-activity.html"><abbr title="api/v3/Activity.php">Activity.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">614</span>
</aside>
<p class="phpdocumentor-summary">Check for required params.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_activity_check_params</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Associated array of fields.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_activity_check_params#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\Exception">Exception</abbr></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>array with errors</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_activity_getlist_params">
_civicrm_api3_activity_getlist_params()
<a href="namespaces/default.html#function__civicrm_api3_activity_getlist_params" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Activity.php"><a href="files/api-v3-activity.html"><abbr title="api/v3/Activity.php">Activity.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">677</span>
</aside>
<p class="phpdocumentor-summary">Get parameters for activity list.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_activity_getlist_params</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$request</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$request</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>API request.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_activity_getlist_params#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\_civicrm_api3_generic_getlist_params">_civicrm_api3_generic_getlist_params</abbr></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_activity_getlist_output">
_civicrm_api3_activity_getlist_output()
<a href="namespaces/default.html#function__civicrm_api3_activity_getlist_output" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Activity.php"><a href="files/api-v3-activity.html"><abbr title="api/v3/Activity.php">Activity.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">704</span>
</aside>
<p class="phpdocumentor-summary">Get output for activity list.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_activity_getlist_output</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$result</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$request</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$result</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$request</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_activity_getlist_output#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\_civicrm_api3_generic_getlist_output">_civicrm_api3_generic_getlist_output</abbr></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_activity_contact_create">
civicrm_api3_activity_contact_create()
<a href="namespaces/default.html#function_civicrm_api3_activity_contact_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/ActivityContact.php"><a href="files/api-v3-activitycontact.html"><abbr title="api/v3/ActivityContact.php">ActivityContact.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">26</span>
</aside>
<p class="phpdocumentor-summary">Add a record relating a contact with an activity.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_activity_contact_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_activity_contact_create_spec">
_civicrm_api3_activity_contact_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_activity_contact_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/ActivityContact.php"><a href="files/api-v3-activitycontact.html"><abbr title="api/v3/ActivityContact.php">ActivityContact.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">38</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_activity_contact_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_activity_contact_delete">
civicrm_api3_activity_contact_delete()
<a href="namespaces/default.html#function_civicrm_api3_activity_contact_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/ActivityContact.php"><a href="files/api-v3-activitycontact.html"><abbr title="api/v3/ActivityContact.php">ActivityContact.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">51</span>
</aside>
<p class="phpdocumentor-summary">Delete an existing ActivityContact record.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_activity_contact_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_activity_contact_get">
civicrm_api3_activity_contact_get()
<a href="namespaces/default.html#function_civicrm_api3_activity_contact_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/ActivityContact.php"><a href="files/api-v3-activitycontact.html"><abbr title="api/v3/ActivityContact.php">ActivityContact.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">64</span>
</aside>
<p class="phpdocumentor-summary">Get a ActivityContact.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_activity_contact_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>An associative array of name/value pairs.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - -deprecated">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_activity_type_deprecation">
_civicrm_api3_activity_type_deprecation()
<a href="namespaces/default.html#function__civicrm_api3_activity_type_deprecation" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/ActivityType.php"><a href="files/api-v3-activitytype.html"><abbr title="api/v3/ActivityType.php">ActivityType.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">27</span>
</aside>
<p class="phpdocumentor-summary">Notification of deprecated function.</p>
<div class="phpdocumentor-admonition">
<svg class="phpdocumentor-admonition__icon" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-3L13.732 4c-.77-1.333-2.694-1.333-3.464 0L3.34 16c-.77 1.333.192 3 1.732 3z"></path></svg>
<article>
<p>api notice</p>
</article>
</div>
<code class="phpdocumentor-code phpdocumentor-signature -deprecated">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_activity_type_deprecation</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
—
<section class="phpdocumentor-description"><p>to indicate this entire api entity is deprecated</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - -deprecated">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_activity_type_get">
civicrm_api3_activity_type_get()
<a href="namespaces/default.html#function_civicrm_api3_activity_type_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/ActivityType.php"><a href="files/api-v3-activitytype.html"><abbr title="api/v3/ActivityType.php">ActivityType.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">40</span>
</aside>
<p class="phpdocumentor-summary">Retrieve activity types.</p>
<div class="phpdocumentor-admonition">
<svg class="phpdocumentor-admonition__icon" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-3L13.732 4c-.77-1.333-2.694-1.333-3.464 0L3.34 16c-.77 1.333.192 3 1.732 3z"></path></svg>
<article>
<ul>
<li>use the getoptions action instead</li>
</ul>
</article>
</div>
<code class="phpdocumentor-code phpdocumentor-signature -deprecated">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_activity_type_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>activity types keyed by id</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - -deprecated">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_activity_type_create">
civicrm_api3_activity_type_create()
<a href="namespaces/default.html#function_civicrm_api3_activity_type_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/ActivityType.php"><a href="files/api-v3-activitytype.html"><abbr title="api/v3/ActivityType.php">ActivityType.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">56</span>
</aside>
<p class="phpdocumentor-summary">Create activity type.</p>
<div class="phpdocumentor-admonition">
<svg class="phpdocumentor-admonition__icon" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-3L13.732 4c-.77-1.333-2.694-1.333-3.464 0L3.34 16c-.77 1.333.192 3 1.732 3z"></path></svg>
<article>
<p>use the OptionValue api instead</p>
</article>
</div>
<code class="phpdocumentor-code phpdocumentor-signature -deprecated">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_activity_type_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>created / updated activity type</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_activity_type_create_spec">
_civicrm_api3_activity_type_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_activity_type_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/ActivityType.php"><a href="files/api-v3-activitytype.html"><abbr title="api/v3/ActivityType.php">ActivityType.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">79</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_activity_type_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - -deprecated">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_activity_type_delete">
civicrm_api3_activity_type_delete()
<a href="namespaces/default.html#function_civicrm_api3_activity_type_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/ActivityType.php"><a href="files/api-v3-activitytype.html"><abbr title="api/v3/ActivityType.php">ActivityType.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">101</span>
</aside>
<p class="phpdocumentor-summary">Delete ActivityType.</p>
<div class="phpdocumentor-admonition">
<svg class="phpdocumentor-admonition__icon" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-3L13.732 4c-.77-1.333-2.694-1.333-3.464 0L3.34 16c-.77 1.333.192 3 1.732 3z"></path></svg>
<article>
<p>use OptionValue api</p>
</article>
</div>
<code class="phpdocumentor-code phpdocumentor-signature -deprecated">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_activity_type_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array including id of activity_type to delete.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_activity_type_delete#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_address_create">
civicrm_api3_address_create()
<a href="namespaces/default.html#function_civicrm_api3_address_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Address.php"><a href="files/api-v3-address.html"><abbr title="api/v3/Address.php">Address.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">29</span>
</aside>
<p class="phpdocumentor-summary">Add an Address for a contact.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_address_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>FIXME: Should be using basic_create util</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields metadata.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_address_create_spec">
_civicrm_api3_address_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_address_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Address.php"><a href="files/api-v3-address.html"><abbr title="api/v3/Address.php">Address.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">76</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_address_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_address_get_spec">
_civicrm_api3_address_get_spec()
<a href="namespaces/default.html#function__civicrm_api3_address_get_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Address.php"><a href="files/api-v3-address.html"><abbr title="api/v3/Address.php">Address.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">113</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Get action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_address_get_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_address_delete">
civicrm_api3_address_delete()
<a href="namespaces/default.html#function_civicrm_api3_address_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Address.php"><a href="files/api-v3-address.html"><abbr title="api/v3/Address.php">Address.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">130</span>
</aside>
<p class="phpdocumentor-summary">Delete an existing Address.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_address_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields metadata.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_address_get">
civicrm_api3_address_get()
<a href="namespaces/default.html#function_civicrm_api3_address_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Address.php"><a href="files/api-v3-address.html"><abbr title="api/v3/Address.php">Address.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">143</span>
</aside>
<p class="phpdocumentor-summary">Retrieve one or more addresses.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_address_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields metadata.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_attachment_create_spec">
_civicrm_api3_attachment_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_attachment_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Attachment.php"><a href="files/api-v3-attachment.html"><abbr title="api/v3/Attachment.php">Attachment.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">74</span>
</aside>
<p class="phpdocumentor-summary">Adjust metadata for "create" action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_attachment_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$spec</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$spec</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>List of fields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_attachment_create">
civicrm_api3_attachment_create()
<a href="namespaces/default.html#function_civicrm_api3_attachment_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Attachment.php"><a href="files/api-v3-attachment.html"><abbr title="api/v3/Attachment.php">Attachment.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">91</span>
</aside>
<p class="phpdocumentor-summary">Create an Attachment.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_attachment_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_attachment_create#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
<section class="phpdocumentor-description"><p>validation errors</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/Civi-API-Subscriber-DynamicFKAuthorization.html"><abbr title="\Civi\API\Subscriber\DynamicFKAuthorization">DynamicFKAuthorization</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_attachment_get_spec">
_civicrm_api3_attachment_get_spec()
<a href="namespaces/default.html#function__civicrm_api3_attachment_get_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Attachment.php"><a href="files/api-v3-attachment.html"><abbr title="api/v3/Attachment.php">Attachment.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">175</span>
</aside>
<p class="phpdocumentor-summary">Adjust metadata for get action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_attachment_get_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$spec</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$spec</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>List of fields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_attachment_get">
civicrm_api3_attachment_get()
<a href="namespaces/default.html#function_civicrm_api3_attachment_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Attachment.php"><a href="files/api-v3-attachment.html"><abbr title="api/v3/Attachment.php">Attachment.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">188</span>
</aside>
<p class="phpdocumentor-summary">Get Attachment.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_attachment_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_attachment_get#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
<section class="phpdocumentor-description"><p>validation errors</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>per APIv3</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_attachment_delete_spec">
_civicrm_api3_attachment_delete_spec()
<a href="namespaces/default.html#function__civicrm_api3_attachment_delete_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Attachment.php"><a href="files/api-v3-attachment.html"><abbr title="api/v3/Attachment.php">Attachment.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">204</span>
</aside>
<p class="phpdocumentor-summary">Adjust metadata for Attachment delete action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_attachment_delete_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$spec</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$spec</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_attachment_delete">
civicrm_api3_attachment_delete()
<a href="namespaces/default.html#function_civicrm_api3_attachment_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Attachment.php"><a href="files/api-v3-attachment.html"><abbr title="api/v3/Attachment.php">Attachment.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">223</span>
</aside>
<p class="phpdocumentor-summary">Delete Attachment.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_attachment_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_attachment_delete#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function___civicrm_api3_attachment_find">
__civicrm_api3_attachment_find()
<a href="namespaces/default.html#function___civicrm_api3_attachment_find" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Attachment.php"><a href="files/api-v3-attachment.html"><abbr title="api/v3/Attachment.php">Attachment.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">276</span>
</aside>
<p class="phpdocumentor-summary">Attachment find helper.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">__civicrm_api3_attachment_find</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int|null </span><span class="phpdocumentor-signature__argument__name">$id</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$file</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$entityFile</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$isTrusted</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/CRM-Core-DAO.html"><abbr title="\CRM_Core_DAO">CRM_Core_DAO</abbr></a></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$id</span>
: <span class="phpdocumentor-signature__argument__return-type">int|null</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>the user-supplied ID of the attachment record</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$file</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The user-supplied vales for the file (mime_type, description, upload_date).</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entityFile</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The user-supplied values of the entity-file (entity_table, entity_id).</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$isTrusted</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function___civicrm_api3_attachment_find#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/CRM-Core-DAO.html"><abbr title="\CRM_Core_DAO">CRM_Core_DAO</abbr></a></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_attachment_parse_params">
_civicrm_api3_attachment_parse_params()
<a href="namespaces/default.html#function__civicrm_api3_attachment_parse_params" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Attachment.php"><a href="files/api-v3-attachment.html"><abbr title="api/v3/Attachment.php">Attachment.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">342</span>
</aside>
<p class="phpdocumentor-summary">Attachment parsing helper.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_attachment_parse_params</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_attachment_parse_params#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
<section class="phpdocumentor-description"><p>validation errors</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>(0 => int $id, 1 => array $file, 2 => array $entityFile, 3 => string $name, 4 => string $content,
5 => string $moveFile, 6 => $isTrusted, 7 => bool $returnContent)</p>
<ul>
<li>array $file: whitelisted fields that can pass through directly to civicrm_file</li>
<li>array $entityFile: whitelisted fields that can pass through directly to civicrm_entity_file</li>
<li>string $name: the printable name</li>
<li>string $moveFile: the full path to a local file whose content should be loaded</li>
<li>bool $isTrusted: whether we trust the requester to do sketchy things (like moving files or reassigning entities)</li>
<li>bool $returnContent: whether we are expected to return the full content of the file</li>
</ul>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_attachment_format_result">
_civicrm_api3_attachment_format_result()
<a href="namespaces/default.html#function__civicrm_api3_attachment_format_result" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Attachment.php"><a href="files/api-v3-attachment.html"><abbr title="api/v3/Attachment.php">Attachment.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">411</span>
</aside>
<p class="phpdocumentor-summary">Attachment result formatting helper.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_attachment_format_result</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-DAO-File.html"><abbr title="\CRM_Core_DAO_File">CRM_Core_DAO_File</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$fileDao</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-DAO-EntityFile.html"><abbr title="\CRM_Core_DAO_EntityFile">CRM_Core_DAO_EntityFile</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$entityFileDao</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$returnContent</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$isTrusted</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fileDao</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-DAO-File.html"><abbr title="\CRM_Core_DAO_File">CRM_Core_DAO_File</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Maybe "File" or "File JOIN EntityFile".</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entityFileDao</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-DAO-EntityFile.html"><abbr title="\CRM_Core_DAO_EntityFile">CRM_Core_DAO_EntityFile</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Maybe "EntityFile" or "File JOIN EntityFile".</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$returnContent</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Whether to return the full content of the file.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$isTrusted</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Whether the current request is trusted to perform file-specific operations.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_attachment_getfields">
_civicrm_api3_attachment_getfields()
<a href="namespaces/default.html#function__civicrm_api3_attachment_getfields" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Attachment.php"><a href="files/api-v3-attachment.html"><abbr title="api/v3/Attachment.php">Attachment.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">449</span>
</aside>
<p class="phpdocumentor-summary">Attachment getfields helper.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_attachment_getfields</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>list of fields (indexed by name)</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_batch_create">
civicrm_api3_batch_create()
<a href="namespaces/default.html#function_civicrm_api3_batch_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Batch.php"><a href="files/api-v3-batch.html"><abbr title="api/v3/Batch.php">Batch.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">27</span>
</aside>
<p class="phpdocumentor-summary">Save a Batch.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_batch_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_batch_create#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/Civi-API-Exception-UnauthorizedException.html"><abbr title="\Civi\API\Exception\UnauthorizedException">UnauthorizedException</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_batch_create_spec">
_civicrm_api3_batch_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_batch_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Batch.php"><a href="files/api-v3-batch.html"><abbr title="api/v3/Batch.php">Batch.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">39</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_batch_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_batch_get">
civicrm_api3_batch_get()
<a href="namespaces/default.html#function_civicrm_api3_batch_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Batch.php"><a href="files/api-v3-batch.html"><abbr title="api/v3/Batch.php">Batch.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">52</span>
</aside>
<p class="phpdocumentor-summary">Get a Batch.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_batch_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array of retrieved batch property values.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_batch_delete">
civicrm_api3_batch_delete()
<a href="namespaces/default.html#function_civicrm_api3_batch_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Batch.php"><a href="files/api-v3-batch.html"><abbr title="api/v3/Batch.php">Batch.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">66</span>
</aside>
<p class="phpdocumentor-summary">Delete a Batch.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_batch_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_batch_delete#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/Civi-API-Exception-UnauthorizedException.html"><abbr title="\Civi\API\Exception\UnauthorizedException">UnauthorizedException</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array of deleted values.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_campaign_create">
civicrm_api3_campaign_create()
<a href="namespaces/default.html#function_civicrm_api3_campaign_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Campaign.php"><a href="files/api-v3-campaign.html"><abbr title="api/v3/Campaign.php">Campaign.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">31</span>
</aside>
<p class="phpdocumentor-summary">Create/update Campaign.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_campaign_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>This API is used to create new campaign or update any of the existing
In case of updating existing campaign, id of that particular campaign must
be in $params array.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_campaign_create_spec">
_civicrm_api3_campaign_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_campaign_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Campaign.php"><a href="files/api-v3-campaign.html"><abbr title="api/v3/Campaign.php">Campaign.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">43</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_campaign_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_campaign_get">
civicrm_api3_campaign_get()
<a href="namespaces/default.html#function_civicrm_api3_campaign_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Campaign.php"><a href="files/api-v3-campaign.html"><abbr title="api/v3/Campaign.php">Campaign.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">57</span>
</aside>
<p class="phpdocumentor-summary">Returns array of campaigns matching a set of one or more properties.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_campaign_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array of matching campaigns</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_campaign_delete">
civicrm_api3_campaign_delete()
<a href="namespaces/default.html#function_civicrm_api3_campaign_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Campaign.php"><a href="files/api-v3-campaign.html"><abbr title="api/v3/Campaign.php">Campaign.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">72</span>
</aside>
<p class="phpdocumentor-summary">Delete an existing campaign.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_campaign_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>This method is used to delete any existing campaign.
Id of the campaign to be deleted is required field in $params array</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>array containing id of the group to be deleted</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_campaign_getlist_params">
_civicrm_api3_campaign_getlist_params()
<a href="namespaces/default.html#function__civicrm_api3_campaign_getlist_params" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Campaign.php"><a href="files/api-v3-campaign.html"><abbr title="api/v3/Campaign.php">Campaign.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">83</span>
</aside>
<p class="phpdocumentor-summary">Get campaign list parameters.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_campaign_getlist_params</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$request</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$request</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_campaign_getlist_params#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\_civicrm_api3_generic_getlist_params">_civicrm_api3_generic_getlist_params</abbr></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_campaign_getlist_output">
_civicrm_api3_campaign_getlist_output()
<a href="namespaces/default.html#function__civicrm_api3_campaign_getlist_output" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Campaign.php"><a href="files/api-v3-campaign.html"><abbr title="api/v3/Campaign.php">Campaign.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">112</span>
</aside>
<p class="phpdocumentor-summary">Get campaign list output.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_campaign_getlist_output</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$result</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$request</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$result</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$request</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_campaign_getlist_output#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\_civicrm_api3_generic_getlist_output">_civicrm_api3_generic_getlist_output</abbr></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_case_create">
civicrm_api3_case_create()
<a href="namespaces/default.html#function_civicrm_api3_case_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Case.php"><a href="files/api-v3-case.html"><abbr title="api/v3/Case.php">Case.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">47</span>
</aside>
<p class="phpdocumentor-summary">Open a new case, add client and manager roles, and standard timeline.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_case_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><pre class="prettyprint"><code class="prettyprint">// REQUIRED for create:
'case_type_id' => int OR
'case_type' => str (provide one or the other)
'contact_id' => int // case client
'subject' => str
// REQUIRED for update:
'id' => case Id
//OPTIONAL
'medium_id' => int // see civicrm option values for possibilities
'creator_id' => int // case manager, default to the logged in user
'status_id' => int // defaults to 1 "ongoing"
'location' => str
'start_date' => str datestamp // defaults to: date('YmdHis')
'duration' => int // in minutes
'details' => str // html format
</code></pre>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_case_create#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>api result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_case_create_xmlProcessor">
_civicrm_api3_case_create_xmlProcessor()
<a href="namespaces/default.html#function__civicrm_api3_case_create_xmlProcessor" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Case.php"><a href="files/api-v3-case.html"><abbr title="api/v3/Case.php">Case.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">139</span>
</aside>
<p class="phpdocumentor-summary">When creating a new case, run the xmlProcessor to get all necessary params/configuration
for the new case, as cases use an xml file to store their configuration.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_case_create_xmlProcessor</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Case-DAO-Case.html"><abbr title="\CRM_Case_DAO_Case">CRM_Case_DAO_Case</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$caseBAO</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$caseBAO</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Case-DAO-Case.html"><abbr title="\CRM_Case_DAO_Case">CRM_Case_DAO_Case</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_case_create_xmlProcessor#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\Exception">Exception</abbr></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_case_get_spec">
_civicrm_api3_case_get_spec()
<a href="namespaces/default.html#function__civicrm_api3_case_get_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Case.php"><a href="files/api-v3-case.html"><abbr title="api/v3/Case.php">Case.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">173</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Get Action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_case_get_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_case_create_spec">
_civicrm_api3_case_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_case_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Case.php"><a href="files/api-v3-case.html"><abbr title="api/v3/Case.php">Case.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">201</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create Action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_case_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_case_update_spec">
_civicrm_api3_case_update_spec()
<a href="namespaces/default.html#function__civicrm_api3_case_update_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Case.php"><a href="files/api-v3-case.html"><abbr title="api/v3/Case.php">Case.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">229</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Update action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_case_update_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_case_delete_spec">
_civicrm_api3_case_delete_spec()
<a href="namespaces/default.html#function__civicrm_api3_case_delete_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Case.php"><a href="files/api-v3-case.html"><abbr title="api/v3/Case.php">Case.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">239</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Delete action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_case_delete_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_case_get">
civicrm_api3_case_get()
<a href="namespaces/default.html#function_civicrm_api3_case_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Case.php"><a href="files/api-v3-case.html"><abbr title="api/v3/Case.php">Case.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">262</span>
</aside>
<p class="phpdocumentor-summary">Get details of a particular case, or search for cases, depending on params.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_case_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$sql</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>Please provide one (and only one) of the four get/search parameters:</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>'id' => if set, will get all available info about a case, including contacts and activities</p>
<p>// if no case_id provided, this function will use one of the following search parameters:
'client_id' => finds all cases with a specific client
'activity_id' => returns the case containing a specific activity
'contact_id' => finds all cases associated with a contact (in any role, not just client)
$params CRM_Utils_SQL_Select $sql
Other apis wishing to wrap & extend this one can pass in a $sql object with extra clauses</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$sql</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_case_get#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>(get mode, case_id provided): Array with case details, case roles, case activity ids, (search mode, case_id not provided): Array of cases found</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_case_activity_create">
civicrm_api3_case_activity_create()
<a href="namespaces/default.html#function_civicrm_api3_case_activity_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Case.php"><a href="files/api-v3-case.html"><abbr title="api/v3/Case.php">Case.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">374</span>
</aside>
<p class="phpdocumentor-summary">Deprecated API.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_case_activity_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>Use activity API instead.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_case_activity_create#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_case_addtimeline">
civicrm_api3_case_addtimeline()
<a href="namespaces/default.html#function_civicrm_api3_case_addtimeline" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Case.php"><a href="files/api-v3-case.html"><abbr title="api/v3/Case.php">Case.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">389</span>
</aside>
<p class="phpdocumentor-summary">Add a timeline to a case.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_case_addtimeline</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_case_addtimeline#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_case_addtimeline_spec">
_civicrm_api3_case_addtimeline_spec()
<a href="namespaces/default.html#function__civicrm_api3_case_addtimeline_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Case.php"><a href="files/api-v3-case.html"><abbr title="api/v3/Case.php">Case.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">411</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for addtimeline action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_case_addtimeline_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_case_merge">
civicrm_api3_case_merge()
<a href="namespaces/default.html#function_civicrm_api3_case_merge" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Case.php"><a href="files/api-v3-case.html"><abbr title="api/v3/Case.php">Case.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">446</span>
</aside>
<p class="phpdocumentor-summary">Merge 2 cases.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_case_merge</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_case_merge#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_case_merge_spec">
_civicrm_api3_case_merge_spec()
<a href="namespaces/default.html#function__civicrm_api3_case_merge_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Case.php"><a href="files/api-v3-case.html"><abbr title="api/v3/Case.php">Case.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">459</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for merge action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_case_merge_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - -deprecated">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_case_deprecation">
_civicrm_api3_case_deprecation()
<a href="namespaces/default.html#function__civicrm_api3_case_deprecation" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Case.php"><a href="files/api-v3-case.html"><abbr title="api/v3/Case.php">Case.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">481</span>
</aside>
<p class="phpdocumentor-summary">Declare deprecated api functions.</p>
<div class="phpdocumentor-admonition">
<svg class="phpdocumentor-admonition__icon" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-3L13.732 4c-.77-1.333-2.694-1.333-3.464 0L3.34 16c-.77 1.333.192 3 1.732 3z"></path></svg>
<article>
<p>api notice</p>
</article>
</div>
<code class="phpdocumentor-code phpdocumentor-signature -deprecated">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_case_deprecation</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array of deprecated actions</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - -deprecated">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_case_update">
civicrm_api3_case_update()
<a href="namespaces/default.html#function_civicrm_api3_case_update" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Case.php"><a href="files/api-v3-case.html"><abbr title="api/v3/Case.php">Case.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">501</span>
</aside>
<div class="phpdocumentor-admonition">
<svg class="phpdocumentor-admonition__icon" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-3L13.732 4c-.77-1.333-2.694-1.333-3.464 0L3.34 16c-.77 1.333.192 3 1.732 3z"></path></svg>
<article>
<p>Update a specified case. Use civicrm_api3_case_create() instead.</p>
</article>
</div>
<code class="phpdocumentor-code phpdocumentor-signature -deprecated">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_case_update</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>//REQUIRED:
'case_id' => int</p>
<p>//OPTIONAL
'status_id' => int
'start_date' => str datestamp
'contact_id' => int // case client</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_case_update#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>api result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_case_delete">
civicrm_api3_case_delete()
<a href="namespaces/default.html#function_civicrm_api3_case_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Case.php"><a href="files/api-v3-case.html"><abbr title="api/v3/Case.php">Case.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">570</span>
</aside>
<p class="phpdocumentor-summary">Delete a specified case.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_case_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><pre class="prettyprint"><code class="prettyprint"> //REQUIRED:
'id' => int
//OPTIONAL
'move_to_trash' => bool (defaults to false)
</code></pre>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_case_delete#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_case_restore_spec">
_civicrm_api3_case_restore_spec()
<a href="namespaces/default.html#function__civicrm_api3_case_restore_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Case.php"><a href="files/api-v3-case.html"><abbr title="api/v3/Case.php">Case.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">588</span>
</aside>
<p class="phpdocumentor-summary">Case.restore API specification</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_case_restore_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$spec</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$spec</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>description of fields supported by this API call</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_case_restore">
civicrm_api3_case_restore()
<a href="namespaces/default.html#function_civicrm_api3_case_restore" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Case.php"><a href="files/api-v3-case.html"><abbr title="api/v3/Case.php">Case.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">600</span>
</aside>
<p class="phpdocumentor-summary">Restore a specified case from the trash.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_case_restore</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_case_restore#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_case_read">
_civicrm_api3_case_read()
<a href="namespaces/default.html#function__civicrm_api3_case_read" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Case.php"><a href="files/api-v3-case.html"><abbr title="api/v3/Case.php">Case.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">615</span>
</aside>
<p class="phpdocumentor-summary">Augment case results with extra data.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_case_read</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$cases</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$options</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$cases</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$options</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_case_format_params">
_civicrm_api3_case_format_params()
<a href="namespaces/default.html#function__civicrm_api3_case_format_params" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Case.php"><a href="files/api-v3-case.html"><abbr title="api/v3/Case.php">Case.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">686</span>
</aside>
<p class="phpdocumentor-summary">Internal function to format create params for processing.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_case_format_params</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_case_getList">
civicrm_api3_case_getList()
<a href="namespaces/default.html#function_civicrm_api3_case_getList" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Case.php"><a href="files/api-v3-case.html"><abbr title="api/v3/Case.php">Case.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">737</span>
</aside>
<p class="phpdocumentor-summary">It actually works a lot better to use the CaseContact api instead of the Case api
for entityRef fields so we can perform the necessary joins,
so we pass off getlist requests to the CaseContact api.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_case_getList</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_case_getlist_spec">
_civicrm_api3_case_getlist_spec()
<a href="namespaces/default.html#function__civicrm_api3_case_getlist_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Case.php"><a href="files/api-v3-case.html"><abbr title="api/v3/Case.php">Case.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">776</span>
</aside>
<p class="phpdocumentor-summary">Needed due to the above override</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_case_getlist_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$apiRequest</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$apiRequest</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_case_getoptions">
civicrm_api3_case_getoptions()
<a href="namespaces/default.html#function_civicrm_api3_case_getoptions" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Case.php"><a href="files/api-v3-case.html"><abbr title="api/v3/Case.php">Case.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">781</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_case_getoptions</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_case_contact_create">
civicrm_api3_case_contact_create()
<a href="namespaces/default.html#function_civicrm_api3_case_contact_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/CaseContact.php"><a href="files/api-v3-casecontact.html"><abbr title="api/v3/CaseContact.php">CaseContact.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">25</span>
</aside>
<p class="phpdocumentor-summary">Save a CaseContact.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_case_contact_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_case_contact_create_spec">
_civicrm_api3_case_contact_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_case_contact_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/CaseContact.php"><a href="files/api-v3-casecontact.html"><abbr title="api/v3/CaseContact.php">CaseContact.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">32</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_case_contact_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$fields</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fields</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_case_contact_get">
civicrm_api3_case_contact_get()
<a href="namespaces/default.html#function_civicrm_api3_case_contact_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/CaseContact.php"><a href="files/api-v3-casecontact.html"><abbr title="api/v3/CaseContact.php">CaseContact.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">44</span>
</aside>
<p class="phpdocumentor-summary">Get a CaseContact.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_case_contact_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array of retrieved case_contact property values.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_case_contact_delete">
civicrm_api3_case_contact_delete()
<a href="namespaces/default.html#function_civicrm_api3_case_contact_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/CaseContact.php"><a href="files/api-v3-casecontact.html"><abbr title="api/v3/CaseContact.php">CaseContact.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">56</span>
</aside>
<p class="phpdocumentor-summary">Delete a CaseContact.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_case_contact_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array of deleted values.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_case_contact_getlist_output">
_civicrm_api3_case_contact_getlist_output()
<a href="namespaces/default.html#function__civicrm_api3_case_contact_getlist_output" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/CaseContact.php"><a href="files/api-v3-casecontact.html"><abbr title="api/v3/CaseContact.php">CaseContact.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">70</span>
</aside>
<p class="phpdocumentor-summary">Results formatting for Case entityRef lookups.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_case_contact_getlist_output</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$result</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$request</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$entity</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$fields</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$result</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$request</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entity</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fields</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_case_type_create">
civicrm_api3_case_type_create()
<a href="namespaces/default.html#function_civicrm_api3_case_type_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/CaseType.php"><a href="files/api-v3-casetype.html"><abbr title="api/v3/CaseType.php">CaseType.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">28</span>
</aside>
<p class="phpdocumentor-summary">Create or update case type.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_case_type_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Input parameters.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_case_type_create#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_case_type_get">
civicrm_api3_case_type_get()
<a href="namespaces/default.html#function_civicrm_api3_case_type_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/CaseType.php"><a href="files/api-v3-casetype.html"><abbr title="api/v3/CaseType.php">CaseType.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">43</span>
</aside>
<p class="phpdocumentor-summary">Retrieve case types.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_case_type_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>case types keyed by id</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_case_type_get_formatResult">
_civicrm_api3_case_type_get_formatResult()
<a href="namespaces/default.html#function__civicrm_api3_case_type_get_formatResult" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/CaseType.php"><a href="files/api-v3-casetype.html"><abbr title="api/v3/CaseType.php">CaseType.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">62</span>
</aside>
<p class="phpdocumentor-summary">Format definition.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_case_type_get_formatResult</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$result</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$options</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$result</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$options</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
= <span class="phpdocumentor-signature__argument__default-value">[]</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_case_type_get_formatResult#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_case_type_delete">
civicrm_api3_case_type_delete()
<a href="namespaces/default.html#function_civicrm_api3_case_type_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/CaseType.php"><a href="files/api-v3-casetype.html"><abbr title="api/v3/CaseType.php">CaseType.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">83</span>
</aside>
<p class="phpdocumentor-summary">Function to delete case type.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_case_type_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array including id of CaseType to delete.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - -deprecated">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_constant_deprecation">
_civicrm_api3_constant_deprecation()
<a href="namespaces/default.html#function__civicrm_api3_constant_deprecation" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Constant.php"><a href="files/api-v3-constant.html"><abbr title="api/v3/Constant.php">Constant.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">27</span>
</aside>
<p class="phpdocumentor-summary">Declare deprecated api entity.</p>
<div class="phpdocumentor-admonition">
<svg class="phpdocumentor-admonition__icon" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-3L13.732 4c-.77-1.333-2.694-1.333-3.464 0L3.34 16c-.77 1.333.192 3 1.732 3z"></path></svg>
<article>
<p>api notice</p>
</article>
</div>
<code class="phpdocumentor-code phpdocumentor-signature -deprecated">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_constant_deprecation</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
—
<section class="phpdocumentor-description"><p>to indicate this entire api entity is deprecated</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - -deprecated">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_constant_get">
civicrm_api3_constant_get()
<a href="namespaces/default.html#function_civicrm_api3_constant_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Constant.php"><a href="files/api-v3-constant.html"><abbr title="api/v3/Constant.php">Constant.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">83</span>
</aside>
<p class="phpdocumentor-summary">Get constant values (deprecated).</p>
<div class="phpdocumentor-admonition">
<svg class="phpdocumentor-admonition__icon" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-3L13.732 4c-.77-1.333-2.694-1.333-3.464 0L3.34 16c-.77 1.333.192 3 1.732 3z"></path></svg>
<article>
<p>as of CiviCRM 4.4.
It's recommended to use the api getoptions action instead</p>
</article>
</div>
<code class="phpdocumentor-code phpdocumentor-signature -deprecated">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_constant_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Name of a public static method of
CRM_Core_PseudoConstant: one of
activityStatus
activityType
addressee
allGroup
country
countryIsoCode
county
currencyCode
currencySymbols
customGroup
emailGreeting
fromEmailAddress
gender
group
groupIterator
honor
IMProvider
individualPrefix
individualSuffix
locationType
locationVcardName
mailProtocol
mappingTypes
paymentProcessor
paymentProcessorType
pcm
phoneType
postalGreeting
priority
relationshipType
stateProvince
stateProvinceAbbreviation
stateProvinceForCountry
staticGroup
tag
tasks
ufGroup
visibility
worldRegion
wysiwygEditor</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_constant_get_spec">
_civicrm_api3_constant_get_spec()
<a href="namespaces/default.html#function__civicrm_api3_constant_get_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Constant.php"><a href="files/api-v3-constant.html"><abbr title="api/v3/Constant.php">Constant.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">127</span>
</aside>
<p class="phpdocumentor-summary">Adjust metadata for constant get action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_constant_get_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_contact_create">
civicrm_api3_contact_create()
<a href="namespaces/default.html#function_civicrm_api3_contact_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Contact.php"><a href="files/api-v3-contact.html"><abbr title="api/v3/Contact.php">Contact.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">37</span>
</aside>
<p class="phpdocumentor-summary">Create or update a Contact.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_contact_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Input parameters.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_contact_create#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API Result Array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_contact_create_spec">
_civicrm_api3_contact_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_contact_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Contact.php"><a href="files/api-v3-contact.html"><abbr title="api/v3/Contact.php">Contact.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">119</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_contact_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_contact_get">
civicrm_api3_contact_get()
<a href="namespaces/default.html#function_civicrm_api3_contact_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Contact.php"><a href="files/api-v3-contact.html"><abbr title="api/v3/Contact.php">Contact.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">159</span>
</aside>
<p class="phpdocumentor-summary">Retrieve one or more contacts, given a set of search params.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_contact_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_contact_get#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API Result Array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_contact_getcount">
civicrm_api3_contact_getcount()
<a href="namespaces/default.html#function_civicrm_api3_contact_getcount" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Contact.php"><a href="files/api-v3-contact.html"><abbr title="api/v3/Contact.php">Contact.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">177</span>
</aside>
<p class="phpdocumentor-summary">Get number of contacts matching the supplied criteria.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_contact_getcount</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_contact_getcount#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">int</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_contact_get_spec">
_civicrm_api3_contact_get_spec()
<a href="namespaces/default.html#function__civicrm_api3_contact_get_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Contact.php"><a href="files/api-v3-contact.html"><abbr title="api/v3/Contact.php">Contact.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">190</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Get action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_contact_get_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_contact_get_supportanomalies">
_civicrm_api3_contact_get_supportanomalies()
<a href="namespaces/default.html#function__civicrm_api3_contact_get_supportanomalies" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Contact.php"><a href="files/api-v3-contact.html"><abbr title="api/v3/Contact.php">Contact.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">377</span>
</aside>
<p class="phpdocumentor-summary">Support for historical oddities.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_contact_get_supportanomalies</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$options</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>We are supporting 'showAll' = 'all', 'trash' or 'active' for Contact get
and for getcount</p>
<ul>
<li>hopefully some day we'll come up with a std syntax for the 3-way-boolean of
0, 1 or not set</li>
</ul>
<p>We also support 'filter_group_id' & 'filter.group_id'</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>As passed into api get or getcount function.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$options</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of options (so we can modify the filter).</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_contact_delete">
civicrm_api3_contact_delete()
<a href="namespaces/default.html#function_civicrm_api3_contact_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Contact.php"><a href="files/api-v3-contact.html"><abbr title="api/v3/Contact.php">Contact.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">456</span>
</aside>
<p class="phpdocumentor-summary">Delete a Contact with given contact_id.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_contact_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>input parameters per getfields</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_contact_delete#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/Civi-API-Exception-UnauthorizedException.html"><abbr title="\Civi\API\Exception\UnauthorizedException">UnauthorizedException</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API Result Array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_contact_check_params">
_civicrm_api3_contact_check_params()
<a href="namespaces/default.html#function__civicrm_api3_contact_check_params" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Contact.php"><a href="files/api-v3-contact.html"><abbr title="api/v3/Contact.php">Contact.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">492</span>
</aside>
<p class="phpdocumentor-summary">Check parameters passed in.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_contact_check_params</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">null</span></code>
<section class="phpdocumentor-description"><p>This function is on it's way out.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_contact_check_params#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">null</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_contact_update">
_civicrm_api3_contact_update()
<a href="namespaces/default.html#function__civicrm_api3_contact_update" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Contact.php"><a href="files/api-v3-contact.html"><abbr title="api/v3/Contact.php">Contact.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">565</span>
</aside>
<p class="phpdocumentor-summary">Helper function for Contact create.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_contact_update</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$contactID</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/CRM-Contact-BAO-Contact.html"><abbr title="\CRM_Contact_BAO_Contact">CRM_Contact_BAO_Contact</abbr></a>|<a href="classes/CRM-Core-Error.html"><abbr title="\CRM_Core_Error">CRM_Core_Error</abbr></a></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>(reference ) an assoc array of name/value pairs.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$contactID</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>If present the contact with that ID is updated.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_contact_update#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/Civi-API-Exception-UnauthorizedException.html"><abbr title="\Civi\API\Exception\UnauthorizedException">UnauthorizedException</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/CRM-Contact-BAO-Contact.html"><abbr title="\CRM_Contact_BAO_Contact">CRM_Contact_BAO_Contact</abbr></a>|<a href="classes/CRM-Core-Error.html"><abbr title="\CRM_Core_Error">CRM_Core_Error</abbr></a></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_greeting_format_params">
_civicrm_api3_greeting_format_params()
<a href="namespaces/default.html#function__civicrm_api3_greeting_format_params" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Contact.php"><a href="files/api-v3-contact.html"><abbr title="api/v3/Contact.php">Contact.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">583</span>
</aside>
<p class="phpdocumentor-summary">Validate the addressee or email or postal greetings.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_greeting_format_params</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields metadata.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_greeting_format_params#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_quicksearch_get_order_by">
_civicrm_api3_quicksearch_get_order_by()
<a href="namespaces/default.html#function__civicrm_api3_quicksearch_get_order_by" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Contact.php"><a href="files/api-v3-contact.html"><abbr title="api/v3/Contact.php">Contact.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">728</span>
</aside>
<p class="phpdocumentor-summary">Get the order by string for the quicksearch query.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_quicksearch_get_order_by</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$name</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$isPrependWildcard</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$field_name</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<section class="phpdocumentor-description"><p>Get the order by string. The string might be</p>
<ul>
<li>sort name if there is no search value provided and the site is configured
to search by sort name</li>
<li>empty if there is no search value provided and the site is not configured
to search by sort name</li>
<li>exactFirst and then sort name if a search value is provided and the site is configured
to search by sort name</li>
<li>exactFirst if a search value is provided and the site is not configured
to search by sort name</li>
</ul>
<p>exactFirst means 'yes if the search value exactly matches the searched field. else no'.
It is intended to prioritise exact matches for the entered string so on a first name search
for 'kath' contacts with a first name of exactly Kath rise to the top.</p>
<p>On short strings it is expensive. Per CRM-19547 there is still an open question
as to whether we should only do exactMatch on a minimum length or on certain fields.</p>
<p>However, we have mitigated this somewhat by not doing an exact match search on
empty strings, non-wildcard sort-name searches and email searches where there is
no @ after the first character.</p>
<p>For the user it is further mitigated by the fact they just don't know the
slower queries are firing. If they type 'smit' slowly enough 4 queries will trigger
but if the first 3 are slow the first result they see may be off the 4th query.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$name</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$isPrependWildcard</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$field_name</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_contact_merge">
civicrm_api3_contact_merge()
<a href="namespaces/default.html#function_civicrm_api3_contact_merge" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Contact.php"><a href="files/api-v3-contact.html"><abbr title="api/v3/Contact.php">Contact.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">760</span>
</aside>
<p class="phpdocumentor-summary">Merges given pair of duplicate contacts.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_contact_merge</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Allowed array keys are:
-int to_keep_id: main contact id with whom merge has to happen
-int to_remove_id: duplicate contact which would be deleted after merge operation
-string mode: "safe" skips the merge if there are no conflicts. Does a force merge otherwise.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_contact_merge#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API Result Array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_contact_merge_spec">
_civicrm_api3_contact_merge_spec()
<a href="namespaces/default.html#function__civicrm_api3_contact_merge_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Contact.php"><a href="files/api-v3-contact.html"><abbr title="api/v3/Contact.php">Contact.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">779</span>
</aside>
<p class="phpdocumentor-summary">Adjust metadata for contact_merge api function.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_contact_merge_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_contact_get_merge_conflicts">
civicrm_api3_contact_get_merge_conflicts()
<a href="namespaces/default.html#function_civicrm_api3_contact_get_merge_conflicts" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Contact.php"><a href="files/api-v3-contact.html"><abbr title="api/v3/Contact.php">Contact.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">817</span>
</aside>
<p class="phpdocumentor-summary">Determines if given pair of contaacts have conflicts that would affect merging them.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_contact_get_merge_conflicts</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Allowed array keys are:
-int main_id: main contact id with whom merge has to happen
-int other_id: duplicate contact which would be deleted after merge operation
-string mode: "safe" skips the merge if there are no conflicts. Does a force merge otherwise.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_contact_get_merge_conflicts#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API Result Array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_contact_get_merge_conflicts_spec">
_civicrm_api3_contact_get_merge_conflicts_spec()
<a href="namespaces/default.html#function__civicrm_api3_contact_get_merge_conflicts_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Contact.php"><a href="files/api-v3-contact.html"><abbr title="api/v3/Contact.php">Contact.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">835</span>
</aside>
<p class="phpdocumentor-summary">Adjust metadata for contact_merge api function.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_contact_get_merge_conflicts_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_contact_getmergedto">
civicrm_api3_contact_getmergedto()
<a href="namespaces/default.html#function_civicrm_api3_contact_getmergedto" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Contact.php"><a href="files/api-v3-contact.html"><abbr title="api/v3/Contact.php">Contact.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">863</span>
</aside>
<p class="phpdocumentor-summary">Get the ultimate contact a contact was merged to.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_contact_getmergedto</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_contact_getmergedto#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API Result Array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_contact_getmergedto">
_civicrm_api3_contact_getmergedto()
<a href="namespaces/default.html#function__civicrm_api3_contact_getmergedto" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Contact.php"><a href="files/api-v3-contact.html"><abbr title="api/v3/Contact.php">Contact.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">887</span>
</aside>
<p class="phpdocumentor-summary">Get the contact our contact was finally merged to.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_contact_getmergedto</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int|false</span></code>
<section class="phpdocumentor-description"><p>If the contact has been merged multiple times the crucial parent activity will have
wound up on the ultimate contact so we can figure out the final resting place of the
contact with only 2 activities even if 50 merges took place.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_contact_getmergedto#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">int|false</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_contact_getmergedto_spec">
_civicrm_api3_contact_getmergedto_spec()
<a href="namespaces/default.html#function__civicrm_api3_contact_getmergedto_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Contact.php"><a href="files/api-v3-contact.html"><abbr title="api/v3/Contact.php">Contact.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">917</span>
</aside>
<p class="phpdocumentor-summary">Adjust metadata for contact_merge api function.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_contact_getmergedto_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_contact_getmergedfrom">
civicrm_api3_contact_getmergedfrom()
<a href="namespaces/default.html#function_civicrm_api3_contact_getmergedfrom" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Contact.php"><a href="files/api-v3-contact.html"><abbr title="api/v3/Contact.php">Contact.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">940</span>
</aside>
<p class="phpdocumentor-summary">Get the ultimate contact a contact was merged to.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_contact_getmergedfrom</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_contact_getmergedfrom#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API Result Array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_contact_getmergedfrom">
_civicrm_api3_contact_getmergedfrom()
<a href="namespaces/default.html#function__civicrm_api3_contact_getmergedfrom" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Contact.php"><a href="files/api-v3-contact.html"><abbr title="api/v3/Contact.php">Contact.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">954</span>
</aside>
<p class="phpdocumentor-summary">Get all the contacts merged into our contact.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_contact_getmergedfrom</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_contact_getmergedfrom#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_contact_getmergedfrom_spec">
_civicrm_api3_contact_getmergedfrom_spec()
<a href="namespaces/default.html#function__civicrm_api3_contact_getmergedfrom_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Contact.php"><a href="files/api-v3-contact.html"><abbr title="api/v3/Contact.php">Contact.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">989</span>
</aside>
<p class="phpdocumentor-summary">Adjust metadata for contact_merge api function.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_contact_getmergedfrom_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_contact_proximity_spec">
_civicrm_api3_contact_proximity_spec()
<a href="namespaces/default.html#function__civicrm_api3_contact_proximity_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Contact.php"><a href="files/api-v3-contact.html"><abbr title="api/v3/Contact.php">Contact.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1007</span>
</aside>
<p class="phpdocumentor-summary">Adjust metadata for contact_proximity api function.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_contact_proximity_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_contact_proximity">
civicrm_api3_contact_proximity()
<a href="namespaces/default.html#function_civicrm_api3_contact_proximity" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Contact.php"><a href="files/api-v3-contact.html"><abbr title="api/v3/Contact.php">Contact.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1034</span>
</aside>
<p class="phpdocumentor-summary">Get contacts by proximity.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_contact_proximity</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_contact_proximity#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\Exception">Exception</abbr></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_contact_getlist_params">
_civicrm_api3_contact_getlist_params()
<a href="namespaces/default.html#function__civicrm_api3_contact_getlist_params" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Contact.php"><a href="files/api-v3-contact.html"><abbr title="api/v3/Contact.php">Contact.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1085</span>
</aside>
<p class="phpdocumentor-summary">Get parameters for getlist function.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_contact_getlist_params</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$request</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$request</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_contact_getlist_params#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\_civicrm_api3_generic_getlist_params">_civicrm_api3_generic_getlist_params</abbr></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_contact_getlist_output">
_civicrm_api3_contact_getlist_output()
<a href="namespaces/default.html#function__civicrm_api3_contact_getlist_output" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Contact.php"><a href="files/api-v3-contact.html"><abbr title="api/v3/Contact.php">Contact.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1138</span>
</aside>
<p class="phpdocumentor-summary">Get output for getlist function.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_contact_getlist_output</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$result</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$request</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$result</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$request</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_contact_getlist_output#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\_civicrm_api3_generic_getlist_output">_civicrm_api3_generic_getlist_output</abbr></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_contact_duplicatecheck">
civicrm_api3_contact_duplicatecheck()
<a href="namespaces/default.html#function_civicrm_api3_contact_duplicatecheck" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Contact.php"><a href="files/api-v3-contact.html"><abbr title="api/v3/Contact.php">Contact.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1196</span>
</aside>
<p class="phpdocumentor-summary">Check for duplicate contacts.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_contact_duplicatecheck</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Params per getfields metadata.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_contact_duplicatecheck#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API formatted array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_contact_duplicatecheck_spec">
_civicrm_api3_contact_duplicatecheck_spec()
<a href="namespaces/default.html#function__civicrm_api3_contact_duplicatecheck_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Contact.php"><a href="files/api-v3-contact.html"><abbr title="api/v3/Contact.php">Contact.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1232</span>
</aside>
<p class="phpdocumentor-summary">Declare metadata for contact dedupe function.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_contact_duplicatecheck_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_contact_type_create">
civicrm_api3_contact_type_create()
<a href="namespaces/default.html#function_civicrm_api3_contact_type_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/ContactType.php"><a href="files/api-v3-contacttype.html"><abbr title="api/v3/ContactType.php">ContactType.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">35</span>
</aside>
<p class="phpdocumentor-summary">Create/update ContactType.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_contact_type_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>This API is used to create new ContactType or update any of the existing
In case of updating existing ContactType, id of that particular ContactType must
be in $params array.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields metadata.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>ContactType array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_contact_type_get">
civicrm_api3_contact_type_get()
<a href="namespaces/default.html#function_civicrm_api3_contact_type_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/ContactType.php"><a href="files/api-v3-contacttype.html"><abbr title="api/v3/ContactType.php">ContactType.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">61</span>
</aside>
<p class="phpdocumentor-summary">Returns array of contact_types matching a set of one or more properties.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_contact_type_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>One or more valid property_name=>value pairs.
If $params is set as null, all contact_types will be returned</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array of matching contact_types</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_contact_type_delete">
civicrm_api3_contact_type_delete()
<a href="namespaces/default.html#function_civicrm_api3_contact_type_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/ContactType.php"><a href="files/api-v3-contacttype.html"><abbr title="api/v3/ContactType.php">ContactType.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">76</span>
</aside>
<p class="phpdocumentor-summary">Delete an existing ContactType.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_contact_type_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>This method is used to delete any existing ContactType given its id.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>[id]</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API Result Array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_contribution_transact_spec">
_civicrm_api3_contribution_transact_spec()
<a href="namespaces/default.html#function__civicrm_api3_contribution_transact_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Contribution/Transact.php"><a href="files/api-v3-contribution-transact.html"><abbr title="api/v3/Contribution/Transact.php">Transact.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">24</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Transact action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_contribution_transact_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - -deprecated">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_contribution_transact">
civicrm_api3_contribution_transact()
<a href="namespaces/default.html#function_civicrm_api3_contribution_transact" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Contribution/Transact.php"><a href="files/api-v3-contribution-transact.html"><abbr title="api/v3/Contribution/Transact.php">Transact.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">41</span>
</aside>
<p class="phpdocumentor-summary">Process a transaction and record it against the contact.</p>
<div class="phpdocumentor-admonition">
<svg class="phpdocumentor-admonition__icon" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-3L13.732 4c-.77-1.333-2.694-1.333-3.464 0L3.34 16c-.77 1.333.192 3 1.732 3z"></path></svg>
<article>
</article>
</div>
<code class="phpdocumentor-code phpdocumentor-signature -deprecated">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_contribution_transact</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Input parameters.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>contribution of created or updated record (or a civicrm error)</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_contribution_create">
civicrm_api3_contribution_create()
<a href="namespaces/default.html#function_civicrm_api3_contribution_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Contribution.php"><a href="files/api-v3-contribution.html"><abbr title="api/v3/Contribution.php">Contribution.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">30</span>
</aside>
<p class="phpdocumentor-summary">Add or update a Contribution.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_contribution_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Input parameters.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_contribution_create#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Api result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_contribution_create_spec">
_civicrm_api3_contribution_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_contribution_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Contribution.php"><a href="files/api-v3-contribution.html"><abbr title="api/v3/Contribution.php">Contribution.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">97</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_contribution_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_contribution_create_legacy_support_45">
_civicrm_api3_contribution_create_legacy_support_45()
<a href="namespaces/default.html#function__civicrm_api3_contribution_create_legacy_support_45" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Contribution.php"><a href="files/api-v3-contribution.html"><abbr title="api/v3/Contribution.php">Contribution.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">186</span>
</aside>
<p class="phpdocumentor-summary">Support for schema changes made in 4.5.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_contribution_create_legacy_support_45</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The main purpose of the API is to provide integrators a level of stability not provided by
the core code or schema - this means we have to provide support for api calls (where possible)
across schema changes.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_contribution_delete">
civicrm_api3_contribution_delete()
<a href="namespaces/default.html#function_civicrm_api3_contribution_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Contribution.php"><a href="files/api-v3-contribution.html"><abbr title="api/v3/Contribution.php">Contribution.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">213</span>
</aside>
<p class="phpdocumentor-summary">Delete a Contribution.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_contribution_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Input parameters.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_contribution_delete#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_contribution_delete_spec">
_civicrm_api3_contribution_delete_spec()
<a href="namespaces/default.html#function__civicrm_api3_contribution_delete_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Contribution.php"><a href="files/api-v3-contribution.html"><abbr title="api/v3/Contribution.php">Contribution.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">232</span>
</aside>
<p class="phpdocumentor-summary">Modify metadata for delete action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_contribution_delete_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>Legacy support for contribution_id.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_contribution_get">
civicrm_api3_contribution_get()
<a href="namespaces/default.html#function_civicrm_api3_contribution_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Contribution.php"><a href="files/api-v3-contribution.html"><abbr title="api/v3/Contribution.php">Contribution.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">245</span>
</aside>
<p class="phpdocumentor-summary">Retrieve a set of contributions.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_contribution_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Input parameters.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array of contributions, if error an array with an error id and error message</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_contribution_get_support_nonunique_returns">
_civicrm_api3_contribution_get_support_nonunique_returns()
<a href="namespaces/default.html#function__civicrm_api3_contribution_get_support_nonunique_returns" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Contribution.php"><a href="files/api-v3-contribution.html"><abbr title="api/v3/Contribution.php">Contribution.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">278</span>
</aside>
<p class="phpdocumentor-summary">Fix the return values to reflect cases where the schema has been changed.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_contribution_get_support_nonunique_returns</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>At the query object level using uniquenames dismbiguates between tables.</p>
<p>However, adding uniquename can change inputs accepted by the api, so we need
to ensure we are asking for the unique name return fields.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_contribution_get_support_nonunique_returns#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_contribution_add_supported_fields">
_civicrm_api3_contribution_add_supported_fields()
<a href="namespaces/default.html#function__civicrm_api3_contribution_add_supported_fields" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Contribution.php"><a href="files/api-v3-contribution.html"><abbr title="api/v3/Contribution.php">Contribution.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">294</span>
</aside>
<p class="phpdocumentor-summary">Support for supported output variables.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_contribution_add_supported_fields</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$contribution</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$contribution</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_contribution_getcount">
civicrm_api3_contribution_getcount()
<a href="namespaces/default.html#function_civicrm_api3_contribution_getcount" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Contribution.php"><a href="files/api-v3-contribution.html"><abbr title="api/v3/Contribution.php">Contribution.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">320</span>
</aside>
<p class="phpdocumentor-summary">Get number of contacts matching the supplied criteria.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_contribution_getcount</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">int</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_format_soft_credit">
_civicrm_api3_format_soft_credit()
<a href="namespaces/default.html#function__civicrm_api3_format_soft_credit" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Contribution.php"><a href="files/api-v3-contribution.html"><abbr title="api/v3/Contribution.php">Contribution.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">333</span>
</aside>
<p class="phpdocumentor-summary">This function is used to format the soft credit for backward compatibility.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_format_soft_credit</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$contribution</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>As of v4.4 we support multiple soft credit, so now contribution returns array with 'soft_credit' as key
but we still return first soft credit as a part of contribution array</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$contribution</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_contribution_get_spec">
_civicrm_api3_contribution_get_spec()
<a href="namespaces/default.html#function__civicrm_api3_contribution_get_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Contribution.php"><a href="files/api-v3-contribution.html"><abbr title="api/v3/Contribution.php">Contribution.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">348</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Get action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_contribution_get_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_contribute_format_params">
_civicrm_api3_contribute_format_params()
<a href="namespaces/default.html#function__civicrm_api3_contribute_format_params" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Contribution.php"><a href="files/api-v3-contribution.html"><abbr title="api/v3/Contribution.php">Contribution.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">377</span>
</aside>
<p class="phpdocumentor-summary">Legacy handling for contribution parameters.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_contribute_format_params</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$values</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>Take the input parameter list as specified in the data model and
convert it into the same format that we use in QF and BAO object.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>property name/value pairs to insert in new contact.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$values</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The reformatted properties that we can use internally.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_contribution_sendconfirmation">
civicrm_api3_contribution_sendconfirmation()
<a href="namespaces/default.html#function_civicrm_api3_contribution_sendconfirmation" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Contribution.php"><a href="files/api-v3-contribution.html"><abbr title="api/v3/Contribution.php">Contribution.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">394</span>
</aside>
<p class="phpdocumentor-summary">Send a contribution confirmation (receipt or invoice).</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_contribution_sendconfirmation</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The appropriate online template will be used (the existence of related objects
(e.g. memberships ) will affect this selection</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Input parameters.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_contribution_sendconfirmation#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\Exception">Exception</abbr></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_contribution_sendconfirmation_spec">
_civicrm_api3_contribution_sendconfirmation_spec()
<a href="namespaces/default.html#function__civicrm_api3_contribution_sendconfirmation_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Contribution.php"><a href="files/api-v3-contribution.html"><abbr title="api/v3/Contribution.php">Contribution.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">422</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for sendconfirmation action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_contribution_sendconfirmation_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_contribution_completetransaction">
civicrm_api3_contribution_completetransaction()
<a href="namespaces/default.html#function_civicrm_api3_contribution_completetransaction" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Contribution.php"><a href="files/api-v3-contribution.html"><abbr title="api/v3/Contribution.php">Contribution.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">480</span>
</aside>
<p class="phpdocumentor-summary">Complete an existing (pending) transaction.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_contribution_completetransaction</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>This will update related entities (participant, membership, pledge etc)
and take any complete actions from the contribution page (e.g. send receipt).</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Input parameters.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_contribution_completetransaction#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><ul>
<li>most of this should live in the BAO layer but as we want it to be an addition
to 4.3 which is already stable we should add it to the api layer & re-factor into the BAO layer later</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\Exception">Exception</abbr></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_contribution_completetransaction_spec">
_civicrm_api3_contribution_completetransaction_spec()
<a href="namespaces/default.html#function__civicrm_api3_contribution_completetransaction_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Contribution.php"><a href="files/api-v3-contribution.html"><abbr title="api/v3/Contribution.php">Contribution.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">531</span>
</aside>
<p class="phpdocumentor-summary">Provide function metadata.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_contribution_completetransaction_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_contribution_repeattransaction">
civicrm_api3_contribution_repeattransaction()
<a href="namespaces/default.html#function_civicrm_api3_contribution_repeattransaction" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Contribution.php"><a href="files/api-v3-contribution.html"><abbr title="api/v3/Contribution.php">Contribution.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">610</span>
</aside>
<p class="phpdocumentor-summary">Complete an existing (pending) transaction.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_contribution_repeattransaction</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>This will update related entities (participant, membership, pledge etc)
and take any complete actions from the contribution page (e.g. send receipt).</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Input parameters.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_contribution_repeattransaction#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><ul>
<li>most of this should live in the BAO layer but as we want it to be an addition
to 4.3 which is already stable we should add it to the api layer & re-factor into the BAO layer later</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>this needs a big refactor to use the
CRM_Contribute_BAO_Contribution::repeatTransaction and Payment.create where
currently it uses CRM_Contribute_BAO_Contribution::completeOrder and repeats
a lot of work. See comments in https://github.com/civicrm/civicrm-core/pull/23928</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Api result array.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_contribution_repeattransaction_spec">
_civicrm_api3_contribution_repeattransaction_spec()
<a href="namespaces/default.html#function__civicrm_api3_contribution_repeattransaction_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Contribution.php"><a href="files/api-v3-contribution.html"><abbr title="api/v3/Contribution.php">Contribution.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">682</span>
</aside>
<p class="phpdocumentor-summary">Provide function metadata.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_contribution_repeattransaction_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_contribution_deprecation">
_civicrm_api3_contribution_deprecation()
<a href="namespaces/default.html#function__civicrm_api3_contribution_deprecation" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Contribution.php"><a href="files/api-v3-contribution.html"><abbr title="api/v3/Contribution.php">Contribution.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">763</span>
</aside>
<p class="phpdocumentor-summary">Declare deprecated functions.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_contribution_deprecation</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array of deprecated actions</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_contribution_page_create">
civicrm_api3_contribution_page_create()
<a href="namespaces/default.html#function_civicrm_api3_contribution_page_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/ContributionPage.php"><a href="files/api-v3-contributionpage.html"><abbr title="api/v3/ContributionPage.php">ContributionPage.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">28</span>
</aside>
<p class="phpdocumentor-summary">Create or update a ContributionPage.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_contribution_page_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields metadata.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>api result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_contribution_page_create_spec">
_civicrm_api3_contribution_page_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_contribution_page_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/ContributionPage.php"><a href="files/api-v3-contributionpage.html"><abbr title="api/v3/ContributionPage.php">ContributionPage.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">43</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_contribution_page_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields metadata.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_contribution_page_get">
civicrm_api3_contribution_page_get()
<a href="namespaces/default.html#function_civicrm_api3_contribution_page_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/ContributionPage.php"><a href="files/api-v3-contributionpage.html"><abbr title="api/v3/ContributionPage.php">ContributionPage.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">58</span>
</aside>
<p class="phpdocumentor-summary">Returns array of ContributionPage(s) matching a set of one or more group properties.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_contribution_page_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields metadata.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API Result array Array of matching contribution_pages</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_contribution_page_delete">
civicrm_api3_contribution_page_delete()
<a href="namespaces/default.html#function_civicrm_api3_contribution_page_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/ContributionPage.php"><a href="files/api-v3-contributionpage.html"><abbr title="api/v3/ContributionPage.php">ContributionPage.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">73</span>
</aside>
<p class="phpdocumentor-summary">Delete an existing ContributionPage.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_contribution_page_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>This method is used to delete any existing ContributionPage given its id.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields metadata.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result Array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_contribution_page_submit">
civicrm_api3_contribution_page_submit()
<a href="namespaces/default.html#function_civicrm_api3_contribution_page_submit" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/ContributionPage.php"><a href="files/api-v3-contributionpage.html"><abbr title="api/v3/ContributionPage.php">ContributionPage.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">86</span>
</aside>
<p class="phpdocumentor-summary">Submit a ContributionPage.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_contribution_page_submit</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields metadata.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_contribution_page_validate">
civicrm_api3_contribution_page_validate()
<a href="namespaces/default.html#function_civicrm_api3_contribution_page_validate" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/ContributionPage.php"><a href="files/api-v3-contributionpage.html"><abbr title="api/v3/ContributionPage.php">ContributionPage.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">100</span>
</aside>
<p class="phpdocumentor-summary">Validate ContributionPage submission parameters.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_contribution_page_validate</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields metadata.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_contribution_page_validate_spec">
_civicrm_api3_contribution_page_validate_spec()
<a href="namespaces/default.html#function__civicrm_api3_contribution_page_validate_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/ContributionPage.php"><a href="files/api-v3-contributionpage.html"><abbr title="api/v3/ContributionPage.php">ContributionPage.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">137</span>
</aside>
<p class="phpdocumentor-summary">Metadata for validate action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_contribution_page_validate_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_contribution_page_getlist_defaults">
_civicrm_api3_contribution_page_getlist_defaults()
<a href="namespaces/default.html#function__civicrm_api3_contribution_page_getlist_defaults" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/ContributionPage.php"><a href="files/api-v3-contributionpage.html"><abbr title="api/v3/ContributionPage.php">ContributionPage.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">154</span>
</aside>
<p class="phpdocumentor-summary">Set default getlist parameters.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_contribution_page_getlist_defaults</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$request</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$request</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_contribution_page_getlist_defaults#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\_civicrm_api3_generic_getlist_defaults">_civicrm_api3_generic_getlist_defaults</abbr></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_contribution_page_deprecation">
_civicrm_api3_contribution_page_deprecation()
<a href="namespaces/default.html#function__civicrm_api3_contribution_page_deprecation" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/ContributionPage.php"><a href="files/api-v3-contributionpage.html"><abbr title="api/v3/ContributionPage.php">ContributionPage.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">165</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_contribution_page_deprecation</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_contribution_product_create">
civicrm_api3_contribution_product_create()
<a href="namespaces/default.html#function_civicrm_api3_contribution_product_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/ContributionProduct.php"><a href="files/api-v3-contributionproduct.html"><abbr title="api/v3/ContributionProduct.php">ContributionProduct.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">29</span>
</aside>
<p class="phpdocumentor-summary">Save a contribution product.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_contribution_product_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_contribution_product_create#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_contribution_product_get">
civicrm_api3_contribution_product_get()
<a href="namespaces/default.html#function_civicrm_api3_contribution_product_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/ContributionProduct.php"><a href="files/api-v3-contributionproduct.html"><abbr title="api/v3/ContributionProduct.php">ContributionProduct.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">41</span>
</aside>
<p class="phpdocumentor-summary">Get a contribution product.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_contribution_product_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array of retrieved product property values.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_contribution_product_delete">
civicrm_api3_contribution_product_delete()
<a href="namespaces/default.html#function_civicrm_api3_contribution_product_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/ContributionProduct.php"><a href="files/api-v3-contributionproduct.html"><abbr title="api/v3/ContributionProduct.php">ContributionProduct.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">54</span>
</aside>
<p class="phpdocumentor-summary">Delete a contribution product.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_contribution_product_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_contribution_product_delete#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array of deleted values.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_contribution_recur_create">
civicrm_api3_contribution_recur_create()
<a href="namespaces/default.html#function_civicrm_api3_contribution_recur_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/ContributionRecur.php"><a href="files/api-v3-contributionrecur.html"><abbr title="api/v3/ContributionRecur.php">ContributionRecur.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">29</span>
</aside>
<p class="phpdocumentor-summary">Create or update a ContributionRecur.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_contribution_recur_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields metadata.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>api result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_contribution_recur_create_spec">
_civicrm_api3_contribution_recur_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_contribution_recur_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/ContributionRecur.php"><a href="files/api-v3-contributionrecur.html"><abbr title="api/v3/ContributionRecur.php">ContributionRecur.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">41</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_contribution_recur_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_contribution_recur_get">
civicrm_api3_contribution_recur_get()
<a href="namespaces/default.html#function_civicrm_api3_contribution_recur_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/ContributionRecur.php"><a href="files/api-v3-contributionrecur.html"><abbr title="api/v3/ContributionRecur.php">ContributionRecur.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">59</span>
</aside>
<p class="phpdocumentor-summary">Returns array of contribution_recurs matching a set of one or more group properties.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_contribution_recur_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of properties. If empty, all records will be returned.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result Array of matching contribution_recurs</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_contribution_recur_cancel">
civicrm_api3_contribution_recur_cancel()
<a href="namespaces/default.html#function_civicrm_api3_contribution_recur_cancel" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/ContributionRecur.php"><a href="files/api-v3-contributionrecur.html"><abbr title="api/v3/ContributionRecur.php">ContributionRecur.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">73</span>
</aside>
<p class="phpdocumentor-summary">Cancel a recurring contribution of existing ContributionRecur given its id.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_contribution_recur_cancel</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array containing id of the recurring contribution.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_contribution_recur_cancel#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>returns true is successfully cancelled</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_contribution_recur_cancel_spec">
_civicrm_api3_contribution_recur_cancel_spec()
<a href="namespaces/default.html#function__civicrm_api3_contribution_recur_cancel_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/ContributionRecur.php"><a href="files/api-v3-contributionrecur.html"><abbr title="api/v3/ContributionRecur.php">ContributionRecur.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">98</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Cancel action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_contribution_recur_cancel_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_contribution_recur_delete">
civicrm_api3_contribution_recur_delete()
<a href="namespaces/default.html#function_civicrm_api3_contribution_recur_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/ContributionRecur.php"><a href="files/api-v3-contributionrecur.html"><abbr title="api/v3/ContributionRecur.php">ContributionRecur.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">117</span>
</aside>
<p class="phpdocumentor-summary">Delete an existing ContributionRecur.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_contribution_recur_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>This method is used to delete an existing ContributionRecur given its id.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>[id]</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_contribution_soft_create">
civicrm_api3_contribution_soft_create()
<a href="namespaces/default.html#function_civicrm_api3_contribution_soft_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/ContributionSoft.php"><a href="files/api-v3-contributionsoft.html"><abbr title="api/v3/ContributionSoft.php">ContributionSoft.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">27</span>
</aside>
<p class="phpdocumentor-summary">Create or Update a Soft Credit.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_contribution_soft_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields metadata.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_contribution_soft_create_spec">
_civicrm_api3_contribution_soft_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_contribution_soft_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/ContributionSoft.php"><a href="files/api-v3-contributionsoft.html"><abbr title="api/v3/ContributionSoft.php">ContributionSoft.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">39</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_contribution_soft_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_contribution_soft_delete">
civicrm_api3_contribution_soft_delete()
<a href="namespaces/default.html#function_civicrm_api3_contribution_soft_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/ContributionSoft.php"><a href="files/api-v3-contributionsoft.html"><abbr title="api/v3/ContributionSoft.php">ContributionSoft.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">55</span>
</aside>
<p class="phpdocumentor-summary">Deletes an existing Soft Credit.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_contribution_soft_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_contribution_soft_delete#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Api formatted result.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_contribution_soft_get">
civicrm_api3_contribution_soft_get()
<a href="namespaces/default.html#function_civicrm_api3_contribution_soft_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/ContributionSoft.php"><a href="files/api-v3-contributionsoft.html"><abbr title="api/v3/ContributionSoft.php">ContributionSoft.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">68</span>
</aside>
<p class="phpdocumentor-summary">Retrieve one or more Soft Credits.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_contribution_soft_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields metadata.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_country_create">
civicrm_api3_country_create()
<a href="namespaces/default.html#function_civicrm_api3_country_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Country.php"><a href="files/api-v3-country.html"><abbr title="api/v3/Country.php">Country.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">28</span>
</aside>
<p class="phpdocumentor-summary">Add an Country for a contact.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_country_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields metadata.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_country_create#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_country_create_spec">
_civicrm_api3_country_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_country_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Country.php"><a href="files/api-v3-country.html"><abbr title="api/v3/Country.php">Country.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">40</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_country_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_country_delete">
civicrm_api3_country_delete()
<a href="namespaces/default.html#function_civicrm_api3_country_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Country.php"><a href="files/api-v3-country.html"><abbr title="api/v3/Country.php">Country.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">51</span>
</aside>
<p class="phpdocumentor-summary">Deletes an existing Country.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_country_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_country_get">
civicrm_api3_country_get()
<a href="namespaces/default.html#function_civicrm_api3_country_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Country.php"><a href="files/api-v3-country.html"><abbr title="api/v3/Country.php">Country.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">64</span>
</aside>
<p class="phpdocumentor-summary">Retrieve one or more countryies.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_country_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields metadata.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>api result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_custom_field_create">
civicrm_api3_custom_field_create()
<a href="namespaces/default.html#function_civicrm_api3_custom_field_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/CustomField.php"><a href="files/api-v3-customfield.html"><abbr title="api/v3/CustomField.php">CustomField.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">32</span>
</aside>
<p class="phpdocumentor-summary">Create a 'custom field' within a custom field group.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_custom_field_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>We also empty the static var in the getfields
function after deletion so that the field is available for us (getfields
manages date conversion among other things</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields metadata.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_custom_field_create#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API success array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_custom_field_flush_static_caches">
_civicrm_api3_custom_field_flush_static_caches()
<a href="namespaces/default.html#function__civicrm_api3_custom_field_flush_static_caches" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/CustomField.php"><a href="files/api-v3-customfield.html"><abbr title="api/v3/CustomField.php">CustomField.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">84</span>
</aside>
<p class="phpdocumentor-summary">Flush static caches in functions that might have stored available custom fields.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_custom_field_flush_static_caches</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_custom_field_create_spec">
_civicrm_api3_custom_field_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_custom_field_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/CustomField.php"><a href="files/api-v3-customfield.html"><abbr title="api/v3/CustomField.php">CustomField.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">98</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_custom_field_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_custom_field_delete">
civicrm_api3_custom_field_delete()
<a href="namespaces/default.html#function_civicrm_api3_custom_field_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/CustomField.php"><a href="files/api-v3-customfield.html"><abbr title="api/v3/CustomField.php">CustomField.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">118</span>
</aside>
<p class="phpdocumentor-summary">Use this API to delete an existing custom field.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_custom_field_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array id of the field to be deleted.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_custom_field_get">
civicrm_api3_custom_field_get()
<a href="namespaces/default.html#function_civicrm_api3_custom_field_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/CustomField.php"><a href="files/api-v3-customfield.html"><abbr title="api/v3/CustomField.php">CustomField.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">135</span>
</aside>
<p class="phpdocumentor-summary">Use this API to get existing custom fields.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_custom_field_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array to search on.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - -deprecated">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_custom_field_validate_field">
_civicrm_api3_custom_field_validate_field()
<a href="namespaces/default.html#function__civicrm_api3_custom_field_validate_field" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/CustomField.php"><a href="files/api-v3-customfield.html"><abbr title="api/v3/CustomField.php">CustomField.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">220</span>
</aside>
<p class="phpdocumentor-summary">Helper function to validate custom field value.</p>
<div class="phpdocumentor-admonition">
<svg class="phpdocumentor-admonition__icon" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-3L13.732 4c-.77-1.333-2.694-1.333-3.464 0L3.34 16c-.77 1.333.192 3 1.732 3z"></path></svg>
<article>
</article>
</div>
<code class="phpdocumentor-code phpdocumentor-signature -deprecated">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_custom_field_validate_field</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$fieldName</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$value</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$fieldDetails</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$errors</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed>|null</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fieldName</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Custom field name (eg: custom_8 ).</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$value</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Field value to be validate.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fieldDetails</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Field Details.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$errors</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
= <span class="phpdocumentor-signature__argument__default-value">[]</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Collect validation errors.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_custom_field_validate_field#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>remove this function - not in use but need to review functionality before
removing as it might be useful in wrapper layer</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed>|null</span>
—
<section class="phpdocumentor-description"><p>Validation errors</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_custom_field_setvalue">
civicrm_api3_custom_field_setvalue()
<a href="namespaces/default.html#function_civicrm_api3_custom_field_setvalue" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/CustomField.php"><a href="files/api-v3-customfield.html"><abbr title="api/v3/CustomField.php">CustomField.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">333</span>
</aside>
<p class="phpdocumentor-summary">CRM-15191 - Hack to ensure the cache gets cleared after updating a custom field.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_custom_field_setvalue</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields metadata.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_custom_field_getoptions">
civicrm_api3_custom_field_getoptions()
<a href="namespaces/default.html#function_civicrm_api3_custom_field_getoptions" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/CustomField.php"><a href="files/api-v3-customfield.html"><abbr title="api/v3/CustomField.php">CustomField.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">342</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_custom_field_getoptions</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_custom_group_create">
civicrm_api3_custom_group_create()
<a href="namespaces/default.html#function_civicrm_api3_custom_group_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/CustomGroup.php"><a href="files/api-v3-customgroup.html"><abbr title="api/v3/CustomGroup.php">CustomGroup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">27</span>
</aside>
<p class="phpdocumentor-summary">This entire function consists of legacy handling, probably for a form that no longer exists.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_custom_group_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>APIv3 is where code like this goes to die...</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>For legacy reasons, 'extends' can be passed as an array (for setting Participant column_value)</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_custom_group_create_spec">
_civicrm_api3_custom_group_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_custom_group_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/CustomGroup.php"><a href="files/api-v3-customgroup.html"><abbr title="api/v3/CustomGroup.php">CustomGroup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">71</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_custom_group_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_custom_group_delete">
civicrm_api3_custom_group_delete()
<a href="namespaces/default.html#function_civicrm_api3_custom_group_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/CustomGroup.php"><a href="files/api-v3-customgroup.html"><abbr title="api/v3/CustomGroup.php">CustomGroup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">85</span>
</aside>
<p class="phpdocumentor-summary">Use this API to delete an existing group.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_custom_group_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_custom_group_get">
civicrm_api3_custom_group_get()
<a href="namespaces/default.html#function_civicrm_api3_custom_group_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/CustomGroup.php"><a href="files/api-v3-customgroup.html"><abbr title="api/v3/CustomGroup.php">CustomGroup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">103</span>
</aside>
<p class="phpdocumentor-summary">API to get existing custom fields.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_custom_group_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields metadata.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_custom_group_setvalue">
civicrm_api3_custom_group_setvalue()
<a href="namespaces/default.html#function_civicrm_api3_custom_group_setvalue" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/CustomGroup.php"><a href="files/api-v3-customgroup.html"><abbr title="api/v3/CustomGroup.php">CustomGroup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">115</span>
</aside>
<p class="phpdocumentor-summary">CRM-15191 - Hack to ensure the cache gets cleared after updating a custom group.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_custom_group_setvalue</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields metadata.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_custom_group_getoptions">
civicrm_api3_custom_group_getoptions()
<a href="namespaces/default.html#function_civicrm_api3_custom_group_getoptions" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/CustomGroup.php"><a href="files/api-v3-customgroup.html"><abbr title="api/v3/CustomGroup.php">CustomGroup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">124</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_custom_group_getoptions</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_custom_search_get">
civicrm_api3_custom_search_get()
<a href="namespaces/default.html#function_civicrm_api3_custom_search_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/CustomSearch.php"><a href="files/api-v3-customsearch.html"><abbr title="api/v3/CustomSearch.php">CustomSearch.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">26</span>
</aside>
<p class="phpdocumentor-summary">Retrieve custom searches.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_custom_search_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_custom_search_create">
civicrm_api3_custom_search_create()
<a href="namespaces/default.html#function_civicrm_api3_custom_search_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/CustomSearch.php"><a href="files/api-v3-customsearch.html"><abbr title="api/v3/CustomSearch.php">CustomSearch.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">42</span>
</aside>
<p class="phpdocumentor-summary">Add a CustomSearch.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_custom_search_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_custom_search_create_spec">
_civicrm_api3_custom_search_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_custom_search_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/CustomSearch.php"><a href="files/api-v3-customsearch.html"><abbr title="api/v3/CustomSearch.php">CustomSearch.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">62</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_custom_search_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_custom_search_delete">
civicrm_api3_custom_search_delete()
<a href="namespaces/default.html#function_civicrm_api3_custom_search_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/CustomSearch.php"><a href="files/api-v3-customsearch.html"><abbr title="api/v3/CustomSearch.php">CustomSearch.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">79</span>
</aside>
<p class="phpdocumentor-summary">Deletes an existing CustomSearch.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_custom_search_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_custom_value_create">
civicrm_api3_custom_value_create()
<a href="namespaces/default.html#function_civicrm_api3_custom_value_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/CustomValue.php"><a href="files/api-v3-customvalue.html"><abbr title="api/v3/CustomValue.php">CustomValue.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">48</span>
</aside>
<p class="phpdocumentor-summary">Sets custom values for an entity.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_custom_value_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Expected keys are in format custom_fieldID:recordID or custom_groupName:fieldName:recordID.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_custom_value_create#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">example:</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><pre class="prettyprint"><code class="prettyprint"> // entity ID. You do not need to specify entity type, we figure it out based on the fields you're using
'entity_id' => 123,
// (omitting :id) inserts or updates a field in a single-valued group
'custom_6' => 'foo',
// custom_24 is checkbox or multiselect, so pass items as an array
'custom_24' => array('bar', 'baz'),
// in this case custom_33 is part of a multi-valued group, and we're updating record id 5
'custom_33:5' => value,
// inserts new record in multi-valued group
'custom_33:-1' => value,
// inserts another new record in multi-valued group
'custom_33:-2' => value,
// you can use group_name:field_name instead of ID
'custom_some_group:my_field' => 'myinfo',
// updates record ID 8 in my_other_field in multi-valued some_big_group
'custom_some_big_group:my_other_field:8' => 'myinfo',
</code></pre>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\Exception">Exception</abbr></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>['values' => TRUE] or ['is_error' => 1, 'error_message' => 'what went wrong']</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_custom_value_create_spec">
_civicrm_api3_custom_value_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_custom_value_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/CustomValue.php"><a href="files/api-v3-customvalue.html"><abbr title="api/v3/CustomValue.php">CustomValue.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">99</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_custom_value_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_custom_value_get">
civicrm_api3_custom_value_get()
<a href="namespaces/default.html#function_civicrm_api3_custom_value_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/CustomValue.php"><a href="files/api-v3-customvalue.html"><abbr title="api/v3/CustomValue.php">CustomValue.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">119</span>
</aside>
<p class="phpdocumentor-summary">Use this API to get existing custom values for an entity.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_custom_value_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array specifying the entity_id.
Optionally include entity_type param, i.e. 'entity_type' => 'Activity'
If no entity_type is supplied, it will be determined based on the fields you request.
If no entity_type is supplied and no fields are specified, 'Contact' will be assumed.
Optionally include the desired custom data to be fetched (or else all custom data for this entity will be returned)
Example: 'entity_id' => 123, 'return.custom_6' => 1, 'return.custom_33' => 1
If you do not know the ID, you may use group name : field name, for example 'return.foo_stuff:my_field' => 1</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_custom_value_get#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_custom_value_get_spec">
_civicrm_api3_custom_value_get_spec()
<a href="namespaces/default.html#function__civicrm_api3_custom_value_get_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/CustomValue.php"><a href="files/api-v3-customvalue.html"><abbr title="api/v3/CustomValue.php">CustomValue.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">223</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Get action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_custom_value_get_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_custom_value_gettree_spec">
_civicrm_api3_custom_value_gettree_spec()
<a href="namespaces/default.html#function__civicrm_api3_custom_value_gettree_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/CustomValue.php"><a href="files/api-v3-customvalue.html"><abbr title="api/v3/CustomValue.php">CustomValue.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">235</span>
</aside>
<p class="phpdocumentor-summary">CustomValue.gettree API specification</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_custom_value_gettree_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$spec</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$spec</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>description of fields supported by this API call</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_custom_value_gettree_spec#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_custom_value_gettree">
civicrm_api3_custom_value_gettree()
<a href="namespaces/default.html#function_civicrm_api3_custom_value_gettree" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/CustomValue.php"><a href="files/api-v3-customvalue.html"><abbr title="api/v3/CustomValue.php">CustomValue.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">286</span>
</aside>
<p class="phpdocumentor-summary">CustomValue.gettree API</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_custom_value_gettree</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_custom_value_gettree#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_custom_value_getdisplayvalue_spec">
_civicrm_api3_custom_value_getdisplayvalue_spec()
<a href="namespaces/default.html#function__civicrm_api3_custom_value_getdisplayvalue_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/CustomValue.php"><a href="files/api-v3-customvalue.html"><abbr title="api/v3/CustomValue.php">CustomValue.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">387</span>
</aside>
<p class="phpdocumentor-summary">CustomValue.getdisplayvalue API specification</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_custom_value_getdisplayvalue_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$spec</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$spec</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>description of fields supported by this API call</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_custom_value_getdisplayvalue">
civicrm_api3_custom_value_getdisplayvalue()
<a href="namespaces/default.html#function_civicrm_api3_custom_value_getdisplayvalue" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/CustomValue.php"><a href="files/api-v3-customvalue.html"><abbr title="api/v3/CustomValue.php">CustomValue.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">416</span>
</aside>
<p class="phpdocumentor-summary">CustomValue.getdisplayvalue API</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_custom_value_getdisplayvalue</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_custom_value_getdisplayvalue#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_cxn_register_spec">
_civicrm_api3_cxn_register_spec()
<a href="namespaces/default.html#function__civicrm_api3_cxn_register_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Cxn.php"><a href="files/api-v3-cxn.html"><abbr title="api/v3/Cxn.php">Cxn.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">27</span>
</aside>
<p class="phpdocumentor-summary">Adjust metadata for "register" action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_cxn_register_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$spec</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$spec</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>List of fields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_cxn_register">
civicrm_api3_cxn_register()
<a href="namespaces/default.html#function_civicrm_api3_cxn_register" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Cxn.php"><a href="files/api-v3-cxn.html"><abbr title="api/v3/Cxn.php">Cxn.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">54</span>
</aside>
<p class="phpdocumentor-summary">Register with a remote application and create a new connection.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_cxn_register</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>One should generally identify an application using the app_guid.
However, if you need to test a new/experimental application, then
disable CIVICRM_CXN_CA and specify app_meta_url.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array with keys:</p>
<ul>
<li>app_guid: The unique identifier of the target application.</li>
<li>app_meta_url: The URL for the application's metadata.</li>
</ul>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_cxn_register#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\Exception">Exception</abbr></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_cxn_unregister_spec">
_civicrm_api3_cxn_unregister_spec()
<a href="namespaces/default.html#function__civicrm_api3_cxn_unregister_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Cxn.php"><a href="files/api-v3-cxn.html"><abbr title="api/v3/Cxn.php">Cxn.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">95</span>
</aside>
<p class="phpdocumentor-summary">Adjust metadata for cxn unregister.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_cxn_unregister_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$spec</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$spec</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_cxn_unregister">
civicrm_api3_cxn_unregister()
<a href="namespaces/default.html#function_civicrm_api3_cxn_unregister" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Cxn.php"><a href="files/api-v3-cxn.html"><abbr title="api/v3/Cxn.php">Cxn.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">120</span>
</aside>
<p class="phpdocumentor-summary">Unregister with a remote application; destroy an existing connection.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_cxn_unregister</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>Specify app_guid XOR cxn_guid.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array with keys:</p>
<ul>
<li>cxn_guid: string</li>
<li>app_guid: string</li>
<li>force: bool</li>
</ul>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_cxn_parseCxnId">
_civicrm_api3_cxn_parseCxnId()
<a href="namespaces/default.html#function__civicrm_api3_cxn_parseCxnId" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Cxn.php"><a href="files/api-v3-cxn.html"><abbr title="api/v3/Cxn.php">Cxn.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">139</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_cxn_parseCxnId</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>An array with cxn_guid and/or app_guid.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_cxn_parseCxnId#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
—
<section class="phpdocumentor-description"><p>The CxnId. (If not available, then an exception is thrown.)</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_cxn_get_spec">
_civicrm_api3_cxn_get_spec()
<a href="namespaces/default.html#function__civicrm_api3_cxn_get_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Cxn.php"><a href="files/api-v3-cxn.html"><abbr title="api/v3/Cxn.php">Cxn.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">164</span>
</aside>
<p class="phpdocumentor-summary">Adjust metadata for cxn get action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_cxn_get_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$spec</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$spec</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_cxn_get">
civicrm_api3_cxn_get()
<a href="namespaces/default.html#function_civicrm_api3_cxn_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Cxn.php"><a href="files/api-v3-cxn.html"><abbr title="api/v3/Cxn.php">Cxn.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">178</span>
</aside>
<p class="phpdocumentor-summary">Returns an array of Cxn records.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_cxn_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of one or more valid property_name=>value pairs.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_cxn_getlink_spec">
_civicrm_api3_cxn_getlink_spec()
<a href="namespaces/default.html#function__civicrm_api3_cxn_getlink_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Cxn.php"><a href="files/api-v3-cxn.html"><abbr title="api/v3/Cxn.php">Cxn.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">205</span>
</aside>
<p class="phpdocumentor-summary">Adjust metadata for "getlink" action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_cxn_getlink_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$spec</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$spec</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>List of fields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_cxn_getlink">
civicrm_api3_cxn_getlink()
<a href="namespaces/default.html#function_civicrm_api3_cxn_getlink" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Cxn.php"><a href="files/api-v3-cxn.html"><abbr title="api/v3/Cxn.php">Cxn.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">229</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_cxn_getlink</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array with keys:</p>
<ul>
<li>cxn_guid OR app_guid: string.</li>
<li>page: string.</li>
</ul>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_cxn_getlink#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\Exception">Exception</abbr></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_cxn_getcfg">
civicrm_api3_cxn_getcfg()
<a href="namespaces/default.html#function_civicrm_api3_cxn_getcfg" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Cxn.php"><a href="files/api-v3-cxn.html"><abbr title="api/v3/Cxn.php">Cxn.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">250</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_cxn_getcfg</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_cxn_getcfg#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\Exception">Exception</abbr></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_cxn_create">
civicrm_api3_cxn_create()
<a href="namespaces/default.html#function_civicrm_api3_cxn_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Cxn.php"><a href="files/api-v3-cxn.html"><abbr title="api/v3/Cxn.php">Cxn.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">271</span>
</aside>
<p class="phpdocumentor-summary">Creates or modifies a Cxn row.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_cxn_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><abbr title="\page">page</abbr></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array with keys:</p>
<ul>
<li>id, cxn_guid OR app_guid: string.</li>
<li>is_active: boolean.</li>
<li>options: JSON</li>
</ul>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_cxn_create#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\Exception">Exception</abbr></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><abbr title="\page">page</abbr></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_cxn_app_get_spec">
_civicrm_api3_cxn_app_get_spec()
<a href="namespaces/default.html#function__civicrm_api3_cxn_app_get_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/CxnApp.php"><a href="files/api-v3-cxnapp.html"><abbr title="api/v3/CxnApp.php">CxnApp.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">34</span>
</aside>
<p class="phpdocumentor-summary">Adjust metadata for "register" action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_cxn_app_get_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$spec</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$spec</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>List of fields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_cxn_app_get">
civicrm_api3_cxn_app_get()
<a href="namespaces/default.html#function_civicrm_api3_cxn_app_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/CxnApp.php"><a href="files/api-v3-cxnapp.html"><abbr title="api/v3/CxnApp.php">CxnApp.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">80</span>
</aside>
<p class="phpdocumentor-summary">Get a list of applications available for connections.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_cxn_app_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_cxn_app_get#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\Civi\Cxn\Rpc\Exception\InvalidMessageException">InvalidMessageException</abbr></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_dashboard_create">
civicrm_api3_dashboard_create()
<a href="namespaces/default.html#function_civicrm_api3_dashboard_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Dashboard.php"><a href="files/api-v3-dashboard.html"><abbr title="api/v3/Dashboard.php">Dashboard.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">26</span>
</aside>
<p class="phpdocumentor-summary">Creates or updates an Dashlet.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_dashboard_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array containing 'is_error' to denote success or failure and details of the created activity</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_dashboard_create_spec">
_civicrm_api3_dashboard_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_dashboard_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Dashboard.php"><a href="files/api-v3-dashboard.html"><abbr title="api/v3/Dashboard.php">Dashboard.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">45</span>
</aside>
<p class="phpdocumentor-summary">Specify Meta data for create.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_dashboard_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>Note that this data is retrievable via the getfields function
and is used for pre-filling defaults and ensuring mandatory requirements are met.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_dashboard_get">
civicrm_api3_dashboard_get()
<a href="namespaces/default.html#function_civicrm_api3_dashboard_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Dashboard.php"><a href="files/api-v3-dashboard.html"><abbr title="api/v3/Dashboard.php">Dashboard.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">57</span>
</aside>
<p class="phpdocumentor-summary">Gets a CiviCRM Dashlets according to parameters.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_dashboard_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_dashboard_delete">
civicrm_api3_dashboard_delete()
<a href="namespaces/default.html#function_civicrm_api3_dashboard_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Dashboard.php"><a href="files/api-v3-dashboard.html"><abbr title="api/v3/Dashboard.php">Dashboard.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">70</span>
</aside>
<p class="phpdocumentor-summary">Delete a specified Dashlet.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_dashboard_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array holding 'id' of dashlet to be deleted.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_dashboard_delete#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_dashboard_contact_create">
civicrm_api3_dashboard_contact_create()
<a href="namespaces/default.html#function_civicrm_api3_dashboard_contact_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/DashboardContact.php"><a href="files/api-v3-dashboardcontact.html"><abbr title="api/v3/DashboardContact.php">DashboardContact.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">25</span>
</aside>
<p class="phpdocumentor-summary">Creates/Updates a new Dashboard Contact Entry.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_dashboard_contact_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_dashboard_contact_get">
civicrm_api3_dashboard_contact_get()
<a href="namespaces/default.html#function_civicrm_api3_dashboard_contact_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/DashboardContact.php"><a href="files/api-v3-dashboardcontact.html"><abbr title="api/v3/DashboardContact.php">DashboardContact.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">37</span>
</aside>
<p class="phpdocumentor-summary">Gets a CiviCRM Dashlets of Contacts according to parameters.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_dashboard_contact_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields metadata.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_dashboard_contact_create_spec">
_civicrm_api3_dashboard_contact_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_dashboard_contact_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/DashboardContact.php"><a href="files/api-v3-dashboardcontact.html"><abbr title="api/v3/DashboardContact.php">DashboardContact.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">49</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_dashboard_contact_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$fields</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fields</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of fields determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_dashboard_contact_delete">
civicrm_api3_dashboard_contact_delete()
<a href="namespaces/default.html#function_civicrm_api3_dashboard_contact_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/DashboardContact.php"><a href="files/api-v3-dashboardcontact.html"><abbr title="api/v3/DashboardContact.php">DashboardContact.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">61</span>
</aside>
<p class="phpdocumentor-summary">Delete an existing dashboard-contact.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_dashboard_contact_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_dashboard_contact_delete#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_dedupe_get">
civicrm_api3_dedupe_get()
<a href="namespaces/default.html#function_civicrm_api3_dedupe_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Dedupe.php"><a href="files/api-v3-dedupe.html"><abbr title="api/v3/Dedupe.php">Dedupe.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">26</span>
</aside>
<p class="phpdocumentor-summary">Get rows for any cached attempted merges on the passed criteria.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_dedupe_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_dedupe_get#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_dedupe_get_spec">
_civicrm_api3_dedupe_get_spec()
<a href="namespaces/default.html#function__civicrm_api3_dedupe_get_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Dedupe.php"><a href="files/api-v3-dedupe.html"><abbr title="api/v3/Dedupe.php">Dedupe.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">49</span>
</aside>
<p class="phpdocumentor-summary">Get rows for getting dedupe cache records.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_dedupe_get_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_dedupe_delete">
civicrm_api3_dedupe_delete()
<a href="namespaces/default.html#function_civicrm_api3_dedupe_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Dedupe.php"><a href="files/api-v3-dedupe.html"><abbr title="api/v3/Dedupe.php">Dedupe.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">64</span>
</aside>
<p class="phpdocumentor-summary">Delete rows for any cached attempted merges on the passed criteria.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_dedupe_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_dedupe_delete#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/Civi-API-Exception-UnauthorizedException.html"><abbr title="\Civi\API\Exception\UnauthorizedException">UnauthorizedException</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_dedupe_create">
civicrm_api3_dedupe_create()
<a href="namespaces/default.html#function_civicrm_api3_dedupe_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Dedupe.php"><a href="files/api-v3-dedupe.html"><abbr title="api/v3/Dedupe.php">Dedupe.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">77</span>
</aside>
<p class="phpdocumentor-summary">Get the statistics for any cached attempted merges on the passed criteria.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_dedupe_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_dedupe_create#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/Civi-API-Exception-UnauthorizedException.html"><abbr title="\Civi\API\Exception\UnauthorizedException">UnauthorizedException</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_dedupe_getstatistics">
civicrm_api3_dedupe_getstatistics()
<a href="namespaces/default.html#function_civicrm_api3_dedupe_getstatistics" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Dedupe.php"><a href="files/api-v3-dedupe.html"><abbr title="api/v3/Dedupe.php">Dedupe.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">89</span>
</aside>
<p class="phpdocumentor-summary">Get the statistics for any cached attempted merges on the passed criteria.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_dedupe_getstatistics</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_dedupe_getstatistics#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_dedupe_getstatistics_spec">
_civicrm_api3_dedupe_getstatistics_spec()
<a href="namespaces/default.html#function__civicrm_api3_dedupe_getstatistics_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Dedupe.php"><a href="files/api-v3-dedupe.html"><abbr title="api/v3/Dedupe.php">Dedupe.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">108</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_dedupe_getstatistics_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_dedupe_getduplicates">
civicrm_api3_dedupe_getduplicates()
<a href="namespaces/default.html#function_civicrm_api3_dedupe_getduplicates" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Dedupe.php"><a href="files/api-v3-dedupe.html"><abbr title="api/v3/Dedupe.php">Dedupe.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">140</span>
</aside>
<p class="phpdocumentor-summary">Get the duplicate contacts for the supplied parameters.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_dedupe_getduplicates</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_dedupe_getduplicates#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_dedupe_getduplicates_spec">
_civicrm_api3_dedupe_getduplicates_spec()
<a href="namespaces/default.html#function__civicrm_api3_dedupe_getduplicates_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Dedupe.php"><a href="files/api-v3-dedupe.html"><abbr title="api/v3/Dedupe.php">Dedupe.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">154</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for getduplicates action..
The metadata is used for setting defaults, documentation & validation.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_dedupe_getduplicates_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_domain_get">
civicrm_api3_domain_get()
<a href="namespaces/default.html#function_civicrm_api3_domain_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Domain.php"><a href="files/api-v3-domain.html"><abbr title="api/v3/Domain.php">Domain.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">26</span>
</aside>
<p class="phpdocumentor-summary">Get CiviCRM Domain details.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_domain_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_domain_get#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_domain_get_spec">
_civicrm_api3_domain_get_spec()
<a href="namespaces/default.html#function__civicrm_api3_domain_get_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Domain.php"><a href="files/api-v3-domain.html"><abbr title="api/v3/Domain.php">Domain.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">104</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Get action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_domain_get_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_domain_create">
civicrm_api3_domain_create()
<a href="namespaces/default.html#function_civicrm_api3_domain_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Domain.php"><a href="files/api-v3-domain.html"><abbr title="api/v3/Domain.php">Domain.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">118</span>
</aside>
<p class="phpdocumentor-summary">Create a new Domain.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_domain_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_domain_create_spec">
_civicrm_api3_domain_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_domain_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Domain.php"><a href="files/api-v3-domain.html"><abbr title="api/v3/Domain.php">Domain.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">145</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_domain_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_email_create">
civicrm_api3_email_create()
<a href="namespaces/default.html#function_civicrm_api3_email_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Email.php"><a href="files/api-v3-email.html"><abbr title="api/v3/Email.php">Email.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">30</span>
</aside>
<p class="phpdocumentor-summary">Add an Email for a contact.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_email_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields metadata.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_email_create#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/Civi-API-Exception-UnauthorizedException.html"><abbr title="\Civi\API\Exception\UnauthorizedException">UnauthorizedException</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_email_create_spec">
_civicrm_api3_email_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_email_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Email.php"><a href="files/api-v3-email.html"><abbr title="api/v3/Email.php">Email.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">42</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_email_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_email_delete">
civicrm_api3_email_delete()
<a href="namespaces/default.html#function_civicrm_api3_email_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Email.php"><a href="files/api-v3-email.html"><abbr title="api/v3/Email.php">Email.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">64</span>
</aside>
<p class="phpdocumentor-summary">Deletes an existing Email.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_email_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields metadata.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_email_delete#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/Civi-API-Exception-UnauthorizedException.html"><abbr title="\Civi\API\Exception\UnauthorizedException">UnauthorizedException</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_email_get">
civicrm_api3_email_get()
<a href="namespaces/default.html#function_civicrm_api3_email_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Email.php"><a href="files/api-v3-email.html"><abbr title="api/v3/Email.php">Email.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">77</span>
</aside>
<p class="phpdocumentor-summary">Retrieve one or more emails.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_email_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields metadata.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>api result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_email_getlist_defaults">
_civicrm_api3_email_getlist_defaults()
<a href="namespaces/default.html#function__civicrm_api3_email_getlist_defaults" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Email.php"><a href="files/api-v3-email.html"><abbr title="api/v3/Email.php">Email.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">90</span>
</aside>
<p class="phpdocumentor-summary">Set default getlist parameters.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_email_getlist_defaults</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$request</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$request</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_email_getlist_defaults#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\_civicrm_api3_generic_getlist_defaults">_civicrm_api3_generic_getlist_defaults</abbr></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_entity_deprecation">
_civicrm_api3_entity_deprecation()
<a href="namespaces/default.html#function__civicrm_api3_entity_deprecation" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Entity.php"><a href="files/api-v3-entity.html"><abbr title="api/v3/Entity.php">Entity.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">13</span>
</aside>
<p class="phpdocumentor-summary">Get list of deprecated entities.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_entity_deprecation</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$entities</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>This is called by the api wrapper when returning the result of api.Entity.get.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entities</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array of deprecated api entities</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_entity_create">
civicrm_api3_entity_create()
<a href="namespaces/default.html#function_civicrm_api3_entity_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Entity.php"><a href="files/api-v3-entity.html"><abbr title="api/v3/Entity.php">Entity.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">36</span>
</aside>
<p class="phpdocumentor-summary">Placeholder function.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_entity_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>This should never be called, as it doesn't have any meaning.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_entity_delete">
civicrm_api3_entity_delete()
<a href="namespaces/default.html#function_civicrm_api3_entity_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Entity.php"><a href="files/api-v3-entity.html"><abbr title="api/v3/Entity.php">Entity.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">49</span>
</aside>
<p class="phpdocumentor-summary">Placeholder function.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_entity_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>This should never be called, as it doesn't have any meaning.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_entity_getfields">
civicrm_api3_entity_getfields()
<a href="namespaces/default.html#function_civicrm_api3_entity_getfields" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Entity.php"><a href="files/api-v3-entity.html"><abbr title="api/v3/Entity.php">Entity.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">62</span>
</aside>
<p class="phpdocumentor-summary">Placeholder function.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_entity_getfields</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>This should never be called, as it doesn't have any meaning.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_entity_batch_get">
civicrm_api3_entity_batch_get()
<a href="namespaces/default.html#function_civicrm_api3_entity_batch_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/EntityBatch.php"><a href="files/api-v3-entitybatch.html"><abbr title="api/v3/EntityBatch.php">EntityBatch.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">27</span>
</aside>
<p class="phpdocumentor-summary">Get entity batches.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_entity_batch_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_entity_batch_create_spec">
_civicrm_api3_entity_batch_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_entity_batch_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/EntityBatch.php"><a href="files/api-v3-entitybatch.html"><abbr title="api/v3/EntityBatch.php">EntityBatch.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">39</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_entity_batch_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_entity_batch_create">
civicrm_api3_entity_batch_create()
<a href="namespaces/default.html#function_civicrm_api3_entity_batch_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/EntityBatch.php"><a href="files/api-v3-entitybatch.html"><abbr title="api/v3/EntityBatch.php">EntityBatch.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">51</span>
</aside>
<p class="phpdocumentor-summary">Create an entity batch.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_entity_batch_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_entity_batch_delete">
civicrm_api3_entity_batch_delete()
<a href="namespaces/default.html#function_civicrm_api3_entity_batch_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/EntityBatch.php"><a href="files/api-v3-entitybatch.html"><abbr title="api/v3/EntityBatch.php">EntityBatch.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">62</span>
</aside>
<p class="phpdocumentor-summary">Mark entity batch as removed.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_entity_batch_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_entity_financial_account_create">
civicrm_api3_entity_financial_account_create()
<a href="namespaces/default.html#function_civicrm_api3_entity_financial_account_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/EntityFinancialAccount.php"><a href="files/api-v3-entityfinancialaccount.html"><abbr title="api/v3/EntityFinancialAccount.php">EntityFinancialAccount.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">25</span>
</aside>
<p class="phpdocumentor-summary">Save an Entity Financial Account record.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_entity_financial_account_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_entity_financial_account_create_spec">
_civicrm_api3_entity_financial_account_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_entity_financial_account_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/EntityFinancialAccount.php"><a href="files/api-v3-entityfinancialaccount.html"><abbr title="api/v3/EntityFinancialAccount.php">EntityFinancialAccount.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">34</span>
</aside>
<p class="phpdocumentor-summary">Save an Entity Financial Account record.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_entity_financial_account_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_entity_financial_account_get">
civicrm_api3_entity_financial_account_get()
<a href="namespaces/default.html#function_civicrm_api3_entity_financial_account_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/EntityFinancialAccount.php"><a href="files/api-v3-entityfinancialaccount.html"><abbr title="api/v3/EntityFinancialAccount.php">EntityFinancialAccount.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">46</span>
</aside>
<p class="phpdocumentor-summary">Get an Entity Financial Account record.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_entity_financial_account_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array of retrieved EntityFinancialAccount property values.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_entity_financial_account_delete">
civicrm_api3_entity_financial_account_delete()
<a href="namespaces/default.html#function_civicrm_api3_entity_financial_account_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/EntityFinancialAccount.php"><a href="files/api-v3-entityfinancialaccount.html"><abbr title="api/v3/EntityFinancialAccount.php">EntityFinancialAccount.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">58</span>
</aside>
<p class="phpdocumentor-summary">Delete an Entity Financial Account record.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_entity_financial_account_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array of deleted values.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_entity_financial_trxn_create">
civicrm_api3_entity_financial_trxn_create()
<a href="namespaces/default.html#function_civicrm_api3_entity_financial_trxn_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/EntityFinancialTrxn.php"><a href="files/api-v3-entityfinancialtrxn.html"><abbr title="api/v3/EntityFinancialTrxn.php">EntityFinancialTrxn.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">25</span>
</aside>
<p class="phpdocumentor-summary">Save a Entity Financial Trxn.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_entity_financial_trxn_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_entity_financial_trxn_get">
civicrm_api3_entity_financial_trxn_get()
<a href="namespaces/default.html#function_civicrm_api3_entity_financial_trxn_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/EntityFinancialTrxn.php"><a href="files/api-v3-entityfinancialtrxn.html"><abbr title="api/v3/EntityFinancialTrxn.php">EntityFinancialTrxn.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">37</span>
</aside>
<p class="phpdocumentor-summary">Get a Entity Financial Trxn.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_entity_financial_trxn_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array of retrieved Entity Financial Trxn property values.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_entity_financial_trxn_delete">
civicrm_api3_entity_financial_trxn_delete()
<a href="namespaces/default.html#function_civicrm_api3_entity_financial_trxn_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/EntityFinancialTrxn.php"><a href="files/api-v3-entityfinancialtrxn.html"><abbr title="api/v3/EntityFinancialTrxn.php">EntityFinancialTrxn.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">49</span>
</aside>
<p class="phpdocumentor-summary">Delete a Entity Financial Trxn.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_entity_financial_trxn_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array of deleted values.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_entity_financial_trxn_create_spec">
_civicrm_api3_entity_financial_trxn_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_entity_financial_trxn_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/EntityFinancialTrxn.php"><a href="files/api-v3-entityfinancialtrxn.html"><abbr title="api/v3/EntityFinancialTrxn.php">EntityFinancialTrxn.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">61</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_entity_financial_trxn_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_entity_tag_get">
civicrm_api3_entity_tag_get()
<a href="namespaces/default.html#function_civicrm_api3_entity_tag_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/EntityTag.php"><a href="files/api-v3-entitytag.html"><abbr title="api/v3/EntityTag.php">EntityTag.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">28</span>
</aside>
<p class="phpdocumentor-summary">Get entity tags.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_entity_tag_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_entity_tag_get_spec">
_civicrm_api3_entity_tag_get_spec()
<a href="namespaces/default.html#function__civicrm_api3_entity_tag_get_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/EntityTag.php"><a href="files/api-v3-entitytag.html"><abbr title="api/v3/EntityTag.php">EntityTag.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">40</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Get action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_entity_tag_get_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_entity_tag_create">
civicrm_api3_entity_tag_create()
<a href="namespaces/default.html#function_civicrm_api3_entity_tag_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/EntityTag.php"><a href="files/api-v3-entitytag.html"><abbr title="api/v3/EntityTag.php">EntityTag.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">52</span>
</aside>
<p class="phpdocumentor-summary">Create an entity tag.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_entity_tag_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_entity_tag_delete">
civicrm_api3_entity_tag_delete()
<a href="namespaces/default.html#function_civicrm_api3_entity_tag_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/EntityTag.php"><a href="files/api-v3-entitytag.html"><abbr title="api/v3/EntityTag.php">EntityTag.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">63</span>
</aside>
<p class="phpdocumentor-summary">Mark entity tag as removed.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_entity_tag_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_entity_tag_delete_spec">
_civicrm_api3_entity_tag_delete_spec()
<a href="namespaces/default.html#function__civicrm_api3_entity_tag_delete_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/EntityTag.php"><a href="files/api-v3-entitytag.html"><abbr title="api/v3/EntityTag.php">EntityTag.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">73</span>
</aside>
<p class="phpdocumentor-summary">Modify metadata.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_entity_tag_delete_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_entity_tag_common">
_civicrm_api3_entity_tag_common()
<a href="namespaces/default.html#function__civicrm_api3_entity_tag_common" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/EntityTag.php"><a href="files/api-v3-entitytag.html"><abbr title="api/v3/EntityTag.php">EntityTag.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">86</span>
</aside>
<p class="phpdocumentor-summary">Helper function for formatting tags (part of api v2 legacy).</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_entity_tag_common</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$op</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">'add'</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$op</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">'add'</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_entity_tag_replace">
civicrm_api3_entity_tag_replace()
<a href="namespaces/default.html#function_civicrm_api3_entity_tag_replace" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/EntityTag.php"><a href="files/api-v3-entitytag.html"><abbr title="api/v3/EntityTag.php">EntityTag.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">151</span>
</aside>
<p class="phpdocumentor-summary">Replace tags for an entity</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_entity_tag_replace</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_event_create">
civicrm_api3_event_create()
<a href="namespaces/default.html#function_civicrm_api3_event_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Event.php"><a href="files/api-v3-event.html"><abbr title="api/v3/Event.php">Event.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">29</span>
</aside>
<p class="phpdocumentor-summary">Create a Event.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_event_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Input parameters.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_event_create#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result Array.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_event_create_spec">
_civicrm_api3_event_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_event_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Event.php"><a href="files/api-v3-event.html"><abbr title="api/v3/Event.php">Event.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">57</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_event_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_event_create_legacy_support_42">
_civicrm_api3_event_create_legacy_support_42()
<a href="namespaces/default.html#function__civicrm_api3_event_create_legacy_support_42" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Event.php"><a href="files/api-v3-event.html"><abbr title="api/v3/Event.php">Event.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">72</span>
</aside>
<p class="phpdocumentor-summary">Support for schema changes made in 4.2.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_event_create_legacy_support_42</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The main purpose of the API is to provide integrators a level of stability not provided by
the core code or schema - this means we have to provide support for api calls (where possible)
across schema changes.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_event_get">
civicrm_api3_event_get()
<a href="namespaces/default.html#function_civicrm_api3_event_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Event.php"><a href="files/api-v3-event.html"><abbr title="api/v3/Event.php">Event.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">86</span>
</aside>
<p class="phpdocumentor-summary">Get Event record.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_event_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array of all found event property values.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_event_get_spec">
_civicrm_api3_event_get_spec()
<a href="namespaces/default.html#function__civicrm_api3_event_get_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Event.php"><a href="files/api-v3-event.html"><abbr title="api/v3/Event.php">Event.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">137</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Get action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_event_get_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_event_get_legacy_support_42">
_civicrm_api3_event_get_legacy_support_42()
<a href="namespaces/default.html#function__civicrm_api3_event_get_legacy_support_42" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Event.php"><a href="files/api-v3-event.html"><abbr title="api/v3/Event.php">Event.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">151</span>
</aside>
<p class="phpdocumentor-summary">Support for schema changes made in 4.2.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_event_get_legacy_support_42</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$event</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$event_id</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The main purpose of the API is to provide integrators a level of stability not provided by
the core code or schema - this means we have to provide support for api calls (where possible)
across schema changes.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$event</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$event_id</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_event_delete">
civicrm_api3_event_delete()
<a href="namespaces/default.html#function_civicrm_api3_event_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Event.php"><a href="files/api-v3-event.html"><abbr title="api/v3/Event.php">Event.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">171</span>
</aside>
<p class="phpdocumentor-summary">Delete an existing Event.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_event_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>This API is used for deleting a event given its id.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_event_delete#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">noinspection</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>PhpUnused</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_event_getisfull">
_civicrm_api3_event_getisfull()
<a href="namespaces/default.html#function__civicrm_api3_event_getisfull" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Event.php"><a href="files/api-v3-event.html"><abbr title="api/v3/Event.php">Event.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">187</span>
</aside>
<p class="phpdocumentor-summary">Add 'is_full' & 'available_seats' to the return array.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_event_getisfull</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$event</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$event_id</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>(this might be better in the BAO)
Default BAO function returns a string if full rather than a Bool - which is more appropriate to a form</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$event</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Return array of the event.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$event_id</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Id of the event to be updated.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_event_getlist_params">
_civicrm_api3_event_getlist_params()
<a href="namespaces/default.html#function__civicrm_api3_event_getlist_params" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Event.php"><a href="files/api-v3-event.html"><abbr title="api/v3/Event.php">Event.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">208</span>
</aside>
<p class="phpdocumentor-summary">Get event list parameters.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_event_getlist_params</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$request</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$request</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_event_getlist_params#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\_civicrm_api3_generic_getlist_params">_civicrm_api3_generic_getlist_params</abbr></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_event_getlist_output">
_civicrm_api3_event_getlist_output()
<a href="namespaces/default.html#function__civicrm_api3_event_getlist_output" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Event.php"><a href="files/api-v3-event.html"><abbr title="api/v3/Event.php">Event.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">237</span>
</aside>
<p class="phpdocumentor-summary">Get event list output.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_event_getlist_output</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$result</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$request</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$result</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$request</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_event_getlist_output#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\_civicrm_api3_generic_getlist_output">_civicrm_api3_generic_getlist_output</abbr></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_exception_get">
civicrm_api3_exception_get()
<a href="namespaces/default.html#function_civicrm_api3_exception_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Exception.php"><a href="files/api-v3-exception.html"><abbr title="api/v3/Exception.php">Exception.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">21</span>
</aside>
<p class="phpdocumentor-summary">Get a Dedupe Exception.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_exception_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields metadata.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array of all found dedupe exception object property values.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_exception_create">
civicrm_api3_exception_create()
<a href="namespaces/default.html#function_civicrm_api3_exception_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Exception.php"><a href="files/api-v3-exception.html"><abbr title="api/v3/Exception.php">Exception.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">33</span>
</aside>
<p class="phpdocumentor-summary">Create or update an dedupe exception.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_exception_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields metadata.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>api result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_exception_delete">
civicrm_api3_exception_delete()
<a href="namespaces/default.html#function_civicrm_api3_exception_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Exception.php"><a href="files/api-v3-exception.html"><abbr title="api/v3/Exception.php">Exception.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">47</span>
</aside>
<p class="phpdocumentor-summary">Delete an existing Exception.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_exception_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>This method is used to delete any existing Exception given its id.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>[id]</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>api result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_extension_install">
civicrm_api3_extension_install()
<a href="namespaces/default.html#function_civicrm_api3_extension_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Extension.php"><a href="files/api-v3-extension.html"><abbr title="api/v3/Extension.php">Extension.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">34</span>
</aside>
<p class="phpdocumentor-summary">Install an extension.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_extension_install</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Input parameters.</p>
<ul>
<li>key: string, eg "com.example.myextension"</li>
<li>keys: array of string, eg array("com.example.myextension1", "com.example.myextension2")</li>
<li>path: string, e.g. "/var/www/extensions/*"</li>
</ul>
<p>Using 'keys' should be more performant than making multiple API calls with 'key'</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_extension_install_spec">
_civicrm_api3_extension_install_spec()
<a href="namespaces/default.html#function__civicrm_api3_extension_install_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Extension.php"><a href="files/api-v3-extension.html"><abbr title="api/v3/Extension.php">Extension.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">55</span>
</aside>
<p class="phpdocumentor-summary">Spec function for getfields</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_extension_install_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$fields</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fields</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_extension_upgrade">
civicrm_api3_extension_upgrade()
<a href="namespaces/default.html#function_civicrm_api3_extension_upgrade" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Extension.php"><a href="files/api-v3-extension.html"><abbr title="api/v3/Extension.php">Extension.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">75</span>
</aside>
<p class="phpdocumentor-summary">Upgrade an extension - runs upgrade_N hooks and system.flush.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_extension_upgrade</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_extension_enable">
civicrm_api3_extension_enable()
<a href="namespaces/default.html#function_civicrm_api3_extension_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Extension.php"><a href="files/api-v3-extension.html"><abbr title="api/v3/Extension.php">Extension.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">112</span>
</aside>
<p class="phpdocumentor-summary">Enable an extension.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_extension_enable</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Input parameters.</p>
<ul>
<li>key: string, eg "com.example.myextension"</li>
<li>keys: array of string, eg array("com.example.myextension1", "com.example.myextension2")</li>
<li>path: string, e.g. "/var/www/vendor/foo/myext" or "/var/www/vendor/*"</li>
</ul>
<p>Using 'keys' should be more performant than making multiple API calls with 'key'</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_extension_enable_spec">
_civicrm_api3_extension_enable_spec()
<a href="namespaces/default.html#function__civicrm_api3_extension_enable_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Extension.php"><a href="files/api-v3-extension.html"><abbr title="api/v3/Extension.php">Extension.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">127</span>
</aside>
<p class="phpdocumentor-summary">Spec function for getfields</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_extension_enable_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$fields</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fields</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_extension_disable">
civicrm_api3_extension_disable()
<a href="namespaces/default.html#function_civicrm_api3_extension_disable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Extension.php"><a href="files/api-v3-extension.html"><abbr title="api/v3/Extension.php">Extension.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">144</span>
</aside>
<p class="phpdocumentor-summary">Disable an extension.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_extension_disable</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Input parameters.</p>
<ul>
<li>key: string, eg "com.example.myextension"</li>
<li>keys: array of string, eg array("com.example.myextension1", "com.example.myextension2")</li>
<li>path: string, e.g. "/var/www/vendor/foo/myext" or "/var/www/vendor/*"</li>
</ul>
<p>Using 'keys' should be more performant than making multiple API calls with 'key'</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_extension_disable_spec">
_civicrm_api3_extension_disable_spec()
<a href="namespaces/default.html#function__civicrm_api3_extension_disable_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Extension.php"><a href="files/api-v3-extension.html"><abbr title="api/v3/Extension.php">Extension.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">158</span>
</aside>
<p class="phpdocumentor-summary">Spec function for getfields</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_extension_disable_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$fields</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fields</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_extension_uninstall">
civicrm_api3_extension_uninstall()
<a href="namespaces/default.html#function_civicrm_api3_extension_uninstall" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Extension.php"><a href="files/api-v3-extension.html"><abbr title="api/v3/Extension.php">Extension.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">177</span>
</aside>
<p class="phpdocumentor-summary">Uninstall an extension.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_extension_uninstall</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Input parameters.</p>
<ul>
<li>key: string, eg "com.example.myextension"</li>
<li>keys: array of string, eg array("com.example.myextension1", "com.example.myextension2")</li>
<li>path: string, e.g. "/var/www/vendor/foo/myext" or "/var/www/vendor/*"</li>
</ul>
<p>Using 'keys' should be more performant than making multiple API calls with 'key'</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_extension_uninstall#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">todo:</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>removeFiles as optional param</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_extension_uninstall_spec">
_civicrm_api3_extension_uninstall_spec()
<a href="namespaces/default.html#function__civicrm_api3_extension_uninstall_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Extension.php"><a href="files/api-v3-extension.html"><abbr title="api/v3/Extension.php">Extension.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">191</span>
</aside>
<p class="phpdocumentor-summary">Spec function for getfields</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_extension_uninstall_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$fields</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fields</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_extension_download">
civicrm_api3_extension_download()
<a href="namespaces/default.html#function_civicrm_api3_extension_download" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Extension.php"><a href="files/api-v3-extension.html"><abbr title="api/v3/Extension.php">Extension.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">212</span>
</aside>
<p class="phpdocumentor-summary">Download and install an extension.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_extension_download</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Input parameters.</p>
<ul>
<li>key: string, eg "com.example.myextension"</li>
<li>url: string eg "http://repo.com/myextension-1.0.zip"</li>
</ul>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_extension_download#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_extension_download_spec">
_civicrm_api3_extension_download_spec()
<a href="namespaces/default.html#function__civicrm_api3_extension_download_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Extension.php"><a href="files/api-v3-extension.html"><abbr title="api/v3/Extension.php">Extension.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">256</span>
</aside>
<p class="phpdocumentor-summary">Spec function for getfields</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_extension_download_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$fields</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fields</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_extension_refresh">
civicrm_api3_extension_refresh()
<a href="namespaces/default.html#function_civicrm_api3_extension_refresh" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Extension.php"><a href="files/api-v3-extension.html"><abbr title="api/v3/Extension.php">Extension.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">287</span>
</aside>
<p class="phpdocumentor-summary">Download and install an extension.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_extension_refresh</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Input parameters.</p>
<ul>
<li>local: bool, whether to rescan local filesystem (default: TRUE)</li>
<li>remote: bool, whether to rescan remote repository (default: TRUE)</li>
</ul>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_extension_refresh_spec">
_civicrm_api3_extension_refresh_spec()
<a href="namespaces/default.html#function__civicrm_api3_extension_refresh_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Extension.php"><a href="files/api-v3-extension.html"><abbr title="api/v3/Extension.php">Extension.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">311</span>
</aside>
<p class="phpdocumentor-summary">Spec function for getfields</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_extension_refresh_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$fields</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fields</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_extension_get">
civicrm_api3_extension_get()
<a href="namespaces/default.html#function_civicrm_api3_extension_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Extension.php"><a href="files/api-v3-extension.html"><abbr title="api/v3/Extension.php">Extension.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">334</span>
</aside>
<p class="phpdocumentor-summary">Get a list of available extensions.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_extension_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_extension_getremote">
civicrm_api3_extension_getremote()
<a href="namespaces/default.html#function_civicrm_api3_extension_getremote" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Extension.php"><a href="files/api-v3-extension.html"><abbr title="api/v3/Extension.php">Extension.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">380</span>
</aside>
<p class="phpdocumentor-summary">Get a list of remotely available extensions.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_extension_getremote</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_getKeys">
_civicrm_api3_getKeys()
<a href="namespaces/default.html#function__civicrm_api3_getKeys" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Extension.php"><a href="files/api-v3-extension.html"><abbr title="api/v3/Extension.php">Extension.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">405</span>
</aside>
<p class="phpdocumentor-summary">Determine the list of extension keys.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_getKeys</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$key</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">'keys'</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$key</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">'keys'</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>API request params with 'keys' or 'path'.</p>
<ul>
<li>keys: A comma-delimited list of extension names</li>
<li>path: An absolute directory path. May append '*' to match all sub-directories.</li>
</ul>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_file_create">
civicrm_api3_file_create()
<a href="namespaces/default.html#function_civicrm_api3_file_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/File.php"><a href="files/api-v3-file.html"><abbr title="api/v3/File.php">File.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">32</span>
</aside>
<p class="phpdocumentor-summary">Create a file record.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_file_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields metadata.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_file_create#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">note</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>This is only one of several steps needed to create a file in CiviCRM.
Use the "Attachment" api to better handle all steps.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_file_get">
civicrm_api3_file_get()
<a href="namespaces/default.html#function_civicrm_api3_file_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/File.php"><a href="files/api-v3-file.html"><abbr title="api/v3/File.php">File.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">74</span>
</aside>
<p class="phpdocumentor-summary">Get a File.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_file_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields metadata.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array of all found file object property values.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_file_update">
civicrm_api3_file_update()
<a href="namespaces/default.html#function_civicrm_api3_file_update" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/File.php"><a href="files/api-v3-file.html"><abbr title="api/v3/File.php">File.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">86</span>
</aside>
<p class="phpdocumentor-summary">Update an existing File.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_file_update</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields metadata.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_file_delete">
civicrm_api3_file_delete()
<a href="namespaces/default.html#function_civicrm_api3_file_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/File.php"><a href="files/api-v3-file.html"><abbr title="api/v3/File.php">File.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">115</span>
</aside>
<p class="phpdocumentor-summary">Delete an existing File.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_file_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields metadata.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_file_delete#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API Result Array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_financial_account_create">
civicrm_api3_financial_account_create()
<a href="namespaces/default.html#function_civicrm_api3_financial_account_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/FinancialAccount.php"><a href="files/api-v3-financialaccount.html"><abbr title="api/v3/FinancialAccount.php">FinancialAccount.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">25</span>
</aside>
<p class="phpdocumentor-summary">Save a FinancialAccount.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_financial_account_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_financial_account_get">
civicrm_api3_financial_account_get()
<a href="namespaces/default.html#function_civicrm_api3_financial_account_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/FinancialAccount.php"><a href="files/api-v3-financialaccount.html"><abbr title="api/v3/FinancialAccount.php">FinancialAccount.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">37</span>
</aside>
<p class="phpdocumentor-summary">Get a FinancialAccount.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_financial_account_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array of retrieved FinancialAccount property values.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_financial_account_delete">
civicrm_api3_financial_account_delete()
<a href="namespaces/default.html#function_civicrm_api3_financial_account_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/FinancialAccount.php"><a href="files/api-v3-financialaccount.html"><abbr title="api/v3/FinancialAccount.php">FinancialAccount.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">49</span>
</aside>
<p class="phpdocumentor-summary">Delete a FinancialAccount.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_financial_account_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array of deleted values.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_financial_item_create">
civicrm_api3_financial_item_create()
<a href="namespaces/default.html#function_civicrm_api3_financial_item_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/FinancialItem.php"><a href="files/api-v3-financialitem.html"><abbr title="api/v3/FinancialItem.php">FinancialItem.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">25</span>
</aside>
<p class="phpdocumentor-summary">Save a Financial Item.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_financial_item_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_financial_item_get">
civicrm_api3_financial_item_get()
<a href="namespaces/default.html#function_civicrm_api3_financial_item_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/FinancialItem.php"><a href="files/api-v3-financialitem.html"><abbr title="api/v3/FinancialItem.php">FinancialItem.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">37</span>
</aside>
<p class="phpdocumentor-summary">Get a FinancialItem.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_financial_item_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array of retrieved Financial Item property values.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_financial_item_delete">
civicrm_api3_financial_item_delete()
<a href="namespaces/default.html#function_civicrm_api3_financial_item_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/FinancialItem.php"><a href="files/api-v3-financialitem.html"><abbr title="api/v3/FinancialItem.php">FinancialItem.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">49</span>
</aside>
<p class="phpdocumentor-summary">Delete a Financial Item.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_financial_item_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array of deleted values.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_financial_trxn_create">
civicrm_api3_financial_trxn_create()
<a href="namespaces/default.html#function_civicrm_api3_financial_trxn_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/FinancialTrxn.php"><a href="files/api-v3-financialtrxn.html"><abbr title="api/v3/FinancialTrxn.php">FinancialTrxn.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">25</span>
</aside>
<p class="phpdocumentor-summary">Save a Financial Item.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_financial_trxn_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_financial_trxn_get">
civicrm_api3_financial_trxn_get()
<a href="namespaces/default.html#function_civicrm_api3_financial_trxn_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/FinancialTrxn.php"><a href="files/api-v3-financialtrxn.html"><abbr title="api/v3/FinancialTrxn.php">FinancialTrxn.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">41</span>
</aside>
<p class="phpdocumentor-summary">Get a Financialtrxn.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_financial_trxn_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array of retrieved Financial trxn property values.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_financial_trxn_delete">
civicrm_api3_financial_trxn_delete()
<a href="namespaces/default.html#function_civicrm_api3_financial_trxn_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/FinancialTrxn.php"><a href="files/api-v3-financialtrxn.html"><abbr title="api/v3/FinancialTrxn.php">FinancialTrxn.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">53</span>
</aside>
<p class="phpdocumentor-summary">Delete a Financial trxn.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_financial_trxn_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array of deleted values.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_financial_trxn_create_spec">
_civicrm_api3_financial_trxn_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_financial_trxn_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/FinancialTrxn.php"><a href="files/api-v3-financialtrxn.html"><abbr title="api/v3/FinancialTrxn.php">FinancialTrxn.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">65</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_financial_trxn_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_financial_type_create">
civicrm_api3_financial_type_create()
<a href="namespaces/default.html#function_civicrm_api3_financial_type_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/FinancialType.php"><a href="files/api-v3-financialtype.html"><abbr title="api/v3/FinancialType.php">FinancialType.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">25</span>
</aside>
<p class="phpdocumentor-summary">Save a FinancialType.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_financial_type_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_financial_type_create_spec">
_civicrm_api3_financial_type_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_financial_type_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/FinancialType.php"><a href="files/api-v3-financialtype.html"><abbr title="api/v3/FinancialType.php">FinancialType.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">29</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_financial_type_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_financial_type_get">
civicrm_api3_financial_type_get()
<a href="namespaces/default.html#function_civicrm_api3_financial_type_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/FinancialType.php"><a href="files/api-v3-financialtype.html"><abbr title="api/v3/FinancialType.php">FinancialType.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">41</span>
</aside>
<p class="phpdocumentor-summary">Get a FinancialType.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_financial_type_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array of retrieved FinancialType property values.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_financial_type_delete">
civicrm_api3_financial_type_delete()
<a href="namespaces/default.html#function_civicrm_api3_financial_type_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/FinancialType.php"><a href="files/api-v3-financialtype.html"><abbr title="api/v3/FinancialType.php">FinancialType.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">53</span>
</aside>
<p class="phpdocumentor-summary">Delete a FinancialType.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_financial_type_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array of deleted values.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_generic_getActions">
civicrm_api3_generic_getActions()
<a href="namespaces/default.html#function_civicrm_api3_generic_getActions" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Generic/Getactions.php"><a href="files/api-v3-generic-getactions.html"><abbr title="api/v3/Generic/Getactions.php">Getactions.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">24</span>
</aside>
<p class="phpdocumentor-summary">Get available api actions.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_generic_getActions</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$apiRequest</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$apiRequest</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_generic_getActions#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_generic_getList">
civicrm_api3_generic_getList()
<a href="namespaces/default.html#function_civicrm_api3_generic_getList" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Generic/Getlist.php"><a href="files/api-v3-generic-getlist.html"><abbr title="api/v3/Generic/Getlist.php">Getlist.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">24</span>
</aside>
<p class="phpdocumentor-summary">Generic api wrapper used for quicksearch and autocomplete.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_generic_getList</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$apiRequest</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$apiRequest</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_generic_getList#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_generic_getlist_get_result">
_civicrm_api3_generic_getlist_get_result()
<a href="namespaces/default.html#function__civicrm_api3_generic_getlist_get_result" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Generic/Getlist.php"><a href="files/api-v3-generic-getlist.html"><abbr title="api/v3/Generic/Getlist.php">Getlist.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">101</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_generic_getlist_get_result</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$request</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$entity</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$meta</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$apiRequest</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$request</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entity</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$meta</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$apiRequest</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_generic_getlist_get_result#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_generic_getList_defaults">
_civicrm_api3_generic_getList_defaults()
<a href="namespaces/default.html#function__civicrm_api3_generic_getList_defaults" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Generic/Getlist.php"><a href="files/api-v3-generic-getlist.html"><abbr title="api/v3/Generic/Getlist.php">Getlist.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">150</span>
</aside>
<p class="phpdocumentor-summary">Set defaults for api.getlist.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_generic_getList_defaults</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$entity</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$request</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$apiDefaults</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$fields</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entity</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$request</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$apiDefaults</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fields</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_generic_getlist_params">
_civicrm_api3_generic_getlist_params()
<a href="namespaces/default.html#function__civicrm_api3_generic_getlist_params" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Generic/Getlist.php"><a href="files/api-v3-generic-getlist.html"><abbr title="api/v3/Generic/Getlist.php">Getlist.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">218</span>
</aside>
<p class="phpdocumentor-summary">Fallback implementation of getlist_params. May be overridden by individual apis.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_generic_getlist_params</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$request</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$request</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_generic_getlist_output">
_civicrm_api3_generic_getlist_output()
<a href="namespaces/default.html#function__civicrm_api3_generic_getlist_output" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Generic/Getlist.php"><a href="files/api-v3-generic-getlist.html"><abbr title="api/v3/Generic/Getlist.php">Getlist.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">242</span>
</aside>
<p class="phpdocumentor-summary">Fallback implementation of getlist_output. May be overridden by individual api functions.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_generic_getlist_output</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$result</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$request</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$entity</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$fields</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$result</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$request</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entity</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fields</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_generic_getlist_postprocess">
_civicrm_api3_generic_getlist_postprocess()
<a href="namespaces/default.html#function__civicrm_api3_generic_getlist_postprocess" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Generic/Getlist.php"><a href="files/api-v3-generic-getlist.html"><abbr title="api/v3/Generic/Getlist.php">Getlist.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">286</span>
</aside>
<p class="phpdocumentor-summary">Common postprocess for getlist output</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_generic_getlist_postprocess</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$result</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$request</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$values</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$result</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$request</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$values</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_generic_getlist_spec">
_civicrm_api3_generic_getlist_spec()
<a href="namespaces/default.html#function__civicrm_api3_generic_getlist_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Generic/Getlist.php"><a href="files/api-v3-generic-getlist.html"><abbr title="api/v3/Generic/Getlist.php">Getlist.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">311</span>
</aside>
<p class="phpdocumentor-summary">Provide metadata for this api</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_generic_getlist_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$apiRequest</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$apiRequest</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_generic_getunique">
civicrm_api3_generic_getunique()
<a href="namespaces/default.html#function_civicrm_api3_generic_getunique" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Generic/Getunique.php"><a href="files/api-v3-generic-getunique.html"><abbr title="api/v3/Generic/Getunique.php">Getunique.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">23</span>
</aside>
<p class="phpdocumentor-summary">Generic api wrapper used to get all unique fields for a given entity.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_generic_getunique</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$apiRequest</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$apiRequest</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_generic_setValue">
civicrm_api3_generic_setValue()
<a href="namespaces/default.html#function_civicrm_api3_generic_setValue" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Generic/Setvalue.php"><a href="files/api-v3-generic-setvalue.html"><abbr title="api/v3/Generic/Setvalue.php">Setvalue.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">27</span>
</aside>
<p class="phpdocumentor-summary">Set a single value using the api.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_generic_setValue</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$apiRequest</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>This function is called when no specific setvalue api exists.
Params must contain at least id=xx & {one of the fields from getfields}=value</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$apiRequest</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_generic_setValue#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - -deprecated">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_generic_update">
civicrm_api3_generic_update()
<a href="namespaces/default.html#function_civicrm_api3_generic_update" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Generic/Update.php"><a href="files/api-v3-generic-update.html"><abbr title="api/v3/Generic/Update.php">Update.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">39</span>
</aside>
<p class="phpdocumentor-summary">Update function is basically a hack.</p>
<div class="phpdocumentor-admonition">
<svg class="phpdocumentor-admonition__icon" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-3L13.732 4c-.77-1.333-2.694-1.333-3.464 0L3.34 16c-.77 1.333.192 3 1.732 3z"></path></svg>
<article>
</article>
</div>
<code class="phpdocumentor-code phpdocumentor-signature -deprecated">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_generic_update</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$apiRequest</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed>|int|mixed</span></code>
<section class="phpdocumentor-description"><p>We want to remove it but must resolve issues in
http://issues.civicrm.org/jira/browse/CRM-12144</p>
<p>It is not recommended & if update doesn't work & fix does then update will not be fixed</p>
<p>To do this, perform a 'get' action to load the existing values, then merge in the updates
and call 'create' to save the revised entity.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$apiRequest</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array with keys:</p>
<ul>
<li>entity: string</li>
<li>action: string</li>
<li>version: string</li>
<li>function: callback (mixed)</li>
<li>params: array, varies</li>
</ul>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed>|int|mixed</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_generic_validate_spec">
_civicrm_api3_generic_validate_spec()
<a href="namespaces/default.html#function__civicrm_api3_generic_validate_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Generic/Validate.php"><a href="files/api-v3-generic-validate.html"><abbr title="api/v3/Generic/Validate.php">Validate.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">21</span>
</aside>
<p class="phpdocumentor-summary">Provide meta-data for this api.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_generic_validate_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_generic_validate">
civicrm_api3_generic_validate()
<a href="namespaces/default.html#function_civicrm_api3_generic_validate" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Generic/Validate.php"><a href="files/api-v3-generic-validate.html"><abbr title="api/v3/Generic/Validate.php">Validate.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">33</span>
</aside>
<p class="phpdocumentor-summary">Generic api wrapper used for validation of entity-action pair.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_generic_validate</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$apiRequest</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$apiRequest</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_generic_getfields">
civicrm_api3_generic_getfields()
<a href="namespaces/default.html#function_civicrm_api3_generic_getfields" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Generic.php"><a href="files/api-v3-generic.html"><abbr title="api/v3/Generic.php">Generic.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">41</span>
</aside>
<p class="phpdocumentor-summary">Get information about fields for a given api request.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_generic_getfields</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$apiRequest</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$unique</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">TRUE</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>Getfields information is used for documentation, validation, default setting
We first query the scheme using the $dao->fields function & then augment
that information by calling the _spec functions that apply to the relevant function
Note that we use 'unique' field names as described in the xml/schema files
for get requests & just field name for create. This is because some get functions
access multiple objects e.g. contact api accesses is_deleted from the activity
table & from the contact table</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$apiRequest</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Api request as an array. Keys are.</p>
<ul>
<li>entity: string</li>
<li>action: string</li>
<li>version: string</li>
<li>function: callback (mixed)</li>
<li>params: array, varies</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$unique</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
= <span class="phpdocumentor-signature__argument__default-value">TRUE</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Determines whether to key by unique field names (only affects get-type) actions</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API success object</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_generic_getfield">
civicrm_api3_generic_getfield()
<a href="namespaces/default.html#function_civicrm_api3_generic_getfield" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Generic.php"><a href="files/api-v3-generic.html"><abbr title="api/v3/Generic.php">Generic.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">207</span>
</aside>
<p class="phpdocumentor-summary">Get metadata for a field</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_generic_getfield</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$apiRequest</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$apiRequest</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API success object</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_generic_getfield_spec">
_civicrm_api3_generic_getfield_spec()
<a href="namespaces/default.html#function__civicrm_api3_generic_getfield_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Generic.php"><a href="files/api-v3-generic.html"><abbr title="api/v3/Generic.php">Generic.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">238</span>
</aside>
<p class="phpdocumentor-summary">Get metadata for getfield action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_generic_getfield_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$apiRequest</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$apiRequest</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_generic_getfield_spec#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\Exception">Exception</abbr></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_generic_getcount">
civicrm_api3_generic_getcount()
<a href="namespaces/default.html#function_civicrm_api3_generic_getcount" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Generic.php"><a href="files/api-v3-generic.html"><abbr title="api/v3/Generic.php">Generic.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">280</span>
</aside>
<p class="phpdocumentor-summary">API return function to reformat results as count.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_generic_getcount</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$apiRequest</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$apiRequest</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Api request as an array. Keys are.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_generic_getcount#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">int</span>
—
<section class="phpdocumentor-description"><p>count of results</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_generic_getsingle">
civicrm_api3_generic_getsingle()
<a href="namespaces/default.html#function_civicrm_api3_generic_getsingle" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Generic.php"><a href="files/api-v3-generic.html"><abbr title="api/v3/Generic.php">Generic.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">301</span>
</aside>
<p class="phpdocumentor-summary">API return function to reformat results as single result.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_generic_getsingle</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$apiRequest</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$apiRequest</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Api request as an array. Keys are.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">int</span>
—
<section class="phpdocumentor-description"><p>count of results</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_generic_getvalue">
civicrm_api3_generic_getvalue()
<a href="namespaces/default.html#function_civicrm_api3_generic_getvalue" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Generic.php"><a href="files/api-v3-generic.html"><abbr title="api/v3/Generic.php">Generic.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">326</span>
</aside>
<p class="phpdocumentor-summary">API return function to reformat results as single value.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_generic_getvalue</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$apiRequest</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$apiRequest</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Api request as an array. Keys are.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">int</span>
—
<section class="phpdocumentor-description"><p>count of results</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_generic_getrefcount_spec">
_civicrm_api3_generic_getrefcount_spec()
<a href="namespaces/default.html#function__civicrm_api3_generic_getrefcount_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Generic.php"><a href="files/api-v3-generic.html"><abbr title="api/v3/Generic.php">Generic.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">355</span>
</aside>
<p class="phpdocumentor-summary">Get count of contact references.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_generic_getrefcount_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$apiRequest</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$apiRequest</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_generic_getrefcount">
civicrm_api3_generic_getrefcount()
<a href="namespaces/default.html#function_civicrm_api3_generic_getrefcount" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Generic.php"><a href="files/api-v3-generic.html"><abbr title="api/v3/Generic.php">Generic.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">371</span>
</aside>
<p class="phpdocumentor-summary">API to determine if a record is in-use.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_generic_getrefcount</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$apiRequest</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$apiRequest</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Api request as an array.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_generic_getrefcount#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result (int 0 or 1)</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_generic_replace">
civicrm_api3_generic_replace()
<a href="namespaces/default.html#function_civicrm_api3_generic_replace" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Generic.php"><a href="files/api-v3-generic.html"><abbr title="api/v3/Generic.php">Generic.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">398</span>
</aside>
<p class="phpdocumentor-summary">API wrapper for replace function.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_generic_replace</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$apiRequest</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$apiRequest</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Api request as an array. Keys are.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">int</span>
—
<section class="phpdocumentor-description"><p>count of results</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_generic_getoptions">
civicrm_api3_generic_getoptions()
<a href="namespaces/default.html#function_civicrm_api3_generic_getoptions" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Generic.php"><a href="files/api-v3-generic.html"><abbr title="api/v3/Generic.php">Generic.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">412</span>
</aside>
<p class="phpdocumentor-summary">API wrapper for getoptions function.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_generic_getoptions</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$apiRequest</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$apiRequest</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Api request as an array.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_generic_getoptions#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array of results</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_generic_getoptions_spec">
_civicrm_api3_generic_getoptions_spec()
<a href="namespaces/default.html#function__civicrm_api3_generic_getoptions_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Generic.php"><a href="files/api-v3-generic.html"><abbr title="api/v3/Generic.php">Generic.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">461</span>
</aside>
<p class="phpdocumentor-summary">Provide metadata for this generic action</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_generic_getoptions_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$apiRequest</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$apiRequest</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_generic_get_metadata_options">
_civicrm_api3_generic_get_metadata_options()
<a href="namespaces/default.html#function__civicrm_api3_generic_get_metadata_options" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Generic.php"><a href="files/api-v3-generic.html"><abbr title="api/v3/Generic.php">Generic.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">515</span>
</aside>
<p class="phpdocumentor-summary">Get metadata.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_generic_get_metadata_options</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$metadata</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$apiRequest</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$fieldname</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$fieldSpec</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>Function fills the 'options' array on the metadata returned by getfields if</p>
<ol>
<li>the param option 'get_options' is defined - e.g. $params['options']['get_options'] => array('custom_1)
(this is passed in as the $fieldsToResolve array)</li>
<li>the field is a pseudoconstant and is NOT an FK</li>
</ol>
<ul>
<li>the reason for this is that checking / transformation is done on pseudoconstants but</li>
<li>if the field is an FK then mysql will enforce the data quality (& we have handling on failure)</li>
</ul>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$metadata</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The array of metadata that will form the result of the getfields function.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$apiRequest</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fieldname</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Field currently being processed.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fieldSpec</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Metadata for that field.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_generic_get_metadata_options#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><ul>
<li>if may be we should define a 'resolve' key on the pseudoconstant for when these rules are not fine enough</li>
</ul>
<p>This function is only split out for the purpose of code clarity / comment block documentation</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_group_create">
civicrm_api3_group_create()
<a href="namespaces/default.html#function_civicrm_api3_group_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Group.php"><a href="files/api-v3-group.html"><abbr title="api/v3/Group.php">Group.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">30</span>
</aside>
<p class="phpdocumentor-summary">Create/update group.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_group_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>name/value pairs to insert in new 'Group'</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_group_create_spec">
_civicrm_api3_group_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_group_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Group.php"><a href="files/api-v3-group.html"><abbr title="api/v3/Group.php">Group.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">42</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_group_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_group_get">
civicrm_api3_group_get()
<a href="namespaces/default.html#function_civicrm_api3_group_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Group.php"><a href="files/api-v3-group.html"><abbr title="api/v3/Group.php">Group.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">56</span>
</aside>
<p class="phpdocumentor-summary">Returns array of groups matching a set of one or more Group properties.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_group_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of properties. If empty, all records will be returned.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array of matching groups</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_group_delete">
civicrm_api3_group_delete()
<a href="namespaces/default.html#function_civicrm_api3_group_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Group.php"><a href="files/api-v3-group.html"><abbr title="api/v3/Group.php">Group.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">81</span>
</aside>
<p class="phpdocumentor-summary">Delete an existing Group.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_group_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>[id]</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_group_delete#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_group_contact_get">
civicrm_api3_group_contact_get()
<a href="namespaces/default.html#function_civicrm_api3_group_contact_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/GroupContact.php"><a href="files/api-v3-groupcontact.html"><abbr title="api/v3/GroupContact.php">GroupContact.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">43</span>
</aside>
<p class="phpdocumentor-summary">Fetch a list of groups for a contact, or contacts for a group.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_group_contact_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Name value pair of contact information.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_group_contact_get#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">Note:</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>this only applies to static groups, not smart groups.
To fetch all contacts in a smart group, use the Contact api
passing a contact_id and group_id.</p>
<p>If no status mentioned in params, by default 'added' will be used
to fetch the records</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>list of groups, given contact subsribed to</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_group_contact_create_spec">
_civicrm_api3_group_contact_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_group_contact_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/GroupContact.php"><a href="files/api-v3-groupcontact.html"><abbr title="api/v3/GroupContact.php">GroupContact.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">65</span>
</aside>
<p class="phpdocumentor-summary">Adjust metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_group_contact_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_group_contact_create">
civicrm_api3_group_contact_create()
<a href="namespaces/default.html#function_civicrm_api3_group_contact_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/GroupContact.php"><a href="files/api-v3-groupcontact.html"><abbr title="api/v3/GroupContact.php">GroupContact.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">109</span>
</aside>
<p class="phpdocumentor-summary">Add contact(s) to group(s).</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_group_contact_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>This api has a legacy/nonstandard signature.
On success, the return array will be structured as follows:</p>
<pre class="prettyprint"><code class="prettyprint">array(
"is_error" => 0,
"version" => 3,
"count" => 3,
"values" => array(
"not_added" => integer,
"added" => integer,
"total_count" => integer
)
)
</code></pre>
<p>On failure, the return array will be structured as follows:</p>
<pre class="prettyprint"><code class="prettyprint">array(
'is_error' => 1,
'error_message' = string,
'error_data' = mixed or undefined
)
</code></pre>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Input parameters:</p>
<ul>
<li>"contact_id" (required): First contact to add, or array of Contact IDs</li>
<li>"group_id" (required): First group to add contact(s) to, or array of Group IDs</li>
<li>"status" (optional): "Added" (default), "Pending" or "Removed"
Legacy input parameters (will be deprecated):</li>
<li>"contact_id.1" etc. (optional): Additional contact_id to add to group(s)</li>
<li>"group_id.1" etc. (optional): Additional groups to add contact(s) to</li>
</ul>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Information about operation results</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - -deprecated">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_group_contact_delete">
civicrm_api3_group_contact_delete()
<a href="namespaces/default.html#function_civicrm_api3_group_contact_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/GroupContact.php"><a href="files/api-v3-groupcontact.html"><abbr title="api/v3/GroupContact.php">GroupContact.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">132</span>
</aside>
<p class="phpdocumentor-summary">Delete group contact record.</p>
<div class="phpdocumentor-admonition">
<svg class="phpdocumentor-admonition__icon" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-3L13.732 4c-.77-1.333-2.694-1.333-3.464 0L3.34 16c-.77 1.333.192 3 1.732 3z"></path></svg>
<article>
</article>
</div>
<code class="phpdocumentor-code phpdocumentor-signature -deprecated">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_group_contact_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_group_contact_delete#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_group_contact_delete_spec">
_civicrm_api3_group_contact_delete_spec()
<a href="namespaces/default.html#function__civicrm_api3_group_contact_delete_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/GroupContact.php"><a href="files/api-v3-groupcontact.html"><abbr title="api/v3/GroupContact.php">GroupContact.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">161</span>
</aside>
<p class="phpdocumentor-summary">Adjust metadata.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_group_contact_delete_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - -deprecated">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_group_contact_pending">
civicrm_api3_group_contact_pending()
<a href="namespaces/default.html#function_civicrm_api3_group_contact_pending" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/GroupContact.php"><a href="files/api-v3-groupcontact.html"><abbr title="api/v3/GroupContact.php">GroupContact.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">174</span>
</aside>
<p class="phpdocumentor-summary">Get pending group contacts.</p>
<div class="phpdocumentor-admonition">
<svg class="phpdocumentor-admonition__icon" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-3L13.732 4c-.77-1.333-2.694-1.333-3.464 0L3.34 16c-.77 1.333.192 3 1.732 3z"></path></svg>
<article>
</article>
</div>
<code class="phpdocumentor-code phpdocumentor-signature -deprecated">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_group_contact_pending</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed>|int</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed>|int</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_group_contact_common">
_civicrm_api3_group_contact_common()
<a href="namespaces/default.html#function__civicrm_api3_group_contact_common" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/GroupContact.php"><a href="files/api-v3-groupcontact.html"><abbr title="api/v3/GroupContact.php">GroupContact.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">190</span>
</aside>
<p class="phpdocumentor-summary">Group contact helper function.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_group_contact_common</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$op</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">'Added'</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$op</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">'Added'</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_group_contact_common#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>behaviour is highly non-standard - need to figure out how to make this 'behave'
& at the very least return IDs & details of the groups created / changed</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - -deprecated">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_group_contact_update_status">
civicrm_api3_group_contact_update_status()
<a href="namespaces/default.html#function_civicrm_api3_group_contact_update_status" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/GroupContact.php"><a href="files/api-v3-groupcontact.html"><abbr title="api/v3/GroupContact.php">GroupContact.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">270</span>
</aside>
<p class="phpdocumentor-summary">Update group contact status.</p>
<div class="phpdocumentor-admonition">
<svg class="phpdocumentor-admonition__icon" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-3L13.732 4c-.77-1.333-2.694-1.333-3.464 0L3.34 16c-.77 1.333.192 3 1.732 3z"></path></svg>
<article>
<ul>
<li>this should be part of create but need to know we aren't missing something</li>
</ul>
</article>
</div>
<code class="phpdocumentor-code phpdocumentor-signature -deprecated">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_group_contact_update_status</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_group_contact_update_status#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article class="phpdocumentor-element -function - -deprecated">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_group_contact_deprecation">
_civicrm_api3_group_contact_deprecation()
<a href="namespaces/default.html#function__civicrm_api3_group_contact_deprecation" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/GroupContact.php"><a href="files/api-v3-groupcontact.html"><abbr title="api/v3/GroupContact.php">GroupContact.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">292</span>
</aside>
<p class="phpdocumentor-summary">Deprecated function notices.</p>
<div class="phpdocumentor-admonition">
<svg class="phpdocumentor-admonition__icon" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-3L13.732 4c-.77-1.333-2.694-1.333-3.464 0L3.34 16c-.77 1.333.192 3 1.732 3z"></path></svg>
<article>
<p>api notice</p>
</article>
</div>
<code class="phpdocumentor-code phpdocumentor-signature -deprecated">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_group_contact_deprecation</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array of deprecated actions</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_group_nesting_get">
civicrm_api3_group_nesting_get()
<a href="namespaces/default.html#function_civicrm_api3_group_nesting_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/GroupNesting.php"><a href="files/api-v3-groupnesting.html"><abbr title="api/v3/GroupNesting.php">GroupNesting.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">29</span>
</aside>
<p class="phpdocumentor-summary">Provides group nesting record(s) given parent and/or child id.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_group_nesting_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>An array containing at least child_group_id or parent_group_id.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>list of group nesting records</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_group_nesting_create">
civicrm_api3_group_nesting_create()
<a href="namespaces/default.html#function_civicrm_api3_group_nesting_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/GroupNesting.php"><a href="files/api-v3-groupnesting.html"><abbr title="api/v3/GroupNesting.php">GroupNesting.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">44</span>
</aside>
<p class="phpdocumentor-summary">Creates group nesting record for given parent and child id.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_group_nesting_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>Parent and child groups need to exist.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Parameters array - allowed array keys include:.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API success array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_group_nesting_create_spec">
_civicrm_api3_group_nesting_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_group_nesting_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/GroupNesting.php"><a href="files/api-v3-groupnesting.html"><abbr title="api/v3/GroupNesting.php">GroupNesting.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">56</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_group_nesting_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_group_nesting_delete">
civicrm_api3_group_nesting_delete()
<a href="namespaces/default.html#function_civicrm_api3_group_nesting_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/GroupNesting.php"><a href="files/api-v3-groupnesting.html"><abbr title="api/v3/GroupNesting.php">GroupNesting.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">71</span>
</aside>
<p class="phpdocumentor-summary">Removes specific nesting records.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_group_nesting_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_group_nesting_delete#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Work out the return value.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API Success or fail array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_group_organization_get">
civicrm_api3_group_organization_get()
<a href="namespaces/default.html#function_civicrm_api3_group_organization_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/GroupOrganization.php"><a href="files/api-v3-grouporganization.html"><abbr title="api/v3/GroupOrganization.php">GroupOrganization.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">27</span>
</aside>
<p class="phpdocumentor-summary">Get group organization record/s.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_group_organization_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Name value pair of contact information.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>list of groups, given contact subscribed to</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_group_organization_create">
civicrm_api3_group_organization_create()
<a href="namespaces/default.html#function_civicrm_api3_group_organization_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/GroupOrganization.php"><a href="files/api-v3-grouporganization.html"><abbr title="api/v3/GroupOrganization.php">GroupOrganization.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">39</span>
</aside>
<p class="phpdocumentor-summary">Create group organization record.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_group_organization_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_group_organization_create_spec">
_civicrm_api3_group_organization_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_group_organization_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/GroupOrganization.php"><a href="files/api-v3-grouporganization.html"><abbr title="api/v3/GroupOrganization.php">GroupOrganization.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">52</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_group_organization_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_group_organization_delete">
civicrm_api3_group_organization_delete()
<a href="namespaces/default.html#function_civicrm_api3_group_organization_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/GroupOrganization.php"><a href="files/api-v3-grouporganization.html"><abbr title="api/v3/GroupOrganization.php">GroupOrganization.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">68</span>
</aside>
<p class="phpdocumentor-summary">Deletes an existing Group Organization.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_group_organization_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>This API is used for deleting a Group Organization</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>With 'id' = ID of the Group Organization to be deleted.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API Result</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_im_create">
civicrm_api3_im_create()
<a href="namespaces/default.html#function_civicrm_api3_im_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Im.php"><a href="files/api-v3-im.html"><abbr title="api/v3/Im.php">Im.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">25</span>
</aside>
<p class="phpdocumentor-summary">Add an IM for a contact.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_im_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_im_create_spec">
_civicrm_api3_im_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_im_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Im.php"><a href="files/api-v3-im.html"><abbr title="api/v3/Im.php">Im.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">37</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_im_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_im_delete">
civicrm_api3_im_delete()
<a href="namespaces/default.html#function_civicrm_api3_im_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Im.php"><a href="files/api-v3-im.html"><abbr title="api/v3/Im.php">Im.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">53</span>
</aside>
<p class="phpdocumentor-summary">Deletes an existing IM.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_im_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result Array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_im_get">
civicrm_api3_im_get()
<a href="namespaces/default.html#function_civicrm_api3_im_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Im.php"><a href="files/api-v3-im.html"><abbr title="api/v3/Im.php">Im.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">66</span>
</aside>
<p class="phpdocumentor-summary">Retrieve one or more IM.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_im_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>An associative array of name/value pairs.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>details of found IM</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_job_create_spec">
_civicrm_api3_job_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_job_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Job.php"><a href="files/api-v3-job.html"><abbr title="api/v3/Job.php">Job.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">26</span>
</aside>
<p class="phpdocumentor-summary">Adjust metadata for "Create" action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_job_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_job_create">
civicrm_api3_job_create()
<a href="namespaces/default.html#function_civicrm_api3_job_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Job.php"><a href="files/api-v3-job.html"><abbr title="api/v3/Job.php">Job.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">44</span>
</aside>
<p class="phpdocumentor-summary">Create scheduled job.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_job_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Associative array of property name/value pairs to insert in new job.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_job_clone_spec">
_civicrm_api3_job_clone_spec()
<a href="namespaces/default.html#function__civicrm_api3_job_clone_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Job.php"><a href="files/api-v3-job.html"><abbr title="api/v3/Job.php">Job.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">53</span>
</aside>
<p class="phpdocumentor-summary">Adjust metadata for clone spec action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_job_clone_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$spec</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$spec</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_job_clone">
civicrm_api3_job_clone()
<a href="namespaces/default.html#function_civicrm_api3_job_clone" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Job.php"><a href="files/api-v3-job.html"><abbr title="api/v3/Job.php">Job.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">70</span>
</aside>
<p class="phpdocumentor-summary">Clone Job.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_job_clone</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_job_clone#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_job_get">
civicrm_api3_job_get()
<a href="namespaces/default.html#function_civicrm_api3_job_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Job.php"><a href="files/api-v3-job.html"><abbr title="api/v3/Job.php">Job.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">91</span>
</aside>
<p class="phpdocumentor-summary">Retrieve one or more job.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_job_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>input parameters</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_job_delete">
civicrm_api3_job_delete()
<a href="namespaces/default.html#function_civicrm_api3_job_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Job.php"><a href="files/api-v3-job.html"><abbr title="api/v3/Job.php">Job.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">100</span>
</aside>
<p class="phpdocumentor-summary">Delete a job.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_job_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_job_execute">
civicrm_api3_job_execute()
<a href="namespaces/default.html#function_civicrm_api3_job_execute" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Job.php"><a href="files/api-v3-job.html"><abbr title="api/v3/Job.php">Job.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">115</span>
</aside>
<p class="phpdocumentor-summary">Dumb wrapper to execute scheduled jobs.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_job_execute</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>Always creates success - errors and results are handled in the job log.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>input parameters (unused).</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API Result Array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_job_execute_spec">
_civicrm_api3_job_execute_spec()
<a href="namespaces/default.html#function__civicrm_api3_job_execute_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Job.php"><a href="files/api-v3-job.html"><abbr title="api/v3/Job.php">Job.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">130</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Execute action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_job_execute_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_job_geocode">
civicrm_api3_job_geocode()
<a href="namespaces/default.html#function_civicrm_api3_job_geocode" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Job.php"><a href="files/api-v3-job.html"><abbr title="api/v3/Job.php">Job.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">142</span>
</aside>
<p class="phpdocumentor-summary">Geocode group of contacts based on given params.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_job_geocode</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>input parameters.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API Result Array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_job_geocode_spec">
_civicrm_api3_job_geocode_spec()
<a href="namespaces/default.html#function__civicrm_api3_job_geocode_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Job.php"><a href="files/api-v3-job.html"><abbr title="api/v3/Job.php">Job.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">162</span>
</aside>
<p class="phpdocumentor-summary">First check on Code documentation.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_job_geocode_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_job_send_reminder">
civicrm_api3_job_send_reminder()
<a href="namespaces/default.html#function_civicrm_api3_job_send_reminder" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Job.php"><a href="files/api-v3-job.html"><abbr title="api/v3/Job.php">Job.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">196</span>
</aside>
<p class="phpdocumentor-summary">Send the scheduled reminders as configured.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_job_send_reminder</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>now - the time to use, in YmdHis format</li>
<li>makes testing a bit simpler since we can simulate past/future time</li>
</ul>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_job_send_reminder#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_job_send_reminder">
_civicrm_api3_job_send_reminder()
<a href="namespaces/default.html#function__civicrm_api3_job_send_reminder" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Job.php"><a href="files/api-v3-job.html"><abbr title="api/v3/Job.php">Job.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">220</span>
</aside>
<p class="phpdocumentor-summary">Adjust metadata for "send_reminder" action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_job_send_reminder</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_job_mail_report">
civicrm_api3_job_mail_report()
<a href="namespaces/default.html#function_civicrm_api3_job_mail_report" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Job.php"><a href="files/api-v3-job.html"><abbr title="api/v3/Job.php">Job.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">240</span>
</aside>
<p class="phpdocumentor-summary">Execute a specific report instance and send the output via email.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_job_mail_report</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>(reference ) input parameters.
sendmail - Boolean - should email be sent?, required
instanceId - Integer - the report instance ID
resetVal - Integer - should we reset form state (always true)?</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_job_update_greeting">
civicrm_api3_job_update_greeting()
<a href="namespaces/default.html#function_civicrm_api3_job_update_greeting" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Job.php"><a href="files/api-v3-job.html"><abbr title="api/v3/Job.php">Job.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">264</span>
</aside>
<p class="phpdocumentor-summary">This method allows to update Email Greetings, Postal Greetings and Addressee for a specific contact type.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_job_update_greeting</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>IMPORTANT: You must first create valid option value before using via admin interface.
Check option lists for Email Greetings, Postal Greetings and Addressee</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_job_update_greeting#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><ul>
<li>is this here by mistake or should it be added to _spec function :id - Integer - greetings option group.</li>
</ul>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_job_update_greeting_spec">
_civicrm_api3_job_update_greeting_spec()
<a href="namespaces/default.html#function__civicrm_api3_job_update_greeting_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Job.php"><a href="files/api-v3-job.html"><abbr title="api/v3/Job.php">Job.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">290</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Get action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_job_update_greeting_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_job_process_pledge">
civicrm_api3_job_process_pledge()
<a href="namespaces/default.html#function_civicrm_api3_job_process_pledge" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Job.php"><a href="files/api-v3-job.html"><abbr title="api/v3/Job.php">Job.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">312</span>
</aside>
<p class="phpdocumentor-summary">Mass update pledge statuses.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_job_process_pledge</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_job_process_pledge#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_job_process_mailing">
civicrm_api3_job_process_mailing()
<a href="namespaces/default.html#function_civicrm_api3_job_process_mailing" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Job.php"><a href="files/api-v3-job.html"><abbr title="api/v3/Job.php">Job.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">326</span>
</aside>
<p class="phpdocumentor-summary">Process mail queue.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_job_process_mailing</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_job_process_sms">
civicrm_api3_job_process_sms()
<a href="namespaces/default.html#function_civicrm_api3_job_process_sms" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Job.php"><a href="files/api-v3-job.html"><abbr title="api/v3/Job.php">Job.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">354</span>
</aside>
<p class="phpdocumentor-summary">Process sms queue.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_job_process_sms</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_job_fetch_bounces">
civicrm_api3_job_fetch_bounces()
<a href="namespaces/default.html#function_civicrm_api3_job_fetch_bounces" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Job.php"><a href="files/api-v3-job.html"><abbr title="api/v3/Job.php">Job.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">375</span>
</aside>
<p class="phpdocumentor-summary">Job to get mail responses from civiMailing.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_job_fetch_bounces</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_job_fetch_bounces_spec">
_civicrm_api3_job_fetch_bounces_spec()
<a href="namespaces/default.html#function__civicrm_api3_job_fetch_bounces_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Job.php"><a href="files/api-v3-job.html"><abbr title="api/v3/Job.php">Job.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">391</span>
</aside>
<p class="phpdocumentor-summary">Metadata for bounce function.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_job_fetch_bounces_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_job_fetch_activities">
civicrm_api3_job_fetch_activities()
<a href="namespaces/default.html#function_civicrm_api3_job_fetch_activities" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Job.php"><a href="files/api-v3-job.html"><abbr title="api/v3/Job.php">Job.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">406</span>
</aside>
<p class="phpdocumentor-summary">Job to get mail and create activities.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_job_fetch_activities</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_job_process_participant">
civicrm_api3_job_process_participant()
<a href="namespaces/default.html#function_civicrm_api3_job_process_participant" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Job.php"><a href="files/api-v3-job.html"><abbr title="api/v3/Job.php">Job.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">433</span>
</aside>
<p class="phpdocumentor-summary">Process participant statuses.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_job_process_participant</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Input parameters.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>array of properties, if error an array with an error id and error message</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_job_process_membership">
civicrm_api3_job_process_membership()
<a href="namespaces/default.html#function_civicrm_api3_job_process_membership" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Job.php"><a href="files/api-v3-job.html"><abbr title="api/v3/Job.php">Job.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">458</span>
</aside>
<p class="phpdocumentor-summary">This api checks and updates the status of all membership records for a given domain.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_job_process_membership</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<section class="phpdocumentor-description"><p>The function uses the calc_membership_status and update_contact_membership APIs.</p>
<p>IMPORTANT:
Sending renewal reminders has been migrated from this job to the Scheduled Reminders function as of 4.3.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Input parameters NOT USED.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
—
<section class="phpdocumentor-description"><p>true if success, else false</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_job_process_membership_spec">
_civicrm_api3_job_process_membership_spec()
<a href="namespaces/default.html#function__civicrm_api3_job_process_membership_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Job.php"><a href="files/api-v3-job.html"><abbr title="api/v3/Job.php">Job.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">482</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_job_process_membership_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_job_process_respondent">
civicrm_api3_job_process_respondent()
<a href="namespaces/default.html#function_civicrm_api3_job_process_respondent" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Job.php"><a href="files/api-v3-job.html"><abbr title="api/v3/Job.php">Job.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">510</span>
</aside>
<p class="phpdocumentor-summary">This api checks and updates the status of all survey respondents.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_job_process_respondent</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>(reference ) input parameters.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
—
<section class="phpdocumentor-description"><p>true if success, else false</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_job_process_batch_merge">
civicrm_api3_job_process_batch_merge()
<a href="namespaces/default.html#function_civicrm_api3_job_process_batch_merge" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Job.php"><a href="files/api-v3-job.html"><abbr title="api/v3/Job.php">Job.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">531</span>
</aside>
<p class="phpdocumentor-summary">Merges given pair of duplicate contacts.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_job_process_batch_merge</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Input parameters.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_job_process_batch_merge#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API Result Array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_job_process_batch_merge_spec">
_civicrm_api3_job_process_batch_merge_spec()
<a href="namespaces/default.html#function__civicrm_api3_job_process_batch_merge_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Job.php"><a href="files/api-v3-job.html"><abbr title="api/v3/Job.php">Job.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">554</span>
</aside>
<p class="phpdocumentor-summary">Metadata for batch merge function.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_job_process_batch_merge_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_job_run_payment_cron">
civicrm_api3_job_run_payment_cron()
<a href="namespaces/default.html#function_civicrm_api3_job_run_payment_cron" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Job.php"><a href="files/api-v3-job.html"><abbr title="api/v3/Job.php">Job.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">592</span>
</aside>
<p class="phpdocumentor-summary">Runs handlePaymentCron method in the specified payment processor.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_job_run_payment_cron</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Input parameters.</p>
<p>Expected @params array keys are: INCORRECTLY DOCUMENTED AND SHOULD BE IN THE _spec function
for retrieval via getfields.
{string 'processor_name' - the name of the payment processor, eg: Sagepay}</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_job_cleanup">
civicrm_api3_job_cleanup()
<a href="namespaces/default.html#function_civicrm_api3_job_cleanup" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Job.php"><a href="files/api-v3-job.html"><abbr title="api/v3/Job.php">Job.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">626</span>
</aside>
<p class="phpdocumentor-summary">This api cleans up all the old session entries and temp tables.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_job_cleanup</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>We recommend that sites run this on an hourly basis.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Sends in various config parameters to decide what needs to be cleaned.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_job_disable_expired_relationships">
civicrm_api3_job_disable_expired_relationships()
<a href="namespaces/default.html#function_civicrm_api3_job_disable_expired_relationships" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Job.php"><a href="files/api-v3-job.html"><abbr title="api/v3/Job.php">Job.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">673</span>
</aside>
<p class="phpdocumentor-summary">Set expired relationships to disabled.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_job_disable_expired_relationships</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_job_disable_expired_relationships#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_job_group_rebuild">
civicrm_api3_job_group_rebuild()
<a href="namespaces/default.html#function_civicrm_api3_job_group_rebuild" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Job.php"><a href="files/api-v3-job.html"><abbr title="api/v3/Job.php">Job.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">694</span>
</aside>
<p class="phpdocumentor-summary">This api reloads all the smart groups.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_job_group_rebuild</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>If the org has a large number of smart groups it is recommended that they use the limit clause
to limit the number of smart groups evaluated on a per job basis.</p>
<p>Might also help to increase the smartGroupCacheTimeout and use the cache.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_job_group_rebuild#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_job_group_cache_flush">
civicrm_api3_job_group_cache_flush()
<a href="namespaces/default.html#function_civicrm_api3_job_group_cache_flush" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Job.php"><a href="files/api-v3-job.html"><abbr title="api/v3/Job.php">Job.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">723</span>
</aside>
<p class="phpdocumentor-summary">Flush smart groups caches.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_job_group_cache_flush</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>This job purges aged smart group cache data (based on the timeout value).
Sites can decide whether they want this job and / or the group cache rebuild
job to run. In some cases performance is better when old caches are cleared
out prior to any attempt to rebuild them. Also, many sites are very happy to
have caches built on demand, provided the user is not having to wait for
deadlocks to clear when invalidating them.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_job_group_cache_flush#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_job_acl_cache_flush">
civicrm_api3_job_acl_cache_flush()
<a href="namespaces/default.html#function_civicrm_api3_job_acl_cache_flush" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Job.php"><a href="files/api-v3-job.html"><abbr title="api/v3/Job.php">Job.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">741</span>
</aside>
<p class="phpdocumentor-summary">Flush acl caches.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_job_acl_cache_flush</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>This job flushes the acl cache. For many sites it is better to do
this by cron (or not at all if acls are not used) than whenever
a contact is edited.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_job_acl_cache_flush#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_job_version_check">
civicrm_api3_job_version_check()
<a href="namespaces/default.html#function_civicrm_api3_job_version_check" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Job.php"><a href="files/api-v3-job.html"><abbr title="api/v3/Job.php">Job.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">751</span>
</aside>
<p class="phpdocumentor-summary">Check for CiviCRM software updates.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_job_version_check</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>Anonymous site statistics are sent back to civicrm.org during this check.</p>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_job_log_get">
civicrm_api3_job_log_get()
<a href="namespaces/default.html#function_civicrm_api3_job_log_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/JobLog.php"><a href="files/api-v3-joblog.html"><abbr title="api/v3/JobLog.php">JobLog.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">20</span>
</aside>
<p class="phpdocumentor-summary">Retrieve one or more job log record.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_job_log_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>input parameters</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_job_log_create">
civicrm_api3_job_log_create()
<a href="namespaces/default.html#function_civicrm_api3_job_log_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/JobLog.php"><a href="files/api-v3-joblog.html"><abbr title="api/v3/JobLog.php">JobLog.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">32</span>
</aside>
<p class="phpdocumentor-summary">Create one or more job log record.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_job_log_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>input parameters</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_job_log_delete">
civicrm_api3_job_log_delete()
<a href="namespaces/default.html#function_civicrm_api3_job_log_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/JobLog.php"><a href="files/api-v3-joblog.html"><abbr title="api/v3/JobLog.php">JobLog.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">44</span>
</aside>
<p class="phpdocumentor-summary">Delete one or more job log record.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_job_log_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>input parameters</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_line_item_create">
civicrm_api3_line_item_create()
<a href="namespaces/default.html#function_civicrm_api3_line_item_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/LineItem.php"><a href="files/api-v3-lineitem.html"><abbr title="api/v3/LineItem.php">LineItem.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">33</span>
</aside>
<p class="phpdocumentor-summary">Create or update a line_item.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_line_item_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of property name/value pairs to insert in new 'line_item'</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_line_item_create#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/Civi-API-Exception-UnauthorizedException.html"><abbr title="\Civi\API\Exception\UnauthorizedException">UnauthorizedException</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>api result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_line_item_create_spec">
_civicrm_api3_line_item_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_line_item_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/LineItem.php"><a href="files/api-v3-lineitem.html"><abbr title="api/v3/LineItem.php">LineItem.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">45</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_line_item_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_line_item_get">
civicrm_api3_line_item_get()
<a href="namespaces/default.html#function_civicrm_api3_line_item_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/LineItem.php"><a href="files/api-v3-lineitem.html"><abbr title="api/v3/LineItem.php">LineItem.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">63</span>
</aside>
<p class="phpdocumentor-summary">Returns array of line_items matching a set of one or more group properties.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_line_item_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of one or more valid property_name=>value pairs. If $params is set.
as null, all line_items will be returned (default limit is 25)</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array of matching line_items</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_line_item_delete">
civicrm_api3_line_item_delete()
<a href="namespaces/default.html#function_civicrm_api3_line_item_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/LineItem.php"><a href="files/api-v3-lineitem.html"><abbr title="api/v3/LineItem.php">LineItem.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">79</span>
</aside>
<p class="phpdocumentor-summary">Delete an existing LineItem.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_line_item_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>This method is used to delete any existing LineItem given its id.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array containing id of the group to be deleted.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_line_item_delete#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_location_type_create">
civicrm_api3_location_type_create()
<a href="namespaces/default.html#function_civicrm_api3_location_type_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/LocationType.php"><a href="files/api-v3-locationtype.html"><abbr title="api/v3/LocationType.php">LocationType.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">26</span>
</aside>
<p class="phpdocumentor-summary">Add a LocationType.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_location_type_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_location_type_create_spec">
_civicrm_api3_location_type_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_location_type_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/LocationType.php"><a href="files/api-v3-locationtype.html"><abbr title="api/v3/LocationType.php">LocationType.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">43</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_location_type_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_location_type_delete">
civicrm_api3_location_type_delete()
<a href="namespaces/default.html#function_civicrm_api3_location_type_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/LocationType.php"><a href="files/api-v3-locationtype.html"><abbr title="api/v3/LocationType.php">LocationType.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">56</span>
</aside>
<p class="phpdocumentor-summary">Deletes an existing LocationType.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_location_type_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_location_type_get">
civicrm_api3_location_type_get()
<a href="namespaces/default.html#function_civicrm_api3_location_type_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/LocationType.php"><a href="files/api-v3-locationtype.html"><abbr title="api/v3/LocationType.php">LocationType.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">69</span>
</aside>
<p class="phpdocumentor-summary">Retrieve one or more LocationTypes.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_location_type_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>An associative array of name/value pairs.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_loc_block_create">
civicrm_api3_loc_block_create()
<a href="namespaces/default.html#function_civicrm_api3_loc_block_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/LocBlock.php"><a href="files/api-v3-locblock.html"><abbr title="api/v3/LocBlock.php">LocBlock.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">29</span>
</aside>
<p class="phpdocumentor-summary">Create or update a LocBlock.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_loc_block_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Name/value pairs to insert in new 'LocBlock'.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_loc_block_create#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_loc_block_get">
civicrm_api3_loc_block_get()
<a href="namespaces/default.html#function_civicrm_api3_loc_block_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/LocBlock.php"><a href="files/api-v3-locblock.html"><abbr title="api/v3/LocBlock.php">LocBlock.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">86</span>
</aside>
<p class="phpdocumentor-summary">Returns array of loc_blocks matching a set of one or more properties.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_loc_block_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of one or more valid property_name=>value pairs. If $params is set.
as null, all loc_blocks will be returned (default limit is 25).</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_loc_block_delete">
civicrm_api3_loc_block_delete()
<a href="namespaces/default.html#function_civicrm_api3_loc_block_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/LocBlock.php"><a href="files/api-v3-locblock.html"><abbr title="api/v3/LocBlock.php">LocBlock.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">120</span>
</aside>
<p class="phpdocumentor-summary">Delete an existing LocBlock.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_loc_block_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array containing id of the record to be deleted.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_logging_revert">
civicrm_api3_logging_revert()
<a href="namespaces/default.html#function_civicrm_api3_logging_revert" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Logging.php"><a href="files/api-v3-logging.html"><abbr title="api/v3/Logging.php">Logging.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">28</span>
</aside>
<p class="phpdocumentor-summary">Revert a log change.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_logging_revert</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_logging_revert#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/Civi-API-Exception-UnauthorizedException.html"><abbr title="\Civi\API\Exception\UnauthorizedException">UnauthorizedException</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API Success Array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_logging_revert_spec">
_civicrm_api3_logging_revert_spec()
<a href="namespaces/default.html#function__civicrm_api3_logging_revert_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Logging.php"><a href="files/api-v3-logging.html"><abbr title="api/v3/Logging.php">Logging.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">45</span>
</aside>
<p class="phpdocumentor-summary">Get a log change.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_logging_revert_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_logging_revert_spec#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/Civi-API-Exception-UnauthorizedException.html"><abbr title="\Civi\API\Exception\UnauthorizedException">UnauthorizedException</abbr></a></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_logging_get">
civicrm_api3_logging_get()
<a href="namespaces/default.html#function_civicrm_api3_logging_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Logging.php"><a href="files/api-v3-logging.html"><abbr title="api/v3/Logging.php">Logging.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">79</span>
</aside>
<p class="phpdocumentor-summary">Get a log change.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_logging_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_logging_get#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/Civi-API-Exception-UnauthorizedException.html"><abbr title="\Civi\API\Exception\UnauthorizedException">UnauthorizedException</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API Success Array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_logging_get_spec">
_civicrm_api3_logging_get_spec()
<a href="namespaces/default.html#function__civicrm_api3_logging_get_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Logging.php"><a href="files/api-v3-logging.html"><abbr title="api/v3/Logging.php">Logging.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">95</span>
</aside>
<p class="phpdocumentor-summary">Get a log change.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_logging_get_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_logging_get_spec#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/Civi-API-Exception-UnauthorizedException.html"><abbr title="\Civi\API\Exception\UnauthorizedException">UnauthorizedException</abbr></a></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_mailing_create">
civicrm_api3_mailing_create()
<a href="namespaces/default.html#function_civicrm_api3_mailing_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Mailing.php"><a href="files/api-v3-mailing.html"><abbr title="api/v3/Mailing.php">Mailing.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">29</span>
</aside>
<p class="phpdocumentor-summary">Handle a create event.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_mailing_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_mailing_create#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/Civi-API-Exception-UnauthorizedException.html"><abbr title="\Civi\API\Exception\UnauthorizedException">UnauthorizedException</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API Success Array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_mailing_gettokens">
civicrm_api3_mailing_gettokens()
<a href="namespaces/default.html#function_civicrm_api3_mailing_gettokens" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Mailing.php"><a href="files/api-v3-mailing.html"><abbr title="api/v3/Mailing.php">Mailing.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">67</span>
</aside>
<p class="phpdocumentor-summary">Get tokens for one or more entity type</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_mailing_gettokens</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>Output will be formatted either as a flat list,
or pass sequential=1 to retrieve as a hierarchy formatted for select2.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Should contain an array of entities to retrieve tokens for.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_mailing_gettokens#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_mailing_gettokens_spec">
_civicrm_api3_mailing_gettokens_spec()
<a href="namespaces/default.html#function__civicrm_api3_mailing_gettokens_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Mailing.php"><a href="files/api-v3-mailing.html"><abbr title="api/v3/Mailing.php">Mailing.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">90</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_mailing_gettokens_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_mailing_create_spec">
_civicrm_api3_mailing_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_mailing_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Mailing.php"><a href="files/api-v3-mailing.html"><abbr title="api/v3/Mailing.php">Mailing.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">115</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_mailing_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_mailing_clone_spec">
_civicrm_api3_mailing_clone_spec()
<a href="namespaces/default.html#function__civicrm_api3_mailing_clone_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Mailing.php"><a href="files/api-v3-mailing.html"><abbr title="api/v3/Mailing.php">Mailing.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">130</span>
</aside>
<p class="phpdocumentor-summary">Adjust metadata for clone spec action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_mailing_clone_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$spec</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$spec</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_mailing_clone">
civicrm_api3_mailing_clone()
<a href="namespaces/default.html#function_civicrm_api3_mailing_clone" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Mailing.php"><a href="files/api-v3-mailing.html"><abbr title="api/v3/Mailing.php">Mailing.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">144</span>
</aside>
<p class="phpdocumentor-summary">Clone mailing.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_mailing_clone</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_mailing_clone#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_mailing_delete">
civicrm_api3_mailing_delete()
<a href="namespaces/default.html#function_civicrm_api3_mailing_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Mailing.php"><a href="files/api-v3-mailing.html"><abbr title="api/v3/Mailing.php">Mailing.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">195</span>
</aside>
<p class="phpdocumentor-summary">Handle a delete event.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_mailing_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API Success Array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_mailing_get">
civicrm_api3_mailing_get()
<a href="namespaces/default.html#function_civicrm_api3_mailing_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Mailing.php"><a href="files/api-v3-mailing.html"><abbr title="api/v3/Mailing.php">Mailing.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">206</span>
</aside>
<p class="phpdocumentor-summary">Handle a get event.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_mailing_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_mailing_get_formatResult">
_civicrm_api3_mailing_get_formatResult()
<a href="namespaces/default.html#function__civicrm_api3_mailing_get_formatResult" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Mailing.php"><a href="files/api-v3-mailing.html"><abbr title="api/v3/Mailing.php">Mailing.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">219</span>
</aside>
<p class="phpdocumentor-summary">Format definition.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_mailing_get_formatResult</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$result</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$result</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_mailing_get_formatResult#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_mailing_submit_spec">
_civicrm_api3_mailing_submit_spec()
<a href="namespaces/default.html#function__civicrm_api3_mailing_submit_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Mailing.php"><a href="files/api-v3-mailing.html"><abbr title="api/v3/Mailing.php">Mailing.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">235</span>
</aside>
<p class="phpdocumentor-summary">Adjust metadata for mailing submit api function.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_mailing_submit_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$spec</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$spec</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_mailing_submit">
civicrm_api3_mailing_submit()
<a href="namespaces/default.html#function_civicrm_api3_mailing_submit" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Mailing.php"><a href="files/api-v3-mailing.html"><abbr title="api/v3/Mailing.php">Mailing.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">253</span>
</aside>
<p class="phpdocumentor-summary">Mailing submit.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_mailing_submit</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_mailing_submit#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_mailing_event_bounce">
civicrm_api3_mailing_event_bounce()
<a href="namespaces/default.html#function_civicrm_api3_mailing_event_bounce" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Mailing.php"><a href="files/api-v3-mailing.html"><abbr title="api/v3/Mailing.php">Mailing.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">296</span>
</aside>
<p class="phpdocumentor-summary">Process a bounce event by passing through to the BAOs.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_mailing_event_bounce</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_mailing_event_bounce#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_mailing_event_bounce_spec">
_civicrm_api3_mailing_event_bounce_spec()
<a href="namespaces/default.html#function__civicrm_api3_mailing_event_bounce_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Mailing.php"><a href="files/api-v3-mailing.html"><abbr title="api/v3/Mailing.php">Mailing.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">318</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for bounce_spec action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_mailing_event_bounce_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - -deprecated">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_mailing_event_confirm">
civicrm_api3_mailing_event_confirm()
<a href="namespaces/default.html#function_civicrm_api3_mailing_event_confirm" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Mailing.php"><a href="files/api-v3-mailing.html"><abbr title="api/v3/Mailing.php">Mailing.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">338</span>
</aside>
<p class="phpdocumentor-summary">Handle a confirm event.</p>
<div class="phpdocumentor-admonition">
<svg class="phpdocumentor-admonition__icon" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-3L13.732 4c-.77-1.333-2.694-1.333-3.464 0L3.34 16c-.77 1.333.192 3 1.732 3z"></path></svg>
<article>
</article>
</div>
<code class="phpdocumentor-code phpdocumentor-signature -deprecated">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_mailing_event_confirm</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - -deprecated">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_mailing_deprecation">
_civicrm_api3_mailing_deprecation()
<a href="namespaces/default.html#function__civicrm_api3_mailing_deprecation" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Mailing.php"><a href="files/api-v3-mailing.html"><abbr title="api/v3/Mailing.php">Mailing.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">349</span>
</aside>
<p class="phpdocumentor-summary">Declare deprecated functions.</p>
<div class="phpdocumentor-admonition">
<svg class="phpdocumentor-admonition__icon" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-3L13.732 4c-.77-1.333-2.694-1.333-3.464 0L3.34 16c-.77 1.333.192 3 1.732 3z"></path></svg>
<article>
<p>api notice</p>
</article>
</div>
<code class="phpdocumentor-code phpdocumentor-signature -deprecated">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_mailing_deprecation</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array of deprecated actions</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_mailing_event_reply">
civicrm_api3_mailing_event_reply()
<a href="namespaces/default.html#function_civicrm_api3_mailing_event_reply" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Mailing.php"><a href="files/api-v3-mailing.html"><abbr title="api/v3/Mailing.php">Mailing.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">363</span>
</aside>
<p class="phpdocumentor-summary">Handle a reply event.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_mailing_event_reply</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_mailing_event_reply_spec">
_civicrm_api3_mailing_event_reply_spec()
<a href="namespaces/default.html#function__civicrm_api3_mailing_event_reply_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Mailing.php"><a href="files/api-v3-mailing.html"><abbr title="api/v3/Mailing.php">Mailing.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">391</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for event_reply action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_mailing_event_reply_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - -deprecated">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_mailing_event_forward">
civicrm_api3_mailing_event_forward()
<a href="namespaces/default.html#function_civicrm_api3_mailing_event_forward" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Mailing.php"><a href="files/api-v3-mailing.html"><abbr title="api/v3/Mailing.php">Mailing.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">417</span>
</aside>
<p class="phpdocumentor-summary">Handle a forward event.</p>
<div class="phpdocumentor-admonition">
<svg class="phpdocumentor-admonition__icon" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-3L13.732 4c-.77-1.333-2.694-1.333-3.464 0L3.34 16c-.77 1.333.192 3 1.732 3z"></path></svg>
<article>
<p>it is highly unlikely this function is ever used because to
use it someone needs to forward an email by clicking on a link rather than..
forwarding the email. Even the links are probably never generated.</p>
<p>Also - it would be poor email server reputation management. Function is nasty
but can die with apiv4 whenever that is (along with surveyRespondant)</p>
</article>
</div>
<code class="phpdocumentor-code phpdocumentor-signature -deprecated">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_mailing_event_forward</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_mailing_event_forward_spec">
_civicrm_api3_mailing_event_forward_spec()
<a href="namespaces/default.html#function__civicrm_api3_mailing_event_forward_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Mailing.php"><a href="files/api-v3-mailing.html"><abbr title="api/v3/Mailing.php">Mailing.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">551</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for event_forward action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_mailing_event_forward_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_mailing_event_click">
civicrm_api3_mailing_event_click()
<a href="namespaces/default.html#function_civicrm_api3_mailing_event_click" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Mailing.php"><a href="files/api-v3-mailing.html"><abbr title="api/v3/Mailing.php">Mailing.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">569</span>
</aside>
<p class="phpdocumentor-summary">Handle a click event.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_mailing_event_click</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_mailing_event_open">
civicrm_api3_mailing_event_open()
<a href="namespaces/default.html#function_civicrm_api3_mailing_event_open" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Mailing.php"><a href="files/api-v3-mailing.html"><abbr title="api/v3/Mailing.php">Mailing.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">595</span>
</aside>
<p class="phpdocumentor-summary">Handle an open event.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_mailing_event_open</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_mailing_preview">
civicrm_api3_mailing_preview()
<a href="namespaces/default.html#function_civicrm_api3_mailing_preview" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Mailing.php"><a href="files/api-v3-mailing.html"><abbr title="api/v3/Mailing.php">Mailing.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">621</span>
</aside>
<p class="phpdocumentor-summary">Preview mailing.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_mailing_preview</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields metadata.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_mailing_preview#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_mailing_send_test_spec">
_civicrm_api3_mailing_send_test_spec()
<a href="namespaces/default.html#function__civicrm_api3_mailing_send_test_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Mailing.php"><a href="files/api-v3-mailing.html"><abbr title="api/v3/Mailing.php">Mailing.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">630</span>
</aside>
<p class="phpdocumentor-summary">Adjust metadata for send test function.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_mailing_send_test_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$spec</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$spec</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_mailing_send_test">
civicrm_api3_mailing_send_test()
<a href="namespaces/default.html#function_civicrm_api3_mailing_send_test" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Mailing.php"><a href="files/api-v3-mailing.html"><abbr title="api/v3/Mailing.php">Mailing.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">645</span>
</aside>
<p class="phpdocumentor-summary">Send test mailing.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_mailing_send_test</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_mailing_send_test#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_mailing_stats_spec">
_civicrm_api3_mailing_stats_spec()
<a href="namespaces/default.html#function__civicrm_api3_mailing_stats_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Mailing.php"><a href="files/api-v3-mailing.html"><abbr title="api/v3/Mailing.php">Mailing.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">749</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for send_mail action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_mailing_stats_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_mailing_stats">
civicrm_api3_mailing_stats()
<a href="namespaces/default.html#function_civicrm_api3_mailing_stats" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Mailing.php"><a href="files/api-v3-mailing.html"><abbr title="api/v3/Mailing.php">Mailing.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">764</span>
</aside>
<p class="phpdocumentor-summary">Function which needs to be explained.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_mailing_stats</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_mailing_stats#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_mailing_update_email_resetdate_spec">
_civicrm_api3_mailing_update_email_resetdate_spec()
<a href="namespaces/default.html#function__civicrm_api3_mailing_update_email_resetdate_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Mailing.php"><a href="files/api-v3-mailing.html"><abbr title="api/v3/Mailing.php">Mailing.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">832</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_mailing_update_email_resetdate_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$spec</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$spec</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_mailing_update_email_resetdate">
civicrm_api3_mailing_update_email_resetdate()
<a href="namespaces/default.html#function_civicrm_api3_mailing_update_email_resetdate" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Mailing.php"><a href="files/api-v3-mailing.html"><abbr title="api/v3/Mailing.php">Mailing.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">854</span>
</aside>
<p class="phpdocumentor-summary">Fix the reset dates on the email record based on when a mail was last delivered.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_mailing_update_email_resetdate</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>We only consider mailings that were completed and finished in the last 3 to 7 days
Both the min and max days can be set via the params</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_mailing_a_b_create_spec">
_civicrm_api3_mailing_a_b_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_mailing_a_b_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MailingAB.php"><a href="files/api-v3-mailingab.html"><abbr title="api/v3/MailingAB.php">MailingAB.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">22</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_mailing_a_b_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$spec</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$spec</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_mailing_a_b_create">
civicrm_api3_mailing_a_b_create()
<a href="namespaces/default.html#function_civicrm_api3_mailing_a_b_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MailingAB.php"><a href="files/api-v3-mailingab.html"><abbr title="api/v3/MailingAB.php">MailingAB.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">37</span>
</aside>
<p class="phpdocumentor-summary">Handle a create mailing ab testing.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_mailing_a_b_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API Success Array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_mailing_a_b_delete">
civicrm_api3_mailing_a_b_delete()
<a href="namespaces/default.html#function_civicrm_api3_mailing_a_b_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MailingAB.php"><a href="files/api-v3-mailingab.html"><abbr title="api/v3/MailingAB.php">MailingAB.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">49</span>
</aside>
<p class="phpdocumentor-summary">Handle a delete event.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_mailing_a_b_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API Success Array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_mailing_a_b_get">
civicrm_api3_mailing_a_b_get()
<a href="namespaces/default.html#function_civicrm_api3_mailing_a_b_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MailingAB.php"><a href="files/api-v3-mailingab.html"><abbr title="api/v3/MailingAB.php">MailingAB.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">60</span>
</aside>
<p class="phpdocumentor-summary">Handle a get event.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_mailing_a_b_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_mailing_a_b_submit_spec">
_civicrm_api3_mailing_a_b_submit_spec()
<a href="namespaces/default.html#function__civicrm_api3_mailing_a_b_submit_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MailingAB.php"><a href="files/api-v3-mailingab.html"><abbr title="api/v3/MailingAB.php">MailingAB.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">72</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for submit action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_mailing_a_b_submit_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$spec</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$spec</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_mailing_a_b_submit">
civicrm_api3_mailing_a_b_submit()
<a href="namespaces/default.html#function_civicrm_api3_mailing_a_b_submit" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MailingAB.php"><a href="files/api-v3-mailingab.html"><abbr title="api/v3/MailingAB.php">MailingAB.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">101</span>
</aside>
<p class="phpdocumentor-summary">Send A/B mail to A/B recipients respectively.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_mailing_a_b_submit</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_mailing_a_b_submit#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_mailing_a_b_fill_winner">
_civicrm_api3_mailing_a_b_fill_winner()
<a href="namespaces/default.html#function__civicrm_api3_mailing_a_b_fill_winner" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MailingAB.php"><a href="files/api-v3-mailingab.html"><abbr title="api/v3/MailingAB.php">MailingAB.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">173</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_mailing_a_b_fill_winner</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$winner_id</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$final_id</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$winner_id</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The experimental mailing chosen as the "winner".</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$final_id</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The final mailing which should imitate the "winner".</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_mailing_a_b_fill_winner#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_mailing_a_b_graph_stats_spec">
_civicrm_api3_mailing_a_b_graph_stats_spec()
<a href="namespaces/default.html#function__civicrm_api3_mailing_a_b_graph_stats_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MailingAB.php"><a href="files/api-v3-mailingab.html"><abbr title="api/v3/MailingAB.php">MailingAB.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">227</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for graph_stats action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_mailing_a_b_graph_stats_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_mailing_a_b_graph_stats">
civicrm_api3_mailing_a_b_graph_stats()
<a href="namespaces/default.html#function_civicrm_api3_mailing_a_b_graph_stats" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MailingAB.php"><a href="files/api-v3-mailingab.html"><abbr title="api/v3/MailingAB.php">MailingAB.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">255</span>
</aside>
<p class="phpdocumentor-summary">Send graph detail for A/B tests mail.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_mailing_a_b_graph_stats</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_mailing_a_b_graph_stats#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_mailing_component_create">
civicrm_api3_mailing_component_create()
<a href="namespaces/default.html#function_civicrm_api3_mailing_component_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MailingComponent.php"><a href="files/api-v3-mailingcomponent.html"><abbr title="api/v3/MailingComponent.php">MailingComponent.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">27</span>
</aside>
<p class="phpdocumentor-summary">Save a MailingComponent.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_mailing_component_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_mailing_component_create#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_mailing_component_create_spec">
_civicrm_api3_mailing_component_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_mailing_component_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MailingComponent.php"><a href="files/api-v3-mailingcomponent.html"><abbr title="api/v3/MailingComponent.php">MailingComponent.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">39</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_mailing_component_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$spec</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$spec</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_mailing_component_get">
civicrm_api3_mailing_component_get()
<a href="namespaces/default.html#function_civicrm_api3_mailing_component_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MailingComponent.php"><a href="files/api-v3-mailingcomponent.html"><abbr title="api/v3/MailingComponent.php">MailingComponent.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">53</span>
</aside>
<p class="phpdocumentor-summary">Get a MailingComponent.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_mailing_component_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_mailing_component_get_spec">
_civicrm_api3_mailing_component_get_spec()
<a href="namespaces/default.html#function__civicrm_api3_mailing_component_get_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MailingComponent.php"><a href="files/api-v3-mailingcomponent.html"><abbr title="api/v3/MailingComponent.php">MailingComponent.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">62</span>
</aside>
<p class="phpdocumentor-summary">Adjust metadata for get.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_mailing_component_get_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_mailing_component_delete">
civicrm_api3_mailing_component_delete()
<a href="namespaces/default.html#function_civicrm_api3_mailing_component_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MailingComponent.php"><a href="files/api-v3-mailingcomponent.html"><abbr title="api/v3/MailingComponent.php">MailingComponent.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">76</span>
</aside>
<p class="phpdocumentor-summary">Delete a MailingComponent.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_mailing_component_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_mailing_component_delete#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_mailing_contact_get">
civicrm_api3_mailing_contact_get()
<a href="namespaces/default.html#function_civicrm_api3_mailing_contact_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MailingContact.php"><a href="files/api-v3-mailingcontact.html"><abbr title="api/v3/MailingContact.php">MailingContact.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">27</span>
</aside>
<p class="phpdocumentor-summary">Get all the mailings and details that a contact was involved with.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_mailing_contact_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Input parameters - see _spec for details (returned by getfields)</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_mailing_contact_getresults">
_civicrm_api3_mailing_contact_getresults()
<a href="namespaces/default.html#function__civicrm_api3_mailing_contact_getresults" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MailingContact.php"><a href="files/api-v3-mailingcontact.html"><abbr title="api/v3/MailingContact.php">MailingContact.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">39</span>
</aside>
<p class="phpdocumentor-summary">This is a wrapper for the functions that return the results from the 'quasi-entity' mailing contact.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_mailing_contact_getresults</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$count</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$count</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_mailing_contact_getresults#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\Exception">Exception</abbr></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_mailing_contact_get_spec">
_civicrm_api3_mailing_contact_get_spec()
<a href="namespaces/default.html#function__civicrm_api3_mailing_contact_get_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MailingContact.php"><a href="files/api-v3-mailingcontact.html"><abbr title="api/v3/MailingContact.php">MailingContact.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">64</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Get action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_mailing_contact_get_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_mailing_contact_query">
_civicrm_api3_mailing_contact_query()
<a href="namespaces/default.html#function__civicrm_api3_mailing_contact_query" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MailingContact.php"><a href="files/api-v3-mailingcontact.html"><abbr title="api/v3/MailingContact.php">MailingContact.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">97</span>
</aside>
<p class="phpdocumentor-summary">Helper function for mailing contact queries.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_mailing_contact_query</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$contactID</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$offset</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$limit</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed>|null </span><span class="phpdocumentor-signature__argument__name">$selectFields</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string|null </span><span class="phpdocumentor-signature__argument__name">$fromClause</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string|null </span><span class="phpdocumentor-signature__argument__name">$whereClause</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string|null </span><span class="phpdocumentor-signature__argument__name">$sort</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$getCount</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$contactID</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$offset</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$limit</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$selectFields</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed>|null</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fromClause</span>
: <span class="phpdocumentor-signature__argument__return-type">string|null</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$whereClause</span>
: <span class="phpdocumentor-signature__argument__return-type">string|null</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$sort</span>
: <span class="phpdocumentor-signature__argument__return-type">string|null</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$getCount</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_mailing_contact_get_delivered">
_civicrm_api3_mailing_contact_get_delivered()
<a href="namespaces/default.html#function__civicrm_api3_mailing_contact_get_delivered" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MailingContact.php"><a href="files/api-v3-mailingcontact.html"><abbr title="api/v3/MailingContact.php">MailingContact.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">206</span>
</aside>
<p class="phpdocumentor-summary">Get delivered mailing contacts.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_mailing_contact_get_delivered</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$contactID</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$offset</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$limit</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string|null </span><span class="phpdocumentor-signature__argument__name">$sort</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$getCount</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$contactID</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$offset</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$limit</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$sort</span>
: <span class="phpdocumentor-signature__argument__return-type">string|null</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$getCount</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_mailing_contact_get_bounced">
_civicrm_api3_mailing_contact_get_bounced()
<a href="namespaces/default.html#function__civicrm_api3_mailing_contact_get_bounced" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MailingContact.php"><a href="files/api-v3-mailingcontact.html"><abbr title="api/v3/MailingContact.php">MailingContact.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">247</span>
</aside>
<p class="phpdocumentor-summary">Get bounced mailing contact records.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_mailing_contact_get_bounced</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$contactID</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$offset</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$limit</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string|null </span><span class="phpdocumentor-signature__argument__name">$sort</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$getCount</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$contactID</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$offset</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$limit</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$sort</span>
: <span class="phpdocumentor-signature__argument__return-type">string|null</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$getCount</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_mailing_contact_getcount">
civicrm_api3_mailing_contact_getcount()
<a href="namespaces/default.html#function_civicrm_api3_mailing_contact_getcount" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MailingContact.php"><a href="files/api-v3-mailingcontact.html"><abbr title="api/v3/MailingContact.php">MailingContact.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">279</span>
</aside>
<p class="phpdocumentor-summary">Get count of all the mailings that a contact was involved with.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_mailing_contact_getcount</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Input parameters per getfields</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_mailing_event_confirm_get">
civicrm_api3_mailing_event_confirm_get()
<a href="namespaces/default.html#function_civicrm_api3_mailing_event_confirm_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MailingEventConfirm.php"><a href="files/api-v3-mailingeventconfirm.html"><abbr title="api/v3/MailingEventConfirm.php">MailingEventConfirm.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">26</span>
</aside>
<p class="phpdocumentor-summary">Get mailing event confirm record.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_mailing_event_confirm_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_mailing_event_confirm_create">
civicrm_api3_mailing_event_confirm_create()
<a href="namespaces/default.html#function_civicrm_api3_mailing_event_confirm_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MailingEventConfirm.php"><a href="files/api-v3-mailingeventconfirm.html"><abbr title="api/v3/MailingEventConfirm.php">MailingEventConfirm.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">40</span>
</aside>
<p class="phpdocumentor-summary">Handle a confirm event.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_mailing_event_confirm_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>name/value pairs to insert in new 'survey'</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_mailing_event_confirm_create#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\Exception">Exception</abbr></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>api result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_mailing_event_confirm_create_spec">
_civicrm_api3_mailing_event_confirm_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_mailing_event_confirm_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MailingEventConfirm.php"><a href="files/api-v3-mailingeventconfirm.html"><abbr title="api/v3/MailingEventConfirm.php">MailingEventConfirm.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">62</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_mailing_event_confirm_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_mailing_event_queue_create">
civicrm_api3_mailing_event_queue_create()
<a href="namespaces/default.html#function_civicrm_api3_mailing_event_queue_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MailingEventQueue.php"><a href="files/api-v3-mailingeventqueue.html"><abbr title="api/v3/MailingEventQueue.php">MailingEventQueue.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">28</span>
</aside>
<p class="phpdocumentor-summary">Handle a queue event.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_mailing_event_queue_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of property.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_mailing_event_queue_create#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\Exception">Exception</abbr></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>api result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_mailing_event_queue_get">
civicrm_api3_mailing_event_queue_get()
<a href="namespaces/default.html#function_civicrm_api3_mailing_event_queue_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MailingEventQueue.php"><a href="files/api-v3-mailingeventqueue.html"><abbr title="api/v3/MailingEventQueue.php">MailingEventQueue.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">47</span>
</aside>
<p class="phpdocumentor-summary">Get mailing event queue record.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_mailing_event_queue_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_mailing_event_queue_delete">
civicrm_api3_mailing_event_queue_delete()
<a href="namespaces/default.html#function_civicrm_api3_mailing_event_queue_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MailingEventQueue.php"><a href="files/api-v3-mailingeventqueue.html"><abbr title="api/v3/MailingEventQueue.php">MailingEventQueue.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">59</span>
</aside>
<p class="phpdocumentor-summary">Delete mailing event queue record.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_mailing_event_queue_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_mailing_event_queue_delete#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_mailing_event_queue_create_spec">
_civicrm_api3_mailing_event_queue_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_mailing_event_queue_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MailingEventQueue.php"><a href="files/api-v3-mailingeventqueue.html"><abbr title="api/v3/MailingEventQueue.php">MailingEventQueue.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">71</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_mailing_event_queue_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_mailing_event_resubscribe_create">
civicrm_api3_mailing_event_resubscribe_create()
<a href="namespaces/default.html#function_civicrm_api3_mailing_event_resubscribe_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MailingEventResubscribe.php"><a href="files/api-v3-mailingeventresubscribe.html"><abbr title="api/v3/MailingEventResubscribe.php">MailingEventResubscribe.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">27</span>
</aside>
<p class="phpdocumentor-summary">Subscribe from mailing group.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_mailing_event_resubscribe_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>api result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_mailing_event_resubscribe_create_spec">
_civicrm_api3_mailing_event_resubscribe_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_mailing_event_resubscribe_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MailingEventResubscribe.php"><a href="files/api-v3-mailingeventresubscribe.html"><abbr title="api/v3/MailingEventResubscribe.php">MailingEventResubscribe.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">54</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_mailing_event_resubscribe_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_mailing_event_subscribe_get">
civicrm_api3_mailing_event_subscribe_get()
<a href="namespaces/default.html#function_civicrm_api3_mailing_event_subscribe_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MailingEventSubscribe.php"><a href="files/api-v3-mailingeventsubscribe.html"><abbr title="api/v3/MailingEventSubscribe.php">MailingEventSubscribe.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">26</span>
</aside>
<p class="phpdocumentor-summary">Get mailing event subscribe record.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_mailing_event_subscribe_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_mailing_event_subscribe_create">
civicrm_api3_mailing_event_subscribe_create()
<a href="namespaces/default.html#function_civicrm_api3_mailing_event_subscribe_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MailingEventSubscribe.php"><a href="files/api-v3-mailingeventsubscribe.html"><abbr title="api/v3/MailingEventSubscribe.php">MailingEventSubscribe.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">40</span>
</aside>
<p class="phpdocumentor-summary">Subscribe from mailing group.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_mailing_event_subscribe_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields metadata.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_mailing_event_subscribe_create#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>api result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_mailing_event_subscribe_create_spec">
_civicrm_api3_mailing_event_subscribe_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_mailing_event_subscribe_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MailingEventSubscribe.php"><a href="files/api-v3-mailingeventsubscribe.html"><abbr title="api/v3/MailingEventSubscribe.php">MailingEventSubscribe.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">81</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_mailing_event_subscribe_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_mailing_event_unsubscribe_get">
civicrm_api3_mailing_event_unsubscribe_get()
<a href="namespaces/default.html#function_civicrm_api3_mailing_event_unsubscribe_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MailingEventUnsubscribe.php"><a href="files/api-v3-mailingeventunsubscribe.html"><abbr title="api/v3/MailingEventUnsubscribe.php">MailingEventUnsubscribe.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">26</span>
</aside>
<p class="phpdocumentor-summary">Get mailing event unsubscribe record.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_mailing_event_unsubscribe_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_mailing_event_unsubscribe_create">
civicrm_api3_mailing_event_unsubscribe_create()
<a href="namespaces/default.html#function_civicrm_api3_mailing_event_unsubscribe_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MailingEventUnsubscribe.php"><a href="files/api-v3-mailingeventunsubscribe.html"><abbr title="api/v3/MailingEventUnsubscribe.php">MailingEventUnsubscribe.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">39</span>
</aside>
<p class="phpdocumentor-summary">Unsubscribe from mailing group.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_mailing_event_unsubscribe_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields metadata.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Api result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_mailing_event_unsubscribe_create_spec">
_civicrm_api3_mailing_event_unsubscribe_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_mailing_event_unsubscribe_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MailingEventUnsubscribe.php"><a href="files/api-v3-mailingeventunsubscribe.html"><abbr title="api/v3/MailingEventUnsubscribe.php">MailingEventUnsubscribe.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">72</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_mailing_event_unsubscribe_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - -deprecated">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_mailing_group_deprecation">
_civicrm_api3_mailing_group_deprecation()
<a href="namespaces/default.html#function__civicrm_api3_mailing_group_deprecation" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MailingGroup.php"><a href="files/api-v3-mailinggroup.html"><abbr title="api/v3/MailingGroup.php">MailingGroup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">26</span>
</aside>
<p class="phpdocumentor-summary">Declare deprecated functions.</p>
<div class="phpdocumentor-admonition">
<svg class="phpdocumentor-admonition__icon" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-3L13.732 4c-.77-1.333-2.694-1.333-3.464 0L3.34 16c-.77 1.333.192 3 1.732 3z"></path></svg>
<article>
<p>api notice</p>
</article>
</div>
<code class="phpdocumentor-code phpdocumentor-signature -deprecated">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_mailing_group_deprecation</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
—
<section class="phpdocumentor-description"><p>to indicate this entire api entity is deprecated</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - -deprecated">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_mailing_group_event_unsubscribe">
civicrm_api3_mailing_group_event_unsubscribe()
<a href="namespaces/default.html#function_civicrm_api3_mailing_group_event_unsubscribe" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MailingGroup.php"><a href="files/api-v3-mailinggroup.html"><abbr title="api/v3/MailingGroup.php">MailingGroup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">45</span>
</aside>
<p class="phpdocumentor-summary">Handle an unsubscribe event.</p>
<div class="phpdocumentor-admonition">
<svg class="phpdocumentor-admonition__icon" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-3L13.732 4c-.77-1.333-2.694-1.333-3.464 0L3.34 16c-.77 1.333.192 3 1.732 3z"></path></svg>
<article>
</article>
</div>
<code class="phpdocumentor-code phpdocumentor-signature -deprecated">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_mailing_group_event_unsubscribe</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - -deprecated">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_mailing_group_event_domain_unsubscribe">
civicrm_api3_mailing_group_event_domain_unsubscribe()
<a href="namespaces/default.html#function_civicrm_api3_mailing_group_event_domain_unsubscribe" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MailingGroup.php"><a href="files/api-v3-mailinggroup.html"><abbr title="api/v3/MailingGroup.php">MailingGroup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">58</span>
</aside>
<p class="phpdocumentor-summary">Handle a site-level unsubscribe event.</p>
<div class="phpdocumentor-admonition">
<svg class="phpdocumentor-admonition__icon" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-3L13.732 4c-.77-1.333-2.694-1.333-3.464 0L3.34 16c-.77 1.333.192 3 1.732 3z"></path></svg>
<article>
</article>
</div>
<code class="phpdocumentor-code phpdocumentor-signature -deprecated">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_mailing_group_event_domain_unsubscribe</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - -deprecated">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_mailing_group_event_resubscribe">
civicrm_api3_mailing_group_event_resubscribe()
<a href="namespaces/default.html#function_civicrm_api3_mailing_group_event_resubscribe" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MailingGroup.php"><a href="files/api-v3-mailinggroup.html"><abbr title="api/v3/MailingGroup.php">MailingGroup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">72</span>
</aside>
<p class="phpdocumentor-summary">Handle a re-subscription event.</p>
<div class="phpdocumentor-admonition">
<svg class="phpdocumentor-admonition__icon" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-3L13.732 4c-.77-1.333-2.694-1.333-3.464 0L3.34 16c-.77 1.333.192 3 1.732 3z"></path></svg>
<article>
</article>
</div>
<code class="phpdocumentor-code phpdocumentor-signature -deprecated">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_mailing_group_event_resubscribe</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - -deprecated">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_mailing_group_event_subscribe">
civicrm_api3_mailing_group_event_subscribe()
<a href="namespaces/default.html#function_civicrm_api3_mailing_group_event_subscribe" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MailingGroup.php"><a href="files/api-v3-mailinggroup.html"><abbr title="api/v3/MailingGroup.php">MailingGroup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">85</span>
</aside>
<p class="phpdocumentor-summary">Handle a subscription event.</p>
<div class="phpdocumentor-admonition">
<svg class="phpdocumentor-admonition__icon" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-3L13.732 4c-.77-1.333-2.694-1.333-3.464 0L3.34 16c-.77 1.333.192 3 1.732 3z"></path></svg>
<article>
</article>
</div>
<code class="phpdocumentor-code phpdocumentor-signature -deprecated">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_mailing_group_event_subscribe</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_mailing_group_create">
civicrm_api3_mailing_group_create()
<a href="namespaces/default.html#function_civicrm_api3_mailing_group_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MailingGroup.php"><a href="files/api-v3-mailinggroup.html"><abbr title="api/v3/MailingGroup.php">MailingGroup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">97</span>
</aside>
<p class="phpdocumentor-summary">Create mailing group.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_mailing_group_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_mailing_group_create#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_mailing_group_get">
civicrm_api3_mailing_group_get()
<a href="namespaces/default.html#function_civicrm_api3_mailing_group_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MailingGroup.php"><a href="files/api-v3-mailinggroup.html"><abbr title="api/v3/MailingGroup.php">MailingGroup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">108</span>
</aside>
<p class="phpdocumentor-summary">Get mailing group.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_mailing_group_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_mailing_group_delete">
civicrm_api3_mailing_group_delete()
<a href="namespaces/default.html#function_civicrm_api3_mailing_group_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MailingGroup.php"><a href="files/api-v3-mailinggroup.html"><abbr title="api/v3/MailingGroup.php">MailingGroup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">120</span>
</aside>
<p class="phpdocumentor-summary">Delete mailing group.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_mailing_group_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_mailing_group_delete#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_mailing_job_create">
civicrm_api3_mailing_job_create()
<a href="namespaces/default.html#function_civicrm_api3_mailing_job_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MailingJob.php"><a href="files/api-v3-mailingjob.html"><abbr title="api/v3/MailingJob.php">MailingJob.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">27</span>
</aside>
<p class="phpdocumentor-summary">Handle creation of a MailingJob for a Mailing.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_mailing_job_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_mailing_job_create#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_mailing_job_create_spec">
_civicrm_api3_mailing_job_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_mailing_job_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MailingJob.php"><a href="files/api-v3-mailingjob.html"><abbr title="api/v3/MailingJob.php">MailingJob.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">45</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_mailing_job_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_mailing_job_get">
civicrm_api3_mailing_job_get()
<a href="namespaces/default.html#function_civicrm_api3_mailing_job_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MailingJob.php"><a href="files/api-v3-mailingjob.html"><abbr title="api/v3/MailingJob.php">MailingJob.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">59</span>
</aside>
<p class="phpdocumentor-summary">Returns array of Mailing Jobs matching a set of one or more group properties.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_mailing_job_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API return Array of matching mailing jobs.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_mailing_job_delete">
civicrm_api3_mailing_job_delete()
<a href="namespaces/default.html#function_civicrm_api3_mailing_job_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MailingJob.php"><a href="files/api-v3-mailingjob.html"><abbr title="api/v3/MailingJob.php">MailingJob.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">71</span>
</aside>
<p class="phpdocumentor-summary">Handle deletion of a Mailing Job for a Mailing.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_mailing_job_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_mailing_job_delete#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_mailing_recipients_get">
civicrm_api3_mailing_recipients_get()
<a href="namespaces/default.html#function_civicrm_api3_mailing_recipients_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MailingRecipients.php"><a href="files/api-v3-mailingrecipients.html"><abbr title="api/v3/MailingRecipients.php">MailingRecipients.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">27</span>
</aside>
<p class="phpdocumentor-summary">Returns array of MailingRecipients.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_mailing_recipients_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields metadata.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API return Array of matching mailing jobs</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_mail_settings_create">
civicrm_api3_mail_settings_create()
<a href="namespaces/default.html#function_civicrm_api3_mail_settings_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MailSettings.php"><a href="files/api-v3-mailsettings.html"><abbr title="api/v3/MailSettings.php">MailSettings.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">27</span>
</aside>
<p class="phpdocumentor-summary">Create or update a MailSettings.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_mail_settings_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>name/value pairs to insert in new 'MailSettings'</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_mail_settings_create_spec">
_civicrm_api3_mail_settings_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_mail_settings_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MailSettings.php"><a href="files/api-v3-mailsettings.html"><abbr title="api/v3/MailSettings.php">MailSettings.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">39</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_mail_settings_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_mail_settings_get">
civicrm_api3_mail_settings_get()
<a href="namespaces/default.html#function_civicrm_api3_mail_settings_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MailSettings.php"><a href="files/api-v3-mailsettings.html"><abbr title="api/v3/MailSettings.php">MailSettings.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">52</span>
</aside>
<p class="phpdocumentor-summary">Returns array of MailSettings matching a set of one or more properties.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_mail_settings_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of one or more property_name=>value pairs.
If $params is set as null, all MailSettings will be returned.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_mail_settings_delete">
civicrm_api3_mail_settings_delete()
<a href="namespaces/default.html#function_civicrm_api3_mail_settings_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MailSettings.php"><a href="files/api-v3-mailsettings.html"><abbr title="api/v3/MailSettings.php">MailSettings.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">65</span>
</aside>
<p class="phpdocumentor-summary">Delete an existing MailSettings.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_mail_settings_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>[id]</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_mapping_create">
civicrm_api3_mapping_create()
<a href="namespaces/default.html#function_civicrm_api3_mapping_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Mapping.php"><a href="files/api-v3-mapping.html"><abbr title="api/v3/Mapping.php">Mapping.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">26</span>
</aside>
<p class="phpdocumentor-summary">Add a Mapping.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_mapping_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_mapping_create_spec">
_civicrm_api3_mapping_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_mapping_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Mapping.php"><a href="files/api-v3-mapping.html"><abbr title="api/v3/Mapping.php">Mapping.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">38</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_mapping_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$spec</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$spec</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_mapping_delete">
civicrm_api3_mapping_delete()
<a href="namespaces/default.html#function_civicrm_api3_mapping_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Mapping.php"><a href="files/api-v3-mapping.html"><abbr title="api/v3/Mapping.php">Mapping.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">50</span>
</aside>
<p class="phpdocumentor-summary">Deletes an existing Mapping.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_mapping_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result Array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_mapping_get">
civicrm_api3_mapping_get()
<a href="namespaces/default.html#function_civicrm_api3_mapping_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Mapping.php"><a href="files/api-v3-mapping.html"><abbr title="api/v3/Mapping.php">Mapping.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">63</span>
</aside>
<p class="phpdocumentor-summary">Retrieve one or more Mappings.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_mapping_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>An associative array of name/value pairs.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>details of found Mappings</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_mapping_field_create">
civicrm_api3_mapping_field_create()
<a href="namespaces/default.html#function_civicrm_api3_mapping_field_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MappingField.php"><a href="files/api-v3-mappingfield.html"><abbr title="api/v3/MappingField.php">MappingField.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">26</span>
</aside>
<p class="phpdocumentor-summary">Add a Mapping Field.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_mapping_field_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_mapping_field_create_spec">
_civicrm_api3_mapping_field_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_mapping_field_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MappingField.php"><a href="files/api-v3-mappingfield.html"><abbr title="api/v3/MappingField.php">MappingField.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">38</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_mapping_field_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_mapping_field_delete">
civicrm_api3_mapping_field_delete()
<a href="namespaces/default.html#function_civicrm_api3_mapping_field_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MappingField.php"><a href="files/api-v3-mappingfield.html"><abbr title="api/v3/MappingField.php">MappingField.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">50</span>
</aside>
<p class="phpdocumentor-summary">Deletes an existing Mapping Field.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_mapping_field_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result Array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_mapping_field_get">
civicrm_api3_mapping_field_get()
<a href="namespaces/default.html#function_civicrm_api3_mapping_field_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MappingField.php"><a href="files/api-v3-mappingfield.html"><abbr title="api/v3/MappingField.php">MappingField.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">63</span>
</aside>
<p class="phpdocumentor-summary">Retrieve one or more Mapping Fields.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_mapping_field_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>An associative array of name/value pairs.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>details of found Mapping Fields</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_membership_delete_spec">
_civicrm_api3_membership_delete_spec()
<a href="namespaces/default.html#function__civicrm_api3_membership_delete_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Membership.php"><a href="files/api-v3-membership.html"><abbr title="api/v3/Membership.php">Membership.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">27</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Delete action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_membership_delete_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_membership_delete">
civicrm_api3_membership_delete()
<a href="namespaces/default.html#function_civicrm_api3_membership_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Membership.php"><a href="files/api-v3-membership.html"><abbr title="api/v3/Membership.php">Membership.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">44</span>
</aside>
<p class="phpdocumentor-summary">Deletes an existing contact Membership.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_membership_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array array holding id - Id of the contact membership to be deleted.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_membership_delete#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_membership_create">
civicrm_api3_membership_create()
<a href="namespaces/default.html#function_civicrm_api3_membership_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Membership.php"><a href="files/api-v3-membership.html"><abbr title="api/v3/Membership.php">Membership.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">72</span>
</aside>
<p class="phpdocumentor-summary">Create a Contact Membership.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_membership_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>This API is used for creating a Membership for a contact.
Required parameters : membership_type_id and status_id.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of name/value property values of civicrm_membership.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_membership_create#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_membership_create_spec">
_civicrm_api3_membership_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_membership_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Membership.php"><a href="files/api-v3-membership.html"><abbr title="api/v3/Membership.php">Membership.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">158</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_membership_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_membership_get_spec">
_civicrm_api3_membership_get_spec()
<a href="namespaces/default.html#function__civicrm_api3_membership_get_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Membership.php"><a href="files/api-v3-membership.html"><abbr title="api/v3/Membership.php">Membership.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">184</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Get action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_membership_get_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_membership_get">
civicrm_api3_membership_get()
<a href="namespaces/default.html#function_civicrm_api3_membership_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Membership.php"><a href="files/api-v3-membership.html"><abbr title="api/v3/Membership.php">Membership.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">207</span>
</aside>
<p class="phpdocumentor-summary">Get contact Membership record.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_membership_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>This api will return the membership records for the contacts
having membership based on the relationship with the direct members.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Key/value pairs for contact_id and some.
options affecting the desired results; has legacy support
for just passing the contact_id itself as the argument</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array of all found membership property values.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_membership_relationsship_get_customv2behaviour">
_civicrm_api3_membership_relationsship_get_customv2behaviour()
<a href="namespaces/default.html#function__civicrm_api3_membership_relationsship_get_customv2behaviour" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Membership.php"><a href="files/api-v3-membership.html"><abbr title="api/v3/Membership.php">Membership.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">251</span>
</aside>
<p class="phpdocumentor-summary">Non-standard behaviour inherited from v2.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_membership_relationsship_get_customv2behaviour</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$membershipValues</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$contactID</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Parameters passed into get function.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$membershipValues</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$contactID</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>result for calling function</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_membership_block_create">
civicrm_api3_membership_block_create()
<a href="namespaces/default.html#function_civicrm_api3_membership_block_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MembershipBlock.php"><a href="files/api-v3-membershipblock.html"><abbr title="api/v3/MembershipBlock.php">MembershipBlock.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">27</span>
</aside>
<p class="phpdocumentor-summary">API to Create or update a MembershipBlock.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_membership_block_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>An associative array of name/value property values of MembershipBlock.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_membership_block_create_spec">
_civicrm_api3_membership_block_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_membership_block_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MembershipBlock.php"><a href="files/api-v3-membershipblock.html"><abbr title="api/v3/MembershipBlock.php">MembershipBlock.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">39</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_membership_block_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_membership_block_get">
civicrm_api3_membership_block_get()
<a href="namespaces/default.html#function_civicrm_api3_membership_block_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MembershipBlock.php"><a href="files/api-v3-membershipblock.html"><abbr title="api/v3/MembershipBlock.php">MembershipBlock.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">57</span>
</aside>
<p class="phpdocumentor-summary">Get a Membership Block.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_membership_block_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>This api is used for finding an existing membership block.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>An associative array of name/value property values of civicrm_membership_block.
{getfields MembershipBlock_get}</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_membership_block_delete">
civicrm_api3_membership_block_delete()
<a href="namespaces/default.html#function_civicrm_api3_membership_block_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MembershipBlock.php"><a href="files/api-v3-membershipblock.html"><abbr title="api/v3/MembershipBlock.php">MembershipBlock.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">72</span>
</aside>
<p class="phpdocumentor-summary">Deletes an existing membership block.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_membership_block_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>This API is used for deleting a membership block
Required parameters : id of a membership block</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_membership_log_create">
civicrm_api3_membership_log_create()
<a href="namespaces/default.html#function_civicrm_api3_membership_log_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MembershipLog.php"><a href="files/api-v3-membershiplog.html"><abbr title="api/v3/MembershipLog.php">MembershipLog.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">27</span>
</aside>
<p class="phpdocumentor-summary">API to Create or update a MembershipLog.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_membership_log_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Values of MembershipLog.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_membership_log_create_spec">
_civicrm_api3_membership_log_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_membership_log_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MembershipLog.php"><a href="files/api-v3-membershiplog.html"><abbr title="api/v3/MembershipLog.php">MembershipLog.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">39</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_membership_log_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_membership_log_get">
civicrm_api3_membership_log_get()
<a href="namespaces/default.html#function_civicrm_api3_membership_log_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MembershipLog.php"><a href="files/api-v3-membershiplog.html"><abbr title="api/v3/MembershipLog.php">MembershipLog.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">55</span>
</aside>
<p class="phpdocumentor-summary">Get a Membership Log.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_membership_log_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>This api is used for finding an existing membership log.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>An associative array of name/value property values of civicrm_membership_log.
{getfields MembershipLog_get}</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_membership_log_delete">
civicrm_api3_membership_log_delete()
<a href="namespaces/default.html#function_civicrm_api3_membership_log_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MembershipLog.php"><a href="files/api-v3-membershiplog.html"><abbr title="api/v3/MembershipLog.php">MembershipLog.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">70</span>
</aside>
<p class="phpdocumentor-summary">Deletes an existing membership log.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_membership_log_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>This API is used for deleting a membership log
Required parameters : id of a membership log</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_membership_payment_create">
civicrm_api3_membership_payment_create()
<a href="namespaces/default.html#function_civicrm_api3_membership_payment_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MembershipPayment.php"><a href="files/api-v3-membershippayment.html"><abbr title="api/v3/MembershipPayment.php">MembershipPayment.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">28</span>
</aside>
<p class="phpdocumentor-summary">Add or update a link between contribution and membership.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_membership_payment_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Input parameters.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_membership_payment_create_spec">
_civicrm_api3_membership_payment_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_membership_payment_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MembershipPayment.php"><a href="files/api-v3-membershippayment.html"><abbr title="api/v3/MembershipPayment.php">MembershipPayment.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">40</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_membership_payment_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_membership_payment_get">
civicrm_api3_membership_payment_get()
<a href="namespaces/default.html#function_civicrm_api3_membership_payment_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MembershipPayment.php"><a href="files/api-v3-membershippayment.html"><abbr title="api/v3/MembershipPayment.php">MembershipPayment.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">59</span>
</aside>
<p class="phpdocumentor-summary">Retrieve one or more membership payment records.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_membership_payment_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Input parameters.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_membership_status_create">
civicrm_api3_membership_status_create()
<a href="namespaces/default.html#function_civicrm_api3_membership_status_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MembershipStatus.php"><a href="files/api-v3-membershipstatus.html"><abbr title="api/v3/MembershipStatus.php">MembershipStatus.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">26</span>
</aside>
<p class="phpdocumentor-summary">Create a Membership Status.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_membership_status_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of name/value property values of civicrm_membership_status.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_membership_status_create_spec">
_civicrm_api3_membership_status_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_membership_status_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MembershipStatus.php"><a href="files/api-v3-membershipstatus.html"><abbr title="api/v3/MembershipStatus.php">MembershipStatus.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">38</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_membership_status_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_membership_status_get">
civicrm_api3_membership_status_get()
<a href="namespaces/default.html#function_civicrm_api3_membership_status_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MembershipStatus.php"><a href="files/api-v3-membershipstatus.html"><abbr title="api/v3/MembershipStatus.php">MembershipStatus.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">53</span>
</aside>
<p class="phpdocumentor-summary">Get a membership status.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_membership_status_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>This api is used for finding an existing membership status.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>An associative array of name/value property values of civicrm_membership_status.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array of all found membership status property values.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - -deprecated">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_membership_status_update">
civicrm_api3_membership_status_update()
<a href="namespaces/default.html#function_civicrm_api3_membership_status_update" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MembershipStatus.php"><a href="files/api-v3-membershipstatus.html"><abbr title="api/v3/MembershipStatus.php">MembershipStatus.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">71</span>
</aside>
<p class="phpdocumentor-summary">Update an existing membership status.</p>
<div class="phpdocumentor-admonition">
<svg class="phpdocumentor-admonition__icon" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-3L13.732 4c-.77-1.333-2.694-1.333-3.464 0L3.34 16c-.77 1.333.192 3 1.732 3z"></path></svg>
<article>
<ul>
<li>should just use create</li>
</ul>
</article>
</div>
<code class="phpdocumentor-code phpdocumentor-signature -deprecated">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_membership_status_update</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>This api is used for updating an existing membership status.
Required parameters: id of a membership status</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of name/value property values of civicrm_membership_status.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array of updated membership status property values</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_membership_status_delete">
civicrm_api3_membership_status_delete()
<a href="namespaces/default.html#function_civicrm_api3_membership_status_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MembershipStatus.php"><a href="files/api-v3-membershipstatus.html"><abbr title="api/v3/MembershipStatus.php">MembershipStatus.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">113</span>
</aside>
<p class="phpdocumentor-summary">Deletes an existing membership status.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_membership_status_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>This API is used for deleting a membership status</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_membership_status_delete#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">noinspection</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>PhpUnused</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_membership_status_calc">
civicrm_api3_membership_status_calc()
<a href="namespaces/default.html#function_civicrm_api3_membership_status_calc" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MembershipStatus.php"><a href="files/api-v3-membershipstatus.html"><abbr title="api/v3/MembershipStatus.php">MembershipStatus.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">131</span>
</aside>
<p class="phpdocumentor-summary">Derives the Membership Status of a given Membership Record.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_membership_status_calc</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$membershipParams</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>This API is used for deriving Membership Status of a given Membership
record using the rules encoded in the membership_status table.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$membershipParams</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_membership_status_calc#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array of status id and status name</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_membership_status_calc_spec">
_civicrm_api3_membership_status_calc_spec()
<a href="namespaces/default.html#function__civicrm_api3_membership_status_calc_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MembershipStatus.php"><a href="files/api-v3-membershipstatus.html"><abbr title="api/v3/MembershipStatus.php">MembershipStatus.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">171</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Calc action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_membership_status_calc_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_membership_type_create">
civicrm_api3_membership_type_create()
<a href="namespaces/default.html#function_civicrm_api3_membership_type_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MembershipType.php"><a href="files/api-v3-membershiptype.html"><abbr title="api/v3/MembershipType.php">MembershipType.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">27</span>
</aside>
<p class="phpdocumentor-summary">API to Create or update a Membership Type.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_membership_type_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of name/value property values of civicrm_membership_type.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_membership_type_create_spec">
_civicrm_api3_membership_type_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_membership_type_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MembershipType.php"><a href="files/api-v3-membershiptype.html"><abbr title="api/v3/MembershipType.php">MembershipType.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">45</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_membership_type_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_membership_type_get">
civicrm_api3_membership_type_get()
<a href="namespaces/default.html#function_civicrm_api3_membership_type_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MembershipType.php"><a href="files/api-v3-membershiptype.html"><abbr title="api/v3/MembershipType.php">MembershipType.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">67</span>
</aside>
<p class="phpdocumentor-summary">Get a Membership Type.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_membership_type_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>This api is used for finding an existing membership type.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of name/value property values of civicrm_membership_type.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_membership_type_get_spec">
_civicrm_api3_membership_type_get_spec()
<a href="namespaces/default.html#function__civicrm_api3_membership_type_get_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MembershipType.php"><a href="files/api-v3-membershiptype.html"><abbr title="api/v3/MembershipType.php">MembershipType.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">91</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Get action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_membership_type_get_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_membership_type_getlist_params">
_civicrm_api3_membership_type_getlist_params()
<a href="namespaces/default.html#function__civicrm_api3_membership_type_getlist_params" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MembershipType.php"><a href="files/api-v3-membershiptype.html"><abbr title="api/v3/MembershipType.php">MembershipType.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">108</span>
</aside>
<p class="phpdocumentor-summary">Adjust input for getlist action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_membership_type_getlist_params</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$request</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>We want to only return active membership types for getlist. It's a bit
arguable whether this should be applied at the 'get' level but, since it's hard
to unset we'll just do it here.</p>
<p>The usage of getlist is entity-reference fields & the like
so using only active ones makes sense.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$request</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_membership_type_delete">
civicrm_api3_membership_type_delete()
<a href="namespaces/default.html#function_civicrm_api3_membership_type_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MembershipType.php"><a href="files/api-v3-membershiptype.html"><abbr title="api/v3/MembershipType.php">MembershipType.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">123</span>
</aside>
<p class="phpdocumentor-summary">Deletes an existing membership type.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_membership_type_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_message_template_create">
civicrm_api3_message_template_create()
<a href="namespaces/default.html#function_civicrm_api3_message_template_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MessageTemplate.php"><a href="files/api-v3-messagetemplate.html"><abbr title="api/v3/MessageTemplate.php">MessageTemplate.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">26</span>
</aside>
<p class="phpdocumentor-summary">Create message template.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_message_template_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_message_template_create#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_message_template_create_spec">
_civicrm_api3_message_template_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_message_template_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MessageTemplate.php"><a href="files/api-v3-messagetemplate.html"><abbr title="api/v3/MessageTemplate.php">MessageTemplate.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">38</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_message_template_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_message_template_delete">
civicrm_api3_message_template_delete()
<a href="namespaces/default.html#function_civicrm_api3_message_template_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MessageTemplate.php"><a href="files/api-v3-messagetemplate.html"><abbr title="api/v3/MessageTemplate.php">MessageTemplate.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">55</span>
</aside>
<p class="phpdocumentor-summary">Delete message template.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_message_template_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_message_template_get_spec">
_civicrm_api3_message_template_get_spec()
<a href="namespaces/default.html#function__civicrm_api3_message_template_get_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MessageTemplate.php"><a href="files/api-v3-messagetemplate.html"><abbr title="api/v3/MessageTemplate.php">MessageTemplate.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">64</span>
</aside>
<p class="phpdocumentor-summary">Adjust metadata for message_template get action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_message_template_get_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_message_template_get">
civicrm_api3_message_template_get()
<a href="namespaces/default.html#function_civicrm_api3_message_template_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MessageTemplate.php"><a href="files/api-v3-messagetemplate.html"><abbr title="api/v3/MessageTemplate.php">MessageTemplate.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">78</span>
</aside>
<p class="phpdocumentor-summary">Retrieve one or more message_template.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_message_template_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of name/value pairs.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_message_template_send">
civicrm_api3_message_template_send()
<a href="namespaces/default.html#function_civicrm_api3_message_template_send" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MessageTemplate.php"><a href="files/api-v3-messagetemplate.html"><abbr title="api/v3/MessageTemplate.php">MessageTemplate.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">90</span>
</aside>
<p class="phpdocumentor-summary">Sends a template.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_message_template_send</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_message_template_send#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_message_template_send_spec">
_civicrm_api3_message_template_send_spec()
<a href="namespaces/default.html#function__civicrm_api3_message_template_send_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/MessageTemplate.php"><a href="files/api-v3-messagetemplate.html"><abbr title="api/v3/MessageTemplate.php">MessageTemplate.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">135</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_message_template_send_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation &
validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_navigation_reset_spec">
_civicrm_api3_navigation_reset_spec()
<a href="namespaces/default.html#function__civicrm_api3_navigation_reset_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Navigation.php"><a href="files/api-v3-navigation.html"><abbr title="api/v3/Navigation.php">Navigation.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">23</span>
</aside>
<p class="phpdocumentor-summary">Adjust metadata for navigation reset action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_navigation_reset_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_navigation_reset">
civicrm_api3_navigation_reset()
<a href="namespaces/default.html#function_civicrm_api3_navigation_reset" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Navigation.php"><a href="files/api-v3-navigation.html"><abbr title="api/v3/Navigation.php">Navigation.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">45</span>
</aside>
<p class="phpdocumentor-summary">Reset navigation.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_navigation_reset</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of name/value pairs.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_navigation_get_spec">
_civicrm_api3_navigation_get_spec()
<a href="namespaces/default.html#function__civicrm_api3_navigation_get_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Navigation.php"><a href="files/api-v3-navigation.html"><abbr title="api/v3/Navigation.php">Navigation.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">58</span>
</aside>
<p class="phpdocumentor-summary">Adjust metadata for navigation get action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_navigation_get_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_navigation_get">
civicrm_api3_navigation_get()
<a href="namespaces/default.html#function_civicrm_api3_navigation_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Navigation.php"><a href="files/api-v3-navigation.html"><abbr title="api/v3/Navigation.php">Navigation.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">70</span>
</aside>
<p class="phpdocumentor-summary">Reset navigation.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_navigation_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of name/value pairs.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_navigation_create">
civicrm_api3_navigation_create()
<a href="namespaces/default.html#function_civicrm_api3_navigation_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Navigation.php"><a href="files/api-v3-navigation.html"><abbr title="api/v3/Navigation.php">Navigation.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">83</span>
</aside>
<p class="phpdocumentor-summary">Create navigation item.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_navigation_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of name/value pairs.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_navigation_create_spec">
_civicrm_api3_navigation_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_navigation_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Navigation.php"><a href="files/api-v3-navigation.html"><abbr title="api/v3/Navigation.php">Navigation.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">93</span>
</aside>
<p class="phpdocumentor-summary">Adjust metadata for navigation create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_navigation_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, array<string|int, mixed>> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$fields</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fields</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, array<string|int, mixed>></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_navigation_delete">
civicrm_api3_navigation_delete()
<a href="namespaces/default.html#function_civicrm_api3_navigation_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Navigation.php"><a href="files/api-v3-navigation.html"><abbr title="api/v3/Navigation.php">Navigation.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">107</span>
</aside>
<p class="phpdocumentor-summary">Delete navigation item.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_navigation_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of name/value pairs.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_note_create">
civicrm_api3_note_create()
<a href="namespaces/default.html#function_civicrm_api3_note_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Note.php"><a href="files/api-v3-note.html"><abbr title="api/v3/Note.php">Note.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">30</span>
</aside>
<p class="phpdocumentor-summary">Create Note.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_note_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>This API is used for creating a note.
Required parameters : entity_id AND note</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>An associative array of name/value property values of civicrm_note.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_note_create_spec">
_civicrm_api3_note_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_note_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Note.php"><a href="files/api-v3-note.html"><abbr title="api/v3/Note.php">Note.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">42</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_note_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_note_delete">
civicrm_api3_note_delete()
<a href="namespaces/default.html#function_civicrm_api3_note_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Note.php"><a href="files/api-v3-note.html"><abbr title="api/v3/Note.php">Note.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">59</span>
</aside>
<p class="phpdocumentor-summary">Deletes an existing note.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_note_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>This API is used for deleting a note</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Including id of the note to be deleted.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_note_get">
civicrm_api3_note_get()
<a href="namespaces/default.html#function_civicrm_api3_note_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Note.php"><a href="files/api-v3-note.html"><abbr title="api/v3/Note.php">Note.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">74</span>
</aside>
<p class="phpdocumentor-summary">Retrieve a specific note or notes, given a set of input params.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_note_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Input parameters.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>array of properties,
if error an array with an error id and error message</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_note_get_spec">
_civicrm_api3_note_get_spec()
<a href="namespaces/default.html#function__civicrm_api3_note_get_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Note.php"><a href="files/api-v3-note.html"><abbr title="api/v3/Note.php">Note.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">86</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Get action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_note_get_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - -deprecated">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_note_tree_get">
civicrm_api3_note_tree_get()
<a href="namespaces/default.html#function_civicrm_api3_note_tree_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Note.php"><a href="files/api-v3-note.html"><abbr title="api/v3/Note.php">Note.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">99</span>
</aside>
<p class="phpdocumentor-summary">Get all descendants of given note.</p>
<div class="phpdocumentor-admonition">
<svg class="phpdocumentor-admonition__icon" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-3L13.732 4c-.77-1.333-2.694-1.333-3.464 0L3.34 16c-.77 1.333.192 3 1.732 3z"></path></svg>
<article>
</article>
</div>
<code class="phpdocumentor-code phpdocumentor-signature -deprecated">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_note_tree_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>array; only required 'id' parameter is used.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Nested associative array beginning with direct children of given note.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_note_deprecation">
_civicrm_api3_note_deprecation()
<a href="namespaces/default.html#function__civicrm_api3_note_deprecation" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Note.php"><a href="files/api-v3-note.html"><abbr title="api/v3/Note.php">Note.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">120</span>
</aside>
<p class="phpdocumentor-summary">Declare deprecated api functions.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_note_deprecation</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_open_i_d_create">
civicrm_api3_open_i_d_create()
<a href="namespaces/default.html#function_civicrm_api3_open_i_d_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/OpenID.php"><a href="files/api-v3-openid.html"><abbr title="api/v3/OpenID.php">OpenID.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">26</span>
</aside>
<p class="phpdocumentor-summary">Add an OpenID for a contact.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_open_i_d_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_open_i_d_create_spec">
_civicrm_api3_open_i_d_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_open_i_d_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/OpenID.php"><a href="files/api-v3-openid.html"><abbr title="api/v3/OpenID.php">OpenID.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">38</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_open_i_d_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_open_i_d_delete">
civicrm_api3_open_i_d_delete()
<a href="namespaces/default.html#function_civicrm_api3_open_i_d_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/OpenID.php"><a href="files/api-v3-openid.html"><abbr title="api/v3/OpenID.php">OpenID.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">54</span>
</aside>
<p class="phpdocumentor-summary">Deletes an existing OpenID.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_open_i_d_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_open_i_d_get">
civicrm_api3_open_i_d_get()
<a href="namespaces/default.html#function_civicrm_api3_open_i_d_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/OpenID.php"><a href="files/api-v3-openid.html"><abbr title="api/v3/OpenID.php">OpenID.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">67</span>
</aside>
<p class="phpdocumentor-summary">Retrieve one or more OpenID.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_open_i_d_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>An associative array of name/value pairs.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_option_group_get">
civicrm_api3_option_group_get()
<a href="namespaces/default.html#function_civicrm_api3_option_group_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/OptionGroup.php"><a href="files/api-v3-optiongroup.html"><abbr title="api/v3/OptionGroup.php">OptionGroup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">27</span>
</aside>
<p class="phpdocumentor-summary">Get option groups.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_option_group_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_option_group_create">
civicrm_api3_option_group_create()
<a href="namespaces/default.html#function_civicrm_api3_option_group_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/OptionGroup.php"><a href="files/api-v3-optiongroup.html"><abbr title="api/v3/OptionGroup.php">OptionGroup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">39</span>
</aside>
<p class="phpdocumentor-summary">Create/update option group.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_option_group_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields metadata.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_option_group_create_spec">
_civicrm_api3_option_group_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_option_group_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/OptionGroup.php"><a href="files/api-v3-optiongroup.html"><abbr title="api/v3/OptionGroup.php">OptionGroup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">56</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_option_group_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_option_group_delete">
civicrm_api3_option_group_delete()
<a href="namespaces/default.html#function_civicrm_api3_option_group_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/OptionGroup.php"><a href="files/api-v3-optiongroup.html"><abbr title="api/v3/OptionGroup.php">OptionGroup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">72</span>
</aside>
<p class="phpdocumentor-summary">Delete an existing Option Group.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_option_group_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>This method is used to delete any existing OptionGroup given its id.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>[id]</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API Result Array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_option_value_get">
civicrm_api3_option_value_get()
<a href="namespaces/default.html#function_civicrm_api3_option_value_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/OptionValue.php"><a href="files/api-v3-optionvalue.html"><abbr title="api/v3/OptionValue.php">OptionValue.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">28</span>
</aside>
<p class="phpdocumentor-summary">Retrieve one or more option values.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_option_value_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_option_value_get_spec">
_civicrm_api3_option_value_get_spec()
<a href="namespaces/default.html#function__civicrm_api3_option_value_get_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/OptionValue.php"><a href="files/api-v3-optionvalue.html"><abbr title="api/v3/OptionValue.php">OptionValue.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">40</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for get action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_option_value_get_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_option_value_create">
civicrm_api3_option_value_create()
<a href="namespaces/default.html#function_civicrm_api3_option_value_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/OptionValue.php"><a href="files/api-v3-optionvalue.html"><abbr title="api/v3/OptionValue.php">OptionValue.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">53</span>
</aside>
<p class="phpdocumentor-summary">Add an OptionValue.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_option_value_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_option_value_create#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_option_value_create_spec">
_civicrm_api3_option_value_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_option_value_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/OptionValue.php"><a href="files/api-v3-optionvalue.html"><abbr title="api/v3/OptionValue.php">OptionValue.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">76</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_option_value_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_option_value_delete">
civicrm_api3_option_value_delete()
<a href="namespaces/default.html#function_civicrm_api3_option_value_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/OptionValue.php"><a href="files/api-v3-optionvalue.html"><abbr title="api/v3/OptionValue.php">OptionValue.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">91</span>
</aside>
<p class="phpdocumentor-summary">Deletes an existing option value.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_option_value_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_option_value_delete#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_order_get">
civicrm_api3_order_get()
<a href="namespaces/default.html#function_civicrm_api3_order_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Order.php"><a href="files/api-v3-order.html"><abbr title="api/v3/Order.php">Order.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">31</span>
</aside>
<p class="phpdocumentor-summary">Retrieve a set of Order.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_order_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Input parameters.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_order_get#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array of Order, if error an array with an error id and error message</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_order_get_spec">
_civicrm_api3_order_get_spec()
<a href="namespaces/default.html#function__civicrm_api3_order_get_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Order.php"><a href="files/api-v3-order.html"><abbr title="api/v3/Order.php">Order.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">59</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Get action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_order_get_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_order_create">
civicrm_api3_order_create()
<a href="namespaces/default.html#function_civicrm_api3_order_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Order.php"><a href="files/api-v3-order.html"><abbr title="api/v3/Order.php">Order.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">76</span>
</aside>
<p class="phpdocumentor-summary">Add or update a Order.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_order_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Input parameters.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_order_create#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Api result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_order_delete">
civicrm_api3_order_delete()
<a href="namespaces/default.html#function_civicrm_api3_order_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Order.php"><a href="files/api-v3-order.html"><abbr title="api/v3/Order.php">Order.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">199</span>
</aside>
<p class="phpdocumentor-summary">Delete a Order.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_order_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Input parameters.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_order_delete#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_order_cancel">
civicrm_api3_order_cancel()
<a href="namespaces/default.html#function_civicrm_api3_order_cancel" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Order.php"><a href="files/api-v3-order.html"><abbr title="api/v3/Order.php">Order.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">222</span>
</aside>
<p class="phpdocumentor-summary">Cancel an Order.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_order_cancel</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Input parameters.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_order_cancel#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_order_cancel_spec">
_civicrm_api3_order_cancel_spec()
<a href="namespaces/default.html#function__civicrm_api3_order_cancel_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Order.php"><a href="files/api-v3-order.html"><abbr title="api/v3/Order.php">Order.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">237</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Cancel action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_order_cancel_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_order_create_spec">
_civicrm_api3_order_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_order_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Order.php"><a href="files/api-v3-order.html"><abbr title="api/v3/Order.php">Order.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">253</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_order_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_order_delete_spec">
_civicrm_api3_order_delete_spec()
<a href="namespaces/default.html#function__civicrm_api3_order_delete_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Order.php"><a href="files/api-v3-order.html"><abbr title="api/v3/Order.php">Order.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">293</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Delete action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_order_delete_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__order_create_wrangle_membership_params">
_order_create_wrangle_membership_params()
<a href="namespaces/default.html#function__order_create_wrangle_membership_params" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Order.php"><a href="files/api-v3-order.html"><abbr title="api/v3/Order.php">Order.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">312</span>
</aside>
<p class="phpdocumentor-summary">Handle possibility of v3 style params.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_order_create_wrangle_membership_params</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$membershipParams</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>We used to call v3 Membership.create. Now we call v4.
This converts membership input parameters.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$membershipParams</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__order_create_wrangle_membership_params#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_participant_create">
civicrm_api3_participant_create()
<a href="namespaces/default.html#function_civicrm_api3_participant_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Participant.php"><a href="files/api-v3-participant.html"><abbr title="api/v3/Participant.php">Participant.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">29</span>
</aside>
<p class="phpdocumentor-summary">Create an Event Participant.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_participant_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>An associative array of name/value property values of civicrm_participant.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_participant_create#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_participant_createlineitem">
_civicrm_api3_participant_createlineitem()
<a href="namespaces/default.html#function__civicrm_api3_participant_createlineitem" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Participant.php"><a href="files/api-v3-participant.html"><abbr title="api/v3/Participant.php">Participant.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">62</span>
</aside>
<p class="phpdocumentor-summary">Create a default participant line item.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_participant_createlineitem</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Event-BAO-Participant.html"><abbr title="\CRM_Event_BAO_Participant">CRM_Event_BAO_Participant</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$participant</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$participant</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Event-BAO-Participant.html"><abbr title="\CRM_Event_BAO_Participant">CRM_Event_BAO_Participant</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_participant_createlineitem#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>this should be done in the BAO not the api</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_participant_create_spec">
_civicrm_api3_participant_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_participant_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Participant.php"><a href="files/api-v3-participant.html"><abbr title="api/v3/Participant.php">Participant.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">125</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_participant_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_participant_get">
civicrm_api3_participant_get()
<a href="namespaces/default.html#function_civicrm_api3_participant_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Participant.php"><a href="files/api-v3-participant.html"><abbr title="api/v3/Participant.php">Participant.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">144</span>
</aside>
<p class="phpdocumentor-summary">Retrieve a specific participant, given a set of input params.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_participant_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>input parameters.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>array of properties, if error an array with an error id and error message</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_participant_get_spec">
_civicrm_api3_participant_get_spec()
<a href="namespaces/default.html#function__civicrm_api3_participant_get_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Participant.php"><a href="files/api-v3-participant.html"><abbr title="api/v3/Participant.php">Participant.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">168</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Get action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_participant_get_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_participant_delete">
civicrm_api3_participant_delete()
<a href="namespaces/default.html#function_civicrm_api3_participant_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Participant.php"><a href="files/api-v3-participant.html"><abbr title="api/v3/Participant.php">Participant.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">187</span>
</aside>
<p class="phpdocumentor-summary">Deletes an existing contact participant.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_participant_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>This API is used for deleting a contact participant</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array containing Id of the contact participant to be deleted.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_participant_delete#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\Exception">Exception</abbr></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_participant_payment_create">
civicrm_api3_participant_payment_create()
<a href="namespaces/default.html#function_civicrm_api3_participant_payment_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/ParticipantPayment.php"><a href="files/api-v3-participantpayment.html"><abbr title="api/v3/ParticipantPayment.php">ParticipantPayment.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">29</span>
</aside>
<p class="phpdocumentor-summary">Create a Event Participant Payment.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_participant_payment_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>This API is used for creating a Participant Payment of Event.
Required parameters: participant_id, contribution_id.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>An associative array of name/value property values of civicrm_participant_payment.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_participant_payment_create_spec">
_civicrm_api3_participant_payment_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_participant_payment_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/ParticipantPayment.php"><a href="files/api-v3-participantpayment.html"><abbr title="api/v3/ParticipantPayment.php">ParticipantPayment.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">41</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_participant_payment_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_participant_payment_delete">
civicrm_api3_participant_payment_delete()
<a href="namespaces/default.html#function_civicrm_api3_participant_payment_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/ParticipantPayment.php"><a href="files/api-v3-participantpayment.html"><abbr title="api/v3/ParticipantPayment.php">ParticipantPayment.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">54</span>
</aside>
<p class="phpdocumentor-summary">Deletes an existing Participant Payment.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_participant_payment_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_participant_payment_get">
civicrm_api3_participant_payment_get()
<a href="namespaces/default.html#function_civicrm_api3_participant_payment_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/ParticipantPayment.php"><a href="files/api-v3-participantpayment.html"><abbr title="api/v3/ParticipantPayment.php">ParticipantPayment.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">68</span>
</aside>
<p class="phpdocumentor-summary">Retrieve one or more participant payment records.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_participant_payment_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Input parameters.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>array of properties, if error an array with an error id and error message</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_participant_status_type_create">
civicrm_api3_participant_status_type_create()
<a href="namespaces/default.html#function_civicrm_api3_participant_status_type_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/ParticipantStatusType.php"><a href="files/api-v3-participantstatustype.html"><abbr title="api/v3/ParticipantStatusType.php">ParticipantStatusType.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">31</span>
</aside>
<p class="phpdocumentor-summary">Create/update participant_status.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_participant_status_type_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>This API is used to create new participant_status or update any of the existing
In case of updating existing participant_status, id of that particular participant_status must
be in $params array.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>name/value pairs to insert in new 'participant_status'</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>participant_status array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_participant_status_type_get">
civicrm_api3_participant_status_type_get()
<a href="namespaces/default.html#function_civicrm_api3_participant_status_type_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/ParticipantStatusType.php"><a href="files/api-v3-participantstatustype.html"><abbr title="api/v3/ParticipantStatusType.php">ParticipantStatusType.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">44</span>
</aside>
<p class="phpdocumentor-summary">Returns array of participant_statuses matching a set of one or more group properties.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_participant_status_type_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of properties. If empty, all records will be returned.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array of matching participant_statuses</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_participant_status_type_delete">
civicrm_api3_participant_status_type_delete()
<a href="namespaces/default.html#function_civicrm_api3_participant_status_type_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/ParticipantStatusType.php"><a href="files/api-v3-participantstatustype.html"><abbr title="api/v3/ParticipantStatusType.php">ParticipantStatusType.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">58</span>
</aside>
<p class="phpdocumentor-summary">Delete an existing participant_status.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_participant_status_type_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>This method is used to delete any existing participant_status given its id.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>[id]</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_participant_status_type_delete#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>api result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_payment_get">
civicrm_api3_payment_get()
<a href="namespaces/default.html#function_civicrm_api3_payment_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Payment.php"><a href="files/api-v3-payment.html"><abbr title="api/v3/Payment.php">Payment.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">29</span>
</aside>
<p class="phpdocumentor-summary">Retrieve a set of financial transactions which are payments.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_payment_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Input parameters.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_payment_get#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array of financial transactions which are payments, if error an array with an error id and error message</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_payment_delete">
civicrm_api3_payment_delete()
<a href="namespaces/default.html#function_civicrm_api3_payment_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Payment.php"><a href="files/api-v3-payment.html"><abbr title="api/v3/Payment.php">Payment.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">76</span>
</aside>
<p class="phpdocumentor-summary">Delete a payment.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_payment_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Input parameters.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_payment_delete#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Api result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_payment_cancel">
civicrm_api3_payment_cancel()
<a href="namespaces/default.html#function_civicrm_api3_payment_cancel" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Payment.php"><a href="files/api-v3-payment.html"><abbr title="api/v3/Payment.php">Payment.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">92</span>
</aside>
<p class="phpdocumentor-summary">Cancel/Refund a payment for a Contribution.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_payment_cancel</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Input parameters.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_payment_cancel#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Api result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_payment_create">
civicrm_api3_payment_create()
<a href="namespaces/default.html#function_civicrm_api3_payment_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Payment.php"><a href="files/api-v3-payment.html"><abbr title="api/v3/Payment.php">Payment.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">128</span>
</aside>
<p class="phpdocumentor-summary">Add a payment for a Contribution.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_payment_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Input parameters.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_payment_create#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Api result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_payment_create_spec">
_civicrm_api3_payment_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_payment_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Payment.php"><a href="files/api-v3-payment.html"><abbr title="api/v3/Payment.php">Payment.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">158</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_payment_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_payment_get_spec">
_civicrm_api3_payment_get_spec()
<a href="namespaces/default.html#function__civicrm_api3_payment_get_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Payment.php"><a href="files/api-v3-payment.html"><abbr title="api/v3/Payment.php">Payment.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">330</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Get action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_payment_get_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_payment_delete_spec">
_civicrm_api3_payment_delete_spec()
<a href="namespaces/default.html#function__civicrm_api3_payment_delete_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Payment.php"><a href="files/api-v3-payment.html"><abbr title="api/v3/Payment.php">Payment.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">372</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Delete action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_payment_delete_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_payment_cancel_spec">
_civicrm_api3_payment_cancel_spec()
<a href="namespaces/default.html#function__civicrm_api3_payment_cancel_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Payment.php"><a href="files/api-v3-payment.html"><abbr title="api/v3/Payment.php">Payment.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">391</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Cancel action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_payment_cancel_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_payment_sendconfirmation">
civicrm_api3_payment_sendconfirmation()
<a href="namespaces/default.html#function_civicrm_api3_payment_sendconfirmation" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Payment.php"><a href="files/api-v3-payment.html"><abbr title="api/v3/Payment.php">Payment.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">415</span>
</aside>
<p class="phpdocumentor-summary">Send a payment confirmation.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_payment_sendconfirmation</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Input parameters.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_payment_sendconfirmation#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\Exception">Exception</abbr></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_payment_sendconfirmation_spec">
_civicrm_api3_payment_sendconfirmation_spec()
<a href="namespaces/default.html#function__civicrm_api3_payment_sendconfirmation_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Payment.php"><a href="files/api-v3-payment.html"><abbr title="api/v3/Payment.php">Payment.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">442</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for sendconfirmation action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_payment_sendconfirmation_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_payment_processor_create">
civicrm_api3_payment_processor_create()
<a href="namespaces/default.html#function_civicrm_api3_payment_processor_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/PaymentProcessor.php"><a href="files/api-v3-paymentprocessor.html"><abbr title="api/v3/PaymentProcessor.php">PaymentProcessor.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">26</span>
</aside>
<p class="phpdocumentor-summary">Add/Update a PaymentProcessor.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_payment_processor_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_payment_processor_create_spec">
_civicrm_api3_payment_processor_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_payment_processor_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/PaymentProcessor.php"><a href="files/api-v3-paymentprocessor.html"><abbr title="api/v3/PaymentProcessor.php">PaymentProcessor.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">38</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_payment_processor_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_payment_processor_delete">
civicrm_api3_payment_processor_delete()
<a href="namespaces/default.html#function_civicrm_api3_payment_processor_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/PaymentProcessor.php"><a href="files/api-v3-paymentprocessor.html"><abbr title="api/v3/PaymentProcessor.php">PaymentProcessor.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">63</span>
</aside>
<p class="phpdocumentor-summary">Deletes an existing PaymentProcessor.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_payment_processor_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_payment_processor_get">
civicrm_api3_payment_processor_get()
<a href="namespaces/default.html#function_civicrm_api3_payment_processor_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/PaymentProcessor.php"><a href="files/api-v3-paymentprocessor.html"><abbr title="api/v3/PaymentProcessor.php">PaymentProcessor.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">76</span>
</aside>
<p class="phpdocumentor-summary">Retrieve one or more PaymentProcessor.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_payment_processor_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of name/value pairs.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_payment_processor_getlist_defaults">
_civicrm_api3_payment_processor_getlist_defaults()
<a href="namespaces/default.html#function__civicrm_api3_payment_processor_getlist_defaults" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/PaymentProcessor.php"><a href="files/api-v3-paymentprocessor.html"><abbr title="api/v3/PaymentProcessor.php">PaymentProcessor.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">89</span>
</aside>
<p class="phpdocumentor-summary">Set default getlist parameters.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_payment_processor_getlist_defaults</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$request</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$request</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_payment_processor_getlist_defaults#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\_civicrm_api3_generic_getlist_defaults">_civicrm_api3_generic_getlist_defaults</abbr></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_payment_processor_pay">
civicrm_api3_payment_processor_pay()
<a href="namespaces/default.html#function_civicrm_api3_payment_processor_pay" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/PaymentProcessor.php"><a href="files/api-v3-paymentprocessor.html"><abbr title="api/v3/PaymentProcessor.php">PaymentProcessor.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">112</span>
</aside>
<p class="phpdocumentor-summary">Action payment.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_payment_processor_pay</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_payment_processor_pay#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_payment_processor_pay_spec">
_civicrm_api3_payment_processor_pay_spec()
<a href="namespaces/default.html#function__civicrm_api3_payment_processor_pay_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/PaymentProcessor.php"><a href="files/api-v3-paymentprocessor.html"><abbr title="api/v3/PaymentProcessor.php">PaymentProcessor.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">135</span>
</aside>
<p class="phpdocumentor-summary">Action payment.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_payment_processor_pay_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_payment_processor_refund">
civicrm_api3_payment_processor_refund()
<a href="namespaces/default.html#function_civicrm_api3_payment_processor_refund" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/PaymentProcessor.php"><a href="files/api-v3-paymentprocessor.html"><abbr title="api/v3/PaymentProcessor.php">PaymentProcessor.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">177</span>
</aside>
<p class="phpdocumentor-summary">Action refund.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_payment_processor_refund</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_payment_processor_refund#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/Civi-Payment-Exception-PaymentProcessorException.html"><abbr title="\Civi\Payment\Exception\PaymentProcessorException">PaymentProcessorException</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_payment_processor_refund_spec">
_civicrm_api3_payment_processor_refund_spec()
<a href="namespaces/default.html#function__civicrm_api3_payment_processor_refund_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/PaymentProcessor.php"><a href="files/api-v3-paymentprocessor.html"><abbr title="api/v3/PaymentProcessor.php">PaymentProcessor.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">194</span>
</aside>
<p class="phpdocumentor-summary">Action Refund.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_payment_processor_refund_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_payment_processor_type_create">
civicrm_api3_payment_processor_type_create()
<a href="namespaces/default.html#function_civicrm_api3_payment_processor_type_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/PaymentProcessorType.php"><a href="files/api-v3-paymentprocessortype.html"><abbr title="api/v3/PaymentProcessorType.php">PaymentProcessorType.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">26</span>
</aside>
<p class="phpdocumentor-summary">Create payment_processor type.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_payment_processor_type_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Associative array of property name/value pairs to insert in new payment_processor type.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_payment_processor_type_create_spec">
_civicrm_api3_payment_processor_type_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_payment_processor_type_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/PaymentProcessorType.php"><a href="files/api-v3-paymentprocessortype.html"><abbr title="api/v3/PaymentProcessorType.php">PaymentProcessorType.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">38</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_payment_processor_type_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_payment_processor_type_get">
civicrm_api3_payment_processor_type_get()
<a href="namespaces/default.html#function_civicrm_api3_payment_processor_type_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/PaymentProcessorType.php"><a href="files/api-v3-paymentprocessortype.html"><abbr title="api/v3/PaymentProcessorType.php">PaymentProcessorType.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">55</span>
</aside>
<p class="phpdocumentor-summary">Get all payment_processor types.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_payment_processor_type_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_payment_processor_type_delete">
civicrm_api3_payment_processor_type_delete()
<a href="namespaces/default.html#function_civicrm_api3_payment_processor_type_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/PaymentProcessorType.php"><a href="files/api-v3-paymentprocessortype.html"><abbr title="api/v3/PaymentProcessorType.php">PaymentProcessorType.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">67</span>
</aside>
<p class="phpdocumentor-summary">Delete a payment_processor type delete.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_payment_processor_type_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API Result Array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_payment_token_create">
civicrm_api3_payment_token_create()
<a href="namespaces/default.html#function_civicrm_api3_payment_token_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/PaymentToken.php"><a href="files/api-v3-paymenttoken.html"><abbr title="api/v3/PaymentToken.php">PaymentToken.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">31</span>
</aside>
<p class="phpdocumentor-summary">Create/update Payment Token.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_payment_token_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>This API is used to create new campaign or update any of the existing
In case of updating existing campaign, id of that particular campaign must
be in $params array.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_payment_token_create_spec">
_civicrm_api3_payment_token_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_payment_token_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/PaymentToken.php"><a href="files/api-v3-paymenttoken.html"><abbr title="api/v3/PaymentToken.php">PaymentToken.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">43</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_payment_token_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_payment_token_get">
civicrm_api3_payment_token_get()
<a href="namespaces/default.html#function_civicrm_api3_payment_token_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/PaymentToken.php"><a href="files/api-v3-paymenttoken.html"><abbr title="api/v3/PaymentToken.php">PaymentToken.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">60</span>
</aside>
<p class="phpdocumentor-summary">Returns array of campaigns matching a set of one or more properties.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_payment_token_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array of matching campaigns</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_payment_token_delete">
civicrm_api3_payment_token_delete()
<a href="namespaces/default.html#function_civicrm_api3_payment_token_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/PaymentToken.php"><a href="files/api-v3-paymenttoken.html"><abbr title="api/v3/PaymentToken.php">PaymentToken.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">75</span>
</aside>
<p class="phpdocumentor-summary">Delete an existing payment token.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_payment_token_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>This method is used to delete any existing payment token.
Id of the payment token to be deleted is required field in $params array</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>array containing id of the group to be deleted</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_pcp_create">
civicrm_api3_pcp_create()
<a href="namespaces/default.html#function_civicrm_api3_pcp_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Pcp.php"><a href="files/api-v3-pcp.html"><abbr title="api/v3/Pcp.php">Pcp.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">28</span>
</aside>
<p class="phpdocumentor-summary">Create or update a survey.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_pcp_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields metadata.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>api result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_pcp_create_spec">
_civicrm_api3_pcp_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_pcp_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Pcp.php"><a href="files/api-v3-pcp.html"><abbr title="api/v3/Pcp.php">Pcp.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">40</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_pcp_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_pcp_get">
civicrm_api3_pcp_get()
<a href="namespaces/default.html#function_civicrm_api3_pcp_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Pcp.php"><a href="files/api-v3-pcp.html"><abbr title="api/v3/Pcp.php">Pcp.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">55</span>
</aside>
<p class="phpdocumentor-summary">Returns array of pcps matching a set of one or more properties.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_pcp_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array of matching pcps</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_pcp_delete">
civicrm_api3_pcp_delete()
<a href="namespaces/default.html#function_civicrm_api3_pcp_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Pcp.php"><a href="files/api-v3-pcp.html"><abbr title="api/v3/Pcp.php">Pcp.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">69</span>
</aside>
<p class="phpdocumentor-summary">Delete an existing PCP.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_pcp_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>This method is used to delete any existing PCP given its id.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>[id]</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>api result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_phone_get">
civicrm_api3_phone_get()
<a href="namespaces/default.html#function_civicrm_api3_phone_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Phone/Get.php"><a href="files/api-v3-phone-get.html"><abbr title="api/v3/Phone/Get.php">Get.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">31</span>
</aside>
<p class="phpdocumentor-summary">Retrieve one or more phones.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_phone_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>This function has been declared there instead than in api/v3/Phone.php
for no specific reasons, beside to demonstrate this feature
(that might be useful in your module, eg if you want to implement a
civicrm_api ('Phone','Dial') that you would then simply put in
your module under api/v3/Phone/Dial.php.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields metadata.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_phone_create">
civicrm_api3_phone_create()
<a href="namespaces/default.html#function_civicrm_api3_phone_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Phone.php"><a href="files/api-v3-phone.html"><abbr title="api/v3/Phone.php">Phone.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">26</span>
</aside>
<p class="phpdocumentor-summary">Add an Phone for a contact.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_phone_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields metadata.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_phone_create_spec">
_civicrm_api3_phone_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_phone_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Phone.php"><a href="files/api-v3-phone.html"><abbr title="api/v3/Phone.php">Phone.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">38</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_phone_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_phone_delete">
civicrm_api3_phone_delete()
<a href="namespaces/default.html#function_civicrm_api3_phone_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Phone.php"><a href="files/api-v3-phone.html"><abbr title="api/v3/Phone.php">Phone.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">58</span>
</aside>
<p class="phpdocumentor-summary">Delete an existing Phone.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_phone_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields metadata.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Api Result</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_pledge_create">
civicrm_api3_pledge_create()
<a href="namespaces/default.html#function_civicrm_api3_pledge_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Pledge.php"><a href="files/api-v3-pledge.html"><abbr title="api/v3/Pledge.php">Pledge.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">27</span>
</aside>
<p class="phpdocumentor-summary">Create or updates an Pledge.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_pledge_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_pledge_create#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array containing 'is_error' to denote success or failure and details of the created pledge</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_pledge_delete">
civicrm_api3_pledge_delete()
<a href="namespaces/default.html#function_civicrm_api3_pledge_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Pledge.php"><a href="files/api-v3-pledge.html"><abbr title="api/v3/Pledge.php">Pledge.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">40</span>
</aside>
<p class="phpdocumentor-summary">Delete a pledge.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_pledge_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array included 'pledge_id' of pledge to delete.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_pledge_delete_spec">
_civicrm_api3_pledge_delete_spec()
<a href="namespaces/default.html#function__civicrm_api3_pledge_delete_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Pledge.php"><a href="files/api-v3-pledge.html"><abbr title="api/v3/Pledge.php">Pledge.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">56</span>
</aside>
<p class="phpdocumentor-summary">Adjust metadata for pledge delete action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_pledge_delete_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_pledge_get_spec">
_civicrm_api3_pledge_get_spec()
<a href="namespaces/default.html#function__civicrm_api3_pledge_get_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Pledge.php"><a href="files/api-v3-pledge.html"><abbr title="api/v3/Pledge.php">Pledge.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">66</span>
</aside>
<p class="phpdocumentor-summary">Adjust field specification specific to get requests.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_pledge_get_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_pledge_create_spec">
_civicrm_api3_pledge_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_pledge_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Pledge.php"><a href="files/api-v3-pledge.html"><abbr title="api/v3/Pledge.php">Pledge.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">84</span>
</aside>
<p class="phpdocumentor-summary">Adjust field specification specific to get requests.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_pledge_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_pledge_get">
civicrm_api3_pledge_get()
<a href="namespaces/default.html#function_civicrm_api3_pledge_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Pledge.php"><a href="files/api-v3-pledge.html"><abbr title="api/v3/Pledge.php">Pledge.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">104</span>
</aside>
<p class="phpdocumentor-summary">Retrieve a set of pledges, given a set of input params.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_pledge_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Input parameters. Use interrogate for possible fields.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>array of pledges, if error an array with an error id and error message</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_pledge_get_defaults">
_civicrm_api3_pledge_get_defaults()
<a href="namespaces/default.html#function__civicrm_api3_pledge_get_defaults" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Pledge.php"><a href="files/api-v3-pledge.html"><abbr title="api/v3/Pledge.php">Pledge.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">120</span>
</aside>
<p class="phpdocumentor-summary">Set default to not return test params.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_pledge_get_defaults</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_pledge_format_params">
_civicrm_api3_pledge_format_params()
<a href="namespaces/default.html#function__civicrm_api3_pledge_format_params" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Pledge.php"><a href="files/api-v3-pledge.html"><abbr title="api/v3/Pledge.php">Pledge.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">135</span>
</aside>
<p class="phpdocumentor-summary">Legacy function to format pledge parameters.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_pledge_format_params</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$values</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>I removed a bunch of stuff no longer required from here but it still needs
more culling
take the input parameter list as specified in the data model and
convert it into the same format that we use in QF and BAO object</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$values</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The reformatted properties that we can use internally.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_pledge_payment_create">
civicrm_api3_pledge_payment_create()
<a href="namespaces/default.html#function_civicrm_api3_pledge_payment_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/PledgePayment.php"><a href="files/api-v3-pledgepayment.html"><abbr title="api/v3/PledgePayment.php">PledgePayment.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">34</span>
</aside>
<p class="phpdocumentor-summary">Add or update a pledge payment.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_pledge_payment_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>Pledge Payment API doesn't actually add a pledge.
If the request is to 'create' and 'id' is not passed in
the oldest pledge with no associated contribution is updated.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Input parameters.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_pledge_payment_create#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>possibly add ability to add payment if there are less payments than pledge installments</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>possibly add ability to recalculate dates if the schedule is changed</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API Result</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_pledge_payment_create_spec">
_civicrm_api3_pledge_payment_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_pledge_payment_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/PledgePayment.php"><a href="files/api-v3-pledgepayment.html"><abbr title="api/v3/PledgePayment.php">PledgePayment.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">68</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_pledge_payment_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_pledge_payment_delete">
civicrm_api3_pledge_payment_delete()
<a href="namespaces/default.html#function_civicrm_api3_pledge_payment_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/PledgePayment.php"><a href="files/api-v3-pledgepayment.html"><abbr title="api/v3/PledgePayment.php">PledgePayment.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">85</span>
</aside>
<p class="phpdocumentor-summary">Delete a pledge Payment - Note this deletes the contribution not just the
link.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_pledge_payment_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Input parameters.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_pledge_payment_delete#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">noinspection</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>PhpUnused</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_pledge_payment_get">
civicrm_api3_pledge_payment_get()
<a href="namespaces/default.html#function_civicrm_api3_pledge_payment_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/PledgePayment.php"><a href="files/api-v3-pledgepayment.html"><abbr title="api/v3/PledgePayment.php">PledgePayment.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">98</span>
</aside>
<p class="phpdocumentor-summary">Retrieve a set of pledges, given a set of input params.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_pledge_payment_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Input parameters.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>array of pledges, if error an array with an error id and error message</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_premium_create">
civicrm_api3_premium_create()
<a href="namespaces/default.html#function_civicrm_api3_premium_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Premium.php"><a href="files/api-v3-premium.html"><abbr title="api/v3/Premium.php">Premium.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">30</span>
</aside>
<p class="phpdocumentor-summary">Save a premium.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_premium_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_premium_create#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_premium_get">
civicrm_api3_premium_get()
<a href="namespaces/default.html#function_civicrm_api3_premium_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Premium.php"><a href="files/api-v3-premium.html"><abbr title="api/v3/Premium.php">Premium.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">42</span>
</aside>
<p class="phpdocumentor-summary">Get a premium.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_premium_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array of retrieved premium property values.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_premium_delete">
civicrm_api3_premium_delete()
<a href="namespaces/default.html#function_civicrm_api3_premium_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Premium.php"><a href="files/api-v3-premium.html"><abbr title="api/v3/Premium.php">Premium.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">55</span>
</aside>
<p class="phpdocumentor-summary">Delete a premium.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_premium_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_premium_delete#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array of deleted values.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_premium_get_spec">
_civicrm_api3_premium_get_spec()
<a href="namespaces/default.html#function__civicrm_api3_premium_get_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Premium.php"><a href="files/api-v3-premium.html"><abbr title="api/v3/Premium.php">Premium.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">64</span>
</aside>
<p class="phpdocumentor-summary">Return field specification specific to get requests.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_premium_get_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_premium_create_spec">
_civicrm_api3_premium_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_premium_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Premium.php"><a href="files/api-v3-premium.html"><abbr title="api/v3/Premium.php">Premium.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">73</span>
</aside>
<p class="phpdocumentor-summary">Return field specification specific to create requests.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_premium_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_price_field_create">
civicrm_api3_price_field_create()
<a href="namespaces/default.html#function_civicrm_api3_price_field_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/PriceField.php"><a href="files/api-v3-pricefield.html"><abbr title="api/v3/PriceField.php">PriceField.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">32</span>
</aside>
<p class="phpdocumentor-summary">Create or update a price_field.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_price_field_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>name/value pairs to insert in new 'price_field'</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>api result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_price_field_create_spec">
_civicrm_api3_price_field_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_price_field_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/PriceField.php"><a href="files/api-v3-pricefield.html"><abbr title="api/v3/PriceField.php">PriceField.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">44</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_price_field_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_price_field_get">
civicrm_api3_price_field_get()
<a href="namespaces/default.html#function_civicrm_api3_price_field_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/PriceField.php"><a href="files/api-v3-pricefield.html"><abbr title="api/v3/PriceField.php">PriceField.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">58</span>
</aside>
<p class="phpdocumentor-summary">Returns array of price_fields matching a set of one or more group properties.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_price_field_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of one or more valid property_name=>value pairs. If $params is set.
as null, all price_fields will be returned (default limit is 25)</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array of matching price_fields</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_price_field_delete">
civicrm_api3_price_field_delete()
<a href="namespaces/default.html#function_civicrm_api3_price_field_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/PriceField.php"><a href="files/api-v3-pricefield.html"><abbr title="api/v3/PriceField.php">PriceField.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">73</span>
</aside>
<p class="phpdocumentor-summary">Delete an existing price_field.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_price_field_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>This method is used to delete any existing price_field given its id.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array containing id of the group to be deleted.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_price_field_value_create">
civicrm_api3_price_field_value_create()
<a href="namespaces/default.html#function_civicrm_api3_price_field_value_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/PriceFieldValue.php"><a href="files/api-v3-pricefieldvalue.html"><abbr title="api/v3/PriceFieldValue.php">PriceFieldValue.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">31</span>
</aside>
<p class="phpdocumentor-summary">Create or update a PriceFieldValue.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_price_field_value_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>name/value pairs to insert in new 'PriceFieldValue'</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_price_field_value_create_spec">
_civicrm_api3_price_field_value_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_price_field_value_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/PriceFieldValue.php"><a href="files/api-v3-pricefieldvalue.html"><abbr title="api/v3/PriceFieldValue.php">PriceFieldValue.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">53</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_price_field_value_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_price_field_value_get">
civicrm_api3_price_field_value_get()
<a href="namespaces/default.html#function_civicrm_api3_price_field_value_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/PriceFieldValue.php"><a href="files/api-v3-pricefieldvalue.html"><abbr title="api/v3/PriceFieldValue.php">PriceFieldValue.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">71</span>
</aside>
<p class="phpdocumentor-summary">Returns array of PriceFieldValues matching a set of one or more group properties.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_price_field_value_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of one or more valid property_name=>value pairs. If $params is set.
as null, all price_field_values will be returned (default limit is 25)</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_price_field_value_delete">
civicrm_api3_price_field_value_delete()
<a href="namespaces/default.html#function_civicrm_api3_price_field_value_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/PriceFieldValue.php"><a href="files/api-v3-pricefieldvalue.html"><abbr title="api/v3/PriceFieldValue.php">PriceFieldValue.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">86</span>
</aside>
<p class="phpdocumentor-summary">Delete an existing PriceFieldValue.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_price_field_value_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>This method is used to delete any existing PriceFieldValue given its id.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array containing id of the group to be deleted.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_price_set_create">
civicrm_api3_price_set_create()
<a href="namespaces/default.html#function_civicrm_api3_price_set_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/PriceSet.php"><a href="files/api-v3-priceset.html"><abbr title="api/v3/PriceSet.php">PriceSet.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">31</span>
</aside>
<p class="phpdocumentor-summary">Create or update a PriceSet.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_price_set_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>name/value pairs to insert in new 'PriceSet'</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>api result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_price_set_create_spec">
_civicrm_api3_price_set_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_price_set_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/PriceSet.php"><a href="files/api-v3-priceset.html"><abbr title="api/v3/PriceSet.php">PriceSet.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">57</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_price_set_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_price_set_get">
civicrm_api3_price_set_get()
<a href="namespaces/default.html#function_civicrm_api3_price_set_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/PriceSet.php"><a href="files/api-v3-priceset.html"><abbr title="api/v3/PriceSet.php">PriceSet.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">71</span>
</aside>
<p class="phpdocumentor-summary">Returns array of price_sets matching a set of one or more group properties.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_price_set_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of one or more valid property_name=>value pairs. If $params is set.
as null, all price_sets will be returned (default limit is 25)</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array of matching price_sets</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_price_set_delete">
civicrm_api3_price_set_delete()
<a href="namespaces/default.html#function_civicrm_api3_price_set_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/PriceSet.php"><a href="files/api-v3-priceset.html"><abbr title="api/v3/PriceSet.php">PriceSet.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">98</span>
</aside>
<p class="phpdocumentor-summary">Delete an existing PriceSet.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_price_set_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>This method is used to delete any existing PriceSet given its id.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array containing id of the group to be deleted.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_print_label_create">
civicrm_api3_print_label_create()
<a href="namespaces/default.html#function_civicrm_api3_print_label_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/PrintLabel.php"><a href="files/api-v3-printlabel.html"><abbr title="api/v3/PrintLabel.php">PrintLabel.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">25</span>
</aside>
<p class="phpdocumentor-summary">Save a PrintLabel.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_print_label_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_print_label_create_spec">
_civicrm_api3_print_label_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_print_label_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/PrintLabel.php"><a href="files/api-v3-printlabel.html"><abbr title="api/v3/PrintLabel.php">PrintLabel.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">34</span>
</aside>
<p class="phpdocumentor-summary">Adjust metadata for navigation create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_print_label_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_print_label_get">
civicrm_api3_print_label_get()
<a href="namespaces/default.html#function_civicrm_api3_print_label_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/PrintLabel.php"><a href="files/api-v3-printlabel.html"><abbr title="api/v3/PrintLabel.php">PrintLabel.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">46</span>
</aside>
<p class="phpdocumentor-summary">Get a PrintLabel.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_print_label_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array of retrieved PrintLabel property values.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_print_label_delete">
civicrm_api3_print_label_delete()
<a href="namespaces/default.html#function_civicrm_api3_print_label_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/PrintLabel.php"><a href="files/api-v3-printlabel.html"><abbr title="api/v3/PrintLabel.php">PrintLabel.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">58</span>
</aside>
<p class="phpdocumentor-summary">Delete a PrintLabel.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_print_label_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array of deleted values.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_product_create">
civicrm_api3_product_create()
<a href="namespaces/default.html#function_civicrm_api3_product_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Product.php"><a href="files/api-v3-product.html"><abbr title="api/v3/Product.php">Product.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">29</span>
</aside>
<p class="phpdocumentor-summary">Save a product.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_product_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_product_create#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_product_create_spec">
_civicrm_api3_product_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_product_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Product.php"><a href="files/api-v3-product.html"><abbr title="api/v3/Product.php">Product.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">41</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_product_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_product_get">
civicrm_api3_product_get()
<a href="namespaces/default.html#function_civicrm_api3_product_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Product.php"><a href="files/api-v3-product.html"><abbr title="api/v3/Product.php">Product.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">54</span>
</aside>
<p class="phpdocumentor-summary">Get a product.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_product_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array of retrieved product property values.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_product_delete">
civicrm_api3_product_delete()
<a href="namespaces/default.html#function_civicrm_api3_product_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Product.php"><a href="files/api-v3-product.html"><abbr title="api/v3/Product.php">Product.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">67</span>
</aside>
<p class="phpdocumentor-summary">Delete a product.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_product_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_product_delete#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array of deleted values.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_profile_get">
civicrm_api3_profile_get()
<a href="namespaces/default.html#function_civicrm_api3_profile_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Profile.php"><a href="files/api-v3-profile.html"><abbr title="api/v3/Profile.php">Profile.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">38</span>
</aside>
<p class="phpdocumentor-summary">Retrieve Profile field values.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_profile_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>NOTE this api is not standard & since it is tested we need to honour that
but the correct behaviour is for it to return an id indexed array as this supports
multiple instances - if a single profile is passed in we will not return a normal api result array
in order to avoid breaking code. (This could still be confusing :-( but we have to keep the tested behaviour working</p>
<p>Note that if contact_id is empty an array of defaults is returned</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Associative array of property name/value.
pairs to get profile field values</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_profile_get#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_profile_get_spec">
_civicrm_api3_profile_get_spec()
<a href="namespaces/default.html#function__civicrm_api3_profile_get_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Profile.php"><a href="files/api-v3-profile.html"><abbr title="api/v3/Profile.php">Profile.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">128</span>
</aside>
<p class="phpdocumentor-summary">Adjust profile get function metadata.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_profile_get_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_profile_submit">
civicrm_api3_profile_submit()
<a href="namespaces/default.html#function_civicrm_api3_profile_submit" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Profile.php"><a href="files/api-v3-profile.html"><abbr title="api/v3/Profile.php">Profile.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">147</span>
</aside>
<p class="phpdocumentor-summary">Submit a set of fields against a profile.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_profile_submit</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>Note choice of submit versus create is discussed CRM-13234 & related to the fact
'profile' is being treated as a data-entry entity</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_profile_submit#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_profile_translate_fieldnames_for_bao">
_civicrm_api3_profile_translate_fieldnames_for_bao()
<a href="namespaces/default.html#function__civicrm_api3_profile_translate_fieldnames_for_bao" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Profile.php"><a href="files/api-v3-profile.html"><abbr title="api/v3/Profile.php">Profile.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">279</span>
</aside>
<p class="phpdocumentor-summary">Translate field names for BAO.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_profile_translate_fieldnames_for_bao</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$fieldName</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<section class="phpdocumentor-description"><p>The api standards expect field names to be lower case but the BAO uses mixed case
so we accept 'email-primary' but pass 'email-Primary' to the BAO
we could make the BAO handle email-primary but this would alter the fieldname seen by hooks
& we would need to consider that change</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fieldName</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>API field name.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
—
<section class="phpdocumentor-description"><p>BAO Field Name</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_profile_submit_spec">
_civicrm_api3_profile_submit_spec()
<a href="namespaces/default.html#function__civicrm_api3_profile_submit_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Profile.php"><a href="files/api-v3-profile.html"><abbr title="api/v3/Profile.php">Profile.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">290</span>
</aside>
<p class="phpdocumentor-summary">Metadata for submit action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_profile_submit_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$apirequest</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$apirequest</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - -deprecated">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_profile_set">
civicrm_api3_profile_set()
<a href="namespaces/default.html#function_civicrm_api3_profile_set" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Profile.php"><a href="files/api-v3-profile.html"><abbr title="api/v3/Profile.php">Profile.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">328</span>
</aside>
<p class="phpdocumentor-summary">Update Profile field values.</p>
<div class="phpdocumentor-admonition">
<svg class="phpdocumentor-admonition__icon" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-3L13.732 4c-.77-1.333-2.694-1.333-3.464 0L3.34 16c-.77 1.333.192 3 1.732 3z"></path></svg>
<article>
<ul>
<li>calling this function directly is deprecated as 'set' is not a clear action
use submit</li>
</ul>
</article>
</div>
<code class="phpdocumentor-code phpdocumentor-signature -deprecated">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_profile_set</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of property name/value.
pairs to update profile field values</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Updated Contact/ Activity object|CRM_Error</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - -deprecated">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_profile_apply">
civicrm_api3_profile_apply()
<a href="namespaces/default.html#function_civicrm_api3_profile_apply" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Profile.php"><a href="files/api-v3-profile.html"><abbr title="api/v3/Profile.php">Profile.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">348</span>
</aside>
<p class="phpdocumentor-summary">Apply profile.</p>
<div class="phpdocumentor-admonition">
<svg class="phpdocumentor-admonition__icon" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-3L13.732 4c-.77-1.333-2.694-1.333-3.464 0L3.34 16c-.77 1.333.192 3 1.732 3z"></path></svg>
<article>
<ul>
<li>appears to be an internal function - should not be accessible via api
Provide formatted values for profile fields.</li>
</ul>
</article>
</div>
<code class="phpdocumentor-code phpdocumentor-signature -deprecated">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_profile_apply</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of property name/value.
pairs to profile field values</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_profile_apply#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>add example</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>add test cases</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_profile_apply_spec">
_civicrm_api3_profile_apply_spec()
<a href="namespaces/default.html#function__civicrm_api3_profile_apply_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Profile.php"><a href="files/api-v3-profile.html"><abbr title="api/v3/Profile.php">Profile.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">384</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Apply action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_profile_apply_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_profile_getbillingpseudoprofile">
_civicrm_api3_profile_getbillingpseudoprofile()
<a href="namespaces/default.html#function__civicrm_api3_profile_getbillingpseudoprofile" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Profile.php"><a href="files/api-v3-profile.html"><abbr title="api/v3/Profile.php">Profile.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">404</span>
</aside>
<p class="phpdocumentor-summary">Get pseudo profile 'billing'.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_profile_getbillingpseudoprofile</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>This is a function to help us 'pretend' billing is a profile & treat it like it is one.
It gets standard credit card address fields etc
Note this is 'better' that the inbuilt version as it will pull in fallback values
billing location -> is_billing -> primary</p>
<p>Note that that since the existing code for deriving a blank profile is not easily accessible our
interim solution is just to return an empty array</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_buildprofile_submitfields">
_civicrm_api3_buildprofile_submitfields()
<a href="namespaces/default.html#function__civicrm_api3_buildprofile_submitfields" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Profile.php"><a href="files/api-v3-profile.html"><abbr title="api/v3/Profile.php">Profile.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">492</span>
</aside>
<p class="phpdocumentor-summary">Here we will build up getfields type data for all the fields in the profile.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_buildprofile_submitfields</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$profileID</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$optionsBehaviour</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$is_flush</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed>|void</span></code>
<section class="phpdocumentor-description"><p>Because the integration with the form layer in core is so hard-coded we are not going to attempt to re-use it
However, as this function is unit-tested & hence 'locked in' we can aspire to extract sharable
code out of the form-layer over time.</p>
<p>The function deciphers which fields belongs to which entites & retrieves metadata about the entities
Unfortunately we have inconsistencies such as 'contribution' uses contribution_status_id
& participant has 'participant_status' so we have to standardise from the outside in here -
find the oddities, 'mask them' at this layer, add tests & work to standardise over time so we can remove this handling</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$profileID</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$optionsBehaviour</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>0 = don't resolve, 1 = resolve non-aggressively, 2 = resolve aggressively - ie include country & state.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$is_flush</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed>|void</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_order_by_weight">
_civicrm_api3_order_by_weight()
<a href="namespaces/default.html#function__civicrm_api3_order_by_weight" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Profile.php"><a href="files/api-v3-profile.html"><abbr title="api/v3/Profile.php">Profile.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">620</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_order_by_weight</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$a</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$b</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$a</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$b</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_map_profile_fields_to_entity">
_civicrm_api3_map_profile_fields_to_entity()
<a href="namespaces/default.html#function__civicrm_api3_map_profile_fields_to_entity" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Profile.php"><a href="files/api-v3-profile.html"><abbr title="api/v3/Profile.php">Profile.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">632</span>
</aside>
<p class="phpdocumentor-summary">Here we map the profile fields as stored in the uf_field table to their 'real entity'
we also return the profile fieldname</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_map_profile_fields_to_entity</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$field</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$field</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_profile_getProfileID">
_civicrm_api3_profile_getProfileID()
<a href="namespaces/default.html#function__civicrm_api3_profile_getProfileID" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Profile.php"><a href="files/api-v3-profile.html"><abbr title="api/v3/Profile.php">Profile.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">717</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_profile_getProfileID</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$profileID</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int|string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$profileID</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_profile_getProfileID#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>this should be handled by the api wrapper using getfields info - need to check
how we add a a pseudoconstant to this pseudo api to make that work</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">int|string</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_profile_appendaliases">
_civicrm_api3_profile_appendaliases()
<a href="namespaces/default.html#function__civicrm_api3_profile_appendaliases" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Profile.php"><a href="files/api-v3-profile.html"><abbr title="api/v3/Profile.php">Profile.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">736</span>
</aside>
<p class="phpdocumentor-summary">helper function to add all aliases as keys to getfields response so we can look for keys within it
since the relationship between profile fields & api / metadata based fields is a bit inconsistent</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_profile_appendaliases</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$values</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$entity</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$values</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>e.g getfields response incl 'membership_type_id' - with api.aliases = 'membership_type'
returned array will include both as keys (with the same values)</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entity</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - -deprecated">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_profile_deprecation">
_civicrm_api3_profile_deprecation()
<a href="namespaces/default.html#function__civicrm_api3_profile_deprecation" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Profile.php"><a href="files/api-v3-profile.html"><abbr title="api/v3/Profile.php">Profile.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">759</span>
</aside>
<div class="phpdocumentor-admonition">
<svg class="phpdocumentor-admonition__icon" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-3L13.732 4c-.77-1.333-2.694-1.333-3.464 0L3.34 16c-.77 1.333.192 3 1.732 3z"></path></svg>
<article>
<p>api notice</p>
</article>
</div>
<code class="phpdocumentor-code phpdocumentor-signature -deprecated">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_profile_deprecation</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array of deprecated actions</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_recurring_entity_get">
civicrm_api3_recurring_entity_get()
<a href="namespaces/default.html#function_civicrm_api3_recurring_entity_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/RecurringEntity.php"><a href="files/api-v3-recurringentity.html"><abbr title="api/v3/RecurringEntity.php">RecurringEntity.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">26</span>
</aside>
<p class="phpdocumentor-summary">Retrieve a recurring entity.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_recurring_entity_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Input parameters.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_recurring_entity_get_spec">
_civicrm_api3_recurring_entity_get_spec()
<a href="namespaces/default.html#function__civicrm_api3_recurring_entity_get_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/RecurringEntity.php"><a href="files/api-v3-recurringentity.html"><abbr title="api/v3/RecurringEntity.php">RecurringEntity.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">38</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Get action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_recurring_entity_get_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_recurring_entity_create">
civicrm_api3_recurring_entity_create()
<a href="namespaces/default.html#function_civicrm_api3_recurring_entity_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/RecurringEntity.php"><a href="files/api-v3-recurringentity.html"><abbr title="api/v3/RecurringEntity.php">RecurringEntity.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">52</span>
</aside>
<p class="phpdocumentor-summary">Add or update a recurring entity.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_recurring_entity_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_recurring_entity_create_spec">
_civicrm_api3_recurring_entity_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_recurring_entity_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/RecurringEntity.php"><a href="files/api-v3-recurringentity.html"><abbr title="api/v3/RecurringEntity.php">RecurringEntity.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">64</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_recurring_entity_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_recurring_entity_delete">
civicrm_api3_recurring_entity_delete()
<a href="namespaces/default.html#function_civicrm_api3_recurring_entity_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/RecurringEntity.php"><a href="files/api-v3-recurringentity.html"><abbr title="api/v3/RecurringEntity.php">RecurringEntity.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">79</span>
</aside>
<p class="phpdocumentor-summary">Deletes an existing ReportInstance.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_recurring_entity_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_relationship_create">
civicrm_api3_relationship_create()
<a href="namespaces/default.html#function_civicrm_api3_relationship_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Relationship.php"><a href="files/api-v3-relationship.html"><abbr title="api/v3/Relationship.php">Relationship.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">29</span>
</aside>
<p class="phpdocumentor-summary">Add or update a relationship.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_relationship_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Input parameters.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_relationship_create#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API Result Array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_relationship_create_spec">
_civicrm_api3_relationship_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_relationship_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Relationship.php"><a href="files/api-v3-relationship.html"><abbr title="api/v3/Relationship.php">Relationship.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">40</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_relationship_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_relationship_delete">
civicrm_api3_relationship_delete()
<a href="namespaces/default.html#function_civicrm_api3_relationship_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Relationship.php"><a href="files/api-v3-relationship.html"><abbr title="api/v3/Relationship.php">Relationship.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">62</span>
</aside>
<p class="phpdocumentor-summary">Delete a relationship.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_relationship_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_relationship_delete#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API Result Array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_relationship_get">
civicrm_api3_relationship_get()
<a href="namespaces/default.html#function_civicrm_api3_relationship_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Relationship.php"><a href="files/api-v3-relationship.html"><abbr title="api/v3/Relationship.php">Relationship.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">79</span>
</aside>
<p class="phpdocumentor-summary">Get one or more relationship/s.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_relationship_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Input parameters.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_relationship_get#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Result is inconsistent depending on whether contact_id is passed in :</p>
<ul>
<li>if you pass in contact_id - it just returns all relationships for 'contact_id'</li>
<li>if you don't pass in contact_id then it does a filter on the relationship table (DAO based search)</li>
</ul>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API Result Array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_handle_relationship_type">
_civicrm_api3_handle_relationship_type()
<a href="namespaces/default.html#function__civicrm_api3_handle_relationship_type" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Relationship.php"><a href="files/api-v3-relationship.html"><abbr title="api/v3/Relationship.php">Relationship.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">117</span>
</aside>
<p class="phpdocumentor-summary">Legacy handling for relationship_type parameter.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_handle_relationship_type</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Associative array of property name/value.
pairs to insert in new contact.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_relationship_setvalue">
civicrm_api3_relationship_setvalue()
<a href="namespaces/default.html#function_civicrm_api3_relationship_setvalue" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Relationship.php"><a href="files/api-v3-relationship.html"><abbr title="api/v3/Relationship.php">Relationship.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">137</span>
</aside>
<p class="phpdocumentor-summary">Hack to ensure inherited membership got created/deleted on
relationship add/delete respectively.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_relationship_setvalue</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields metadata.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_relationship_getoptions_spec">
_civicrm_api3_relationship_getoptions_spec()
<a href="namespaces/default.html#function__civicrm_api3_relationship_getoptions_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Relationship.php"><a href="files/api-v3-relationship.html"><abbr title="api/v3/Relationship.php">Relationship.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">151</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_relationship_getoptions_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_relationship_type_create">
civicrm_api3_relationship_type_create()
<a href="namespaces/default.html#function_civicrm_api3_relationship_type_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/RelationshipType.php"><a href="files/api-v3-relationshiptype.html"><abbr title="api/v3/RelationshipType.php">RelationshipType.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">26</span>
</aside>
<p class="phpdocumentor-summary">Create relationship type.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_relationship_type_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields metadata.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_relationship_type_create_spec">
_civicrm_api3_relationship_type_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_relationship_type_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/RelationshipType.php"><a href="files/api-v3-relationshiptype.html"><abbr title="api/v3/RelationshipType.php">RelationshipType.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">48</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_relationship_type_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_relationship_type_get">
civicrm_api3_relationship_type_get()
<a href="namespaces/default.html#function_civicrm_api3_relationship_type_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/RelationshipType.php"><a href="files/api-v3-relationshiptype.html"><abbr title="api/v3/RelationshipType.php">RelationshipType.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">61</span>
</aside>
<p class="phpdocumentor-summary">Get all relationship types.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_relationship_type_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_relationship_type_delete">
civicrm_api3_relationship_type_delete()
<a href="namespaces/default.html#function_civicrm_api3_relationship_type_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/RelationshipType.php"><a href="files/api-v3-relationshiptype.html"><abbr title="api/v3/RelationshipType.php">RelationshipType.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">73</span>
</aside>
<p class="phpdocumentor-summary">Delete a relationship type.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_relationship_type_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API Result Array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_relationship_type_getlist_defaults">
_civicrm_api3_relationship_type_getlist_defaults()
<a href="namespaces/default.html#function__civicrm_api3_relationship_type_getlist_defaults" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/RelationshipType.php"><a href="files/api-v3-relationshiptype.html"><abbr title="api/v3/RelationshipType.php">RelationshipType.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">86</span>
</aside>
<p class="phpdocumentor-summary">Get list defaults for relationship types.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_relationship_type_getlist_defaults</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$request</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$request</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_relationship_type_getlist_defaults#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\_civicrm_api3_generic_getlist_defaults">_civicrm_api3_generic_getlist_defaults</abbr></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_report_instance_get">
civicrm_api3_report_instance_get()
<a href="namespaces/default.html#function_civicrm_api3_report_instance_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/ReportInstance.php"><a href="files/api-v3-reportinstance.html"><abbr title="api/v3/ReportInstance.php">ReportInstance.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">27</span>
</aside>
<p class="phpdocumentor-summary">Retrieve a report instance.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_report_instance_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Input parameters.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_report_instance_create">
civicrm_api3_report_instance_create()
<a href="namespaces/default.html#function_civicrm_api3_report_instance_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/ReportInstance.php"><a href="files/api-v3-reportinstance.html"><abbr title="api/v3/ReportInstance.php">ReportInstance.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">39</span>
</aside>
<p class="phpdocumentor-summary">Add or update a report instance.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_report_instance_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_report_instance_create_spec">
_civicrm_api3_report_instance_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_report_instance_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/ReportInstance.php"><a href="files/api-v3-reportinstance.html"><abbr title="api/v3/ReportInstance.php">ReportInstance.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">51</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_report_instance_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_report_instance_delete">
civicrm_api3_report_instance_delete()
<a href="namespaces/default.html#function_civicrm_api3_report_instance_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/ReportInstance.php"><a href="files/api-v3-reportinstance.html"><abbr title="api/v3/ReportInstance.php">ReportInstance.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">72</span>
</aside>
<p class="phpdocumentor-summary">Deletes an existing ReportInstance.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_report_instance_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_report_template_get">
civicrm_api3_report_template_get()
<a href="namespaces/default.html#function_civicrm_api3_report_template_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/ReportTemplate.php"><a href="files/api-v3-reporttemplate.html"><abbr title="api/v3/ReportTemplate.php">ReportTemplate.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">26</span>
</aside>
<p class="phpdocumentor-summary">Retrieve a report template.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_report_template_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_report_template_create">
civicrm_api3_report_template_create()
<a href="namespaces/default.html#function_civicrm_api3_report_template_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/ReportTemplate.php"><a href="files/api-v3-reporttemplate.html"><abbr title="api/v3/ReportTemplate.php">ReportTemplate.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">46</span>
</aside>
<p class="phpdocumentor-summary">Add a Report Template.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_report_template_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>Templates are stored as OptionValues.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_report_template_create#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_report_template_create_spec">
_civicrm_api3_report_template_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_report_template_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/ReportTemplate.php"><a href="files/api-v3-reporttemplate.html"><abbr title="api/v3/ReportTemplate.php">ReportTemplate.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">66</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_report_template_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_report_template_delete">
civicrm_api3_report_template_delete()
<a href="namespaces/default.html#function_civicrm_api3_report_template_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/ReportTemplate.php"><a href="files/api-v3-reporttemplate.html"><abbr title="api/v3/ReportTemplate.php">ReportTemplate.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">87</span>
</aside>
<p class="phpdocumentor-summary">Deletes an existing ReportTemplate.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_report_template_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_report_template_delete#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_report_template_getrows">
civicrm_api3_report_template_getrows()
<a href="namespaces/default.html#function_civicrm_api3_report_template_getrows" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/ReportTemplate.php"><a href="files/api-v3-reporttemplate.html"><abbr title="api/v3/ReportTemplate.php">ReportTemplate.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">103</span>
</aside>
<p class="phpdocumentor-summary">Retrieve rows from a report template.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_report_template_getrows</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Input parameters.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_report_template_getrows#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_report_template_getrows">
_civicrm_api3_report_template_getrows()
<a href="namespaces/default.html#function__civicrm_api3_report_template_getrows" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/ReportTemplate.php"><a href="files/api-v3-reporttemplate.html"><abbr title="api/v3/ReportTemplate.php">ReportTemplate.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">119</span>
</aside>
<p class="phpdocumentor-summary">Get report template rows.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_report_template_getrows</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_report_template_getrows#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_report_template_getstatistics">
civicrm_api3_report_template_getstatistics()
<a href="namespaces/default.html#function_civicrm_api3_report_template_getstatistics" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/ReportTemplate.php"><a href="files/api-v3-reporttemplate.html"><abbr title="api/v3/ReportTemplate.php">ReportTemplate.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">181</span>
</aside>
<p class="phpdocumentor-summary">Get statistics from a given report.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_report_template_getstatistics</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_report_template_getstatistics#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_report_template_getrows_spec">
_civicrm_api3_report_template_getrows_spec()
<a href="namespaces/default.html#function__civicrm_api3_report_template_getrows_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/ReportTemplate.php"><a href="files/api-v3-reporttemplate.html"><abbr title="api/v3/ReportTemplate.php">ReportTemplate.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">198</span>
</aside>
<p class="phpdocumentor-summary">Adjust metadata for template getrows action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_report_template_getrows_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Input parameters.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_rule_create">
civicrm_api3_rule_create()
<a href="namespaces/default.html#function_civicrm_api3_rule_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Rule.php"><a href="files/api-v3-rule.html"><abbr title="api/v3/Rule.php">Rule.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">29</span>
</aside>
<p class="phpdocumentor-summary">Create or update a rule.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_rule_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields metadata.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_rule_create_spec">
_civicrm_api3_rule_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_rule_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Rule.php"><a href="files/api-v3-rule.html"><abbr title="api/v3/Rule.php">Rule.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">41</span>
</aside>
<p class="phpdocumentor-summary">Specify Meta data for create.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_rule_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>Note that this data is retrievable via the getfields function
and is used for pre-filling defaults and ensuring mandatory requirements are met.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_rule_delete">
civicrm_api3_rule_delete()
<a href="namespaces/default.html#function_civicrm_api3_rule_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Rule.php"><a href="files/api-v3-rule.html"><abbr title="api/v3/Rule.php">Rule.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">56</span>
</aside>
<p class="phpdocumentor-summary">Delete an existing Rule.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_rule_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_rule_get">
civicrm_api3_rule_get()
<a href="namespaces/default.html#function_civicrm_api3_rule_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Rule.php"><a href="files/api-v3-rule.html"><abbr title="api/v3/Rule.php">Rule.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">69</span>
</aside>
<p class="phpdocumentor-summary">Get a Rule.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_rule_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields metadata.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_rule_group_create">
civicrm_api3_rule_group_create()
<a href="namespaces/default.html#function_civicrm_api3_rule_group_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/RuleGroup.php"><a href="files/api-v3-rulegroup.html"><abbr title="api/v3/RuleGroup.php">RuleGroup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">29</span>
</aside>
<p class="phpdocumentor-summary">Create or update a rule_group.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_rule_group_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields metadata.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_rule_group_create_spec">
_civicrm_api3_rule_group_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_rule_group_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/RuleGroup.php"><a href="files/api-v3-rulegroup.html"><abbr title="api/v3/RuleGroup.php">RuleGroup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">42</span>
</aside>
<p class="phpdocumentor-summary">Specify Meta data for create.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_rule_group_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>Note that this data is retrievable via the getfields function
and is used for pre-filling defaults and ensuring mandatory requirements are met.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_rule_group_delete">
civicrm_api3_rule_group_delete()
<a href="namespaces/default.html#function_civicrm_api3_rule_group_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/RuleGroup.php"><a href="files/api-v3-rulegroup.html"><abbr title="api/v3/RuleGroup.php">RuleGroup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">56</span>
</aside>
<p class="phpdocumentor-summary">Delete an existing RuleGroup.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_rule_group_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_rule_group_get">
civicrm_api3_rule_group_get()
<a href="namespaces/default.html#function_civicrm_api3_rule_group_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/RuleGroup.php"><a href="files/api-v3-rulegroup.html"><abbr title="api/v3/RuleGroup.php">RuleGroup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">69</span>
</aside>
<p class="phpdocumentor-summary">Get a RuleGroup.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_rule_group_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields metadata.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_saved_search_create">
civicrm_api3_saved_search_create()
<a href="namespaces/default.html#function_civicrm_api3_saved_search_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/SavedSearch.php"><a href="files/api-v3-savedsearch.html"><abbr title="api/v3/SavedSearch.php">SavedSearch.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">33</span>
</aside>
<p class="phpdocumentor-summary">Create or update a saved search.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_saved_search_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Associative array of property name-value pairs to insert in new saved search.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_saved_search_create#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">example</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>SavedSearch/Create.php Std create example.</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">access</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>public</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>api result array
saved_search_create</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_saved_search_create_spec">
_civicrm_api3_saved_search_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_saved_search_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/SavedSearch.php"><a href="files/api-v3-savedsearch.html"><abbr title="api/v3/SavedSearch.php">SavedSearch.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">42</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_saved_search_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$fields</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fields</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_saved_search_delete">
civicrm_api3_saved_search_delete()
<a href="namespaces/default.html#function_civicrm_api3_saved_search_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/SavedSearch.php"><a href="files/api-v3-savedsearch.html"><abbr title="api/v3/SavedSearch.php">SavedSearch.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">63</span>
</aside>
<p class="phpdocumentor-summary">Delete an existing saved search.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_saved_search_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Associative array of property name-value pairs. $params['id'] should be
the ID of the saved search to be deleted.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_saved_search_delete#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">example</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>SavedSearch/Delete.php Std delete example.</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">access</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>public</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>api result array
saved_search_delete</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_saved_search_get">
civicrm_api3_saved_search_get()
<a href="namespaces/default.html#function_civicrm_api3_saved_search_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/SavedSearch.php"><a href="files/api-v3-savedsearch.html"><abbr title="api/v3/SavedSearch.php">SavedSearch.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">78</span>
</aside>
<p class="phpdocumentor-summary">Retrieve one or more saved search(es).</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_saved_search_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>An associative array of name-value pairs.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_saved_search_get#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">example</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>SavedSearch/Get.php Std get example.</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">access</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>public</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>api result array
saved_search_get</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_saved_search_result_cleanup">
_civicrm_api3_saved_search_result_cleanup()
<a href="namespaces/default.html#function__civicrm_api3_saved_search_result_cleanup" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/SavedSearch.php"><a href="files/api-v3-savedsearch.html"><abbr title="api/v3/SavedSearch.php">SavedSearch.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">91</span>
</aside>
<p class="phpdocumentor-summary">Unserialize the form_values field in SavedSearch API results.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_saved_search_result_cleanup</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$result</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>Note: APIv4 handles serialization automatically based on metadata.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$result</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>API result to be cleaned up.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_setting_getfields">
civicrm_api3_setting_getfields()
<a href="namespaces/default.html#function_civicrm_api3_setting_getfields" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Setting.php"><a href="files/api-v3-setting.html"><abbr title="api/v3/Setting.php">Setting.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">25</span>
</aside>
<p class="phpdocumentor-summary">Get fields for setting api calls.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_setting_getfields</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_setting_getfields_spec">
_civicrm_api3_setting_getfields_spec()
<a href="namespaces/default.html#function__civicrm_api3_setting_getfields_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Setting.php"><a href="files/api-v3-setting.html"><abbr title="api/v3/Setting.php">Setting.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">68</span>
</aside>
<p class="phpdocumentor-summary">Alter metadata for getfields functions.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_setting_getfields_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_setting_getdefaults">
civicrm_api3_setting_getdefaults()
<a href="namespaces/default.html#function_civicrm_api3_setting_getdefaults" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Setting.php"><a href="files/api-v3-setting.html"><abbr title="api/v3/Setting.php">Setting.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">96</span>
</aside>
<p class="phpdocumentor-summary">Return default values for settings.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_setting_getdefaults</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>We will domain key this as it could vary by domain (ie. urls)
as we will be creating the option for a function rather than an value to be in the defaults
Note that is not in place as yet.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_setting_getdefaults#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\Exception">Exception</abbr></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_setting_getdefaults_spec">
_civicrm_api3_setting_getdefaults_spec()
<a href="namespaces/default.html#function__civicrm_api3_setting_getdefaults_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Setting.php"><a href="files/api-v3-setting.html"><abbr title="api/v3/Setting.php">Setting.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">117</span>
</aside>
<p class="phpdocumentor-summary">Metadata for Setting create function.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_setting_getdefaults_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Parameters as passed to the API.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_setting_getoptions">
civicrm_api3_setting_getoptions()
<a href="namespaces/default.html#function_civicrm_api3_setting_getoptions" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Setting.php"><a href="files/api-v3-setting.html"><abbr title="api/v3/Setting.php">Setting.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">134</span>
</aside>
<p class="phpdocumentor-summary">Get options for settings.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_setting_getoptions</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_setting_getoptions#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_setting_revert">
civicrm_api3_setting_revert()
<a href="namespaces/default.html#function_civicrm_api3_setting_revert" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Setting.php"><a href="files/api-v3-setting.html"><abbr title="api/v3/Setting.php">Setting.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">153</span>
</aside>
<p class="phpdocumentor-summary">Revert settings to defaults.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_setting_revert</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_setting_revert#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\Exception">Exception</abbr></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_setting_revert_spec">
_civicrm_api3_setting_revert_spec()
<a href="namespaces/default.html#function__civicrm_api3_setting_revert_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Setting.php"><a href="files/api-v3-setting.html"><abbr title="api/v3/Setting.php">Setting.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">189</span>
</aside>
<p class="phpdocumentor-summary">Alter metadata for getfields functions.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_setting_revert_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - -deprecated">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_setting_fill">
civicrm_api3_setting_fill()
<a href="namespaces/default.html#function_civicrm_api3_setting_fill" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Setting.php"><a href="files/api-v3-setting.html"><abbr title="api/v3/Setting.php">Setting.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">215</span>
</aside>
<p class="phpdocumentor-summary">Revert settings to defaults.</p>
<div class="phpdocumentor-admonition">
<svg class="phpdocumentor-admonition__icon" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-3L13.732 4c-.77-1.333-2.694-1.333-3.464 0L3.34 16c-.77 1.333.192 3 1.732 3z"></path></svg>
<article>
</article>
</div>
<code class="phpdocumentor-code phpdocumentor-signature -deprecated">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_setting_fill</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_setting_fill#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\Exception">Exception</abbr></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_setting_fill_spec">
_civicrm_api3_setting_fill_spec()
<a href="namespaces/default.html#function__civicrm_api3_setting_fill_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Setting.php"><a href="files/api-v3-setting.html"><abbr title="api/v3/Setting.php">Setting.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">238</span>
</aside>
<p class="phpdocumentor-summary">Alter metadata for getfields functions.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_setting_fill_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_setting_deprecation">
_civicrm_api3_setting_deprecation()
<a href="namespaces/default.html#function__civicrm_api3_setting_deprecation" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Setting.php"><a href="files/api-v3-setting.html"><abbr title="api/v3/Setting.php">Setting.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">260</span>
</aside>
<p class="phpdocumentor-summary">Declare deprecated api functions.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_setting_deprecation</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_setting_create">
civicrm_api3_setting_create()
<a href="namespaces/default.html#function_civicrm_api3_setting_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Setting.php"><a href="files/api-v3-setting.html"><abbr title="api/v3/Setting.php">Setting.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">275</span>
</aside>
<p class="phpdocumentor-summary">Create or update a setting.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_setting_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Parameters as per getfields.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_setting_create#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>api result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_setting_create_spec">
_civicrm_api3_setting_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_setting_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Setting.php"><a href="files/api-v3-setting.html"><abbr title="api/v3/Setting.php">Setting.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">287</span>
</aside>
<p class="phpdocumentor-summary">Metadata for setting create function.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_setting_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Parameters as passed to the API.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_setting_get">
civicrm_api3_setting_get()
<a href="namespaces/default.html#function_civicrm_api3_setting_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Setting.php"><a href="files/api-v3-setting.html"><abbr title="api/v3/Setting.php">Setting.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">309</span>
</aside>
<p class="phpdocumentor-summary">Returns array of settings matching input parameters.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_setting_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of one or more valid property_name=>value pairs.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array of matching settings</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_setting_get_spec">
_civicrm_api3_setting_get_spec()
<a href="namespaces/default.html#function__civicrm_api3_setting_get_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Setting.php"><a href="files/api-v3-setting.html"><abbr title="api/v3/Setting.php">Setting.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">325</span>
</aside>
<p class="phpdocumentor-summary">Metadata for setting create function.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_setting_get_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Parameters as passed to the API.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_setting_getvalue">
civicrm_api3_setting_getvalue()
<a href="namespaces/default.html#function_civicrm_api3_setting_getvalue" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Setting.php"><a href="files/api-v3-setting.html"><abbr title="api/v3/Setting.php">Setting.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">350</span>
</aside>
<p class="phpdocumentor-summary">Returns value for specific parameter.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_setting_getvalue</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>Function requires more fields than 'get' but is intended for
runtime usage & should be quicker</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of one or more valid.
property_name=>value pairs.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_setting_getvalue_spec">
_civicrm_api3_setting_getvalue_spec()
<a href="namespaces/default.html#function__civicrm_api3_setting_getvalue_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Setting.php"><a href="files/api-v3-setting.html"><abbr title="api/v3/Setting.php">Setting.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">371</span>
</aside>
<p class="phpdocumentor-summary">Metadata for setting create function.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_setting_getvalue_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Parameters as passed to the API.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_setting_getDomainArray">
_civicrm_api3_setting_getDomainArray()
<a href="namespaces/default.html#function__civicrm_api3_setting_getDomainArray" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Setting.php"><a href="files/api-v3-setting.html"><abbr title="api/v3/Setting.php">Setting.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">411</span>
</aside>
<p class="phpdocumentor-summary">Converts domain input into an array.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_setting_getDomainArray</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>If an array is passed in this is used, if 'all' is passed
in this is converted to 'all arrays'</p>
<p>Really domain_id should always be set but doing an empty check because at the moment
using crm-editable will pass an id & default won't be applied
we did talk about id being a pseudonym for domain_id in this api so applying it here.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_setting_getDomainArray#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_sms_provider_create">
civicrm_api3_sms_provider_create()
<a href="namespaces/default.html#function_civicrm_api3_sms_provider_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/SmsProvider.php"><a href="files/api-v3-smsprovider.html"><abbr title="api/v3/SmsProvider.php">SmsProvider.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">25</span>
</aside>
<p class="phpdocumentor-summary">Save an sms_provider.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_sms_provider_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_sms_provider_create_spec">
_civicrm_api3_sms_provider_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_sms_provider_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/SmsProvider.php"><a href="files/api-v3-smsprovider.html"><abbr title="api/v3/SmsProvider.php">SmsProvider.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">37</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_sms_provider_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_sms_provider_get">
civicrm_api3_sms_provider_get()
<a href="namespaces/default.html#function_civicrm_api3_sms_provider_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/SmsProvider.php"><a href="files/api-v3-smsprovider.html"><abbr title="api/v3/SmsProvider.php">SmsProvider.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">49</span>
</aside>
<p class="phpdocumentor-summary">Get an sms_provider.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_sms_provider_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array of retrieved sms_provider property values.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_sms_provider_delete">
civicrm_api3_sms_provider_delete()
<a href="namespaces/default.html#function_civicrm_api3_sms_provider_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/SmsProvider.php"><a href="files/api-v3-smsprovider.html"><abbr title="api/v3/SmsProvider.php">SmsProvider.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">61</span>
</aside>
<p class="phpdocumentor-summary">Delete an sms_provider.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_sms_provider_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array of deleted values.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_state_province_create">
civicrm_api3_state_province_create()
<a href="namespaces/default.html#function_civicrm_api3_state_province_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/StateProvince.php"><a href="files/api-v3-stateprovince.html"><abbr title="api/v3/StateProvince.php">StateProvince.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">28</span>
</aside>
<p class="phpdocumentor-summary">Add a state/province.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_state_province_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields metadata.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_state_province_create#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_state_province_create_spec">
_civicrm_api3_state_province_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_state_province_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/StateProvince.php"><a href="files/api-v3-stateprovince.html"><abbr title="api/v3/StateProvince.php">StateProvince.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">40</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_state_province_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_state_province_delete">
civicrm_api3_state_province_delete()
<a href="namespaces/default.html#function_civicrm_api3_state_province_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/StateProvince.php"><a href="files/api-v3-stateprovince.html"><abbr title="api/v3/StateProvince.php">StateProvince.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">53</span>
</aside>
<p class="phpdocumentor-summary">Deletes an existing state/province.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_state_province_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_state_province_get">
civicrm_api3_state_province_get()
<a href="namespaces/default.html#function_civicrm_api3_state_province_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/StateProvince.php"><a href="files/api-v3-stateprovince.html"><abbr title="api/v3/StateProvince.php">StateProvince.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">66</span>
</aside>
<p class="phpdocumentor-summary">Retrieve one or more states/provinces.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_state_province_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields metadata.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>api result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_status_preference_create">
civicrm_api3_status_preference_create()
<a href="namespaces/default.html#function_civicrm_api3_status_preference_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/StatusPreference.php"><a href="files/api-v3-statuspreference.html"><abbr title="api/v3/StatusPreference.php">StatusPreference.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">25</span>
</aside>
<p class="phpdocumentor-summary">Save a Status Preference.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_status_preference_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_status_preference_get">
civicrm_api3_status_preference_get()
<a href="namespaces/default.html#function_civicrm_api3_status_preference_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/StatusPreference.php"><a href="files/api-v3-statuspreference.html"><abbr title="api/v3/StatusPreference.php">StatusPreference.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">37</span>
</aside>
<p class="phpdocumentor-summary">Get an Acl.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_status_preference_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array of retrieved Acl property values.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_status_preference_delete">
civicrm_api3_status_preference_delete()
<a href="namespaces/default.html#function_civicrm_api3_status_preference_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/StatusPreference.php"><a href="files/api-v3-statuspreference.html"><abbr title="api/v3/StatusPreference.php">StatusPreference.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">49</span>
</aside>
<p class="phpdocumentor-summary">Delete an Acl.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_status_preference_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array of deleted values.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_status_preference_create_spec">
_civicrm_api3_status_preference_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_status_preference_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/StatusPreference.php"><a href="files/api-v3-statuspreference.html"><abbr title="api/v3/StatusPreference.php">StatusPreference.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">59</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_status_preference_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_survey_create">
civicrm_api3_survey_create()
<a href="namespaces/default.html#function_civicrm_api3_survey_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Survey.php"><a href="files/api-v3-survey.html"><abbr title="api/v3/Survey.php">Survey.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">31</span>
</aside>
<p class="phpdocumentor-summary">Create or update a survey.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_survey_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields metadata.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>api result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_survey_create_spec">
_civicrm_api3_survey_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_survey_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Survey.php"><a href="files/api-v3-survey.html"><abbr title="api/v3/Survey.php">Survey.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">43</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_survey_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_survey_get">
civicrm_api3_survey_get()
<a href="namespaces/default.html#function_civicrm_api3_survey_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Survey.php"><a href="files/api-v3-survey.html"><abbr title="api/v3/Survey.php">Survey.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">56</span>
</aside>
<p class="phpdocumentor-summary">Returns array of surveys matching a set of one or more group properties.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_survey_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of properties. If empty, all records will be returned.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result Array of matching surveys</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_survey_delete">
civicrm_api3_survey_delete()
<a href="namespaces/default.html#function_civicrm_api3_survey_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Survey.php"><a href="files/api-v3-survey.html"><abbr title="api/v3/Survey.php">Survey.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">71</span>
</aside>
<p class="phpdocumentor-summary">Delete an existing survey.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_survey_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>This method is used to delete any existing survey given its id.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>[id]</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>api result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_survey_getlist_defaults">
_civicrm_api3_survey_getlist_defaults()
<a href="namespaces/default.html#function__civicrm_api3_survey_getlist_defaults" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Survey.php"><a href="files/api-v3-survey.html"><abbr title="api/v3/Survey.php">Survey.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">84</span>
</aside>
<p class="phpdocumentor-summary">Set default getlist parameters.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_survey_getlist_defaults</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$request</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$request</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_survey_getlist_defaults#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\_civicrm_api3_generic_getlist_defaults">_civicrm_api3_generic_getlist_defaults</abbr></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - -deprecated">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_survey_respondant_deprecation">
_civicrm_api3_survey_respondant_deprecation()
<a href="namespaces/default.html#function__civicrm_api3_survey_respondant_deprecation" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/SurveyRespondant.php"><a href="files/api-v3-surveyrespondant.html"><abbr title="api/v3/SurveyRespondant.php">SurveyRespondant.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">27</span>
</aside>
<p class="phpdocumentor-summary">Notify caller of deprecated function.</p>
<div class="phpdocumentor-admonition">
<svg class="phpdocumentor-admonition__icon" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-3L13.732 4c-.77-1.333-2.694-1.333-3.464 0L3.34 16c-.77 1.333.192 3 1.732 3z"></path></svg>
<article>
<p>api notice</p>
</article>
</div>
<code class="phpdocumentor-code phpdocumentor-signature -deprecated">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_survey_respondant_deprecation</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
—
<section class="phpdocumentor-description"><p>String output indicates this entire api entity as deprecated</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - -deprecated">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_survey_respondant_get">
civicrm_api3_survey_respondant_get()
<a href="namespaces/default.html#function_civicrm_api3_survey_respondant_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/SurveyRespondant.php"><a href="files/api-v3-surveyrespondant.html"><abbr title="api/v3/SurveyRespondant.php">SurveyRespondant.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">41</span>
</aside>
<p class="phpdocumentor-summary">Get the list of signatories.</p>
<div class="phpdocumentor-admonition">
<svg class="phpdocumentor-admonition__icon" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-3L13.732 4c-.77-1.333-2.694-1.333-3.464 0L3.34 16c-.77 1.333.192 3 1.732 3z"></path></svg>
<article>
<ul>
<li>api currently not supported</li>
</ul>
</article>
</div>
<code class="phpdocumentor-code phpdocumentor-signature -deprecated">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_survey_respondant_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>input parameters.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - -deprecated">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_survey_respondant_count">
civicrm_api3_survey_respondant_count()
<a href="namespaces/default.html#function_civicrm_api3_survey_respondant_count" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/SurveyRespondant.php"><a href="files/api-v3-surveyrespondant.html"><abbr title="api/v3/SurveyRespondant.php">SurveyRespondant.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">75</span>
</aside>
<p class="phpdocumentor-summary">Count survey respondents.</p>
<div class="phpdocumentor-admonition">
<svg class="phpdocumentor-admonition__icon" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-3L13.732 4c-.77-1.333-2.694-1.333-3.464 0L3.34 16c-.77 1.333.192 3 1.732 3z"></path></svg>
<article>
<ul>
<li>api currently not supported</li>
</ul>
</article>
</div>
<code class="phpdocumentor-code phpdocumentor-signature -deprecated">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__reference-operator">&</span> <span class="phpdocumentor-signature__name">civicrm_api3_survey_respondant_count</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_system_flush">
civicrm_api3_system_flush()
<a href="namespaces/default.html#function_civicrm_api3_system_flush" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/System.php"><a href="files/api-v3-system.html"><abbr title="api/v3/System.php">System.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">30</span>
</aside>
<p class="phpdocumentor-summary">Flush all system caches.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_system_flush</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Input parameters.</p>
<ul>
<li>triggers: bool, whether to drop/create SQL triggers; default: FALSE</li>
<li>session: bool, whether to reset the CiviCRM session data; default: FALSE</li>
</ul>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_system_flush_spec">
_civicrm_api3_system_flush_spec()
<a href="namespaces/default.html#function__civicrm_api3_system_flush_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/System.php"><a href="files/api-v3-system.html"><abbr title="api/v3/System.php">System.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">46</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Flush action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_system_flush_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_system_check_spec">
_civicrm_api3_system_check_spec()
<a href="namespaces/default.html#function__civicrm_api3_system_check_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/System.php"><a href="files/api-v3-system.html"><abbr title="api/v3/System.php">System.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">69</span>
</aside>
<p class="phpdocumentor-summary">System.Check API specification (optional).</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_system_check_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$spec</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>This is used for documentation and validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$spec</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Description of fields supported by this API call.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_system_check_spec#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards">http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards</a></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_system_check">
civicrm_api3_system_check()
<a href="namespaces/default.html#function_civicrm_api3_system_check" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/System.php"><a href="files/api-v3-system.html"><abbr title="api/v3/System.php">System.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">130</span>
</aside>
<p class="phpdocumentor-summary">System Check API.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_system_check</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_system_check#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\civicrm_api3_create_success">civicrm_api3_create_success</abbr></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\civicrm_api3_create_error">civicrm_api3_create_error</abbr></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result descriptor; return items are alert codes/messages</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_system_log">
civicrm_api3_system_log()
<a href="namespaces/default.html#function_civicrm_api3_system_log" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/System.php"><a href="files/api-v3-system.html"><abbr title="api/v3/System.php">System.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">153</span>
</aside>
<p class="phpdocumentor-summary">Log entry to system log table.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_system_log</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_system_log_spec">
_civicrm_api3_system_log_spec()
<a href="namespaces/default.html#function__civicrm_api3_system_log_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/System.php"><a href="files/api-v3-system.html"><abbr title="api/v3/System.php">System.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">175</span>
</aside>
<p class="phpdocumentor-summary">Metadata for log function.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_system_log_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_system_get">
civicrm_api3_system_get()
<a href="namespaces/default.html#function_civicrm_api3_system_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/System.php"><a href="files/api-v3-system.html"><abbr title="api/v3/System.php">System.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">213</span>
</aside>
<p class="phpdocumentor-summary">System.Get API.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_system_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_system_get_redacted_ini">
_civicrm_api3_system_get_redacted_ini()
<a href="namespaces/default.html#function__civicrm_api3_system_get_redacted_ini" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/System.php"><a href="files/api-v3-system.html"><abbr title="api/v3/System.php">System.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">286</span>
</aside>
<p class="phpdocumentor-summary">Generate a sanitized/anonymized/redacted dump of the PHP configuration.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_system_get_redacted_ini</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>Some INI fields contain site-identifying information (SII) -- e.g. URLs,
hostnames, file paths, IP addresses, passwords, or free-form comments
could be used to identify a site or gain access to its resources.</p>
<p>A number of INI fields have been examined to determine whether they
contain SII. Approved fields are put in a whitelist; all other fields
are redacted.</p>
<p>Redaction hides the substance of a field but does not completely omit
all information. Consider the field 'mail.log' - setting this field
has a functional effect (it enables or disables the logging behavior)
and also points to particular file. Empty values (FALSE/NULL/0/"")
will pass through redaction, but all other values will be replaced
by a string (eg "REDACTED"). This roughly indicates whether the
option is enabled/disabled without giving away its content.</p>
</section>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_system_get_redacted_mysql">
_civicrm_api3_system_get_redacted_mysql()
<a href="namespaces/default.html#function__civicrm_api3_system_get_redacted_mysql" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/System.php"><a href="files/api-v3-system.html"><abbr title="api/v3/System.php">System.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">312</span>
</aside>
<p class="phpdocumentor-summary">Generate ae sanitized/anonymized/redacted dump of MySQL configuration.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_system_get_redacted_mysql</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_system_get_redacted_mysql#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\_civicrm_api3_system_get_redacted_ini">_civicrm_api3_system_get_redacted_ini</abbr></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_system_get_redacted_settings">
_civicrm_api3_system_get_redacted_settings()
<a href="namespaces/default.html#function__civicrm_api3_system_get_redacted_settings" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/System.php"><a href="files/api-v3-system.html"><abbr title="api/v3/System.php">System.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">339</span>
</aside>
<p class="phpdocumentor-summary">Get redacted settings.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_system_get_redacted_settings</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_system_get_redacted_settings#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_system_get_whitelist">
_civicrm_api3_system_get_whitelist()
<a href="namespaces/default.html#function__civicrm_api3_system_get_whitelist" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/System.php"><a href="files/api-v3-system.html"><abbr title="api/v3/System.php">System.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">365</span>
</aside>
<p class="phpdocumentor-summary">Read a whitelist.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_system_get_whitelist</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$whitelistFile</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$whitelistFile</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Name of a file. Each line is a field name. Comments begin with "#".</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_system_updatelogtables">
civicrm_api3_system_updatelogtables()
<a href="namespaces/default.html#function_civicrm_api3_system_updatelogtables" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/System.php"><a href="files/api-v3-system.html"><abbr title="api/v3/System.php">System.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">381</span>
</aside>
<p class="phpdocumentor-summary">Update log table structures.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_system_updatelogtables</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>This updates the engine type if defined in the hook and changes the field type
for log_conn_id to reflect CRM-18193.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_system_utf8conversion">
civicrm_api3_system_utf8conversion()
<a href="namespaces/default.html#function_civicrm_api3_system_utf8conversion" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/System.php"><a href="files/api-v3-system.html"><abbr title="api/v3/System.php">System.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">399</span>
</aside>
<p class="phpdocumentor-summary">Update log table structures.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_system_utf8conversion</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>This updates the engine type if defined in the hook and changes the field type
for log_conn_id to reflect CRM-18193.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_system_utf8conversion#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_system_utf8conversion_spec">
_civicrm_api3_system_utf8conversion_spec()
<a href="namespaces/default.html#function__civicrm_api3_system_utf8conversion_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/System.php"><a href="files/api-v3-system.html"><abbr title="api/v3/System.php">System.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">418</span>
</aside>
<p class="phpdocumentor-summary">Metadata for conversion function.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_system_utf8conversion_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_system_updatelogtables_spec">
_civicrm_api3_system_updatelogtables_spec()
<a href="namespaces/default.html#function__civicrm_api3_system_updatelogtables_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/System.php"><a href="files/api-v3-system.html"><abbr title="api/v3/System.php">System.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">443</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Flush action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_system_updatelogtables_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_system_updateindexes">
civicrm_api3_system_updateindexes()
<a href="namespaces/default.html#function_civicrm_api3_system_updateindexes" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/System.php"><a href="files/api-v3-system.html"><abbr title="api/v3/System.php">System.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">467</span>
</aside>
<p class="phpdocumentor-summary">Update indexes.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_system_updateindexes</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>This adds any indexes that exist in the schema but not the database.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_system_updateindexes_spec">
_civicrm_api3_system_updateindexes_spec()
<a href="namespaces/default.html#function__civicrm_api3_system_updateindexes_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/System.php"><a href="files/api-v3-system.html"><abbr title="api/v3/System.php">System.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">478</span>
</aside>
<p class="phpdocumentor-summary">Declare metadata for api System.getmissingindices</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_system_updateindexes_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_system_getmissingindices">
civicrm_api3_system_getmissingindices()
<a href="namespaces/default.html#function_civicrm_api3_system_getmissingindices" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/System.php"><a href="files/api-v3-system.html"><abbr title="api/v3/System.php">System.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">493</span>
</aside>
<p class="phpdocumentor-summary">Get an array of indices that should be defined but are not.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_system_getmissingindices</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_system_getmissingindices_spec">
_civicrm_api3_system_getmissingindices_spec()
<a href="namespaces/default.html#function__civicrm_api3_system_getmissingindices_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/System.php"><a href="files/api-v3-system.html"><abbr title="api/v3/System.php">System.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">504</span>
</aside>
<p class="phpdocumentor-summary">Declare metadata for api System.getmissingindices</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_system_getmissingindices_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_system_createmissinglogtables">
civicrm_api3_system_createmissinglogtables()
<a href="namespaces/default.html#function_civicrm_api3_system_createmissinglogtables" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/System.php"><a href="files/api-v3-system.html"><abbr title="api/v3/System.php">System.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">517</span>
</aside>
<p class="phpdocumentor-summary">Creates missing log tables.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_system_createmissinglogtables</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>CRM-20838 - This adds any missing log tables into the database.</p>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_system_rebuildmultilingualschema">
civicrm_api3_system_rebuildmultilingualschema()
<a href="namespaces/default.html#function_civicrm_api3_system_rebuildmultilingualschema" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/System.php"><a href="files/api-v3-system.html"><abbr title="api/v3/System.php">System.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">532</span>
</aside>
<p class="phpdocumentor-summary">Rebuild Multilingual Schema</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_system_rebuildmultilingualschema</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_system_log_delete">
civicrm_api3_system_log_delete()
<a href="namespaces/default.html#function_civicrm_api3_system_log_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/SystemLog.php"><a href="files/api-v3-systemlog.html"><abbr title="api/v3/SystemLog.php">SystemLog.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">25</span>
</aside>
<p class="phpdocumentor-summary">Delete system log record.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_system_log_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_system_log_create">
civicrm_api3_system_log_create()
<a href="namespaces/default.html#function_civicrm_api3_system_log_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/SystemLog.php"><a href="files/api-v3-systemlog.html"><abbr title="api/v3/SystemLog.php">SystemLog.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">39</span>
</aside>
<p class="phpdocumentor-summary">Create system log record.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_system_log_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>It's arguable whether this function should exist as it fits our crud pattern and adding it meets our SyntaxConformance test requirements
but it just wraps system.log which is more consistent with the PSR3 implemented.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_system_log_create_spec">
_civicrm_api3_system_log_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_system_log_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/SystemLog.php"><a href="files/api-v3-systemlog.html"><abbr title="api/v3/SystemLog.php">SystemLog.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">48</span>
</aside>
<p class="phpdocumentor-summary">Adjust system log create metadata.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_system_log_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_system_log_get">
civicrm_api3_system_log_get()
<a href="namespaces/default.html#function_civicrm_api3_system_log_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/SystemLog.php"><a href="files/api-v3-systemlog.html"><abbr title="api/v3/SystemLog.php">SystemLog.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">60</span>
</aside>
<p class="phpdocumentor-summary">Get system log record.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_system_log_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_tag_create">
civicrm_api3_tag_create()
<a href="namespaces/default.html#function_civicrm_api3_tag_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Tag.php"><a href="files/api-v3-tag.html"><abbr title="api/v3/Tag.php">Tag.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">34</span>
</aside>
<p class="phpdocumentor-summary">Create or update a tag.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_tag_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>Tags are used to classify CRM entities (including Contacts, Groups and Actions).</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields metadata.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_tag_create_spec">
_civicrm_api3_tag_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_tag_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Tag.php"><a href="files/api-v3-tag.html"><abbr title="api/v3/Tag.php">Tag.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">46</span>
</aside>
<p class="phpdocumentor-summary">Specify Meta data for create.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_tag_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>Note that this data is retrievable via the getfields function
and is used for pre-filling defaults and ensuring mandatory requirements are met.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_tag_delete">
civicrm_api3_tag_delete()
<a href="namespaces/default.html#function_civicrm_api3_tag_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Tag.php"><a href="files/api-v3-tag.html"><abbr title="api/v3/Tag.php">Tag.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">59</span>
</aside>
<p class="phpdocumentor-summary">Delete an existing Tag.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_tag_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_tag_get">
civicrm_api3_tag_get()
<a href="namespaces/default.html#function_civicrm_api3_tag_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Tag.php"><a href="files/api-v3-tag.html"><abbr title="api/v3/Tag.php">Tag.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">75</span>
</aside>
<p class="phpdocumentor-summary">Get a Tag.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_tag_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>This api is used for finding an existing tag.
Either id or name of tag are required parameters for this api.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields metadata.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_uf_field_create">
civicrm_api3_uf_field_create()
<a href="namespaces/default.html#function_civicrm_api3_uf_field_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/UFField.php"><a href="files/api-v3-uffield.html"><abbr title="api/v3/UFField.php">UFField.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">29</span>
</aside>
<p class="phpdocumentor-summary">Defines 'uf field' within a group.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_uf_field_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields metadata.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_uf_field_create#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Newly created $ufFieldArray</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_uf_field_create_spec">
_civicrm_api3_uf_field_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_uf_field_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/UFField.php"><a href="files/api-v3-uffield.html"><abbr title="api/v3/UFField.php">UFField.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">38</span>
</aside>
<p class="phpdocumentor-summary">Adjust metadata for civicrm_uf_field create.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_uf_field_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_uf_field_get">
civicrm_api3_uf_field_get()
<a href="namespaces/default.html#function_civicrm_api3_uf_field_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/UFField.php"><a href="files/api-v3-uffield.html"><abbr title="api/v3/UFField.php">UFField.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">59</span>
</aside>
<p class="phpdocumentor-summary">Returns array of uf groups (profiles) matching a set of one or more group properties.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_uf_field_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields metadata.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_uf_field_delete">
civicrm_api3_uf_field_delete()
<a href="namespaces/default.html#function_civicrm_api3_uf_field_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/UFField.php"><a href="files/api-v3-uffield.html"><abbr title="api/v3/UFField.php">UFField.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">72</span>
</aside>
<p class="phpdocumentor-summary">Delete uf field.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_uf_field_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_uf_field_delete#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_uf_field_delete_spec">
_civicrm_api3_uf_field_delete_spec()
<a href="namespaces/default.html#function__civicrm_api3_uf_field_delete_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/UFField.php"><a href="files/api-v3-uffield.html"><abbr title="api/v3/UFField.php">UFField.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">93</span>
</aside>
<p class="phpdocumentor-summary">Field id accepted for backward compatibility - unset required on id.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_uf_field_delete_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_uf_group_create_spec">
_civicrm_api3_uf_group_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_uf_group_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/UFGroup.php"><a href="files/api-v3-ufgroup.html"><abbr title="api/v3/UFGroup.php">UFGroup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">23</span>
</aside>
<p class="phpdocumentor-summary">Adjust metadata for create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_uf_group_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_uf_group_create">
civicrm_api3_uf_group_create()
<a href="namespaces/default.html#function_civicrm_api3_uf_group_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/UFGroup.php"><a href="files/api-v3-ufgroup.html"><abbr title="api/v3/UFGroup.php">UFGroup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">46</span>
</aside>
<p class="phpdocumentor-summary">Use this API to create a new group.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_uf_group_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>See the CRM Data Model for uf_group property definitions</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields metadata.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_uf_group_get">
civicrm_api3_uf_group_get()
<a href="namespaces/default.html#function_civicrm_api3_uf_group_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/UFGroup.php"><a href="files/api-v3-ufgroup.html"><abbr title="api/v3/UFGroup.php">UFGroup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">59</span>
</aside>
<p class="phpdocumentor-summary">Returns array of uf groups (profiles) matching a set of one or more group properties.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_uf_group_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of properties. If empty, all records will be returned.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array of matching profiles</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_uf_group_delete">
civicrm_api3_uf_group_delete()
<a href="namespaces/default.html#function_civicrm_api3_uf_group_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/UFGroup.php"><a href="files/api-v3-ufgroup.html"><abbr title="api/v3/UFGroup.php">UFGroup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">71</span>
</aside>
<p class="phpdocumentor-summary">Delete uf group.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_uf_group_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_uf_group_getlist_defaults">
_civicrm_api3_uf_group_getlist_defaults()
<a href="namespaces/default.html#function__civicrm_api3_uf_group_getlist_defaults" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/UFGroup.php"><a href="files/api-v3-ufgroup.html"><abbr title="api/v3/UFGroup.php">UFGroup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">84</span>
</aside>
<p class="phpdocumentor-summary">Set default getlist parameters.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_uf_group_getlist_defaults</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$request</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$request</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_uf_group_getlist_defaults#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\_civicrm_api3_generic_getlist_defaults">_civicrm_api3_generic_getlist_defaults</abbr></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_uf_group_getlist_output">
_civicrm_api3_uf_group_getlist_output()
<a href="namespaces/default.html#function__civicrm_api3_uf_group_getlist_output" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/UFGroup.php"><a href="files/api-v3-ufgroup.html"><abbr title="api/v3/UFGroup.php">UFGroup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">108</span>
</aside>
<p class="phpdocumentor-summary">Format getlist output</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_uf_group_getlist_output</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$result</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$request</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$entity</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$fields</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$result</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$request</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entity</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fields</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_uf_group_getlist_output#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\_civicrm_api3_generic_getlist_output">_civicrm_api3_generic_getlist_output</abbr></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_uf_join_create">
civicrm_api3_uf_join_create()
<a href="namespaces/default.html#function_civicrm_api3_uf_join_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/UFJoin.php"><a href="files/api-v3-ufjoin.html"><abbr title="api/v3/UFJoin.php">UFJoin.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">27</span>
</aside>
<p class="phpdocumentor-summary">Takes an associative array and creates a uf join in the database.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_uf_join_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields metadata.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>CRM_Core_DAO_UFJoin Array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_uf_join_create_spec">
_civicrm_api3_uf_join_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_uf_join_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/UFJoin.php"><a href="files/api-v3-ufjoin.html"><abbr title="api/v3/UFJoin.php">UFJoin.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">42</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_uf_join_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_uf_join_create_spec#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><ul>
<li>suspect module, weight don't need to be required - need to test</li>
</ul>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_uf_join_get">
civicrm_api3_uf_join_get()
<a href="namespaces/default.html#function_civicrm_api3_uf_join_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/UFJoin.php"><a href="files/api-v3-ufjoin.html"><abbr title="api/v3/UFJoin.php">UFJoin.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">57</span>
</aside>
<p class="phpdocumentor-summary">Get CiviCRM UF_Joins (ie joins between CMS user records & CiviCRM user record.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_uf_join_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of name/value pairs.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_uf_join_delete">
civicrm_api3_uf_join_delete()
<a href="namespaces/default.html#function_civicrm_api3_uf_join_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/UFJoin.php"><a href="files/api-v3-ufjoin.html"><abbr title="api/v3/UFJoin.php">UFJoin.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">70</span>
</aside>
<p class="phpdocumentor-summary">Delete a CiviCRM UF_Join.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_uf_join_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of name/value pairs.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_uf_match_get">
civicrm_api3_uf_match_get()
<a href="namespaces/default.html#function_civicrm_api3_uf_match_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/UFMatch.php"><a href="files/api-v3-ufmatch.html"><abbr title="api/v3/UFMatch.php">UFMatch.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">25</span>
</aside>
<p class="phpdocumentor-summary">Get the contact_id given a uf_id or vice versa.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_uf_match_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_uf_match_create">
civicrm_api3_uf_match_create()
<a href="namespaces/default.html#function_civicrm_api3_uf_match_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/UFMatch.php"><a href="files/api-v3-ufmatch.html"><abbr title="api/v3/UFMatch.php">UFMatch.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">38</span>
</aside>
<p class="phpdocumentor-summary">Create or update a UF Match record.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_uf_match_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields metadata.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Api result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_uf_match_create_spec">
_civicrm_api3_uf_match_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_uf_match_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/UFMatch.php"><a href="files/api-v3-ufmatch.html"><abbr title="api/v3/UFMatch.php">UFMatch.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">50</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_uf_match_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_uf_match_delete">
civicrm_api3_uf_match_delete()
<a href="namespaces/default.html#function_civicrm_api3_uf_match_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/UFMatch.php"><a href="files/api-v3-ufmatch.html"><abbr title="api/v3/UFMatch.php">UFMatch.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">64</span>
</aside>
<p class="phpdocumentor-summary">Delete a UF Match record.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_uf_match_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Api result array.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_user_get">
civicrm_api3_user_get()
<a href="namespaces/default.html#function_civicrm_api3_user_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/User.php"><a href="files/api-v3-user.html"><abbr title="api/v3/User.php">User.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">25</span>
</aside>
<p class="phpdocumentor-summary">Get details about the CMS User entity.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_user_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_user_get_spec">
_civicrm_api3_user_get_spec()
<a href="namespaces/default.html#function__civicrm_api3_user_get_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/User.php"><a href="files/api-v3-user.html"><abbr title="api/v3/User.php">User.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">52</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Get action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_user_get_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_initialize">
_civicrm_api3_initialize()
<a href="namespaces/default.html#function__civicrm_api3_initialize" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/utils.php"><a href="files/api-v3-utils.html"><abbr title="api/v3/utils.php">utils.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">21</span>
</aside>
<p class="phpdocumentor-summary">Initialize CiviCRM - should be run at the start of each API function.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_initialize</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_verify_one_mandatory">
civicrm_api3_verify_one_mandatory()
<a href="namespaces/default.html#function_civicrm_api3_verify_one_mandatory" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/utils.php"><a href="files/api-v3-utils.html"><abbr title="api/v3/utils.php">utils.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">39</span>
</aside>
<p class="phpdocumentor-summary">Wrapper Function for civicrm_verify_mandatory to make it simple to pass either / or fields for checking.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_verify_one_mandatory</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$daoName</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$keyoptions</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of fields to check.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$daoName</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>String DAO to check for required fields (create functions only).</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$keyoptions</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
= <span class="phpdocumentor-signature__argument__default-value">[]</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>List of required fields options. One of the options is required.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_verify_one_mandatory#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_verify_mandatory">
civicrm_api3_verify_mandatory()
<a href="namespaces/default.html#function_civicrm_api3_verify_mandatory" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/utils.php"><a href="files/api-v3-utils.html"><abbr title="api/v3/utils.php">utils.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">60</span>
</aside>
<p class="phpdocumentor-summary">Check mandatory fields are included.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_verify_mandatory</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$daoName</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$keys</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$verifyDAO</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">TRUE</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of fields to check.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$daoName</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>String DAO to check for required fields (create functions only).</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$keys</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
= <span class="phpdocumentor-signature__argument__default-value">[]</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>List of required fields. A value can be an array denoting that either this or that is required.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$verifyDAO</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
= <span class="phpdocumentor-signature__argument__default-value">TRUE</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_verify_mandatory#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_create_error">
civicrm_api3_create_error()
<a href="namespaces/default.html#function_civicrm_api3_create_error" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/utils.php"><a href="files/api-v3-utils.html"><abbr title="api/v3/utils.php">utils.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">110</span>
</aside>
<p class="phpdocumentor-summary">Create error array.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_create_error</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$msg</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$data</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$msg</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$data</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
= <span class="phpdocumentor-signature__argument__default-value">[]</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_create_success">
civicrm_api3_create_success()
<a href="namespaces/default.html#function_civicrm_api3_create_success" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/utils.php"><a href="files/api-v3-utils.html"><abbr title="api/v3/utils.php">utils.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">147</span>
</aside>
<p class="phpdocumentor-summary">Format array in result output style.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_create_success</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed>|int </span><span class="phpdocumentor-signature__argument__name">$values</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">1</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$entity</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$action</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">object </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$dao</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$extraReturnValues</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$values</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed>|int</span>
= <span class="phpdocumentor-signature__argument__default-value">1</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>values generated by API operation (the result)</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
= <span class="phpdocumentor-signature__argument__default-value">[]</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Parameters passed into API call.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entity</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The entity being acted on.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$action</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The action passed to the API.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$dao</span>
: <span class="phpdocumentor-signature__argument__return-type">object</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>DAO object to be freed here.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$extraReturnValues</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
= <span class="phpdocumentor-signature__argument__default-value">[]</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Additional values to be added to top level of result array(.</p>
<ul>
<li>this param is currently used for legacy behaviour support</li>
</ul>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_create_success#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_load_DAO">
_civicrm_api3_load_DAO()
<a href="namespaces/default.html#function__civicrm_api3_load_DAO" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/utils.php"><a href="files/api-v3-utils.html"><abbr title="api/v3/utils.php">utils.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">280</span>
</aside>
<p class="phpdocumentor-summary">Load the DAO of the entity.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_load_DAO</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$entity</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entity</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_get_DAO">
_civicrm_api3_get_DAO()
<a href="namespaces/default.html#function__civicrm_api3_get_DAO" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/utils.php"><a href="files/api-v3-utils.html"><abbr title="api/v3/utils.php">utils.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">299</span>
</aside>
<p class="phpdocumentor-summary">Return the DAO of the function or Entity.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_get_DAO</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$name</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/CRM-Core-DAO.html"><abbr title="\CRM_Core_DAO">CRM_Core_DAO</abbr></a>|string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$name</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Either a function of the api (civicrm_{entity}_create or the entity name.
return the DAO name to manipulate this function
eg. "civicrm_api3_contact_create" or "Contact" will return "CRM_Contact_BAO_Contact"</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/CRM-Core-DAO.html"><abbr title="\CRM_Core_DAO">CRM_Core_DAO</abbr></a>|string</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_get_BAO">
_civicrm_api3_get_BAO()
<a href="namespaces/default.html#function__civicrm_api3_get_BAO" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/utils.php"><a href="files/api-v3-utils.html"><abbr title="api/v3/utils.php">utils.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">362</span>
</aside>
<p class="phpdocumentor-summary">Return the BAO name of the function or Entity.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_get_BAO</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$name</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string|null</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$name</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Is either a function of the api (civicrm_{entity}_create or the entity name.
return the DAO name to manipulate this function
eg. "civicrm_contact_create" or "Contact" will return "CRM_Contact_BAO_Contact"</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string|null</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_separate_values">
_civicrm_api3_separate_values()
<a href="namespaces/default.html#function__civicrm_api3_separate_values" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/utils.php"><a href="files/api-v3-utils.html"><abbr title="api/v3/utils.php">utils.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">395</span>
</aside>
<p class="phpdocumentor-summary">Recursive function to explode value-separated strings into arrays.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_separate_values</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$values</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$values</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_filter_fields_for_bao">
_civicrm_api3_filter_fields_for_bao()
<a href="namespaces/default.html#function__civicrm_api3_filter_fields_for_bao" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/utils.php"><a href="files/api-v3-utils.html"><abbr title="api/v3/utils.php">utils.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">426</span>
</aside>
<p class="phpdocumentor-summary">This is a legacy wrapper for api_store_values.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_filter_fields_for_bao</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$entity</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$values</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>It checks suitable fields using getfields rather than DAO->fields.</p>
<p>Getfields has handling for how to deal with unique names which dao->fields doesn't</p>
<p>Note this is used by BAO type create functions - eg. contribution</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entity</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$values</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_store_values">
_civicrm_api3_store_values()
<a href="namespaces/default.html#function__civicrm_api3_store_values" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/utils.php"><a href="files/api-v3-utils.html"><abbr title="api/v3/utils.php">utils.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">441</span>
</aside>
<p class="phpdocumentor-summary">Copy values (other than id) from params to values if they exist in fields.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_store_values</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$fields</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$values</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fields</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$values</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_get_using_query_object">
_civicrm_api3_get_using_query_object()
<a href="namespaces/default.html#function__civicrm_api3_get_using_query_object" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/utils.php"><a href="files/api-v3-utils.html"><abbr title="api/v3/utils.php">utils.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">483</span>
</aside>
<p class="phpdocumentor-summary">Get function for query object api.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_get_using_query_object</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$entity</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$additional_options</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$getCount</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$mode</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">1</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">null|array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$defaultReturnProperties</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>The API supports 2 types of get request. The more complex uses the BAO query object.
This is a generic function for those functions that call it</p>
<p>At the moment only called by contact we should extend to contribution &
others that use the query object. Note that this function passes permission information in.
The others don't</p>
<p>Ideally this would be merged with _civicrm_get_query_object but we need to resolve differences in what the
2 variants call</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entity</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>As passed into api get or getcount function.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$additional_options</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
= <span class="phpdocumentor-signature__argument__default-value">[]</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of options (so we can modify the filter).</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$getCount</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Are we just after the count.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$mode</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
= <span class="phpdocumentor-signature__argument__default-value">1</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>This basically correlates to the component.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$defaultReturnProperties</span>
: <span class="phpdocumentor-signature__argument__return-type">null|array<string|int, mixed></span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Default return properties for the entity
(used if return not set - but don't do that - set return!).</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_get_using_query_object#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_get_query_object">
_civicrm_api3_get_query_object()
<a href="namespaces/default.html#function__civicrm_api3_get_query_object" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/utils.php"><a href="files/api-v3-utils.html"><abbr title="api/v3/utils.php">utils.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">571</span>
</aside>
<p class="phpdocumentor-summary">Get dao query object based on input params.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_get_query_object</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$mode</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$entity</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>Ideally this would be merged with _civicrm_get_using_query_object but we need to resolve differences in what the
2 variants call</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$mode</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entity</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>[CRM_Core_DAO|CRM_Contact_BAO_Query]</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - -deprecated">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_dao_set_filter">
_civicrm_api3_dao_set_filter()
<a href="namespaces/default.html#function__civicrm_api3_dao_set_filter" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/utils.php"><a href="files/api-v3-utils.html"><abbr title="api/v3/utils.php">utils.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">618</span>
</aside>
<p class="phpdocumentor-summary">Function transfers the filters being passed into the DAO onto the params object.</p>
<div class="phpdocumentor-admonition">
<svg class="phpdocumentor-admonition__icon" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-3L13.732 4c-.77-1.333-2.694-1.333-3.464 0L3.34 16c-.77 1.333.192 3 1.732 3z"></path></svg>
<article>
<p>DAO based retrieval is being phased out.</p>
</article>
</div>
<code class="phpdocumentor-code phpdocumentor-signature -deprecated">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_dao_set_filter</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-DAO.html"><abbr title="\CRM_Core_DAO">CRM_Core_DAO</abbr></a> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$dao</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$unique</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">TRUE</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$extraSql</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$dao</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-DAO.html"><abbr title="\CRM_Core_DAO">CRM_Core_DAO</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$unique</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
= <span class="phpdocumentor-signature__argument__default-value">TRUE</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$extraSql</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
= <span class="phpdocumentor-signature__argument__default-value">[]</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>API specific queries eg for event isCurrent would be converted to
$extraSql['where'] = array('civicrm_event' => array('(start_date >= CURDATE() || end_date >= CURDATE())'));</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_dao_set_filter#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\Exception">Exception</abbr></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_apply_filters_to_dao">
_civicrm_api3_apply_filters_to_dao()
<a href="namespaces/default.html#function__civicrm_api3_apply_filters_to_dao" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/utils.php"><a href="files/api-v3-utils.html"><abbr title="api/v3/utils.php">utils.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">719</span>
</aside>
<p class="phpdocumentor-summary">Apply filters (e.g. high, low) to DAO object (prior to find).</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_apply_filters_to_dao</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$filterField</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$filterValue</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">object </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$dao</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$filterField</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Field name of filter.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$filterValue</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Field value of filter.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$dao</span>
: <span class="phpdocumentor-signature__argument__return-type">object</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>DAO object.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_get_options_from_params">
_civicrm_api3_get_options_from_params()
<a href="namespaces/default.html#function__civicrm_api3_get_options_from_params" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/utils.php"><a href="files/api-v3-utils.html"><abbr title="api/v3/utils.php">utils.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">756</span>
</aside>
<p class="phpdocumentor-summary">Get sort, limit etc options from the params - supporting old & new formats.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_get_options_from_params</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$queryObject</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">FALSE</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$entity</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">''</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$action</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">''</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>Get returnProperties for legacy</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Params array as passed into civicrm_api.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$queryObject</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
= <span class="phpdocumentor-signature__argument__default-value">FALSE</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Is this supporting a queryObject api (e.g contact) - if so we support more options.
for legacy report & return a unique fields array</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entity</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">''</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$action</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">''</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_get_options_from_params#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>options extracted from params</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_apply_options_to_dao">
_civicrm_api3_apply_options_to_dao()
<a href="namespaces/default.html#function__civicrm_api3_apply_options_to_dao" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/utils.php"><a href="files/api-v3-utils.html"><abbr title="api/v3/utils.php">utils.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">871</span>
</aside>
<p class="phpdocumentor-summary">Apply options (e.g. sort, limit, order by) to DAO object (prior to find).</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_apply_options_to_dao</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">object </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$dao</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$entity</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Params array as passed into civicrm_api.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$dao</span>
: <span class="phpdocumentor-signature__argument__return-type">object</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>DAO object.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entity</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_apply_options_to_dao#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_build_fields_array">
_civicrm_api3_build_fields_array()
<a href="namespaces/default.html#function__civicrm_api3_build_fields_array" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/utils.php"><a href="files/api-v3-utils.html"><abbr title="api/v3/utils.php">utils.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">896</span>
</aside>
<p class="phpdocumentor-summary">Build fields array.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_build_fields_array</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-DAO.html"><abbr title="\CRM_Core_DAO">CRM_Core_DAO</abbr></a> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$bao</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$unique</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">TRUE</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>This is the array of fields as it relates to the given DAO
returns unique fields as keys by default but if set but can return by DB fields</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$bao</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-DAO.html"><abbr title="\CRM_Core_DAO">CRM_Core_DAO</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$unique</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
= <span class="phpdocumentor-signature__argument__default-value">TRUE</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_get_unique_name_array">
_civicrm_api3_get_unique_name_array()
<a href="namespaces/default.html#function__civicrm_api3_get_unique_name_array" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/utils.php"><a href="files/api-v3-utils.html"><abbr title="api/v3/utils.php">utils.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">925</span>
</aside>
<p class="phpdocumentor-summary">Build fields array.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_get_unique_name_array</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-DAO.html"><abbr title="\CRM_Core_DAO">CRM_Core_DAO</abbr></a> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$bao</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>This is the array of fields as it relates to the given DAO
returns unique fields as keys by default but if set but can return by DB fields</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$bao</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-DAO.html"><abbr title="\CRM_Core_DAO">CRM_Core_DAO</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - -deprecated">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_dao_to_array">
_civicrm_api3_dao_to_array()
<a href="namespaces/default.html#function__civicrm_api3_dao_to_array" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/utils.php"><a href="files/api-v3-utils.html"><abbr title="api/v3/utils.php">utils.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">950</span>
</aside>
<p class="phpdocumentor-summary">Converts an DAO object to an array.</p>
<div class="phpdocumentor-admonition">
<svg class="phpdocumentor-admonition__icon" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-3L13.732 4c-.77-1.333-2.694-1.333-3.464 0L3.34 16c-.77 1.333.192 3 1.732 3z"></path></svg>
<article>
<ul>
<li>DAO based retrieval is being phased out.</li>
</ul>
</article>
</div>
<code class="phpdocumentor-code phpdocumentor-signature -deprecated">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_dao_to_array</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-DAO.html"><abbr title="\CRM_Core_DAO">CRM_Core_DAO</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$dao</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$uniqueFields</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">TRUE</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$entity</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">""</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$autoFind</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">TRUE</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$dao</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-DAO.html"><abbr title="\CRM_Core_DAO">CRM_Core_DAO</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Object to convert.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$uniqueFields</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
= <span class="phpdocumentor-signature__argument__default-value">TRUE</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entity</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">""</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$autoFind</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
= <span class="phpdocumentor-signature__argument__default-value">TRUE</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_dao_to_array#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_custom_fields_are_required">
_civicrm_api3_custom_fields_are_required()
<a href="namespaces/default.html#function__civicrm_api3_custom_fields_are_required" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/utils.php"><a href="files/api-v3-utils.html"><abbr title="api/v3/utils.php">utils.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1002</span>
</aside>
<p class="phpdocumentor-summary">Determine if custom fields need to be retrieved.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_custom_fields_are_required</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$entity</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<section class="phpdocumentor-description"><p>We currently retrieve all custom fields or none at this level so if we know the entity
&& it can take custom fields & there is the string 'custom' in their return request we get them all, they are filtered on the way out</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entity</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Entity name in CamelCase.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_custom_fields_are_required#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>filter so only required fields are queried</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_object_to_array">
_civicrm_api3_object_to_array()
<a href="namespaces/default.html#function__civicrm_api3_object_to_array" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/utils.php"><a href="files/api-v3-utils.html"><abbr title="api/v3/utils.php">utils.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1023</span>
</aside>
<p class="phpdocumentor-summary">Converts an object to an array.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_object_to_array</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">object </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$dao</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$values</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed>|bool </span><span class="phpdocumentor-signature__argument__name">$uniqueFields</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">FALSE</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$dao</span>
: <span class="phpdocumentor-signature__argument__return-type">object</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>(reference) object to convert.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$values</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>(reference) array.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$uniqueFields</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed>|bool</span>
= <span class="phpdocumentor-signature__argument__default-value">FALSE</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_object_to_array_unique_fields">
_civicrm_api3_object_to_array_unique_fields()
<a href="namespaces/default.html#function__civicrm_api3_object_to_array_unique_fields" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/utils.php"><a href="files/api-v3-utils.html"><abbr title="api/v3/utils.php">utils.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1041</span>
</aside>
<p class="phpdocumentor-summary">Wrapper for _civicrm_object_to_array when api supports unique fields.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_object_to_array_unique_fields</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-DAO.html"><abbr title="\CRM_Core_DAO">CRM_Core_DAO</abbr></a> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$dao</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$values</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$dao</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-DAO.html"><abbr title="\CRM_Core_DAO">CRM_Core_DAO</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$values</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_custom_format_params">
_civicrm_api3_custom_format_params()
<a href="namespaces/default.html#function__civicrm_api3_custom_format_params" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/utils.php"><a href="files/api-v3-utils.html"><abbr title="api/v3/utils.php">utils.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1055</span>
</aside>
<p class="phpdocumentor-summary">Format custom parameters.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_custom_format_params</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$values</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$extends</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$entityId</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$values</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$extends</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Entity that this custom field extends (e.g. contribution, event, contact).</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entityId</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>ID of entity per $extends.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_format_params_for_create">
_civicrm_api3_format_params_for_create()
<a href="namespaces/default.html#function__civicrm_api3_format_params_for_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/utils.php"><a href="files/api-v3-utils.html"><abbr title="api/v3/utils.php">utils.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1095</span>
</aside>
<p class="phpdocumentor-summary">Format parameters for create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_format_params_for_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$entity</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entity</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_formatCheckBoxField">
formatCheckBoxField()
<a href="namespaces/default.html#function_formatCheckBoxField" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/utils.php"><a href="files/api-v3-utils.html"><abbr title="api/v3/utils.php">utils.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1136</span>
</aside>
<p class="phpdocumentor-summary">We can't rely on downstream to add separators to checkboxes so we'll check here.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">formatCheckBoxField</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$checkboxFieldValue</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$customFieldLabel</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$entity</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>We should look at pushing to BAO function
and / or validate function but this is a safe place for now as it has massive test coverage & we can keep the change very specific
note that this is specifically tested in the GRANT api test case so later refactoring should use that as a checking point</p>
<p>We will only alter the value if we are sure that changing it will make it correct - if it appears wrong but does not appear to have a clear fix we
don't touch - lots of very cautious code in here</p>
<p>The resulting array should look like
array(
'key' => 1,
'key1' => 1,
);</p>
<p>OR one or more keys wrapped in a CRM_Core_DAO::VALUE_SEPARATOR - either it accepted by the receiving function</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$checkboxFieldValue</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$customFieldLabel</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entity</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_formatCheckBoxField#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><ul>
<li>we are probably skipping handling disabled options as presumably getoptions is not giving us them. This should be non-regressive but might
be fixed in future</li>
</ul>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_basic_get">
_civicrm_api3_basic_get()
<a href="namespaces/default.html#function__civicrm_api3_basic_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/utils.php"><a href="files/api-v3-utils.html"><abbr title="api/v3/utils.php">utils.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1229</span>
</aside>
<p class="phpdocumentor-summary">Function to do a 'standard' api get - when the api is only doing a $bao->find then use this.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_basic_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string|<a href="classes/CRM-Core-DAO.html"><abbr title="\CRM_Core_DAO">CRM_Core_DAO</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$bao_name</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$returnAsSuccess</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">TRUE</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$entity</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">""</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Utils-SQL-Select.html"><abbr title="\CRM_Utils_SQL_Select">CRM_Utils_SQL_Select</abbr></a>|null </span><span class="phpdocumentor-signature__argument__name">$sql</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$uniqueFields</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">FALSE</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$bao_name</span>
: <span class="phpdocumentor-signature__argument__return-type">string|<a href="classes/CRM-Core-DAO.html"><abbr title="\CRM_Core_DAO">CRM_Core_DAO</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Name of BAO.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Params from api.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$returnAsSuccess</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
= <span class="phpdocumentor-signature__argument__default-value">TRUE</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Return in api success format.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entity</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">""</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$sql</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Utils-SQL-Select.html"><abbr title="\CRM_Utils_SQL_Select">CRM_Utils_SQL_Select</abbr></a>|null</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Extra SQL bits to add to the query. For filtering current events, this might be:
CRM_Utils_SQL_Select::fragment()->where('(start_date >= CURDATE() || end_date >= CURDATE())');</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$uniqueFields</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
= <span class="phpdocumentor-signature__argument__default-value">FALSE</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Should unique field names be returned (for backward compatibility)</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_basic_create">
_civicrm_api3_basic_create()
<a href="namespaces/default.html#function__civicrm_api3_basic_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/utils.php"><a href="files/api-v3-utils.html"><abbr title="api/v3/utils.php">utils.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1275</span>
</aside>
<p class="phpdocumentor-summary">Function to do a 'standard' api create - when the api is only doing a $bao::create then use this.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_basic_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$bao_name</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$entity</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$bao_name</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Name of BAO Class.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Parameters passed into the api call.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entity</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Entity - pass in if entity is non-standard & required $ids array.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_basic_create#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/Civi-API-Exception-UnauthorizedException.html"><abbr title="\Civi\API\Exception\UnauthorizedException">UnauthorizedException</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_basic_create_fallback">
_civicrm_api3_basic_create_fallback()
<a href="namespaces/default.html#function__civicrm_api3_basic_create_fallback" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/utils.php"><a href="files/api-v3-utils.html"><abbr title="api/v3/utils.php">utils.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1346</span>
</aside>
<p class="phpdocumentor-summary">For BAO's which don't have a create() or add() functions, use this fallback implementation.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_basic_create_fallback</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string|<a href="classes/CRM-Core-DAO.html"><abbr title="\CRM_Core_DAO">CRM_Core_DAO</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$bao_name</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/CRM-Core-DAO.html"><abbr title="\CRM_Core_DAO">CRM_Core_DAO</abbr></a>|null</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$bao_name</span>
: <span class="phpdocumentor-signature__argument__return-type">string|<a href="classes/CRM-Core-DAO.html"><abbr title="\CRM_Core_DAO">CRM_Core_DAO</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_basic_create_fallback#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/CRM-Core-DAO.html"><abbr title="\CRM_Core_DAO">CRM_Core_DAO</abbr></a>|null</span>
—
<section class="phpdocumentor-description"><p>An instance of the BAO</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_basic_delete">
_civicrm_api3_basic_delete()
<a href="namespaces/default.html#function__civicrm_api3_basic_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/utils.php"><a href="files/api-v3-utils.html"><abbr title="api/v3/utils.php">utils.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1365</span>
</aside>
<p class="phpdocumentor-summary">Function to do a 'standard' api del.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_basic_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string|<a href="classes/CRM-Core-DAO.html"><abbr title="\CRM_Core_DAO">CRM_Core_DAO</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$bao_name</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>When the api is only doing a $bao::del then use this if api::del doesn't exist it will try DAO delete method.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$bao_name</span>
: <span class="phpdocumentor-signature__argument__return-type">string|<a href="classes/CRM-Core-DAO.html"><abbr title="\CRM_Core_DAO">CRM_Core_DAO</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_basic_delete#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/Civi-API-Exception-UnauthorizedException.html"><abbr title="\Civi\API\Exception\UnauthorizedException">UnauthorizedException</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_custom_data_get">
_civicrm_api3_custom_data_get()
<a href="namespaces/default.html#function__civicrm_api3_custom_data_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/utils.php"><a href="files/api-v3-utils.html"><abbr title="api/v3/utils.php">utils.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1409</span>
</aside>
<p class="phpdocumentor-summary">Get custom data for the given entity & Add it to the returnArray.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_custom_data_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$returnArray</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$checkPermission</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$entity</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$entity_id</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$groupID</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$subType</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$subName</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>This looks like 'custom_123' = 'custom string' AND
'custom_123_1' = 'custom string'
Where 123 is field value & 1 is the id within the custom group data table (value ID)</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$returnArray</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array to append custom data too - generally $result[4] where 4 is the entity id.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$checkPermission</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entity</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>E.g membership, event.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entity_id</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$groupID</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Per CRM_Core_BAO_CustomGroup::getTree.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$subType</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>E.g. membership_type_id where custom data doesn't apply to all membership types.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$subName</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Subtype of entity.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_custom_data_get#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_validate">
_civicrm_api3_validate()
<a href="namespaces/default.html#function__civicrm_api3_validate" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/utils.php"><a href="files/api-v3-utils.html"><abbr title="api/v3/utils.php">utils.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1466</span>
</aside>
<p class="phpdocumentor-summary">Used by the Validate API.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_validate</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$entity</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$action</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entity</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$action</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_validate#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>$errors</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_validate_switch_cases">
_civicrm_api3_validate_switch_cases()
<a href="namespaces/default.html#function__civicrm_api3_validate_switch_cases" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/utils.php"><a href="files/api-v3-utils.html"><abbr title="api/v3/utils.php">utils.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1519</span>
</aside>
<p class="phpdocumentor-summary">Used by the Validate API.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_validate_switch_cases</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$fieldName</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$fieldInfo</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$entity</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$action</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fieldName</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fieldInfo</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entity</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$action</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_validate_switch_cases#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\Exception">Exception</abbr></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_validate_fields">
_civicrm_api3_validate_fields()
<a href="namespaces/default.html#function__civicrm_api3_validate_fields" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/utils.php"><a href="files/api-v3-utils.html"><abbr title="api/v3/utils.php">utils.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1566</span>
</aside>
<p class="phpdocumentor-summary">Validate fields being passed into API.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_validate_fields</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$entity</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$action</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$fields</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>This function relies on the getFields function working accurately
for the given API.</p>
<p>As of writing only date was implemented.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entity</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$action</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>-.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fields</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Response from getfields all variables are the same as per civicrm_api.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_validate_fields#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\Exception">Exception</abbr></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_validate_foreign_keys">
_civicrm_api3_validate_foreign_keys()
<a href="namespaces/default.html#function__civicrm_api3_validate_foreign_keys" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/utils.php"><a href="files/api-v3-utils.html"><abbr title="api/v3/utils.php">utils.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1636</span>
</aside>
<p class="phpdocumentor-summary">Validate foreign key values of fields being passed into API.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_validate_foreign_keys</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$entity</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$action</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$fields</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>This function relies on the getFields function working accurately
for the given API.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entity</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$action</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fields</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Response from getfields all variables are the same as per civicrm_api.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_validate_foreign_keys#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\Exception">Exception</abbr></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_validate_date">
_civicrm_api3_validate_date()
<a href="namespaces/default.html#function__civicrm_api3_validate_date" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/utils.php"><a href="files/api-v3-utils.html"><abbr title="api/v3/utils.php">utils.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1676</span>
</aside>
<p class="phpdocumentor-summary">Validate date fields being passed into API.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_validate_date</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$fieldName</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$fieldInfo</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>It currently converts both unique fields and DB field names to a mysql date.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Params from civicrm_api.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fieldName</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Uniquename of field being checked.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fieldInfo</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of fields from getfields function.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_validate_date#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><ul>
<li>probably the unique field handling & the if exists handling is now done before this
function is reached in the wrapper - can reduce this code down to assume we
are only checking the passed in field</li>
</ul>
<p>It also checks against the RULE:date function. This is a centralisation of code that was scattered and
may not be the best thing to do. There is no code level documentation on the existing functions to work off</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\Exception">Exception</abbr></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_getValidDate">
_civicrm_api3_getValidDate()
<a href="namespaces/default.html#function__civicrm_api3_getValidDate" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/utils.php"><a href="files/api-v3-utils.html"><abbr title="api/v3/utils.php">utils.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1715</span>
</aside>
<p class="phpdocumentor-summary">Convert date into BAO friendly date.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_getValidDate</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$dateValue</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$fieldName</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$fieldType</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>We accept 'whatever strtotime accepts'</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$dateValue</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fieldName</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fieldType</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_getValidDate#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\Exception">Exception</abbr></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_validate_constraint">
_civicrm_api3_validate_constraint()
<a href="namespaces/default.html#function__civicrm_api3_validate_constraint" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/utils.php"><a href="files/api-v3-utils.html"><abbr title="api/v3/utils.php">utils.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1741</span>
</aside>
<p class="phpdocumentor-summary">Validate foreign constraint fields being passed into API.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_validate_constraint</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$fieldValue</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$fieldName</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$fieldInfo</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$entity</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fieldValue</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fieldName</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Unique name of field being checked.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fieldInfo</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of fields from getfields function.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entity</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_validate_constraint#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_validate_unique_key">
_civicrm_api3_validate_unique_key()
<a href="namespaces/default.html#function__civicrm_api3_validate_unique_key" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/utils.php"><a href="files/api-v3-utils.html"><abbr title="api/v3/utils.php">utils.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1766</span>
</aside>
<p class="phpdocumentor-summary">Validate foreign constraint fields being passed into API.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_validate_unique_key</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$fieldName</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Params from civicrm_api.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fieldName</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Uniquename of field being checked.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_validate_unique_key#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\Exception">Exception</abbr></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_generic_replace">
_civicrm_api3_generic_replace()
<a href="namespaces/default.html#function__civicrm_api3_generic_replace" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/utils.php"><a href="files/api-v3-utils.html"><abbr title="api/v3/utils.php">utils.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1800</span>
</aside>
<p class="phpdocumentor-summary">Generic implementation of the "replace" action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_generic_replace</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$entity</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed>|int</span></code>
<section class="phpdocumentor-description"><p>Replace the old set of entities (matching some given keys) with a new set of
entities (matching the same keys).</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entity</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Entity name.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Params from civicrm_api, including:.</p>
<ul>
<li>'values': an array of records to save</li>
<li>all other items: keys which identify new/pre-existing records.</li>
</ul>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_generic_replace#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">note</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>This will verify that 'values' is present, but it does not directly verify
any other parameters.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed>|int</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_generic_replace_base_params">
_civicrm_api3_generic_replace_base_params()
<a href="namespaces/default.html#function__civicrm_api3_generic_replace_base_params" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/utils.php"><a href="files/api-v3-utils.html"><abbr title="api/v3/utils.php">utils.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1869</span>
</aside>
<p class="phpdocumentor-summary">Replace base parameters.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_generic_replace_base_params</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api_get_fields">
_civicrm_api_get_fields()
<a href="namespaces/default.html#function__civicrm_api_get_fields" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/utils.php"><a href="files/api-v3-utils.html"><abbr title="api/v3/utils.php">utils.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1889</span>
</aside>
<p class="phpdocumentor-summary">Returns fields allowable by api.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api_get_fields</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$entity</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$unique</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">FALSE</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entity</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>String Entity to query.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$unique</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
= <span class="phpdocumentor-signature__argument__default-value">FALSE</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Index by unique fields?.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
= <span class="phpdocumentor-signature__argument__default-value">[]</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api_get_custom_fields">
_civicrm_api_get_custom_fields()
<a href="namespaces/default.html#function__civicrm_api_get_custom_fields" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/utils.php"><a href="files/api-v3-utils.html"><abbr title="api/v3/utils.php">utils.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1962</span>
</aside>
<p class="phpdocumentor-summary">Return an array of fields for a given entity.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api_get_custom_fields</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$entity</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>This is the same as the BAO function but fields are prefixed with 'custom_' to represent api params.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entity</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_swap_out_aliases">
_civicrm_api3_swap_out_aliases()
<a href="namespaces/default.html#function__civicrm_api3_swap_out_aliases" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/utils.php"><a href="files/api-v3-utils.html"><abbr title="api/v3/utils.php">utils.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">2004</span>
</aside>
<p class="phpdocumentor-summary">Fill params array with alternate (alias) values where a field has an alias and that is filled & the main field isn't.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_swap_out_aliases</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$apiRequest</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$fields</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>If multiple aliases the last takes precedence</p>
<p>Function also swaps unique fields for non-unique fields & vice versa.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$apiRequest</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fields</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_validate_integer">
_civicrm_api3_validate_integer()
<a href="namespaces/default.html#function__civicrm_api3_validate_integer" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/utils.php"><a href="files/api-v3-utils.html"><abbr title="api/v3/utils.php">utils.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">2056</span>
</aside>
<p class="phpdocumentor-summary">Validate integer fields being passed into API.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_validate_integer</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$fieldName</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$fieldInfo</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$entity</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>It currently converts the incoming value 'user_contact_id' into the id of the currently logged in user.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Params from civicrm_api.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fieldName</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Uniquename of field being checked.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fieldInfo</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of fields from getfields function.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entity</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_validate_integer#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_resolve_country_id">
_civicrm_api3_resolve_country_id()
<a href="namespaces/default.html#function__civicrm_api3_resolve_country_id" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/utils.php"><a href="files/api-v3-utils.html"><abbr title="api/v3/utils.php">utils.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">2132</span>
</aside>
<p class="phpdocumentor-summary">Helper function to determine country_id given the myriad of values for country_id or country that are supported</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_resolve_country_id</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int|null</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">int|null</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_resolve_contactID">
_civicrm_api3_resolve_contactID()
<a href="namespaces/default.html#function__civicrm_api3_resolve_contactID" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/utils.php"><a href="files/api-v3-utils.html"><abbr title="api/v3/utils.php">utils.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">2179</span>
</aside>
<p class="phpdocumentor-summary">Determine a contact ID using a string expression.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_resolve_contactID</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$contactIdExpr</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int|null|"unknown-user"</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$contactIdExpr</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>E.g. "user_contact_id" or "@user:username".</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_resolve_contactID#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">int|null|"unknown-user"</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_validate_html">
_civicrm_api3_validate_html()
<a href="namespaces/default.html#function__civicrm_api3_validate_html" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/utils.php"><a href="files/api-v3-utils.html"><abbr title="api/v3/utils.php">utils.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">2211</span>
</aside>
<p class="phpdocumentor-summary">Validate html (check for scripting attack).</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_validate_html</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$fieldName</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$fieldInfo</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fieldName</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fieldInfo</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_validate_html#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_validate_string">
_civicrm_api3_validate_string()
<a href="namespaces/default.html#function__civicrm_api3_validate_string" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/utils.php"><a href="files/api-v3-utils.html"><abbr title="api/v3/utils.php">utils.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">2233</span>
</aside>
<p class="phpdocumentor-summary">Validate string fields being passed into API.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_validate_string</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$fieldName</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$fieldInfo</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$entity</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$action</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Params from civicrm_api.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fieldName</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Uniquename of field being checked.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fieldInfo</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of fields from getfields function.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entity</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$action</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_validate_string#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\Exception">Exception</abbr></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_api_match_pseudoconstant">
_civicrm_api3_api_match_pseudoconstant()
<a href="namespaces/default.html#function__civicrm_api3_api_match_pseudoconstant" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/utils.php"><a href="files/api-v3-utils.html"><abbr title="api/v3/utils.php">utils.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">2292</span>
</aside>
<p class="phpdocumentor-summary">Validate & swap out any pseudoconstants / options.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_api_match_pseudoconstant</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$fieldValue</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$entity</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$fieldName</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$fieldInfo</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$op</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">'='</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$additional_lookup_params</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fieldValue</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entity</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>: api entity name</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fieldName</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>: field name used in api call (not necessarily the canonical name)</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fieldInfo</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>: getfields meta-data</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$op</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">'='</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$additional_lookup_params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
= <span class="phpdocumentor-signature__argument__default-value">[]</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_api_match_pseudoconstant#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_api_match_pseudoconstant_value">
_civicrm_api3_api_match_pseudoconstant_value()
<a href="namespaces/default.html#function__civicrm_api3_api_match_pseudoconstant_value" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/utils.php"><a href="files/api-v3-utils.html"><abbr title="api/v3/utils.php">utils.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">2346</span>
</aside>
<p class="phpdocumentor-summary">Validate & swap a single option value for a field.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_api_match_pseudoconstant_value</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$options</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$fieldName</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$isRequired</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$value</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>field value</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$options</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>array of options for this field</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fieldName</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>field name used in api call (not necessarily the canonical name)</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$isRequired</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Is this a required field or is 'null' an acceptable option. We allow 'null' last
in case we have the weird situation of it being a valid option in which case our
brains will probably explode.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_api_match_pseudoconstant_value#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_api_resolve_alias">
_civicrm_api3_api_resolve_alias()
<a href="namespaces/default.html#function__civicrm_api3_api_resolve_alias" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/utils.php"><a href="files/api-v3-utils.html"><abbr title="api/v3/utils.php">utils.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">2414</span>
</aside>
<p class="phpdocumentor-summary">Returns the canonical name of a field.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_api_resolve_alias</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$entity</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$fieldName</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$action</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">'create'</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool|string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entity</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>api entity name (string should already be standardized - no camelCase).</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fieldName</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>any variation of a field's name (name, unique_name, api.alias).</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$action</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">'create'</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool|string</span>
—
<section class="phpdocumentor-description"><p>FieldName or FALSE if the field does not exist</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_deprecation_check">
_civicrm_api3_deprecation_check()
<a href="namespaces/default.html#function__civicrm_api3_deprecation_check" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/utils.php"><a href="files/api-v3-utils.html"><abbr title="api/v3/utils.php">utils.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">2458</span>
</aside>
<p class="phpdocumentor-summary">Check if the function is deprecated.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_deprecation_check</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$entity</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$result</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string|array<string|int, mixed>|null</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entity</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$result</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
= <span class="phpdocumentor-signature__argument__default-value">[]</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string|array<string|int, mixed>|null</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_field_value_check">
_civicrm_api3_field_value_check()
<a href="namespaces/default.html#function__civicrm_api3_field_value_check" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/utils.php"><a href="files/api-v3-utils.html"><abbr title="api/v3/utils.php">utils.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">2480</span>
</aside>
<p class="phpdocumentor-summary">Get the actual field value.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_field_value_check</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$fieldName</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$type</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>In some case $params[$fieldName] holds Array value in this format Array([operator] => [value])
So this function returns the actual field value.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fieldName</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$type</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_basic_array_get">
_civicrm_api3_basic_array_get()
<a href="namespaces/default.html#function__civicrm_api3_basic_array_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/utils.php"><a href="files/api-v3-utils.html"><abbr title="api/v3/utils.php">utils.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">2512</span>
</aside>
<p class="phpdocumentor-summary">A generic "get" API based on simple array data. This is comparable to
_civicrm_api3_basic_get but does not use DAO/BAO. This is useful for
small/mid-size data loaded from external JSON or XML documents.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_basic_array_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$entity</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$records</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$idCol</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$filterableFields</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entity</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>API parameters.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$records</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>List of all records.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$idCol</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The property which defines the ID of a record</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$filterableFields</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>List of filterable fields.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_basic_array_get#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_check_edit_permissions">
_civicrm_api3_check_edit_permissions()
<a href="namespaces/default.html#function__civicrm_api3_check_edit_permissions" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/utils.php"><a href="files/api-v3-utils.html"><abbr title="api/v3/utils.php">utils.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">2626</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_check_edit_permissions</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$bao_name</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$bao_name</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_check_edit_permissions#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/Civi-API-Exception-UnauthorizedException.html"><abbr title="\Civi\API\Exception\UnauthorizedException">UnauthorizedException</abbr></a></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_compare_timestamps">
_civicrm_api3_compare_timestamps()
<a href="namespaces/default.html#function__civicrm_api3_compare_timestamps" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/utils.php"><a href="files/api-v3-utils.html"><abbr title="api/v3/utils.php">utils.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">2656</span>
</aside>
<p class="phpdocumentor-summary">Check if an entity has been modified since the last known modified_date</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_compare_timestamps</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$modifiedDate</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$id</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$entity</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$modifiedDate</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Last knowm modified_date</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$id</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Id of record to check</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entity</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>API Entity</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_compare_timestamps#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_website_create">
civicrm_api3_website_create()
<a href="namespaces/default.html#function_civicrm_api3_website_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Website.php"><a href="files/api-v3-website.html"><abbr title="api/v3/Website.php">Website.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">26</span>
</aside>
<p class="phpdocumentor-summary">Add an Website for a contact.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_website_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_website_create_spec">
_civicrm_api3_website_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_website_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Website.php"><a href="files/api-v3-website.html"><abbr title="api/v3/Website.php">Website.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">38</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_website_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_website_delete">
civicrm_api3_website_delete()
<a href="namespaces/default.html#function_civicrm_api3_website_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Website.php"><a href="files/api-v3-website.html"><abbr title="api/v3/Website.php">Website.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">51</span>
</aside>
<p class="phpdocumentor-summary">Deletes an existing Website.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_website_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_website_delete#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_website_get">
civicrm_api3_website_get()
<a href="namespaces/default.html#function_civicrm_api3_website_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/Website.php"><a href="files/api-v3-website.html"><abbr title="api/v3/Website.php">Website.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">63</span>
</aside>
<p class="phpdocumentor-summary">Retrieve one or more websites.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_website_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_word_replacement_get">
civicrm_api3_word_replacement_get()
<a href="namespaces/default.html#function_civicrm_api3_word_replacement_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/WordReplacement.php"><a href="files/api-v3-wordreplacement.html"><abbr title="api/v3/WordReplacement.php">WordReplacement.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">29</span>
</aside>
<p class="phpdocumentor-summary">Get CiviCRM Word Replacement details.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_word_replacement_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_word_replacement_get#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_word_replacement_create">
civicrm_api3_word_replacement_create()
<a href="namespaces/default.html#function_civicrm_api3_word_replacement_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/WordReplacement.php"><a href="files/api-v3-wordreplacement.html"><abbr title="api/v3/WordReplacement.php">WordReplacement.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">40</span>
</aside>
<p class="phpdocumentor-summary">Create a new Word Replacement.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_word_replacement_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_word_replacement_create_spec">
_civicrm_api3_word_replacement_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_word_replacement_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/WordReplacement.php"><a href="files/api-v3-wordreplacement.html"><abbr title="api/v3/WordReplacement.php">WordReplacement.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">52</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_word_replacement_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_word_replacement_delete">
civicrm_api3_word_replacement_delete()
<a href="namespaces/default.html#function_civicrm_api3_word_replacement_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="api/v3/WordReplacement.php"><a href="files/api-v3-wordreplacement.html"><abbr title="api/v3/WordReplacement.php">WordReplacement.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">67</span>
</aside>
<p class="phpdocumentor-summary">Delete an existing WordReplacement.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_word_replacement_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array containing id of the WordReplacement to be deleted.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_run">
run()
<a href="namespaces/default.html#function_run" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="bin/migrate/export.php"><a href="files/bin-migrate-export.html"><abbr title="bin/migrate/export.php">export.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">17</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">run</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_run#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">copyright</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>CiviCRM LLC https://civicrm.org/licensing</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_run">
run()
<a href="namespaces/default.html#function_run" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="bin/migrate/exportJSON.php"><a href="files/bin-migrate-exportjson.html"><abbr title="bin/migrate/exportJSON.php">exportJSON.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">17</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">run</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_run#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">copyright</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>CiviCRM LLC https://civicrm.org/licensing</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_run">
run()
<a href="namespaces/default.html#function_run" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="bin/migrate/import.php"><a href="files/bin-migrate-import.html"><abbr title="bin/migrate/import.php">import.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">17</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">run</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_run#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">copyright</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>CiviCRM LLC https://civicrm.org/licensing</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_run">
run()
<a href="namespaces/default.html#function_run" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="bin/migrate/importJSON.php"><a href="files/bin-migrate-importjson.html"><abbr title="bin/migrate/importJSON.php">importJSON.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">17</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">run</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_run#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">copyright</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>CiviCRM LLC https://civicrm.org/licensing</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_run">
run()
<a href="namespaces/default.html#function_run" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="bin/migrate/move.php"><a href="files/bin-migrate-move.html"><abbr title="bin/migrate/move.php">move.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">17</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">run</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_run#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">copyright</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>CiviCRM LLC https://civicrm.org/licensing</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_permissions">
_civicrm_api3_permissions()
<a href="namespaces/default.html#function__civicrm_api3_permissions" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/DAO/permissions.php"><a href="files/crm-core-dao-permissions.html"><abbr title="CRM/Core/DAO/permissions.php">permissions.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">22</span>
</aside>
<p class="phpdocumentor-summary">Decide what permissions to check for an api call</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_permissions</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$entity</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$action</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entity</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>api entity</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$action</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>api action</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>api params</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array of permissions to check for this entity-action combo</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_smarty_block_crmButton">
smarty_block_crmButton()
<a href="namespaces/default.html#function_smarty_block_crmButton" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/plugins/block.crmButton.php"><a href="files/crm-core-smarty-plugins-block-crmbutton.html"><abbr title="CRM/Core/Smarty/plugins/block.crmButton.php">block.crmButton.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">33</span>
</aside>
<p class="phpdocumentor-summary">Generate the html for a button-style link</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">smarty_block_crmButton</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$text</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-Smarty.html"><abbr title="\CRM_Core_Smarty">CRM_Core_Smarty</abbr></a> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$smarty</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$repeat</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string|null</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Params of the {crmButton} call.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$text</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Contents of block.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$smarty</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-Smarty.html"><abbr title="\CRM_Core_Smarty">CRM_Core_Smarty</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The Smarty object.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$repeat</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Repeat is true for the opening tag, false for the closing tag</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string|null</span>
—
<section class="phpdocumentor-description"><p>The generated html.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_smarty_block_crmPermission">
smarty_block_crmPermission()
<a href="namespaces/default.html#function_smarty_block_crmPermission" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/plugins/block.crmPermission.php"><a href="files/crm-core-smarty-plugins-block-crmpermission.html"><abbr title="CRM/Core/Smarty/plugins/block.crmPermission.php">block.crmPermission.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">33</span>
</aside>
<p class="phpdocumentor-summary">Show block conditionally, based on the permission</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">smarty_block_crmPermission</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$content</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-Smarty.html"><abbr title="\CRM_Core_Smarty">CRM_Core_Smarty</abbr></a> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$smarty</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$repeat</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<section class="phpdocumentor-description"><p>/**</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array containing the permission/s to check and optional contact ID.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$content</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$smarty</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-Smarty.html"><abbr title="\CRM_Core_Smarty">CRM_Core_Smarty</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The Smarty object.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$repeat</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Repeat is true for the opening tag, false for the closing tag</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_smarty_block_crmPermission#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">noinspection</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>PhpUnused</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
—
<section class="phpdocumentor-description"><p>The content in the black, if allowed.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_smarty_block_crmRegion">
smarty_block_crmRegion()
<a href="namespaces/default.html#function_smarty_block_crmRegion" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/plugins/block.crmRegion.php"><a href="files/crm-core-smarty-plugins-block-crmregion.html"><abbr title="CRM/Core/Smarty/plugins/block.crmRegion.php">block.crmRegion.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">19</span>
</aside>
<p class="phpdocumentor-summary">Smarty block function for defining content-regions which can be dynamically-altered</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">smarty_block_crmRegion</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$content</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-Smarty.html"><abbr title="\CRM_Core_Smarty">CRM_Core_Smarty</abbr></a> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$smarty</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$repeat</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Must define 'name'.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$content</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Default content.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$smarty</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-Smarty.html"><abbr title="\CRM_Core_Smarty">CRM_Core_Smarty</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The Smarty object.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$repeat</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_smarty_block_crmRegion#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\CRM_Core_Regions">CRM_Core_Regions</abbr></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_smarty_block_crmScope">
smarty_block_crmScope()
<a href="namespaces/default.html#function_smarty_block_crmScope" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/plugins/block.crmScope.php"><a href="files/crm-core-smarty-plugins-block-crmscope.html"><abbr title="CRM/Core/Smarty/plugins/block.crmScope.php">block.crmScope.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">29</span>
</aside>
<p class="phpdocumentor-summary">Smarty block function to temporarily define variables.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">smarty_block_crmScope</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$content</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><abbr title="\Smarty_Internal_Template">Smarty_Internal_Template</abbr> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$smarty</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$repeat</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<section class="phpdocumentor-description"><p>Example:</p>
<pre class="prettyprint"><code class="prettyprint">{tsScope x=1}
Expect {$x}==1
{tsScope x=2}
Expect {$x}==2
{/tsScope}
Expect {$x}==1
{/tsScope}
</code></pre>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Must define 'name'.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$content</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Default content.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$smarty</span>
: <span class="phpdocumentor-signature__argument__return-type"><abbr title="\Smarty_Internal_Template">Smarty_Internal_Template</abbr></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The Smarty object.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$repeat</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_smarty_block_crmUpgradeSnapshot">
smarty_block_crmUpgradeSnapshot()
<a href="namespaces/default.html#function_smarty_block_crmUpgradeSnapshot" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/plugins/block.crmUpgradeSnapshot.php"><a href="files/crm-core-smarty-plugins-block-crmupgradesnapshot.html"><abbr title="CRM/Core/Smarty/plugins/block.crmUpgradeSnapshot.php">block.crmUpgradeSnapshot.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">40</span>
</aside>
<p class="phpdocumentor-summary">Generate a pre-upgrade data-snapshot -- if the local policy supports them.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">smarty_block_crmUpgradeSnapshot</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string|null </span><span class="phpdocumentor-signature__argument__name">$text</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-Smarty.html"><abbr title="\CRM_Core_Smarty">CRM_Core_Smarty</abbr></a> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$smarty</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$repeat</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string|null</span></code>
<section class="phpdocumentor-description"><p>(Rule of thumb: Small databases enable snapshots. Large databases and multi-lingual
databases do not. Some sysadmins may force-enable or force-disable snapshots.)</p>
<p>Example: Before modifying <code class="prettyprint">civicrm_foobar.some_field</code>, make a snapshot of that column</p>
<p>{crmUpgradeSnapshot name=foobar}
SELECT id, some_field FROM civicrm_foobar
{/crmUpgradeSnapshot}
UPDATE civicrm_foobar SET some_field = 999 WHERE some_field = 666;</p>
<p>TIP: If you are modifying a large table (like <code class="prettyprint">civicrm_contact</code> or <code class="prettyprint">civicrm_mailing_event_queue</code>),
then you probably shouldn't use <code class="prettyprint">*.mysql.tpl</code> because it doesn't paginate operations. Similarly,
<code class="prettyprint">{crmUpgradeSnapshot}</code> doesn't paginate. For pagination, use non-Smarty upgrade-tasks.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$text</span>
: <span class="phpdocumentor-signature__argument__return-type">string|null</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The SELECT query which supplies the interesting data to be stored in the snapshot.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$smarty</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-Smarty.html"><abbr title="\CRM_Core_Smarty">CRM_Core_Smarty</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$repeat</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Repeat is true for the opening tag, false for the closing tag</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_smarty_block_crmUpgradeSnapshot#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Upgrade-Snapshot.html"><abbr title="\CRM_Upgrade_Snapshot">CRM_Upgrade_Snapshot</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string|null</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_smarty_block_edit">
smarty_block_edit()
<a href="namespaces/default.html#function_smarty_block_edit" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/plugins/block.edit.php"><a href="files/crm-core-smarty-plugins-block-edit.html"><abbr title="CRM/Core/Smarty/plugins/block.edit.php">block.edit.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">39</span>
</aside>
<p class="phpdocumentor-summary">Smarty block function providing edit-only display support</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">smarty_block_edit</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$text</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-Smarty.html"><abbr title="\CRM_Core_Smarty">CRM_Core_Smarty</abbr></a> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$smarty</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$repeat</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string|null</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Template call's parameters.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$text</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>{edit} block contents from the template.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$smarty</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-Smarty.html"><abbr title="\CRM_Core_Smarty">CRM_Core_Smarty</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The Smarty object.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$repeat</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Repeat is true for the opening tag, false for the closing tag</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string|null</span>
—
<section class="phpdocumentor-description"><p>the string, translated by gettext</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_smarty_block_htxt">
smarty_block_htxt()
<a href="namespaces/default.html#function_smarty_block_htxt" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/plugins/block.htxt.php"><a href="files/crm-core-smarty-plugins-block-htxt.html"><abbr title="CRM/Core/Smarty/plugins/block.htxt.php">block.htxt.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">35</span>
</aside>
<p class="phpdocumentor-summary">Smarty block function providing support for
CiviCRM's helptext mechanism</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">smarty_block_htxt</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$text</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-Smarty.html"><abbr title="\CRM_Core_Smarty">CRM_Core_Smarty</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$smarty</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$repeat</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string|null</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Template call's parameters.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$text</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>{ts} block contents from the template.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$smarty</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-Smarty.html"><abbr title="\CRM_Core_Smarty">CRM_Core_Smarty</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The Smarty object.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$repeat</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Repeat is true for the opening tag, false for the closing tag</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string|null</span>
—
<section class="phpdocumentor-description"><p>the string, translated by gettext</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_smarty_block_icon">
smarty_block_icon()
<a href="namespaces/default.html#function_smarty_block_icon" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/plugins/block.icon.php"><a href="files/crm-core-smarty-plugins-block-icon.html"><abbr title="CRM/Core/Smarty/plugins/block.icon.php">block.icon.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">38</span>
</aside>
<p class="phpdocumentor-summary">Display an icon with some alternative text.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">smarty_block_icon</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$text</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$smarty</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$repeat</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string|null</span></code>
<section class="phpdocumentor-description"><p>This is a wrapper around CRM_Core_Page::icon().</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>condition: if present and falsey, return empty</li>
<li>icon: the icon class to display instead of fa-check</li>
<li>anything else is passed along as attributes for the icon</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$text</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The translated text to include in the icon's title and screen-reader text.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$smarty</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$repeat</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Repeat is true for the opening tag, false for the closing tag</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string|null</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_smarty_block_localize">
smarty_block_localize()
<a href="namespaces/default.html#function_smarty_block_localize" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/plugins/block.localize.php"><a href="files/crm-core-smarty-plugins-block-localize.html"><abbr title="CRM/Core/Smarty/plugins/block.localize.php">block.localize.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">36</span>
</aside>
<p class="phpdocumentor-summary">Smarty block function for multilingualizing upgrade SQL queries.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">smarty_block_localize</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$text</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-Smarty.html"><abbr title="\CRM_Core_Smarty">CRM_Core_Smarty</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$smarty</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$repeat</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<section class="phpdocumentor-description"><p>The string passed in $text is repeated locale-number times, with the
param field (if provided) appended with a different locale every time.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Template call's parameters.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$text</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>{ts} block contents from the template.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$smarty</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-Smarty.html"><abbr title="\CRM_Core_Smarty">CRM_Core_Smarty</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The Smarty object.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$repeat</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Confusing variable that means it's either the opening tag or you can use
it to signal back not to repeat.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
—
<section class="phpdocumentor-description"><p>multilingualized query</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_smarty_block_ts">
smarty_block_ts()
<a href="namespaces/default.html#function_smarty_block_ts" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/plugins/block.ts.php"><a href="files/crm-core-smarty-plugins-block-ts.html"><abbr title="CRM/Core/Smarty/plugins/block.ts.php">block.ts.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">38</span>
</aside>
<p class="phpdocumentor-summary">Smarty block function providing gettext support</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">smarty_block_ts</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$text</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-Smarty.html"><abbr title="\CRM_Core_Smarty">CRM_Core_Smarty</abbr></a> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$smarty</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$repeat</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string|null</span></code>
<section class="phpdocumentor-description"><p>See CRM_Core_I18n class documentation for details.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Template call's parameters.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$text</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>{ts} block contents from the template.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$smarty</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-Smarty.html"><abbr title="\CRM_Core_Smarty">CRM_Core_Smarty</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The Smarty object.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$repeat</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Repeat is true for the opening tag, false for the closing tag</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string|null</span>
—
<section class="phpdocumentor-description"><p>the string, translated by gettext</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_smarty_block_url">
smarty_block_url()
<a href="namespaces/default.html#function_smarty_block_url" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/plugins/block.url.php"><a href="files/crm-core-smarty-plugins-block-url.html"><abbr title="CRM/Core/Smarty/plugins/block.url.php">block.url.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">42</span>
</aside>
<p class="phpdocumentor-summary">Generate a URL. This is thin wrapper for the Civi::url() helper.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">smarty_block_url</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$text</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-Smarty.html"><abbr title="\CRM_Core_Smarty">CRM_Core_Smarty</abbr></a> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$smarty</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$repeat</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The following parameters have specific meanings:</p>
<ul>
<li>"assign" (string) - Assign output to a Smarty variable</li>
<li>"flags" (string) - List of options, as per <code class="prettyprint">Civi::url(...$flags)</code>
All other parameters will be passed-through as variables for the URL.</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$text</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Contents of block.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$smarty</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-Smarty.html"><abbr title="\CRM_Core_Smarty">CRM_Core_Smarty</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The Smarty object.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$repeat</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Repeat is true for the opening tag, false for the closing tag</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_smarty_block_url#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/Civi.html#method_url"><abbr title="\Civi::url()">Civi::url()</abbr></a></span>
<section class="phpdocumentor-description"><p>Ex: Generate a backend URL.
{url}backend://civicrm/admin?reset=1{/url}</p>
<p>Ex: Generate a backend URL. Assign it to a Smarty variable.
{url assign=tmpVar}backend://civicrm/admin?reset=1{/url}</p>
<p>Ex: Generate a backend URL. Set optional flags: (t)ext, (s)sl, (a)bsolute.
{url flags=tsa}backend://civicrm/admin?reset=1{/url}</p>
<p>Ex: Generate a URL in the current (active) routing scheme. Add named variables. (Values are escaped).
{url verb="Eat" target="Apples and bananas"}//civicrm/fruit?method=[verb]&data=[target]{/url}</p>
<p>Ex: As above, but use numerical variables.
{url 1="Eat" 2="Apples and bananas"}//civicrm/fruit?method=[1]&data=[2]{/url}</p>
<p>Ex: Generate a URL. Add some pre-escaped variables using Smarty {$foo}.
{assign var=myEscapedAction value="Eat"}
{assign var=myEscapedData value="Apples+and+bananas"}
{url}//civicrm/fruit?method={$myEscapedAction}&data={$myEscapedData}{/url}</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_smarty_compiler_continue">
smarty_compiler_continue()
<a href="namespaces/default.html#function_smarty_compiler_continue" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/plugins/compiler.continue.php"><a href="files/crm-core-smarty-plugins-compiler-continue.html"><abbr title="CRM/Core/Smarty/plugins/compiler.continue.php">compiler.continue.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">9</span>
</aside>
<p class="phpdocumentor-summary">Skip remaining logic in the current iteration of a loop.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">smarty_compiler_continue</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$contents</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$smarty</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$contents</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$smarty</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_smarty_function_copyIcon">
smarty_function_copyIcon()
<a href="namespaces/default.html#function_smarty_function_copyIcon" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/plugins/function.copyIcon.php"><a href="files/crm-core-smarty-plugins-function-copyicon.html"><abbr title="CRM/Core/Smarty/plugins/function.copyIcon.php">function.copyIcon.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">29</span>
</aside>
<p class="phpdocumentor-summary">Display a copy icon that copies the first row's values down.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">smarty_function_copyIcon</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$smarty</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>name: the field name</li>
<li>title: the field title</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$smarty</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_smarty_function_crmAPI">
smarty_function_crmAPI()
<a href="namespaces/default.html#function_smarty_function_crmAPI" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/plugins/function.crmAPI.php"><a href="files/crm-core-smarty-plugins-function-crmapi.html"><abbr title="CRM/Core/Smarty/plugins/function.crmAPI.php">function.crmAPI.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">24</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">smarty_function_crmAPI</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$smarty</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string|void</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$smarty</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string|void</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_smarty_function_crmAttributes">
smarty_function_crmAttributes()
<a href="namespaces/default.html#function_smarty_function_crmAttributes" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/plugins/function.crmAttributes.php"><a href="files/crm-core-smarty-plugins-function-crmattributes.html"><abbr title="CRM/Core/Smarty/plugins/function.crmAttributes.php">function.crmAttributes.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">28</span>
</aside>
<p class="phpdocumentor-summary">Formats an array of attributes as html</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">smarty_function_crmAttributes</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-Smarty.html"><abbr title="\CRM_Core_Smarty">CRM_Core_Smarty</abbr></a> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$smarty</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>['a'] array of attributes.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$smarty</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-Smarty.html"><abbr title="\CRM_Core_Smarty">CRM_Core_Smarty</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_smarty_function_crmCrudLink">
smarty_function_crmCrudLink()
<a href="namespaces/default.html#function_smarty_function_crmCrudLink" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/plugins/function.crmCrudLink.php"><a href="files/crm-core-smarty-plugins-function-crmcrudlink.html"><abbr title="CRM/Core/Smarty/plugins/function.crmCrudLink.php">function.crmCrudLink.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">31</span>
</aside>
<p class="phpdocumentor-summary">Dynamically construct a link based on an entity-type and entity-id.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">smarty_function_crmCrudLink</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-Smarty.html"><abbr title="\CRM_Core_Smarty">CRM_Core_Smarty</abbr></a> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$smarty</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array with keys:</p>
<ul>
<li>entity|table: string</li>
<li>id: int</li>
<li>action: string, 'view', 'update', 'delete', etc [default: view]</li>
<li>title: string [optionally override default title]</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$smarty</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-Smarty.html"><abbr title="\CRM_Core_Smarty">CRM_Core_Smarty</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_smarty_function_crmGetAttribute">
smarty_function_crmGetAttribute()
<a href="namespaces/default.html#function_smarty_function_crmGetAttribute" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/plugins/function.crmGetAttribute.php"><a href="files/crm-core-smarty-plugins-function-crmgetattribute.html"><abbr title="CRM/Core/Smarty/plugins/function.crmGetAttribute.php">function.crmGetAttribute.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">27</span>
</aside>
<p class="phpdocumentor-summary">Fetch an attribute from html</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">smarty_function_crmGetAttribute</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-Smarty.html"><abbr title="\CRM_Core_Smarty">CRM_Core_Smarty</abbr></a> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$smarty</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$smarty</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-Smarty.html"><abbr title="\CRM_Core_Smarty">CRM_Core_Smarty</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_smarty_function_crmKey">
smarty_function_crmKey()
<a href="namespaces/default.html#function_smarty_function_crmKey" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/plugins/function.crmKey.php"><a href="files/crm-core-smarty-plugins-function-crmkey.html"><abbr title="CRM/Core/Smarty/plugins/function.crmKey.php">function.crmKey.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">29</span>
</aside>
<p class="phpdocumentor-summary">Generate a CRM_Core_Key of a given name</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">smarty_function_crmKey</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-Smarty.html"><abbr title="\CRM_Core_Smarty">CRM_Core_Smarty</abbr></a> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$smarty</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Params of the {crmKey} call, with the ‘name’ key holding the name of the key.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$smarty</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-Smarty.html"><abbr title="\CRM_Core_Smarty">CRM_Core_Smarty</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The Smarty object.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
—
<section class="phpdocumentor-description"><p>the generated key</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_smarty_function_crmResPath">
smarty_function_crmResPath()
<a href="namespaces/default.html#function_smarty_function_crmResPath" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/plugins/function.crmResPath.php"><a href="files/crm-core-smarty-plugins-function-crmrespath.html"><abbr title="CRM/Core/Smarty/plugins/function.crmResPath.php">function.crmResPath.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">33</span>
</aside>
<p class="phpdocumentor-summary">Determine the path of a resource file</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">smarty_function_crmResPath</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-Smarty.html"><abbr title="\CRM_Core_Smarty">CRM_Core_Smarty</abbr></a> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$smarty</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Identify the resource by either 'ext'+'file' or 'expr'.</p>
<p>Array with keys:</p>
<ul>
<li>ext: string, extension name. see CRM_Core_Resources::getPath</li>
<li>file: string, relative file path. see CRM_Core_Resources::getPath</li>
<li>expr: string, a dynamic path expression. See: \Civi\Core\Paths::getPath()</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$smarty</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-Smarty.html"><abbr title="\CRM_Core_Smarty">CRM_Core_Smarty</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_smarty_function_crmResURL">
smarty_function_crmResURL()
<a href="namespaces/default.html#function_smarty_function_crmResURL" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/plugins/function.crmResURL.php"><a href="files/crm-core-smarty-plugins-function-crmresurl.html"><abbr title="CRM/Core/Smarty/plugins/function.crmResURL.php">function.crmResURL.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">33</span>
</aside>
<p class="phpdocumentor-summary">Determine the URL of a resource file</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">smarty_function_crmResURL</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-Smarty.html"><abbr title="\CRM_Core_Smarty">CRM_Core_Smarty</abbr></a> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$smarty</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Identify the resource by either 'ext'+'file' or 'expr'.</p>
<p>Array with keys:</p>
<ul>
<li>ext: string, extension name. see CRM_Core_Resources::getUrl</li>
<li>file: string, relative file path. see CRM_Core_Resources::getUrl</li>
<li>expr: string, a dynamic path expression. See: \Civi\Core\Paths::getUrl()</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$smarty</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-Smarty.html"><abbr title="\CRM_Core_Smarty">CRM_Core_Smarty</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_smarty_function_crmScript">
smarty_function_crmScript()
<a href="namespaces/default.html#function_smarty_function_crmScript" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/plugins/function.crmScript.php"><a href="files/crm-core-smarty-plugins-function-crmscript.html"><abbr title="CRM/Core/Smarty/plugins/function.crmScript.php">function.crmScript.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">33</span>
</aside>
<p class="phpdocumentor-summary">Add a Javascript file to a specific part of the page</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">smarty_function_crmScript</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-Smarty.html"><abbr title="\CRM_Core_Smarty">CRM_Core_Smarty</abbr></a> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$smarty</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array with keys:</p>
<ul>
<li>ext: string, extension name. see CRM_Core_Resources::addScriptFile</li>
<li>file: string, relative file path. see CRM_Core_Resources::addScriptFile</li>
<li>url: string. see CRM_Core_Resources::addScriptURL</li>
<li>weight: int; default: CRM_Core_Resources::DEFAULT_WEIGHT (0)</li>
<li>region: string; default: CRM_Core_Resources::DEFAULT_REGION ('html-header')</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$smarty</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-Smarty.html"><abbr title="\CRM_Core_Smarty">CRM_Core_Smarty</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_smarty_function_crmScript#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\Exception">Exception</abbr></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_smarty_function_crmSetting">
smarty_function_crmSetting()
<a href="namespaces/default.html#function_smarty_function_crmSetting" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/plugins/function.crmSetting.php"><a href="files/crm-core-smarty-plugins-function-crmsetting.html"><abbr title="CRM/Core/Smarty/plugins/function.crmSetting.php">function.crmSetting.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">27</span>
</aside>
<p class="phpdocumentor-summary">Retrieve CiviCRM settings from the api for use in templates.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">smarty_function_crmSetting</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$smarty</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int|string|null</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$smarty</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">int|string|null</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_smarty_function_crmSigner">
smarty_function_crmSigner()
<a href="namespaces/default.html#function_smarty_function_crmSigner" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/plugins/function.crmSigner.php"><a href="files/crm-core-smarty-plugins-function-crmsigner.html"><abbr title="CRM/Core/Smarty/plugins/function.crmSigner.php">function.crmSigner.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">34</span>
</aside>
<p class="phpdocumentor-summary">Generate a secure signature</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">smarty_function_crmSigner</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$smarty</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>{code}
{crmSigner var=mySig extra=123}
var urlParams = ts={$mySig.ts}&extra={$mySig.extra}&sig={$mySig.signature}
{endcode}</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array with keys:</p>
<ul>
<li>var: string, a smarty variable to generate</li>
<li>ts: int, the current time (if omitted, autogenerated)</li>
<li>any other vars are put into the signature (sorted)</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$smarty</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_smarty_function_crmStyle">
smarty_function_crmStyle()
<a href="namespaces/default.html#function_smarty_function_crmStyle" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/plugins/function.crmStyle.php"><a href="files/crm-core-smarty-plugins-function-crmstyle.html"><abbr title="CRM/Core/Smarty/plugins/function.crmStyle.php">function.crmStyle.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">33</span>
</aside>
<p class="phpdocumentor-summary">Add a stylesheet <LINK> to a specific part of the page</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">smarty_function_crmStyle</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-Smarty.html"><abbr title="\CRM_Core_Smarty">CRM_Core_Smarty</abbr></a> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$smarty</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array with keys:</p>
<ul>
<li>ext: string, extension name. see CRM_Core_Resources::addStyleFile</li>
<li>file: string, relative file path. see CRM_Core_Resources::addStyleFile</li>
<li>url: string. see CRM_Core_Resources::addStyleURL</li>
<li>weight: int; default: CRM_Core_Resources::DEFAULT_WEIGHT (0)</li>
<li>region: string; default: CRM_Core_Resources::DEFAULT_REGION ('html-header')</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$smarty</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-Smarty.html"><abbr title="\CRM_Core_Smarty">CRM_Core_Smarty</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_smarty_function_crmStyle#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\Exception">Exception</abbr></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_smarty_function_crmURL">
smarty_function_crmURL()
<a href="namespaces/default.html#function_smarty_function_crmURL" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/plugins/function.crmURL.php"><a href="files/crm-core-smarty-plugins-function-crmurl.html"><abbr title="CRM/Core/Smarty/plugins/function.crmURL.php">function.crmURL.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">48</span>
</aside>
<p class="phpdocumentor-summary">Generate a URL.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">smarty_function_crmURL</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<section class="phpdocumentor-description"><p>Ex: <code class="prettyprint">{crmURL p='civicrm/acl/entityrole' q='reset=1'}</code>
Ex: <code class="prettyprint">{crmURL p='civicrm/profile/create' q='id=123&reset=1' fe=1}</code></p>
<p>Each URL component uses an abbreviation (e.g. "p"<=>"path"; "q"<=>"query").</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>List of URL properties.</p>
<ul>
<li>"p" (string $path)
The path being linked to, such as "civicrm/add".</li>
<li>"q" (array|string $query)
A query string to append to the link, or an array of key-value pairs.</li>
<li>"a" (bool $absolute)
Whether to force the output to be an absolute link (beginning with a
URI-scheme such as 'http:'). Useful for links that will be displayed
outside the site, such as in an RSS feed.</li>
<li>"f" (string $fragment)
A "#" fragment to append to the link. This could a named anchor (as
in <code class="prettyprint">#section2</code>) or a client-side route (as in <code class="prettyprint">#/mailing/new</code>).</li>
<li>"h" (bool $htmlize)
Whether to encode special html characters such as &.</li>
<li>"fe" (bool $frontend)
This link should be to the CMS front end (applies to WP & Joomla).</li>
<li>"fb" (bool $forceBackend)
This link should be to the CMS back end (applies to WP & Joomla).</li>
</ul>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_smarty_function_crmVersion">
smarty_function_crmVersion()
<a href="namespaces/default.html#function_smarty_function_crmVersion" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/plugins/function.crmVersion.php"><a href="files/crm-core-smarty-plugins-function-crmversion.html"><abbr title="CRM/Core/Smarty/plugins/function.crmVersion.php">function.crmVersion.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">33</span>
</aside>
<p class="phpdocumentor-summary">Display the CiviCRM version</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">smarty_function_crmVersion</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$smarty</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<section class="phpdocumentor-description"><pre class="prettyprint"><code class="prettyprint">The version is {crmVersion}.
{crmVersion redact=auto assign=ver}The version is {$ver}.
</code></pre>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$smarty</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_smarty_function_docURL">
smarty_function_docURL()
<a href="namespaces/default.html#function_smarty_function_docURL" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/plugins/function.docURL.php"><a href="files/crm-core-smarty-plugins-function-docurl.html"><abbr title="CRM/Core/Smarty/plugins/function.docURL.php">function.docURL.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">30</span>
</aside>
<p class="phpdocumentor-summary">Given one of: ( page, title, text ) parameters, generates
an HTML link to documentation.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">smarty_function_docURL</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-Smarty.html"><abbr title="\CRM_Core_Smarty">CRM_Core_Smarty</abbr></a> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$smarty</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string|null</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The function params.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$smarty</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-Smarty.html"><abbr title="\CRM_Core_Smarty">CRM_Core_Smarty</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Reference to the smarty object.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string|null</span>
—
<section class="phpdocumentor-description"><p>HTML code of a link to documentation</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_smarty_function_help">
smarty_function_help()
<a href="namespaces/default.html#function_smarty_function_help" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/plugins/function.help.php"><a href="files/crm-core-smarty-plugins-function-help.html"><abbr title="CRM/Core/Smarty/plugins/function.help.php">function.help.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">36</span>
</aside>
<p class="phpdocumentor-summary">Adds inline help.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">smarty_function_help</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><abbr title="\Smarty">Smarty</abbr> </span><span class="phpdocumentor-signature__argument__name">$smarty</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<section class="phpdocumentor-description"><p>This function adds a call to the js function which loads the help text in a pop-up.</p>
<p>It does a lot of work to get the title which it passes into the crmHelp function
but the main reason it gets that title is because it adds that to the css as
title & aria-label. Since it's loaded it somewhat makes sense to pass it into
CRM.help but .. it's confusing.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The function params.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$smarty</span>
: <span class="phpdocumentor-signature__argument__return-type"><abbr title="\Smarty">Smarty</abbr></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Smarty object.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
—
<section class="phpdocumentor-description"><p>the help html to be inserted</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_smarty_function_isValueChange">
smarty_function_isValueChange()
<a href="namespaces/default.html#function_smarty_function_isValueChange" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/plugins/function.isValueChange.php"><a href="files/crm-core-smarty-plugins-function-isvaluechange.html"><abbr title="CRM/Core/Smarty/plugins/function.isValueChange.php">function.isValueChange.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">38</span>
</aside>
<p class="phpdocumentor-summary">Smarty function for checking change in a property's value, for example
when looping through an array.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">smarty_function_isValueChange</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-Smarty.html"><abbr title="\CRM_Core_Smarty">CRM_Core_Smarty</abbr></a> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$smarty</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">null</span></code>
<section class="phpdocumentor-description"><p>Smarty param: string $key unique identifier for this property (REQUIRED)
Smarty param: mixed $value the current value of the property
Smarty param: string $assign name of template variable to which to assign result</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Template call's parameters.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$smarty</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-Smarty.html"><abbr title="\CRM_Core_Smarty">CRM_Core_Smarty</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The Smarty object.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">null</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_smarty_function_privacyFlag">
smarty_function_privacyFlag()
<a href="namespaces/default.html#function_smarty_function_privacyFlag" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/plugins/function.privacyFlag.php"><a href="files/crm-core-smarty-plugins-function-privacyflag.html"><abbr title="CRM/Core/Smarty/plugins/function.privacyFlag.php">function.privacyFlag.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">31</span>
</aside>
<p class="phpdocumentor-summary">Display a banned icon to flag privacy preferences</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">smarty_function_privacyFlag</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$smarty</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>field: the applicable privacy field
(one of CRM_Core_SelectValues::privacy() or <code class="prettyprint">on_hold</code>)</li>
<li>condition: if present and falsey, return empty</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$smarty</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
</section>
</article>
<article class="phpdocumentor-element -function - -deprecated">
<h4 class="phpdocumentor-element__name" id="function_smarty_function_sectionTotal">
smarty_function_sectionTotal()
<a href="namespaces/default.html#function_smarty_function_sectionTotal" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/plugins/function.sectionTotal.php"><a href="files/crm-core-smarty-plugins-function-sectiontotal.html"><abbr title="CRM/Core/Smarty/plugins/function.sectionTotal.php">function.sectionTotal.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">38</span>
</aside>
<p class="phpdocumentor-summary">Smarty block function for printing the correct report section total</p>
<div class="phpdocumentor-admonition">
<svg class="phpdocumentor-admonition__icon" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-3L13.732 4c-.77-1.333-2.694-1.333-3.464 0L3.34 16c-.77 1.333.192 3 1.732 3z"></path></svg>
<article>
<p>This is called from table.tpl but we aim to remove
from there.</p>
</article>
</div>
<code class="phpdocumentor-code phpdocumentor-signature -deprecated">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">smarty_function_sectionTotal</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<section class="phpdocumentor-description"><p>Smarty param: string $key value of the current section column
Smarty param: int $depth the depth of the current section
(sections declared first have lesser depth, starting at 0)</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Template call's parameters.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
—
<section class="phpdocumentor-description"><p>the string, translated by gettext</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_smarty_function_simpleActivityContacts">
smarty_function_simpleActivityContacts()
<a href="namespaces/default.html#function_smarty_function_simpleActivityContacts" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/plugins/function.simpleActivityContacts.php"><a href="files/crm-core-smarty-plugins-function-simpleactivitycontacts.html"><abbr title="CRM/Core/Smarty/plugins/function.simpleActivityContacts.php">function.simpleActivityContacts.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">25</span>
</aside>
<p class="phpdocumentor-summary">Get details for the target and assignee contact of an activity.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">smarty_function_simpleActivityContacts</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-Smarty.html"><abbr title="\CRM_Core_Smarty">CRM_Core_Smarty</abbr></a> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$smarty</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<section class="phpdocumentor-description"><p>This is "simple" in that it is only appropriate for activities in which the business-process
guarantees that there is only one target and one assignee. If the business-process permits
multiple targets or multiple assignees, then consider the more versatile (but less sugary)
function "crmAPI".</p>
<p>Note: This will perform like a dog, but who cares -- at most, we deal with O(100) iterations
as part of a background task.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>, Array with keys:</p>
<ul>
<li>activity_id: int, required</li>
<li>target_var: string, optional; name of a variable which will store the first/only target contact; default "target"</li>
<li>assignee_var: string, optional; name of a variable which will store the first/only assignee contact; default "assignee"</li>
<li>return: string, optional; comma-separated list of fields to return for each contact</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$smarty</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-Smarty.html"><abbr title="\CRM_Core_Smarty">CRM_Core_Smarty</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_smarty_modifier_colorContrast">
smarty_modifier_colorContrast()
<a href="namespaces/default.html#function_smarty_modifier_colorContrast" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/plugins/modifier.colorContrast.php"><a href="files/crm-core-smarty-plugins-modifier-colorcontrast.html"><abbr title="CRM/Core/Smarty/plugins/modifier.colorContrast.php">modifier.colorContrast.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">25</span>
</aside>
<p class="phpdocumentor-summary">Wrapper around CRM_Utils_Color::getContrast</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">smarty_modifier_colorContrast</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$color</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$color</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_smarty_modifier_crmAddClass">
smarty_modifier_crmAddClass()
<a href="namespaces/default.html#function_smarty_modifier_crmAddClass" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/plugins/modifier.crmAddClass.php"><a href="files/crm-core-smarty-plugins-modifier-crmaddclass.html"><abbr title="CRM/Core/Smarty/plugins/modifier.crmAddClass.php">modifier.crmAddClass.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">29</span>
</aside>
<p class="phpdocumentor-summary">Add a class to an html element</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">smarty_modifier_crmAddClass</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$string</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$class</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$string</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The html to be tweaked.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$class</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The new class or classes to add (separate with a space).</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
—
<section class="phpdocumentor-description"><p>the new modified html string</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_smarty_modifier_crmBtnType">
smarty_modifier_crmBtnType()
<a href="namespaces/default.html#function_smarty_modifier_crmBtnType" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/plugins/modifier.crmBtnType.php"><a href="files/crm-core-smarty-plugins-modifier-crmbtntype.html"><abbr title="CRM/Core/Smarty/plugins/modifier.crmBtnType.php">modifier.crmBtnType.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">27</span>
</aside>
<p class="phpdocumentor-summary">Grab the button type from a passed button element 'name' by checking for reserved QF button type strings</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">smarty_modifier_crmBtnType</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$btnName</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$btnName</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
—
<section class="phpdocumentor-description"><p>button type, one of: 'upload', 'next', 'back', 'cancel', 'refresh'
'submit', 'done', 'display', 'jump' 'process'</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_smarty_modifier_crmCountCharacters">
smarty_modifier_crmCountCharacters()
<a href="namespaces/default.html#function_smarty_modifier_crmCountCharacters" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/plugins/modifier.crmCountCharacters.php"><a href="files/crm-core-smarty-plugins-modifier-crmcountcharacters.html"><abbr title="CRM/Core/Smarty/plugins/modifier.crmCountCharacters.php">modifier.crmCountCharacters.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">21</span>
</aside>
<p class="phpdocumentor-summary">Smarty count_characters modifier plugin</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">smarty_modifier_crmCountCharacters</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$string</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$include_spaces</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">FALSE</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
<section class="phpdocumentor-description"><p>Type: modifier<br>
Name: crmCountCharacteres<br>
Purpose: count the number of characters in a text with handling for NULL values</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$string</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$include_spaces</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
= <span class="phpdocumentor-signature__argument__default-value">FALSE</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>include whitespace in the character count</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_smarty_modifier_crmCountCharacters#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="http://smarty.php.net/manual/en/language.modifier.count.characters.php"> <p>count_characters (Smarty online manual)</p>
</a>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">author</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Monte Ohrt <monte at ohrt dot com></p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">int</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_smarty_modifier_crmDate">
smarty_modifier_crmDate()
<a href="namespaces/default.html#function_smarty_modifier_crmDate" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/plugins/modifier.crmDate.php"><a href="files/crm-core-smarty-plugins-modifier-crmdate.html"><abbr title="CRM/Core/Smarty/plugins/modifier.crmDate.php">modifier.crmDate.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">40</span>
</aside>
<p class="phpdocumentor-summary">Convert the date string "YYYY-MM-DD" to "MM<long> DD, YYYY".</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">smarty_modifier_crmDate</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$dateString</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string|null </span><span class="phpdocumentor-signature__argument__name">$dateFormat</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$onlyTime</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">FALSE</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$dateString</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Date which needs to converted to human readable format.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$dateFormat</span>
: <span class="phpdocumentor-signature__argument__return-type">string|null</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>A string per https://www.php.net/manual/en/function.strftime.php or
one of our configured formats name - eg</p>
<ul>
<li>dateformatDatetime</li>
<li>dateformatFull</li>
<li>dateformatPartial</li>
<li>dateformatTime</li>
<li>dateformatYear</li>
<li>dateformatFinancialBatch</li>
<li>dateformatshortdate</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$onlyTime</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
= <span class="phpdocumentor-signature__argument__default-value">FALSE</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
—
<section class="phpdocumentor-description"><p>human readable date format | invalid date message</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_smarty_modifier_crmDelete">
smarty_modifier_crmDelete()
<a href="namespaces/default.html#function_smarty_modifier_crmDelete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/plugins/modifier.crmDelete.php"><a href="files/crm-core-smarty-plugins-modifier-crmdelete.html"><abbr title="CRM/Core/Smarty/plugins/modifier.crmDelete.php">modifier.crmDelete.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">32</span>
</aside>
<p class="phpdocumentor-summary">Replace the value of an attribute in the input string. Assume
the the attribute is well formed, of the type name="value". If
no replacement is mentioned the value is inserted at the end of
the form element</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">smarty_modifier_crmDelete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$string</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$attribute</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$string</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The html to be tweaked with.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$attribute</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The attribute to modify.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
—
<section class="phpdocumentor-description"><p>the new modified html string</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_smarty_modifier_crmFirstWord">
smarty_modifier_crmFirstWord()
<a href="namespaces/default.html#function_smarty_modifier_crmFirstWord" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/plugins/modifier.crmFirstWord.php"><a href="files/crm-core-smarty-plugins-modifier-crmfirstword.html"><abbr title="CRM/Core/Smarty/plugins/modifier.crmFirstWord.php">modifier.crmFirstWord.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">26</span>
</aside>
<p class="phpdocumentor-summary">Replace a string with the first word in the string</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">smarty_modifier_crmFirstWord</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$string</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$string</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The html to be tweaked with.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_smarty_modifier_crmICalDate">
smarty_modifier_crmICalDate()
<a href="namespaces/default.html#function_smarty_modifier_crmICalDate" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/plugins/modifier.crmICalDate.php"><a href="files/crm-core-smarty-plugins-modifier-crmicaldate.html"><abbr title="CRM/Core/Smarty/plugins/modifier.crmICalDate.php">modifier.crmICalDate.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">30</span>
</aside>
<p class="phpdocumentor-summary">Format the given text in an ical suitable format</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">smarty_modifier_crmICalDate</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$str</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$gdata</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">FALSE</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$str</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$gdata</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
= <span class="phpdocumentor-signature__argument__default-value">FALSE</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
—
<section class="phpdocumentor-description"><p>formatted text</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_smarty_modifier_crmICalText">
smarty_modifier_crmICalText()
<a href="namespaces/default.html#function_smarty_modifier_crmICalText" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/plugins/modifier.crmICalText.php"><a href="files/crm-core-smarty-plugins-modifier-crmicaltext.html"><abbr title="CRM/Core/Smarty/plugins/modifier.crmICalText.php">modifier.crmICalText.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">28</span>
</aside>
<p class="phpdocumentor-summary">Format the given text in an ical suitable format</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">smarty_modifier_crmICalText</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$str</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$keep_html</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">FALSE</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$position</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">0</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$str</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$keep_html</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">FALSE</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$position</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">0</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
—
<section class="phpdocumentor-description"><p>formatted text</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_smarty_modifier_crmInsert">
smarty_modifier_crmInsert()
<a href="namespaces/default.html#function_smarty_modifier_crmInsert" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/plugins/modifier.crmInsert.php"><a href="files/crm-core-smarty-plugins-modifier-crminsert.html"><abbr title="CRM/Core/Smarty/plugins/modifier.crmInsert.php">modifier.crmInsert.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">36</span>
</aside>
<p class="phpdocumentor-summary">Replace the value of an attribute in the input string. Assume
the the attribute is well formed, of the type name="value". If
no replacement is mentioned the value is inserted at the end of
the form element</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">smarty_modifier_crmInsert</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$string</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$attribute</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$value</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$insertBefore</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">'/>'</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$string</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The html to be tweaked with.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$attribute</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The attribute to insert.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$value</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The new attribute value.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$insertBefore</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">'/>'</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The string before which we want this tag inserted.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
—
<section class="phpdocumentor-description"><p>the new modified html string</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_smarty_modifier_crmMoney">
smarty_modifier_crmMoney()
<a href="namespaces/default.html#function_smarty_modifier_crmMoney" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/plugins/modifier.crmMoney.php"><a href="files/crm-core-smarty-plugins-modifier-crmmoney.html"><abbr title="CRM/Core/Smarty/plugins/modifier.crmMoney.php">modifier.crmMoney.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">31</span>
</aside>
<p class="phpdocumentor-summary">Format the given monetary amount (and currency) for display</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">smarty_modifier_crmMoney</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string|int|float </span><span class="phpdocumentor-signature__argument__name">$amount</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string|null </span><span class="phpdocumentor-signature__argument__name">$currency</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string|null </span><span class="phpdocumentor-signature__argument__name">$locale</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$amount</span>
: <span class="phpdocumentor-signature__argument__return-type">string|int|float</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The monetary amount up for display.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$currency</span>
: <span class="phpdocumentor-signature__argument__return-type">string|null</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The (optional) currency.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$locale</span>
: <span class="phpdocumentor-signature__argument__return-type">string|null</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The (optional) locale.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
—
<section class="phpdocumentor-description"><p>formatted monetary amount</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_smarty_modifier_crmNumberFormat">
smarty_modifier_crmNumberFormat()
<a href="namespaces/default.html#function_smarty_modifier_crmNumberFormat" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/plugins/modifier.crmNumberFormat.php"><a href="files/crm-core-smarty-plugins-modifier-crmnumberformat.html"><abbr title="CRM/Core/Smarty/plugins/modifier.crmNumberFormat.php">modifier.crmNumberFormat.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">37</span>
</aside>
<p class="phpdocumentor-summary">Add thousands separator to numeric strings using
PHP number_format() function.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">smarty_modifier_crmNumberFormat</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">float </span><span class="phpdocumentor-signature__argument__name">$number</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$decimals</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">0</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$dec_point</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$thousands_sep</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$number</span>
: <span class="phpdocumentor-signature__argument__return-type">float</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Numeric value to be formatted.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$decimals</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
= <span class="phpdocumentor-signature__argument__default-value">0</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Number of decimal places.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$dec_point</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Decimal point character (if other than ".").</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$thousands_sep</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Thousands sep character (if other than ",").</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
—
<section class="phpdocumentor-description"><p>the formatted string</p>
<p>For alternate decimal point and thousands separator, delimit values with single quotes in the template.
EXAMPLE: {$number|crmNumberFormat:2:',':' '} for French notation - 1234.56 becomes 1 234,56</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_smarty_modifier_crmReplace">
smarty_modifier_crmReplace()
<a href="namespaces/default.html#function_smarty_modifier_crmReplace" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/plugins/modifier.crmReplace.php"><a href="files/crm-core-smarty-plugins-modifier-crmreplace.html"><abbr title="CRM/Core/Smarty/plugins/modifier.crmReplace.php">modifier.crmReplace.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">34</span>
</aside>
<p class="phpdocumentor-summary">Replace the value of an attribute in the input string. Assume
the the attribute is well formed, of the type name="value". If
no replacement is mentioned the value is inserted at the end of
the form element</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">smarty_modifier_crmReplace</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$string</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$attribute</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$string</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The html to be tweaked with.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$attribute</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The attribute to modify.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$value</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The new attribute value.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
—
<section class="phpdocumentor-description"><p>the new modified html string</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_smarty_modifier_crmRSSPubDate">
smarty_modifier_crmRSSPubDate()
<a href="namespaces/default.html#function_smarty_modifier_crmRSSPubDate" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/plugins/modifier.crmRSSPubDate.php"><a href="files/crm-core-smarty-plugins-modifier-crmrsspubdate.html"><abbr title="CRM/Core/Smarty/plugins/modifier.crmRSSPubDate.php">modifier.crmRSSPubDate.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">22</span>
</aside>
<p class="phpdocumentor-summary">Format the given date to RSS pubDate RFC822 format,
http://www.w3.org/Protocols/rfc822/#z28</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">smarty_modifier_crmRSSPubDate</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$dateString</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$dateString</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Date which needs to converted to RFC822 format.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
—
<section class="phpdocumentor-description"><p>formatted text</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_smarty_modifier_crmStripAlternatives">
smarty_modifier_crmStripAlternatives()
<a href="namespaces/default.html#function_smarty_modifier_crmStripAlternatives" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/plugins/modifier.crmStripAlternatives.php"><a href="files/crm-core-smarty-plugins-modifier-crmstripalternatives.html"><abbr title="CRM/Core/Smarty/plugins/modifier.crmStripAlternatives.php">modifier.crmStripAlternatives.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">28</span>
</aside>
<p class="phpdocumentor-summary">Given an ezComponents-parsed representation of
a text with alternatives return only the first one</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">smarty_modifier_crmStripAlternatives</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$full</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$full</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>All alternatives as a long string (or some other text).</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
—
<section class="phpdocumentor-description"><p>only the first alternative found (or the text without alternatives)</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_smarty_modifier_crmUpper">
smarty_modifier_crmUpper()
<a href="namespaces/default.html#function_smarty_modifier_crmUpper" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/plugins/modifier.crmUpper.php"><a href="files/crm-core-smarty-plugins-modifier-crmupper.html"><abbr title="CRM/Core/Smarty/plugins/modifier.crmUpper.php">modifier.crmUpper.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">26</span>
</aside>
<p class="phpdocumentor-summary">Upper case a string but use the multibyte strtoupper function to better handle accents / umlaut</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">smarty_modifier_crmUpper</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$string</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$string</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>the string to upper case</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_smarty_modifier_htmlize">
smarty_modifier_htmlize()
<a href="namespaces/default.html#function_smarty_modifier_htmlize" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/plugins/modifier.htmlize.php"><a href="files/crm-core-smarty-plugins-modifier-htmlize.html"><abbr title="CRM/Core/Smarty/plugins/modifier.htmlize.php">modifier.htmlize.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">27</span>
</aside>
<p class="phpdocumentor-summary">Convert a given text part a better HTML representation (add paragraphs and make URLs clickable)</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">smarty_modifier_htmlize</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$text</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$text</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Text to HTML-ize.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
—
<section class="phpdocumentor-description"><p>HTML-ized version of $text</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_smarty_modifier_json">
smarty_modifier_json()
<a href="namespaces/default.html#function_smarty_modifier_json" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/plugins/modifier.json.php"><a href="files/crm-core-smarty-plugins-modifier-json.html"><abbr title="CRM/Core/Smarty/plugins/modifier.json.php">modifier.json.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">28</span>
</aside>
<p class="phpdocumentor-summary">Convert the data to a JSON string</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">smarty_modifier_json</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$data</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<section class="phpdocumentor-description"><p>Example usage: {$myArray|@json}</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$data</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
—
<section class="phpdocumentor-description"><p>JSON</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_smarty_modifier_mb_truncate">
smarty_modifier_mb_truncate()
<a href="namespaces/default.html#function_smarty_modifier_mb_truncate" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/plugins/modifier.mb_truncate.php"><a href="files/crm-core-smarty-plugins-modifier-mb-truncate.html"><abbr title="CRM/Core/Smarty/plugins/modifier.mb_truncate.php">modifier.mb_truncate.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">42</span>
</aside>
<p class="phpdocumentor-summary">Smarty mb_truncate modifier plugin</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">smarty_modifier_mb_truncate</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$string</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$length</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">80</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$etc</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">'...'</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$break_words</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">FALSE</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<section class="phpdocumentor-description"><p>Type: modifier<br>
Name: mb_truncate<br>
Purpose: Truncate a string to a certain length if necessary,
optionally splitting in the middle of a word, and
appending the $etc string. Multibyte version.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$string</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$length</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
= <span class="phpdocumentor-signature__argument__default-value">80</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$etc</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">'...'</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$break_words</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
= <span class="phpdocumentor-signature__argument__default-value">FALSE</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_smarty_modifier_mb_truncate#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="http://smarty.php.net/manual/en/language.modifier.truncate.php"> <p>truncate (Smarty online manual)</p>
</a>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_smarty_modifier_nl2brIfNotHTML">
smarty_modifier_nl2brIfNotHTML()
<a href="namespaces/default.html#function_smarty_modifier_nl2brIfNotHTML" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/plugins/modifier.nl2brIfNotHTML.php"><a href="files/crm-core-smarty-plugins-modifier-nl2brifnothtml.html"><abbr title="CRM/Core/Smarty/plugins/modifier.nl2brIfNotHTML.php">modifier.nl2brIfNotHTML.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">29</span>
</aside>
<p class="phpdocumentor-summary">If the given string looks like HTML, do nothing and return it.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">smarty_modifier_nl2brIfNotHTML</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$text</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<section class="phpdocumentor-description"><p>If it doesn't, replace newlines with br tags.
The HTML check is somewhat greedy and may not add br tags
to some non-HTML text that contains angle brackets.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$text</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
—
<section class="phpdocumentor-description"><p>Text with br tags if input was non-HTML.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_smarty_modifier_print_array">
smarty_modifier_print_array()
<a href="namespaces/default.html#function_smarty_modifier_print_array" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/plugins/modifier.print_array.php"><a href="files/crm-core-smarty-plugins-modifier-print-array.html"><abbr title="CRM/Core/Smarty/plugins/modifier.print_array.php">modifier.print_array.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">30</span>
</aside>
<p class="phpdocumentor-summary">Smarty print_array modifier plugin</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">smarty_modifier_print_array</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed>|object </span><span class="phpdocumentor-signature__argument__name">$var</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$depth</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">0</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$length</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">40</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<section class="phpdocumentor-description"><p>Type: modifier<br>
Name: print_array<br>
Purpose: formats array for output in DAO files and in APIv3 Examples
To find where this is used do a grep in Smarty templates for |@print_array</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$var</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed>|object</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$depth</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
= <span class="phpdocumentor-signature__argument__default-value">0</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$length</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
= <span class="phpdocumentor-signature__argument__default-value">40</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_smarty_modifier_purify">
smarty_modifier_purify()
<a href="namespaces/default.html#function_smarty_modifier_purify" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/plugins/modifier.purify.php"><a href="files/crm-core-smarty-plugins-modifier-purify.html"><abbr title="CRM/Core/Smarty/plugins/modifier.purify.php">modifier.purify.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">26</span>
</aside>
<p class="phpdocumentor-summary">Purify HTML to mitigate against XSS attacks</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">smarty_modifier_purify</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$text</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$text</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Input text, potentially containing XSS</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
—
<section class="phpdocumentor-description"><p>Output text, containing only clean HTML</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_smarty_modifier_smarty">
smarty_modifier_smarty()
<a href="namespaces/default.html#function_smarty_modifier_smarty" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/plugins/modifier.smarty.php"><a href="files/crm-core-smarty-plugins-modifier-smarty.html"><abbr title="CRM/Core/Smarty/plugins/modifier.smarty.php">modifier.smarty.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">39</span>
</aside>
<p class="phpdocumentor-summary">Implement smarty:nodefaults for Smarty3.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">smarty_modifier_smarty</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$string</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$modifier</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<section class="phpdocumentor-description"><p>Adding |smarty:nodefaults to strings is the smarty
v2 way to indicates that a string should not be escaped.
It doesn't work with smarty 3 but it is a useful way to make strings
findable for this purpose as we figure out the best way for smarty 3.</p>
<p>As a bridging mechanism this ensures the modifiers added in v2 do not error in v3.</p>
<p>Eventually we want to run v3/v4 to escape by default but we are deferring that challenge
until we have achieved the first set of upgrading to v3.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$string</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The html to be tweaked.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$modifier</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Either nodefaults or nothing</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
—
<section class="phpdocumentor-description"><p>the new modified html string</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_smarty_modifier_substring">
smarty_modifier_substring()
<a href="namespaces/default.html#function_smarty_modifier_substring" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/plugins/modifier.substring.php"><a href="files/crm-core-smarty-plugins-modifier-substring.html"><abbr title="CRM/Core/Smarty/plugins/modifier.substring.php">modifier.substring.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">40</span>
</aside>
<p class="phpdocumentor-summary">Smarty plugin
Type: modifier
Name: substring
Version: 0.1
Date: 2006-16-02
Author: Thorsten Albrecht <thor_REMOVE.THIS_@wolke7.net>
Purpose: "substring" allows you to retrieve a small part (substring) of a string.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">smarty_modifier_substring</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$string</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$position</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$length</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<section class="phpdocumentor-description"><p>Notes: The substring is specified by giving the start position and the length.
Unlike the original function substr() in PHP the position of the characters
in the string starts at 1 (not at 0 as usual in php).
Example smarty code:
{$my_string|substring:2:4}
returns substring from character 2 until character 6</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$string</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$position</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>startposition of the substring, beginning with 0</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$length</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>length of substring</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_smarty_modifier_substring#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="based"> <p>on substr(): http://www.zend.com/manual/function.substr.php</p>
</a>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_smarty_prefilter_htxtFilter">
smarty_prefilter_htxtFilter()
<a href="namespaces/default.html#function_smarty_prefilter_htxtFilter" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/plugins/prefilter.htxtFilter.php"><a href="files/crm-core-smarty-plugins-prefilter-htxtfilter.html"><abbr title="CRM/Core/Smarty/plugins/prefilter.htxtFilter.php">prefilter.htxtFilter.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">11</span>
</aside>
<p class="phpdocumentor-summary">The content of an "{htxt}" block should not be evaluated unless
the active request is relevant. Otherwise, it will try to
evaluate unassigned variables.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">smarty_prefilter_htxtFilter</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$tpl_source</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$tpl_source</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_smarty_prefilter_resetExtScope">
smarty_prefilter_resetExtScope()
<a href="namespaces/default.html#function_smarty_prefilter_resetExtScope" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/plugins/prefilter.resetExtScope.php"><a href="files/crm-core-smarty-plugins-prefilter-resetextscope.html"><abbr title="CRM/Core/Smarty/plugins/prefilter.resetExtScope.php">prefilter.resetExtScope.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">10</span>
</aside>
<p class="phpdocumentor-summary">Wrap every Smarty template in a {crmScope} tag that sets the
variable "extensionKey" to blank.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">smarty_prefilter_resetExtScope</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$tpl_source</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$tpl_source</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_smarty_resource_string_get_template">
civicrm_smarty_resource_string_get_template()
<a href="namespaces/default.html#function_civicrm_smarty_resource_string_get_template" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/resources/String.php"><a href="files/crm-core-smarty-resources-string.html"><abbr title="CRM/Core/Smarty/resources/String.php">String.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">21</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_smarty_resource_string_get_template</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$tpl_name</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$tpl_source</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$tpl_name</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$tpl_source</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_smarty_resource_string_get_template#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">copyright</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>CiviCRM LLC https://civicrm.org/licensing</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_smarty_resource_string_get_timestamp">
civicrm_smarty_resource_string_get_timestamp()
<a href="namespaces/default.html#function_civicrm_smarty_resource_string_get_timestamp" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/resources/String.php"><a href="files/crm-core-smarty-resources-string.html"><abbr title="CRM/Core/Smarty/resources/String.php">String.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">32</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_smarty_resource_string_get_timestamp</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$tpl_name</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$tpl_timestamp</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$tpl_name</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$tpl_timestamp</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_smarty_resource_string_get_secure">
civicrm_smarty_resource_string_get_secure()
<a href="namespaces/default.html#function_civicrm_smarty_resource_string_get_secure" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/resources/String.php"><a href="files/crm-core-smarty-resources-string.html"><abbr title="CRM/Core/Smarty/resources/String.php">String.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">40</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_smarty_resource_string_get_secure</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_smarty_resource_string_get_trusted">
civicrm_smarty_resource_string_get_trusted()
<a href="namespaces/default.html#function_civicrm_smarty_resource_string_get_trusted" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/resources/String.php"><a href="files/crm-core-smarty-resources-string.html"><abbr title="CRM/Core/Smarty/resources/String.php">String.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">46</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_smarty_resource_string_get_trusted</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_smarty_register_string_resource">
civicrm_smarty_register_string_resource()
<a href="namespaces/default.html#function_civicrm_smarty_register_string_resource" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/Smarty/resources/String.php"><a href="files/crm-core-smarty-resources-string.html"><abbr title="CRM/Core/Smarty/resources/String.php">String.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">50</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_smarty_register_string_resource</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_crm_smarty_compatibility_get_path">
crm_smarty_compatibility_get_path()
<a href="namespaces/default.html#function_crm_smarty_compatibility_get_path" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="CRM/Core/SmartyCompatibility.php"><a href="files/crm-core-smartycompatibility.html"><abbr title="CRM/Core/SmartyCompatibility.php">SmartyCompatibility.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">39</span>
</aside>
<p class="phpdocumentor-summary">Get the path to load Smarty.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">crm_smarty_compatibility_get_path</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string|null</span></code>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string|null</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_generateJoomlaConfig">
generateJoomlaConfig()
<a href="namespaces/default.html#function_generateJoomlaConfig" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="distmaker/utils/joomlaxml.php"><a href="files/distmaker-utils-joomlaxml.html"><abbr title="distmaker/utils/joomlaxml.php">joomlaxml.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">39</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">generateJoomlaConfig</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$version</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$version</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_repo">
repo()
<a href="namespaces/default.html#function_repo" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="distmaker/utils/repo-report.php"><a href="files/distmaker-utils-repo-report.html"><abbr title="distmaker/utils/repo-report.php">repo-report.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">11</span>
</aside>
<p class="phpdocumentor-summary">Make a small report about the git content in a given folder+branch.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">repo</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$path</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$branch</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$path</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$branch</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><ul>
<li>branch: string</li>
<li>commit: string</li>
</ul>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__afform_admin_civix_civicrm_config">
_afform_admin_civix_civicrm_config()
<a href="namespaces/default.html#function__afform_admin_civix_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/admin/afform_admin.civix.php"><a href="files/ext-afform-admin-afform-admin-civix.html"><abbr title="ext/afform/admin/afform_admin.civix.php">afform_admin.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">87</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_afform_admin_civix_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$config</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__afform_admin_civix_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__afform_admin_civix_civicrm_install">
_afform_admin_civix_civicrm_install()
<a href="namespaces/default.html#function__afform_admin_civix_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/admin/afform_admin.civix.php"><a href="files/ext-afform-admin-afform-admin-civix.html"><abbr title="ext/afform/admin/afform_admin.civix.php">afform_admin.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">105</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_afform_admin_civix_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__afform_admin_civix_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__afform_admin_civix_civicrm_enable">
_afform_admin_civix_civicrm_enable()
<a href="namespaces/default.html#function__afform_admin_civix_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/admin/afform_admin.civix.php"><a href="files/ext-afform-admin-afform-admin-civix.html"><abbr title="ext/afform/admin/afform_admin.civix.php">afform_admin.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">115</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_afform_admin_civix_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__afform_admin_civix_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__afform_admin_civix_insert_navigation_menu">
_afform_admin_civix_insert_navigation_menu()
<a href="namespaces/default.html#function__afform_admin_civix_insert_navigation_menu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/admin/afform_admin.civix.php"><a href="files/ext-afform-admin-afform-admin-civix.html"><abbr title="ext/afform/admin/afform_admin.civix.php">afform_admin.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">131</span>
</aside>
<p class="phpdocumentor-summary">Inserts a navigation menu item at a given place in the hierarchy.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_afform_admin_civix_insert_navigation_menu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$menu</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$path</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$item</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$menu</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>menu hierarchy</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$path</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>path to parent of this item, e.g. 'my_extension/submenu'
'Mailing', or 'Administer/System Settings'</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$item</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>the item to insert (parent/child attributes will be
filled for you)</li>
</ul>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__afform_admin_civix_navigationMenu">
_afform_admin_civix_navigationMenu()
<a href="namespaces/default.html#function__afform_admin_civix_navigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/admin/afform_admin.civix.php"><a href="files/ext-afform-admin-afform-admin-civix.html"><abbr title="ext/afform/admin/afform_admin.civix.php">afform_admin.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">162</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_navigationMenu().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_afform_admin_civix_navigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__afform_admin_civix_fixNavigationMenu">
_afform_admin_civix_fixNavigationMenu()
<a href="namespaces/default.html#function__afform_admin_civix_fixNavigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/admin/afform_admin.civix.php"><a href="files/ext-afform-admin-afform-admin-civix.html"><abbr title="ext/afform/admin/afform_admin.civix.php">afform_admin.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">172</span>
</aside>
<p class="phpdocumentor-summary">Given a navigation menu, generate navIDs for any items which are
missing them.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_afform_admin_civix_fixNavigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__afform_admin_civix_fixNavigationMenuItems">
_afform_admin_civix_fixNavigationMenuItems()
<a href="namespaces/default.html#function__afform_admin_civix_fixNavigationMenuItems" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/admin/afform_admin.civix.php"><a href="files/ext-afform-admin-afform-admin-civix.html"><abbr title="ext/afform/admin/afform_admin.civix.php">afform_admin.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">182</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_afform_admin_civix_fixNavigationMenuItems</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$maxNavID</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$parentID</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$maxNavID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$parentID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_afform_admin_civicrm_config">
afform_admin_civicrm_config()
<a href="namespaces/default.html#function_afform_admin_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/admin/afform_admin.php"><a href="files/ext-afform-admin-afform-admin.html"><abbr title="ext/afform/admin/afform_admin.php">afform_admin.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">11</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">afform_admin_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$config</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_afform_admin_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_config"> http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_config </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_afform_admin_civicrm_install">
afform_admin_civicrm_install()
<a href="namespaces/default.html#function_afform_admin_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/admin/afform_admin.php"><a href="files/ext-afform-admin-afform-admin.html"><abbr title="ext/afform/admin/afform_admin.php">afform_admin.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">20</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">afform_admin_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_afform_admin_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_install"> http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_afform_admin_civicrm_enable">
afform_admin_civicrm_enable()
<a href="namespaces/default.html#function_afform_admin_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/admin/afform_admin.php"><a href="files/ext-afform-admin-afform-admin.html"><abbr title="ext/afform/admin/afform_admin.php">afform_admin.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">29</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">afform_admin_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_afform_admin_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_enable"> http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__afform_civix_class_loader">
_afform_civix_class_loader()
<a href="namespaces/default.html#function__afform_civix_class_loader" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/core/afform.civix.php"><a href="files/ext-afform-core-afform-civix.html"><abbr title="ext/afform/core/afform.civix.php">afform.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">94</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_afform_civix_class_loader</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$class</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$class</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__afform_civix_civicrm_config">
_afform_civix_civicrm_config()
<a href="namespaces/default.html#function__afform_civix_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/core/afform.civix.php"><a href="files/ext-afform-core-afform-civix.html"><abbr title="ext/afform/core/afform.civix.php">afform.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">122</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_afform_civix_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$config</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__afform_civix_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__afform_civix_civicrm_install">
_afform_civix_civicrm_install()
<a href="namespaces/default.html#function__afform_civix_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/core/afform.civix.php"><a href="files/ext-afform-core-afform-civix.html"><abbr title="ext/afform/core/afform.civix.php">afform.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">140</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_afform_civix_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__afform_civix_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__afform_civix_civicrm_enable">
_afform_civix_civicrm_enable()
<a href="namespaces/default.html#function__afform_civix_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/core/afform.civix.php"><a href="files/ext-afform-core-afform-civix.html"><abbr title="ext/afform/core/afform.civix.php">afform.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">150</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_afform_civix_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__afform_civix_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__afform_civix_insert_navigation_menu">
_afform_civix_insert_navigation_menu()
<a href="namespaces/default.html#function__afform_civix_insert_navigation_menu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/core/afform.civix.php"><a href="files/ext-afform-core-afform-civix.html"><abbr title="ext/afform/core/afform.civix.php">afform.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">166</span>
</aside>
<p class="phpdocumentor-summary">Inserts a navigation menu item at a given place in the hierarchy.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_afform_civix_insert_navigation_menu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$menu</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$path</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$item</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$menu</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>menu hierarchy</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$path</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>path to parent of this item, e.g. 'my_extension/submenu'
'Mailing', or 'Administer/System Settings'</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$item</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>the item to insert (parent/child attributes will be
filled for you)</li>
</ul>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__afform_civix_navigationMenu">
_afform_civix_navigationMenu()
<a href="namespaces/default.html#function__afform_civix_navigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/core/afform.civix.php"><a href="files/ext-afform-core-afform-civix.html"><abbr title="ext/afform/core/afform.civix.php">afform.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">197</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_navigationMenu().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_afform_civix_navigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__afform_civix_fixNavigationMenu">
_afform_civix_fixNavigationMenu()
<a href="namespaces/default.html#function__afform_civix_fixNavigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/core/afform.civix.php"><a href="files/ext-afform-core-afform-civix.html"><abbr title="ext/afform/core/afform.civix.php">afform.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">207</span>
</aside>
<p class="phpdocumentor-summary">Given a navigation menu, generate navIDs for any items which are
missing them.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_afform_civix_fixNavigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__afform_civix_fixNavigationMenuItems">
_afform_civix_fixNavigationMenuItems()
<a href="namespaces/default.html#function__afform_civix_fixNavigationMenuItems" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/core/afform.civix.php"><a href="files/ext-afform-core-afform-civix.html"><abbr title="ext/afform/core/afform.civix.php">afform.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">217</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_afform_civix_fixNavigationMenuItems</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$maxNavID</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$parentID</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$maxNavID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$parentID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__afform_fields_filter">
_afform_fields_filter()
<a href="namespaces/default.html#function__afform_fields_filter" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/core/afform.php"><a href="files/ext-afform-core-afform.html"><abbr title="ext/afform/core/afform.php">afform.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">12</span>
</aside>
<p class="phpdocumentor-summary">Filter the content of $params to only have supported afform fields.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_afform_fields_filter</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_afform_civicrm_config">
afform_civicrm_config()
<a href="namespaces/default.html#function_afform_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/core/afform.php"><a href="files/ext-afform-core-afform.html"><abbr title="ext/afform/core/afform.php">afform.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">32</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">afform_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$config</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_afform_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_config"> http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_config </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_afform_civicrm_install">
afform_civicrm_install()
<a href="namespaces/default.html#function_afform_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/core/afform.php"><a href="files/ext-afform-core-afform.html"><abbr title="ext/afform/core/afform.php">afform.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">57</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">afform_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_afform_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_install"> http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_afform_civicrm_enable">
afform_civicrm_enable()
<a href="namespaces/default.html#function_afform_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/core/afform.php"><a href="files/ext-afform-core-afform.html"><abbr title="ext/afform/core/afform.php">afform.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">66</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">afform_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_afform_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_enable"> http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_afform_civicrm_managed">
afform_civicrm_managed()
<a href="namespaces/default.html#function_afform_civicrm_managed" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/core/afform.php"><a href="files/ext-afform-core-afform.html"><abbr title="ext/afform/core/afform.php">afform.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">78</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_managed().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">afform_civicrm_managed</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$entities</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$modules</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>Generate a list of entities to create/deactivate/delete when this module
is installed, disabled, uninstalled.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entities</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$modules</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_afform_civicrm_managed#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_managed"> http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_managed </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_afform_civicrm_tabset">
afform_civicrm_tabset()
<a href="namespaces/default.html#function_afform_civicrm_tabset" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/core/afform.php"><a href="files/ext-afform-core-afform.html"><abbr title="ext/afform/core/afform.php">afform.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">155</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_tabset().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">afform_civicrm_tabset</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$tabsetName</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$tabs</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$context</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>Adds afforms as contact summary tabs.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$tabsetName</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$tabs</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$context</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_afform_civicrm_pageRun">
afform_civicrm_pageRun()
<a href="namespaces/default.html#function_afform_civicrm_pageRun" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/core/afform.php"><a href="files/ext-afform-core-afform.html"><abbr title="ext/afform/core/afform.php">afform.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">201</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_pageRun().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">afform_civicrm_pageRun</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$page</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>Adds afforms as contact summary blocks.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$page</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_afform_civicrm_contactSummaryBlocks">
afform_civicrm_contactSummaryBlocks()
<a href="namespaces/default.html#function_afform_civicrm_contactSummaryBlocks" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/core/afform.php"><a href="files/ext-afform-core-afform.html"><abbr title="ext/afform/core/afform.php">afform.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">248</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_contactSummaryBlocks().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">afform_civicrm_contactSummaryBlocks</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$blocks</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$blocks</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_afform_civicrm_contactSummaryBlocks#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://github.com/civicrm/org.civicrm.contactlayout"> https://github.com/civicrm/org.civicrm.contactlayout </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__afform_get_contact_types">
_afform_get_contact_types()
<a href="namespaces/default.html#function__afform_get_contact_types" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/core/afform.php"><a href="files/ext-afform-core-afform.html"><abbr title="ext/afform/core/afform.php">afform.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">288</span>
</aside>
<p class="phpdocumentor-summary">Resolve a mixed list of contact types and sub-types into just top-level contact types (Individual, Organization, Household)</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_afform_get_contact_types</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$mixedTypes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$mixedTypes</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__afform_get_contact_types#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__afform_hook_civicrm_angularModules">
_afform_hook_civicrm_angularModules()
<a href="namespaces/default.html#function__afform_hook_civicrm_angularModules" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/core/afform.php"><a href="files/ext-afform-core-afform.html"><abbr title="ext/afform/core/afform.php">afform.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">306</span>
</aside>
<p class="phpdocumentor-summary">Late-listener for Angular modules: adds all Afforms and their dependencies.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_afform_hook_civicrm_angularModules</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/Civi-Core-Event-GenericHookEvent.html"><abbr title="\Civi\Core\Event\GenericHookEvent">GenericHookEvent</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$e</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>Must run last so that all other modules are present for reverse-dependency mapping.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$e</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/Civi-Core-Event-GenericHookEvent.html"><abbr title="\Civi\Core\Event\GenericHookEvent">GenericHookEvent</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__afform_hook_civicrm_angularModules#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">implements</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>CRM_Utils_Hook::angularModules</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__afform_get_partials">
_afform_get_partials()
<a href="namespaces/default.html#function__afform_get_partials" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/core/afform.php"><a href="files/ext-afform-core-afform.html"><abbr title="ext/afform/core/afform.php">afform.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">355</span>
</aside>
<p class="phpdocumentor-summary">Callback to retrieve partials for a given afform/angular module.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_afform_get_partials</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$moduleName</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$module</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$moduleName</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The module name.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$module</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The module definition.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__afform_get_partials#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\afform_civicrm_angularModules">afform_civicrm_angularModules</abbr></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array(string $filename => string $html).</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_afform_civicrm_buildAsset">
afform_civicrm_buildAsset()
<a href="namespaces/default.html#function_afform_civicrm_buildAsset" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/core/afform.php"><a href="files/ext-afform-core-afform.html"><abbr title="ext/afform/core/afform.php">afform.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">370</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_buildAsset().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">afform_civicrm_buildAsset</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$asset</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$mimeType</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$content</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$asset</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$mimeType</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$content</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_afform_civicrm_alterMenu">
afform_civicrm_alterMenu()
<a href="namespaces/default.html#function_afform_civicrm_alterMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/core/afform.php"><a href="files/ext-afform-core-afform.html"><abbr title="ext/afform/core/afform.php">afform.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">398</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_alterMenu().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">afform_civicrm_alterMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$items</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$items</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_afform_civicrm_permission">
afform_civicrm_permission()
<a href="namespaces/default.html#function_afform_civicrm_permission" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/core/afform.php"><a href="files/ext-afform-core-afform.html"><abbr title="ext/afform/core/afform.php">afform.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">428</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_permission().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">afform_civicrm_permission</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$permissions</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>Define Afform permissions.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$permissions</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_afform_civicrm_permission_check">
afform_civicrm_permission_check()
<a href="namespaces/default.html#function_afform_civicrm_permission_check" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/core/afform.php"><a href="files/ext-afform-core-afform.html"><abbr title="ext/afform/core/afform.php">afform.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">448</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_permission_check().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">afform_civicrm_permission_check</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$permission</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$granted</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$contactId</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>This extends the list of permissions available in <code class="prettyprint">CRM_Core_Permission:check()</code>
by introducing virtual-permissions named <code class="prettyprint">@afform:myForm</code>. The evaluation
of these virtual-permissions is dependent on the settings for <code class="prettyprint">myForm</code>.
<code class="prettyprint">myForm</code> may be exposed/integrated through multiple subsystems (routing,
nav-menu, API, etc), and the use of virtual-permissions makes easy to enforce
consistent permissions across any relevant subsystems.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$permission</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$granted</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$contactId</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_afform_civicrm_permission_check#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Utils-Hook.html#method_permission_check"><abbr title="\CRM_Utils_Hook::permission_check()">CRM_Utils_Hook::permission_check()</abbr></a></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_afform_civicrm_permissionList">
afform_civicrm_permissionList()
<a href="namespaces/default.html#function_afform_civicrm_permissionList" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/core/afform.php"><a href="files/ext-afform-core-afform.html"><abbr title="ext/afform/core/afform.php">afform.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">472</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_permissionList().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">afform_civicrm_permissionList</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$permissions</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$permissions</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_afform_civicrm_permissionList#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Utils-Hook.html#method_permissionList"><abbr title="\CRM_Utils_Hook::permissionList()">CRM_Utils_Hook::permissionList()</abbr></a></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__afform_clear">
_afform_clear()
<a href="namespaces/default.html#function__afform_clear" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/core/afform.php"><a href="files/ext-afform-core-afform.html"><abbr title="ext/afform/core/afform.php">afform.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">492</span>
</aside>
<p class="phpdocumentor-summary">Clear any local/in-memory caches based on afform data.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_afform_clear</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__afform_angular_module_name">
_afform_angular_module_name()
<a href="namespaces/default.html#function__afform_angular_module_name" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/core/afform.php"><a href="files/ext-afform-core-afform.html"><abbr title="ext/afform/core/afform.php">afform.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">507</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_afform_angular_module_name</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$fileBaseName</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$format</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">'camel'</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fileBaseName</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Ex: foo-bar</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$format</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">'camel'</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>'camel' or 'dash'.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__afform_angular_module_name#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\Exception">Exception</abbr></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
—
<section class="phpdocumentor-description"><p>Ex: 'FooBar' or 'foo-bar'.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_afform_civicrm_preProcess">
afform_civicrm_preProcess()
<a href="namespaces/default.html#function_afform_civicrm_preProcess" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/core/afform.php"><a href="files/ext-afform-core-afform.html"><abbr title="ext/afform/core/afform.php">afform.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">525</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_preProcess().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">afform_civicrm_preProcess</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$formName</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$form</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>Wordpress only: Adds Afforms to the shortcode dialog (when editing pages/posts).</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$formName</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$form</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_afform_civicrm_pre">
afform_civicrm_pre()
<a href="namespaces/default.html#function_afform_civicrm_pre" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/core/afform.php"><a href="files/ext-afform-core-afform.html"><abbr title="ext/afform/core/afform.php">afform.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">544</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_pre().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">afform_civicrm_pre</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$op</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$entity</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$id</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$op</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entity</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$id</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_afform_civicrm_referenceCounts">
afform_civicrm_referenceCounts()
<a href="namespaces/default.html#function_afform_civicrm_referenceCounts" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/core/afform.php"><a href="files/ext-afform-core-afform.html"><abbr title="ext/afform/core/afform.php">afform.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">570</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_referenceCounts().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">afform_civicrm_referenceCounts</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$dao</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$counts</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$dao</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$counts</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_afform_shortcode_content">
afform_shortcode_content()
<a href="namespaces/default.html#function_afform_shortcode_content" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/core/afform.php"><a href="files/ext-afform-core-afform.html"><abbr title="ext/afform/core/afform.php">afform.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">641</span>
</aside>
<p class="phpdocumentor-summary">Wordpress only: Render Afform content for shortcodes.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">afform_shortcode_content</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$content</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$atts</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$args</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$context</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$content</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>HTML Markup</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$atts</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Shortcode attributes.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$args</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Existing shortcode arguments.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$context</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>How many shortcodes are present on the page: 'single' or 'multiple'.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
—
<section class="phpdocumentor-description"><p>Modified markup.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_afform_civicrm_searchKitTasks">
afform_civicrm_searchKitTasks()
<a href="namespaces/default.html#function_afform_civicrm_searchKitTasks" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/core/afform.php"><a href="files/ext-afform-core-afform.html"><abbr title="ext/afform/core/afform.php">afform.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">664</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_searchKitTasks().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">afform_civicrm_searchKitTasks</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$tasks</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$checkPermissions</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int|null </span><span class="phpdocumentor-signature__argument__name">$userID</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$tasks</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$checkPermissions</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$userID</span>
: <span class="phpdocumentor-signature__argument__return-type">int|null</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_afform_get">
civicrm_api3_afform_get()
<a href="namespaces/default.html#function_civicrm_api3_afform_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/core/api/v3/Afform.php"><a href="files/ext-afform-core-api-v3-afform.html"><abbr title="ext/afform/core/api/v3/Afform.php">Afform.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">14</span>
</aside>
<p class="phpdocumentor-summary">Get a list of afforms.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_afform_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>This API exists solely for the purpose of entityRef widgets.
All other Afform api functionality is v4.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_afform_get_spec">
_civicrm_api3_afform_get_spec()
<a href="namespaces/default.html#function__civicrm_api3_afform_get_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/core/api/v3/Afform.php"><a href="files/ext-afform-core-api-v3-afform.html"><abbr title="ext/afform/core/api/v3/Afform.php">Afform.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">39</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_afform_get_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$fields</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fields</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_afform_getlist_params">
_civicrm_api3_afform_getlist_params()
<a href="namespaces/default.html#function__civicrm_api3_afform_getlist_params" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/core/api/v3/Afform.php"><a href="files/ext-afform-core-api-v3-afform.html"><abbr title="ext/afform/core/api/v3/Afform.php">Afform.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">89</span>
</aside>
<p class="phpdocumentor-summary">Augment parameters for Afform entityRef list.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_afform_getlist_params</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$request</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$request</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>API request.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_afform_getlist_params#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\_civicrm_api3_generic_getlist_params">_civicrm_api3_generic_getlist_params</abbr></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_afform_getlist_output">
_civicrm_api3_afform_getlist_output()
<a href="namespaces/default.html#function__civicrm_api3_afform_getlist_output" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/core/api/v3/Afform.php"><a href="files/ext-afform-core-api-v3-afform.html"><abbr title="ext/afform/core/api/v3/Afform.php">Afform.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">111</span>
</aside>
<p class="phpdocumentor-summary">Format output for Afform entityRef list.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_afform_getlist_output</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$result</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$request</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$result</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$request</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_afform_getlist_output#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\_civicrm_api3_generic_getlist_output">_civicrm_api3_generic_getlist_output</abbr></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_cv">
cv()
<a href="namespaces/default.html#function_cv" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/core/tests/phpunit/bootstrap.php"><a href="files/ext-afform-core-tests-phpunit-bootstrap.html"><abbr title="ext/afform/core/tests/phpunit/bootstrap.php">bootstrap.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">27</span>
</aside>
<p class="phpdocumentor-summary">Call the "cv" command.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">cv</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$cmd</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$decode</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">'json'</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$cmd</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The rest of the command to send.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$decode</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">'json'</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Ex: 'json' or 'phpcode'.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_cv#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\RuntimeException">RuntimeException</abbr></span>
<section class="phpdocumentor-description"><p>If the command terminates abnormally.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
—
<section class="phpdocumentor-description"><p>Response output (if the command executed normally).</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__afform_html_civix_civicrm_config">
_afform_html_civix_civicrm_config()
<a href="namespaces/default.html#function__afform_html_civix_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/html/afform_html.civix.php"><a href="files/ext-afform-html-afform-html-civix.html"><abbr title="ext/afform/html/afform_html.civix.php">afform_html.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">87</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_afform_html_civix_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$config</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__afform_html_civix_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__afform_html_civix_civicrm_install">
_afform_html_civix_civicrm_install()
<a href="namespaces/default.html#function__afform_html_civix_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/html/afform_html.civix.php"><a href="files/ext-afform-html-afform-html-civix.html"><abbr title="ext/afform/html/afform_html.civix.php">afform_html.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">105</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_afform_html_civix_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__afform_html_civix_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__afform_html_civix_civicrm_enable">
_afform_html_civix_civicrm_enable()
<a href="namespaces/default.html#function__afform_html_civix_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/html/afform_html.civix.php"><a href="files/ext-afform-html-afform-html-civix.html"><abbr title="ext/afform/html/afform_html.civix.php">afform_html.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">115</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_afform_html_civix_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__afform_html_civix_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__afform_html_civix_insert_navigation_menu">
_afform_html_civix_insert_navigation_menu()
<a href="namespaces/default.html#function__afform_html_civix_insert_navigation_menu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/html/afform_html.civix.php"><a href="files/ext-afform-html-afform-html-civix.html"><abbr title="ext/afform/html/afform_html.civix.php">afform_html.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">131</span>
</aside>
<p class="phpdocumentor-summary">Inserts a navigation menu item at a given place in the hierarchy.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_afform_html_civix_insert_navigation_menu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$menu</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$path</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$item</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$menu</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>menu hierarchy</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$path</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>path to parent of this item, e.g. 'my_extension/submenu'
'Mailing', or 'Administer/System Settings'</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$item</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>the item to insert (parent/child attributes will be
filled for you)</li>
</ul>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__afform_html_civix_navigationMenu">
_afform_html_civix_navigationMenu()
<a href="namespaces/default.html#function__afform_html_civix_navigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/html/afform_html.civix.php"><a href="files/ext-afform-html-afform-html-civix.html"><abbr title="ext/afform/html/afform_html.civix.php">afform_html.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">162</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_navigationMenu().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_afform_html_civix_navigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__afform_html_civix_fixNavigationMenu">
_afform_html_civix_fixNavigationMenu()
<a href="namespaces/default.html#function__afform_html_civix_fixNavigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/html/afform_html.civix.php"><a href="files/ext-afform-html-afform-html-civix.html"><abbr title="ext/afform/html/afform_html.civix.php">afform_html.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">172</span>
</aside>
<p class="phpdocumentor-summary">Given a navigation menu, generate navIDs for any items which are
missing them.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_afform_html_civix_fixNavigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__afform_html_civix_fixNavigationMenuItems">
_afform_html_civix_fixNavigationMenuItems()
<a href="namespaces/default.html#function__afform_html_civix_fixNavigationMenuItems" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/html/afform_html.civix.php"><a href="files/ext-afform-html-afform-html-civix.html"><abbr title="ext/afform/html/afform_html.civix.php">afform_html.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">182</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_afform_html_civix_fixNavigationMenuItems</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$maxNavID</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$parentID</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$maxNavID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$parentID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_afform_html_civicrm_config">
afform_html_civicrm_config()
<a href="namespaces/default.html#function_afform_html_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/html/afform_html.php"><a href="files/ext-afform-html-afform-html.html"><abbr title="ext/afform/html/afform_html.php">afform_html.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">15</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">afform_html_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$config</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_afform_html_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_config"> http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_config </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_afform_html_civicrm_install">
afform_html_civicrm_install()
<a href="namespaces/default.html#function_afform_html_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/html/afform_html.php"><a href="files/ext-afform-html-afform-html.html"><abbr title="ext/afform/html/afform_html.php">afform_html.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">24</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">afform_html_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_afform_html_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_install"> http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_afform_html_civicrm_enable">
afform_html_civicrm_enable()
<a href="namespaces/default.html#function_afform_html_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/html/afform_html.php"><a href="files/ext-afform-html-afform-html.html"><abbr title="ext/afform/html/afform_html.php">afform_html.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">33</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">afform_html_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_afform_html_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_enable"> http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__afform_login_token_civix_civicrm_config">
_afform_login_token_civix_civicrm_config()
<a href="namespaces/default.html#function__afform_login_token_civix_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/login_token/afform_login_token.civix.php"><a href="files/ext-afform-login-token-afform-login-token-civix.html"><abbr title="ext/afform/login_token/afform_login_token.civix.php">afform_login_token.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">87</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_afform_login_token_civix_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$config</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__afform_login_token_civix_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__afform_login_token_civix_civicrm_install">
_afform_login_token_civix_civicrm_install()
<a href="namespaces/default.html#function__afform_login_token_civix_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/login_token/afform_login_token.civix.php"><a href="files/ext-afform-login-token-afform-login-token-civix.html"><abbr title="ext/afform/login_token/afform_login_token.civix.php">afform_login_token.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">105</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_afform_login_token_civix_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__afform_login_token_civix_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__afform_login_token_civix_civicrm_enable">
_afform_login_token_civix_civicrm_enable()
<a href="namespaces/default.html#function__afform_login_token_civix_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/login_token/afform_login_token.civix.php"><a href="files/ext-afform-login-token-afform-login-token-civix.html"><abbr title="ext/afform/login_token/afform_login_token.civix.php">afform_login_token.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">115</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_afform_login_token_civix_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__afform_login_token_civix_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__afform_login_token_civix_insert_navigation_menu">
_afform_login_token_civix_insert_navigation_menu()
<a href="namespaces/default.html#function__afform_login_token_civix_insert_navigation_menu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/login_token/afform_login_token.civix.php"><a href="files/ext-afform-login-token-afform-login-token-civix.html"><abbr title="ext/afform/login_token/afform_login_token.civix.php">afform_login_token.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">131</span>
</aside>
<p class="phpdocumentor-summary">Inserts a navigation menu item at a given place in the hierarchy.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_afform_login_token_civix_insert_navigation_menu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$menu</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$path</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$item</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$menu</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>menu hierarchy</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$path</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>path to parent of this item, e.g. 'my_extension/submenu'
'Mailing', or 'Administer/System Settings'</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$item</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>the item to insert (parent/child attributes will be
filled for you)</li>
</ul>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__afform_login_token_civix_navigationMenu">
_afform_login_token_civix_navigationMenu()
<a href="namespaces/default.html#function__afform_login_token_civix_navigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/login_token/afform_login_token.civix.php"><a href="files/ext-afform-login-token-afform-login-token-civix.html"><abbr title="ext/afform/login_token/afform_login_token.civix.php">afform_login_token.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">162</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_navigationMenu().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_afform_login_token_civix_navigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__afform_login_token_civix_fixNavigationMenu">
_afform_login_token_civix_fixNavigationMenu()
<a href="namespaces/default.html#function__afform_login_token_civix_fixNavigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/login_token/afform_login_token.civix.php"><a href="files/ext-afform-login-token-afform-login-token-civix.html"><abbr title="ext/afform/login_token/afform_login_token.civix.php">afform_login_token.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">172</span>
</aside>
<p class="phpdocumentor-summary">Given a navigation menu, generate navIDs for any items which are
missing them.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_afform_login_token_civix_fixNavigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__afform_login_token_civix_fixNavigationMenuItems">
_afform_login_token_civix_fixNavigationMenuItems()
<a href="namespaces/default.html#function__afform_login_token_civix_fixNavigationMenuItems" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/login_token/afform_login_token.civix.php"><a href="files/ext-afform-login-token-afform-login-token-civix.html"><abbr title="ext/afform/login_token/afform_login_token.civix.php">afform_login_token.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">182</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_afform_login_token_civix_fixNavigationMenuItems</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$maxNavID</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$parentID</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$maxNavID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$parentID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_afform_login_token_civicrm_config">
afform_login_token_civicrm_config()
<a href="namespaces/default.html#function_afform_login_token_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/login_token/afform_login_token.php"><a href="files/ext-afform-login-token-afform-login-token.html"><abbr title="ext/afform/login_token/afform_login_token.php">afform_login_token.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">12</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">afform_login_token_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$config</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_afform_login_token_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/ </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_afform_login_token_civicrm_install">
afform_login_token_civicrm_install()
<a href="namespaces/default.html#function_afform_login_token_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/login_token/afform_login_token.php"><a href="files/ext-afform-login-token-afform-login-token.html"><abbr title="ext/afform/login_token/afform_login_token.php">afform_login_token.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">21</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">afform_login_token_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_afform_login_token_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_afform_login_token_civicrm_enable">
afform_login_token_civicrm_enable()
<a href="namespaces/default.html#function_afform_login_token_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/login_token/afform_login_token.php"><a href="files/ext-afform-login-token-afform-login-token.html"><abbr title="ext/afform/login_token/afform_login_token.php">afform_login_token.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">30</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">afform_login_token_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_afform_login_token_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__afform_mock_civix_civicrm_config">
_afform_mock_civix_civicrm_config()
<a href="namespaces/default.html#function__afform_mock_civix_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/mock/afform_mock.civix.php"><a href="files/ext-afform-mock-afform-mock-civix.html"><abbr title="ext/afform/mock/afform_mock.civix.php">afform_mock.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">87</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_afform_mock_civix_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$config</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__afform_mock_civix_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__afform_mock_civix_civicrm_install">
_afform_mock_civix_civicrm_install()
<a href="namespaces/default.html#function__afform_mock_civix_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/mock/afform_mock.civix.php"><a href="files/ext-afform-mock-afform-mock-civix.html"><abbr title="ext/afform/mock/afform_mock.civix.php">afform_mock.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">105</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_afform_mock_civix_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__afform_mock_civix_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__afform_mock_civix_civicrm_enable">
_afform_mock_civix_civicrm_enable()
<a href="namespaces/default.html#function__afform_mock_civix_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/mock/afform_mock.civix.php"><a href="files/ext-afform-mock-afform-mock-civix.html"><abbr title="ext/afform/mock/afform_mock.civix.php">afform_mock.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">115</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_afform_mock_civix_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__afform_mock_civix_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__afform_mock_civix_insert_navigation_menu">
_afform_mock_civix_insert_navigation_menu()
<a href="namespaces/default.html#function__afform_mock_civix_insert_navigation_menu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/mock/afform_mock.civix.php"><a href="files/ext-afform-mock-afform-mock-civix.html"><abbr title="ext/afform/mock/afform_mock.civix.php">afform_mock.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">131</span>
</aside>
<p class="phpdocumentor-summary">Inserts a navigation menu item at a given place in the hierarchy.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_afform_mock_civix_insert_navigation_menu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$menu</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$path</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$item</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$menu</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>menu hierarchy</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$path</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>path to parent of this item, e.g. 'my_extension/submenu'
'Mailing', or 'Administer/System Settings'</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$item</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>the item to insert (parent/child attributes will be
filled for you)</li>
</ul>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__afform_mock_civix_navigationMenu">
_afform_mock_civix_navigationMenu()
<a href="namespaces/default.html#function__afform_mock_civix_navigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/mock/afform_mock.civix.php"><a href="files/ext-afform-mock-afform-mock-civix.html"><abbr title="ext/afform/mock/afform_mock.civix.php">afform_mock.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">162</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_navigationMenu().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_afform_mock_civix_navigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__afform_mock_civix_fixNavigationMenu">
_afform_mock_civix_fixNavigationMenu()
<a href="namespaces/default.html#function__afform_mock_civix_fixNavigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/mock/afform_mock.civix.php"><a href="files/ext-afform-mock-afform-mock-civix.html"><abbr title="ext/afform/mock/afform_mock.civix.php">afform_mock.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">172</span>
</aside>
<p class="phpdocumentor-summary">Given a navigation menu, generate navIDs for any items which are
missing them.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_afform_mock_civix_fixNavigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__afform_mock_civix_fixNavigationMenuItems">
_afform_mock_civix_fixNavigationMenuItems()
<a href="namespaces/default.html#function__afform_mock_civix_fixNavigationMenuItems" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/mock/afform_mock.civix.php"><a href="files/ext-afform-mock-afform-mock-civix.html"><abbr title="ext/afform/mock/afform_mock.civix.php">afform_mock.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">182</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_afform_mock_civix_fixNavigationMenuItems</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$maxNavID</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$parentID</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$maxNavID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$parentID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_afform_mock_civicrm_config">
afform_mock_civicrm_config()
<a href="namespaces/default.html#function_afform_mock_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/mock/afform_mock.php"><a href="files/ext-afform-mock-afform-mock.html"><abbr title="ext/afform/mock/afform_mock.php">afform_mock.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">11</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">afform_mock_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$config</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_afform_mock_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_config"> http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_config </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_afform_mock_civicrm_install">
afform_mock_civicrm_install()
<a href="namespaces/default.html#function_afform_mock_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/mock/afform_mock.php"><a href="files/ext-afform-mock-afform-mock.html"><abbr title="ext/afform/mock/afform_mock.php">afform_mock.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">20</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">afform_mock_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_afform_mock_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_install"> http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_afform_mock_civicrm_enable">
afform_mock_civicrm_enable()
<a href="namespaces/default.html#function_afform_mock_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/mock/afform_mock.php"><a href="files/ext-afform-mock-afform-mock.html"><abbr title="ext/afform/mock/afform_mock.php">afform_mock.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">29</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">afform_mock_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_afform_mock_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_enable"> http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_cv">
cv()
<a href="namespaces/default.html#function_cv" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/afform/mock/tests/phpunit/bootstrap.php"><a href="files/ext-afform-mock-tests-phpunit-bootstrap.html"><abbr title="ext/afform/mock/tests/phpunit/bootstrap.php">bootstrap.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">30</span>
</aside>
<p class="phpdocumentor-summary">Call the "cv" command.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">cv</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$cmd</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$decode</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">'json'</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$cmd</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The rest of the command to send.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$decode</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">'json'</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Ex: 'json' or 'phpcode'.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_cv#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\RuntimeException">RuntimeException</abbr></span>
<section class="phpdocumentor-description"><p>If the command terminates abnormally.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
—
<section class="phpdocumentor-description"><p>Response output (if the command executed normally).
For 'raw' or 'phpcode', this will be a string. For 'json', it could be any JSON value.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__authx_civix_civicrm_config">
_authx_civix_civicrm_config()
<a href="namespaces/default.html#function__authx_civix_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/authx/authx.civix.php"><a href="files/ext-authx-authx-civix.html"><abbr title="ext/authx/authx.civix.php">authx.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">87</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_authx_civix_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$config</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__authx_civix_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__authx_civix_civicrm_install">
_authx_civix_civicrm_install()
<a href="namespaces/default.html#function__authx_civix_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/authx/authx.civix.php"><a href="files/ext-authx-authx-civix.html"><abbr title="ext/authx/authx.civix.php">authx.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">105</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_authx_civix_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__authx_civix_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__authx_civix_civicrm_enable">
_authx_civix_civicrm_enable()
<a href="namespaces/default.html#function__authx_civix_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/authx/authx.civix.php"><a href="files/ext-authx-authx-civix.html"><abbr title="ext/authx/authx.civix.php">authx.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">115</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_authx_civix_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__authx_civix_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__authx_civix_insert_navigation_menu">
_authx_civix_insert_navigation_menu()
<a href="namespaces/default.html#function__authx_civix_insert_navigation_menu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/authx/authx.civix.php"><a href="files/ext-authx-authx-civix.html"><abbr title="ext/authx/authx.civix.php">authx.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">131</span>
</aside>
<p class="phpdocumentor-summary">Inserts a navigation menu item at a given place in the hierarchy.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_authx_civix_insert_navigation_menu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$menu</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$path</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$item</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$menu</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>menu hierarchy</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$path</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>path to parent of this item, e.g. 'my_extension/submenu'
'Mailing', or 'Administer/System Settings'</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$item</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>the item to insert (parent/child attributes will be
filled for you)</li>
</ul>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__authx_civix_navigationMenu">
_authx_civix_navigationMenu()
<a href="namespaces/default.html#function__authx_civix_navigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/authx/authx.civix.php"><a href="files/ext-authx-authx-civix.html"><abbr title="ext/authx/authx.civix.php">authx.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">162</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_navigationMenu().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_authx_civix_navigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__authx_civix_fixNavigationMenu">
_authx_civix_fixNavigationMenu()
<a href="namespaces/default.html#function__authx_civix_fixNavigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/authx/authx.civix.php"><a href="files/ext-authx-authx-civix.html"><abbr title="ext/authx/authx.civix.php">authx.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">172</span>
</aside>
<p class="phpdocumentor-summary">Given a navigation menu, generate navIDs for any items which are
missing them.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_authx_civix_fixNavigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__authx_civix_fixNavigationMenuItems">
_authx_civix_fixNavigationMenuItems()
<a href="namespaces/default.html#function__authx_civix_fixNavigationMenuItems" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/authx/authx.civix.php"><a href="files/ext-authx-authx-civix.html"><abbr title="ext/authx/authx.civix.php">authx.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">182</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_authx_civix_fixNavigationMenuItems</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$maxNavID</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$parentID</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$maxNavID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$parentID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_authx_login">
authx_login()
<a href="namespaces/default.html#function_authx_login" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/authx/authx.php"><a href="files/ext-authx-authx.html"><abbr title="ext/authx/authx.php">authx.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">37</span>
</aside>
<p class="phpdocumentor-summary">Perform a system login.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">authx_login</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array{flow: ?string, useSession: ?bool, principal: ?array, cred: ?string} </span><span class="phpdocumentor-signature__argument__name">$details</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array{contactId: int, userId: ?int, flow: string, credType: string, useSession: bool}</span></code>
<section class="phpdocumentor-description"><p>This is useful for backend scripts that need to switch to a specific user.</p>
<p>As needed, this will update the Civi session and CMS data.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$details</span>
: <span class="phpdocumentor-signature__argument__return-type">array{flow: ?string, useSession: ?bool, principal: ?array, cred: ?string}</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Describe the authentication process with these properties:</p>
<ul>
<li>string $flow (default 'script');
The type of authentication flow being used
Ex: 'param', 'header', 'auto'</li>
<li>bool $useSession (default FALSE)
If TRUE, then the authentication should be persistent (in a session variable).
If FALSE, then the authentication should be ephemeral (single page-request).</li>
</ul>
<p>And then ONE of these properties to describe the user/principal:</p>
<ul>
<li>string $cred
The credential, as formatted in the 'Authorization' header.
Ex: 'Bearer 12345', 'Basic ASDFFDSA=='</li>
<li>array $principal
Description of a validated principal.
Must include 'contactId', 'userId', xor 'user'</li>
</ul>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_authx_login#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/Civi-Authx-AuthxException.html"><abbr title="\Civi\Authx\AuthxException">AuthxException</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array{contactId: int, userId: ?int, flow: string, credType: string, useSession: bool}</span>
—
<section class="phpdocumentor-description"><p>An array describing the authenticated session.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__authx_uf">
_authx_uf()
<a href="namespaces/default.html#function__authx_uf" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/authx/authx.php"><a href="files/ext-authx-authx.html"><abbr title="ext/authx/authx.php">authx.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">49</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_authx_uf</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/Civi-Authx-AuthxInterface.html"><abbr title="\Civi\Authx\AuthxInterface">AuthxInterface</abbr></a></span></code>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/Civi-Authx-AuthxInterface.html"><abbr title="\Civi\Authx\AuthxInterface">AuthxInterface</abbr></a></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__authx_redact">
_authx_redact()
<a href="namespaces/default.html#function__authx_redact" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/authx/authx.php"><a href="files/ext-authx-authx.html"><abbr title="ext/authx/authx.php">authx.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">61</span>
</aside>
<p class="phpdocumentor-summary">For parameter-based authentication, this option will hide parameters.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_authx_redact</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$keys</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>This is mostly a precaution, hedging against the possibility that some routes
make broad use of $_GET or $_PARAMS.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$keys</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__authx_reload">
_authx_reload()
<a href="namespaces/default.html#function__authx_reload" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/authx/authx.php"><a href="files/ext-authx-authx.html"><abbr title="ext/authx/authx.php">authx.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">73</span>
</aside>
<p class="phpdocumentor-summary">Reload the current page-view.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_authx_reload</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$route</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$queryString</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$route</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$queryString</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_authx_civicrm_config">
authx_civicrm_config()
<a href="namespaces/default.html#function_authx_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/authx/authx.php"><a href="files/ext-authx-authx.html"><abbr title="ext/authx/authx.php">authx.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">89</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">authx_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$config</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_authx_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/ </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_authx_civicrm_install">
authx_civicrm_install()
<a href="namespaces/default.html#function_authx_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/authx/authx.php"><a href="files/ext-authx-authx.html"><abbr title="ext/authx/authx.php">authx.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">98</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">authx_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_authx_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_authx_civicrm_enable">
authx_civicrm_enable()
<a href="namespaces/default.html#function_authx_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/authx/authx.php"><a href="files/ext-authx-authx.html"><abbr title="ext/authx/authx.php">authx.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">108</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">authx_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_authx_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_authx_civicrm_permission">
authx_civicrm_permission()
<a href="namespaces/default.html#function_authx_civicrm_permission" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/authx/authx.php"><a href="files/ext-authx-authx.html"><abbr title="ext/authx/authx.php">authx.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">124</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_permission().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">authx_civicrm_permission</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$permissions</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$permissions</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_authx_civicrm_permission#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Utils-Hook.html#method_permission"><abbr title="\CRM_Utils_Hook::permission()">CRM_Utils_Hook::permission()</abbr></a></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_cv">
cv()
<a href="namespaces/default.html#function_cv" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/authx/tests/phpunit/bootstrap.php"><a href="files/ext-authx-tests-phpunit-bootstrap.html"><abbr title="ext/authx/tests/phpunit/bootstrap.php">bootstrap.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">27</span>
</aside>
<p class="phpdocumentor-summary">Call the "cv" command.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">cv</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$cmd</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$decode</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">'json'</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$cmd</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The rest of the command to send.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$decode</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">'json'</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Ex: 'json' or 'phpcode'.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_cv#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\RuntimeException">RuntimeException</abbr></span>
<section class="phpdocumentor-description"><p>If the command terminates abnormally.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
—
<section class="phpdocumentor-description"><p>Response output (if the command executed normally).</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__chart_kit_civix_civicrm_config">
_chart_kit_civix_civicrm_config()
<a href="namespaces/default.html#function__chart_kit_civix_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/chart_kit/chart_kit.civix.php"><a href="files/ext-chart-kit-chart-kit-civix.html"><abbr title="ext/chart_kit/chart_kit.civix.php">chart_kit.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">87</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_chart_kit_civix_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$config</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__chart_kit_civix_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__chart_kit_civix_civicrm_install">
_chart_kit_civix_civicrm_install()
<a href="namespaces/default.html#function__chart_kit_civix_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/chart_kit/chart_kit.civix.php"><a href="files/ext-chart-kit-chart-kit-civix.html"><abbr title="ext/chart_kit/chart_kit.civix.php">chart_kit.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">105</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_chart_kit_civix_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__chart_kit_civix_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__chart_kit_civix_civicrm_enable">
_chart_kit_civix_civicrm_enable()
<a href="namespaces/default.html#function__chart_kit_civix_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/chart_kit/chart_kit.civix.php"><a href="files/ext-chart-kit-chart-kit-civix.html"><abbr title="ext/chart_kit/chart_kit.civix.php">chart_kit.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">115</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_chart_kit_civix_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__chart_kit_civix_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__chart_kit_civix_insert_navigation_menu">
_chart_kit_civix_insert_navigation_menu()
<a href="namespaces/default.html#function__chart_kit_civix_insert_navigation_menu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/chart_kit/chart_kit.civix.php"><a href="files/ext-chart-kit-chart-kit-civix.html"><abbr title="ext/chart_kit/chart_kit.civix.php">chart_kit.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">131</span>
</aside>
<p class="phpdocumentor-summary">Inserts a navigation menu item at a given place in the hierarchy.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_chart_kit_civix_insert_navigation_menu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$menu</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$path</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$item</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$menu</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>menu hierarchy</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$path</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>path to parent of this item, e.g. 'my_extension/submenu'
'Mailing', or 'Administer/System Settings'</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$item</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>the item to insert (parent/child attributes will be
filled for you)</li>
</ul>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__chart_kit_civix_navigationMenu">
_chart_kit_civix_navigationMenu()
<a href="namespaces/default.html#function__chart_kit_civix_navigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/chart_kit/chart_kit.civix.php"><a href="files/ext-chart-kit-chart-kit-civix.html"><abbr title="ext/chart_kit/chart_kit.civix.php">chart_kit.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">162</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_navigationMenu().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_chart_kit_civix_navigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__chart_kit_civix_fixNavigationMenu">
_chart_kit_civix_fixNavigationMenu()
<a href="namespaces/default.html#function__chart_kit_civix_fixNavigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/chart_kit/chart_kit.civix.php"><a href="files/ext-chart-kit-chart-kit-civix.html"><abbr title="ext/chart_kit/chart_kit.civix.php">chart_kit.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">172</span>
</aside>
<p class="phpdocumentor-summary">Given a navigation menu, generate navIDs for any items which are
missing them.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_chart_kit_civix_fixNavigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__chart_kit_civix_fixNavigationMenuItems">
_chart_kit_civix_fixNavigationMenuItems()
<a href="namespaces/default.html#function__chart_kit_civix_fixNavigationMenuItems" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/chart_kit/chart_kit.civix.php"><a href="files/ext-chart-kit-chart-kit-civix.html"><abbr title="ext/chart_kit/chart_kit.civix.php">chart_kit.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">182</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_chart_kit_civix_fixNavigationMenuItems</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$maxNavID</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$parentID</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$maxNavID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$parentID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_chart_kit_civicrm_config">
chart_kit_civicrm_config()
<a href="namespaces/default.html#function_chart_kit_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/chart_kit/chart_kit.php"><a href="files/ext-chart-kit-chart-kit.html"><abbr title="ext/chart_kit/chart_kit.php">chart_kit.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">13</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">chart_kit_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$config</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_chart_kit_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/ </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_chart_kit_civicrm_install">
chart_kit_civicrm_install()
<a href="namespaces/default.html#function_chart_kit_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/chart_kit/chart_kit.php"><a href="files/ext-chart-kit-chart-kit.html"><abbr title="ext/chart_kit/chart_kit.php">chart_kit.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">22</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">chart_kit_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_chart_kit_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_chart_kit_civicrm_enable">
chart_kit_civicrm_enable()
<a href="namespaces/default.html#function_chart_kit_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/chart_kit/chart_kit.php"><a href="files/ext-chart-kit-chart-kit.html"><abbr title="ext/chart_kit/chart_kit.php">chart_kit.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">31</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">chart_kit_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_chart_kit_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civi_campaign_civix_civicrm_config">
_civi_campaign_civix_civicrm_config()
<a href="namespaces/default.html#function__civi_campaign_civix_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_campaign/civi_campaign.civix.php"><a href="files/ext-civi-campaign-civi-campaign-civix.html"><abbr title="ext/civi_campaign/civi_campaign.civix.php">civi_campaign.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">87</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civi_campaign_civix_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$config</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civi_campaign_civix_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civi_campaign_civix_civicrm_install">
_civi_campaign_civix_civicrm_install()
<a href="namespaces/default.html#function__civi_campaign_civix_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_campaign/civi_campaign.civix.php"><a href="files/ext-civi-campaign-civi-campaign-civix.html"><abbr title="ext/civi_campaign/civi_campaign.civix.php">civi_campaign.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">105</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civi_campaign_civix_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civi_campaign_civix_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civi_campaign_civix_civicrm_enable">
_civi_campaign_civix_civicrm_enable()
<a href="namespaces/default.html#function__civi_campaign_civix_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_campaign/civi_campaign.civix.php"><a href="files/ext-civi-campaign-civi-campaign-civix.html"><abbr title="ext/civi_campaign/civi_campaign.civix.php">civi_campaign.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">115</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civi_campaign_civix_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civi_campaign_civix_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civi_campaign_civix_insert_navigation_menu">
_civi_campaign_civix_insert_navigation_menu()
<a href="namespaces/default.html#function__civi_campaign_civix_insert_navigation_menu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_campaign/civi_campaign.civix.php"><a href="files/ext-civi-campaign-civi-campaign-civix.html"><abbr title="ext/civi_campaign/civi_campaign.civix.php">civi_campaign.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">131</span>
</aside>
<p class="phpdocumentor-summary">Inserts a navigation menu item at a given place in the hierarchy.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civi_campaign_civix_insert_navigation_menu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$menu</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$path</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$item</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$menu</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>menu hierarchy</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$path</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>path to parent of this item, e.g. 'my_extension/submenu'
'Mailing', or 'Administer/System Settings'</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$item</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>the item to insert (parent/child attributes will be
filled for you)</li>
</ul>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civi_campaign_civix_navigationMenu">
_civi_campaign_civix_navigationMenu()
<a href="namespaces/default.html#function__civi_campaign_civix_navigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_campaign/civi_campaign.civix.php"><a href="files/ext-civi-campaign-civi-campaign-civix.html"><abbr title="ext/civi_campaign/civi_campaign.civix.php">civi_campaign.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">162</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_navigationMenu().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civi_campaign_civix_navigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civi_campaign_civix_fixNavigationMenu">
_civi_campaign_civix_fixNavigationMenu()
<a href="namespaces/default.html#function__civi_campaign_civix_fixNavigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_campaign/civi_campaign.civix.php"><a href="files/ext-civi-campaign-civi-campaign-civix.html"><abbr title="ext/civi_campaign/civi_campaign.civix.php">civi_campaign.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">172</span>
</aside>
<p class="phpdocumentor-summary">Given a navigation menu, generate navIDs for any items which are
missing them.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civi_campaign_civix_fixNavigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civi_campaign_civix_fixNavigationMenuItems">
_civi_campaign_civix_fixNavigationMenuItems()
<a href="namespaces/default.html#function__civi_campaign_civix_fixNavigationMenuItems" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_campaign/civi_campaign.civix.php"><a href="files/ext-civi-campaign-civi-campaign-civix.html"><abbr title="ext/civi_campaign/civi_campaign.civix.php">civi_campaign.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">182</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civi_campaign_civix_fixNavigationMenuItems</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$maxNavID</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$parentID</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$maxNavID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$parentID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civi_case_civix_civicrm_config">
_civi_case_civix_civicrm_config()
<a href="namespaces/default.html#function__civi_case_civix_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_case/civi_case.civix.php"><a href="files/ext-civi-case-civi-case-civix.html"><abbr title="ext/civi_case/civi_case.civix.php">civi_case.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">87</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civi_case_civix_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$config</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civi_case_civix_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civi_case_civix_civicrm_install">
_civi_case_civix_civicrm_install()
<a href="namespaces/default.html#function__civi_case_civix_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_case/civi_case.civix.php"><a href="files/ext-civi-case-civi-case-civix.html"><abbr title="ext/civi_case/civi_case.civix.php">civi_case.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">105</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civi_case_civix_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civi_case_civix_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civi_case_civix_civicrm_enable">
_civi_case_civix_civicrm_enable()
<a href="namespaces/default.html#function__civi_case_civix_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_case/civi_case.civix.php"><a href="files/ext-civi-case-civi-case-civix.html"><abbr title="ext/civi_case/civi_case.civix.php">civi_case.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">115</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civi_case_civix_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civi_case_civix_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civi_case_civix_insert_navigation_menu">
_civi_case_civix_insert_navigation_menu()
<a href="namespaces/default.html#function__civi_case_civix_insert_navigation_menu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_case/civi_case.civix.php"><a href="files/ext-civi-case-civi-case-civix.html"><abbr title="ext/civi_case/civi_case.civix.php">civi_case.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">131</span>
</aside>
<p class="phpdocumentor-summary">Inserts a navigation menu item at a given place in the hierarchy.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civi_case_civix_insert_navigation_menu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$menu</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$path</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$item</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$menu</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>menu hierarchy</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$path</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>path to parent of this item, e.g. 'my_extension/submenu'
'Mailing', or 'Administer/System Settings'</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$item</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>the item to insert (parent/child attributes will be
filled for you)</li>
</ul>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civi_case_civix_navigationMenu">
_civi_case_civix_navigationMenu()
<a href="namespaces/default.html#function__civi_case_civix_navigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_case/civi_case.civix.php"><a href="files/ext-civi-case-civi-case-civix.html"><abbr title="ext/civi_case/civi_case.civix.php">civi_case.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">162</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_navigationMenu().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civi_case_civix_navigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civi_case_civix_fixNavigationMenu">
_civi_case_civix_fixNavigationMenu()
<a href="namespaces/default.html#function__civi_case_civix_fixNavigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_case/civi_case.civix.php"><a href="files/ext-civi-case-civi-case-civix.html"><abbr title="ext/civi_case/civi_case.civix.php">civi_case.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">172</span>
</aside>
<p class="phpdocumentor-summary">Given a navigation menu, generate navIDs for any items which are
missing them.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civi_case_civix_fixNavigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civi_case_civix_fixNavigationMenuItems">
_civi_case_civix_fixNavigationMenuItems()
<a href="namespaces/default.html#function__civi_case_civix_fixNavigationMenuItems" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_case/civi_case.civix.php"><a href="files/ext-civi-case-civi-case-civix.html"><abbr title="ext/civi_case/civi_case.civix.php">civi_case.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">182</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civi_case_civix_fixNavigationMenuItems</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$maxNavID</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$parentID</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$maxNavID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$parentID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civi_case_civicrm_managed">
civi_case_civicrm_managed()
<a href="namespaces/default.html#function_civi_case_civicrm_managed" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_case/civi_case.php"><a href="files/ext-civi-case-civi-case.html"><abbr title="ext/civi_case/civi_case.php">civi_case.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">9</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_managed().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civi_case_civicrm_managed</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$entities</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$modules</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entities</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$modules</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civi_case_civicrm_selectWhereClause">
civi_case_civicrm_selectWhereClause()
<a href="namespaces/default.html#function_civi_case_civicrm_selectWhereClause" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_case/civi_case.php"><a href="files/ext-civi-case-civi-case.html"><abbr title="ext/civi_case/civi_case.php">civi_case.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">26</span>
</aside>
<p class="phpdocumentor-summary">Applies Case permissions to Activities</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civi_case_civicrm_selectWhereClause</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$entityName</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$clauses</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$userId</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$conditions</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entityName</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$clauses</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$userId</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$conditions</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civi_case_civicrm_selectWhereClause#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">implements</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>CRM_Utils_Hook::selectWhereClause</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civi_contribute_civix_civicrm_config">
_civi_contribute_civix_civicrm_config()
<a href="namespaces/default.html#function__civi_contribute_civix_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_contribute/civi_contribute.civix.php"><a href="files/ext-civi-contribute-civi-contribute-civix.html"><abbr title="ext/civi_contribute/civi_contribute.civix.php">civi_contribute.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">87</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civi_contribute_civix_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$config</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civi_contribute_civix_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civi_contribute_civix_civicrm_install">
_civi_contribute_civix_civicrm_install()
<a href="namespaces/default.html#function__civi_contribute_civix_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_contribute/civi_contribute.civix.php"><a href="files/ext-civi-contribute-civi-contribute-civix.html"><abbr title="ext/civi_contribute/civi_contribute.civix.php">civi_contribute.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">105</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civi_contribute_civix_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civi_contribute_civix_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civi_contribute_civix_civicrm_enable">
_civi_contribute_civix_civicrm_enable()
<a href="namespaces/default.html#function__civi_contribute_civix_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_contribute/civi_contribute.civix.php"><a href="files/ext-civi-contribute-civi-contribute-civix.html"><abbr title="ext/civi_contribute/civi_contribute.civix.php">civi_contribute.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">115</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civi_contribute_civix_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civi_contribute_civix_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civi_contribute_civix_insert_navigation_menu">
_civi_contribute_civix_insert_navigation_menu()
<a href="namespaces/default.html#function__civi_contribute_civix_insert_navigation_menu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_contribute/civi_contribute.civix.php"><a href="files/ext-civi-contribute-civi-contribute-civix.html"><abbr title="ext/civi_contribute/civi_contribute.civix.php">civi_contribute.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">131</span>
</aside>
<p class="phpdocumentor-summary">Inserts a navigation menu item at a given place in the hierarchy.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civi_contribute_civix_insert_navigation_menu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$menu</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$path</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$item</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$menu</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>menu hierarchy</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$path</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>path to parent of this item, e.g. 'my_extension/submenu'
'Mailing', or 'Administer/System Settings'</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$item</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>the item to insert (parent/child attributes will be
filled for you)</li>
</ul>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civi_contribute_civix_navigationMenu">
_civi_contribute_civix_navigationMenu()
<a href="namespaces/default.html#function__civi_contribute_civix_navigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_contribute/civi_contribute.civix.php"><a href="files/ext-civi-contribute-civi-contribute-civix.html"><abbr title="ext/civi_contribute/civi_contribute.civix.php">civi_contribute.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">162</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_navigationMenu().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civi_contribute_civix_navigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civi_contribute_civix_fixNavigationMenu">
_civi_contribute_civix_fixNavigationMenu()
<a href="namespaces/default.html#function__civi_contribute_civix_fixNavigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_contribute/civi_contribute.civix.php"><a href="files/ext-civi-contribute-civi-contribute-civix.html"><abbr title="ext/civi_contribute/civi_contribute.civix.php">civi_contribute.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">172</span>
</aside>
<p class="phpdocumentor-summary">Given a navigation menu, generate navIDs for any items which are
missing them.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civi_contribute_civix_fixNavigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civi_contribute_civix_fixNavigationMenuItems">
_civi_contribute_civix_fixNavigationMenuItems()
<a href="namespaces/default.html#function__civi_contribute_civix_fixNavigationMenuItems" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_contribute/civi_contribute.civix.php"><a href="files/ext-civi-contribute-civi-contribute-civix.html"><abbr title="ext/civi_contribute/civi_contribute.civix.php">civi_contribute.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">182</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civi_contribute_civix_fixNavigationMenuItems</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$maxNavID</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$parentID</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$maxNavID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$parentID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_cv">
cv()
<a href="namespaces/default.html#function_cv" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_contribute/tests/phpunit/bootstrap.php"><a href="files/ext-civi-contribute-tests-phpunit-bootstrap.html"><abbr title="ext/civi_contribute/tests/phpunit/bootstrap.php">bootstrap.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">30</span>
</aside>
<p class="phpdocumentor-summary">Call the "cv" command.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">cv</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$cmd</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$decode</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">'json'</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$cmd</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The rest of the command to send.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$decode</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">'json'</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Ex: 'json' or 'phpcode'.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_cv#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\RuntimeException">RuntimeException</abbr></span>
<section class="phpdocumentor-description"><p>If the command terminates abnormally.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
—
<section class="phpdocumentor-description"><p>Response output (if the command executed normally).
For 'raw' or 'phpcode', this will be a string. For 'json', it could be any JSON value.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civi_event_civix_civicrm_config">
_civi_event_civix_civicrm_config()
<a href="namespaces/default.html#function__civi_event_civix_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_event/civi_event.civix.php"><a href="files/ext-civi-event-civi-event-civix.html"><abbr title="ext/civi_event/civi_event.civix.php">civi_event.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">87</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civi_event_civix_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$config</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civi_event_civix_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civi_event_civix_civicrm_install">
_civi_event_civix_civicrm_install()
<a href="namespaces/default.html#function__civi_event_civix_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_event/civi_event.civix.php"><a href="files/ext-civi-event-civi-event-civix.html"><abbr title="ext/civi_event/civi_event.civix.php">civi_event.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">105</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civi_event_civix_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civi_event_civix_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civi_event_civix_civicrm_enable">
_civi_event_civix_civicrm_enable()
<a href="namespaces/default.html#function__civi_event_civix_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_event/civi_event.civix.php"><a href="files/ext-civi-event-civi-event-civix.html"><abbr title="ext/civi_event/civi_event.civix.php">civi_event.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">115</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civi_event_civix_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civi_event_civix_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civi_event_civix_insert_navigation_menu">
_civi_event_civix_insert_navigation_menu()
<a href="namespaces/default.html#function__civi_event_civix_insert_navigation_menu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_event/civi_event.civix.php"><a href="files/ext-civi-event-civi-event-civix.html"><abbr title="ext/civi_event/civi_event.civix.php">civi_event.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">131</span>
</aside>
<p class="phpdocumentor-summary">Inserts a navigation menu item at a given place in the hierarchy.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civi_event_civix_insert_navigation_menu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$menu</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$path</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$item</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$menu</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>menu hierarchy</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$path</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>path to parent of this item, e.g. 'my_extension/submenu'
'Mailing', or 'Administer/System Settings'</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$item</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>the item to insert (parent/child attributes will be
filled for you)</li>
</ul>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civi_event_civix_navigationMenu">
_civi_event_civix_navigationMenu()
<a href="namespaces/default.html#function__civi_event_civix_navigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_event/civi_event.civix.php"><a href="files/ext-civi-event-civi-event-civix.html"><abbr title="ext/civi_event/civi_event.civix.php">civi_event.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">162</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_navigationMenu().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civi_event_civix_navigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civi_event_civix_fixNavigationMenu">
_civi_event_civix_fixNavigationMenu()
<a href="namespaces/default.html#function__civi_event_civix_fixNavigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_event/civi_event.civix.php"><a href="files/ext-civi-event-civi-event-civix.html"><abbr title="ext/civi_event/civi_event.civix.php">civi_event.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">172</span>
</aside>
<p class="phpdocumentor-summary">Given a navigation menu, generate navIDs for any items which are
missing them.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civi_event_civix_fixNavigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civi_event_civix_fixNavigationMenuItems">
_civi_event_civix_fixNavigationMenuItems()
<a href="namespaces/default.html#function__civi_event_civix_fixNavigationMenuItems" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_event/civi_event.civix.php"><a href="files/ext-civi-event-civi-event-civix.html"><abbr title="ext/civi_event/civi_event.civix.php">civi_event.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">182</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civi_event_civix_fixNavigationMenuItems</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$maxNavID</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$parentID</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$maxNavID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$parentID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civi_mail_civix_civicrm_config">
_civi_mail_civix_civicrm_config()
<a href="namespaces/default.html#function__civi_mail_civix_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_mail/civi_mail.civix.php"><a href="files/ext-civi-mail-civi-mail-civix.html"><abbr title="ext/civi_mail/civi_mail.civix.php">civi_mail.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">87</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civi_mail_civix_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$config</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civi_mail_civix_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civi_mail_civix_civicrm_install">
_civi_mail_civix_civicrm_install()
<a href="namespaces/default.html#function__civi_mail_civix_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_mail/civi_mail.civix.php"><a href="files/ext-civi-mail-civi-mail-civix.html"><abbr title="ext/civi_mail/civi_mail.civix.php">civi_mail.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">105</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civi_mail_civix_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civi_mail_civix_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civi_mail_civix_civicrm_enable">
_civi_mail_civix_civicrm_enable()
<a href="namespaces/default.html#function__civi_mail_civix_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_mail/civi_mail.civix.php"><a href="files/ext-civi-mail-civi-mail-civix.html"><abbr title="ext/civi_mail/civi_mail.civix.php">civi_mail.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">115</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civi_mail_civix_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civi_mail_civix_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civi_mail_civix_insert_navigation_menu">
_civi_mail_civix_insert_navigation_menu()
<a href="namespaces/default.html#function__civi_mail_civix_insert_navigation_menu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_mail/civi_mail.civix.php"><a href="files/ext-civi-mail-civi-mail-civix.html"><abbr title="ext/civi_mail/civi_mail.civix.php">civi_mail.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">131</span>
</aside>
<p class="phpdocumentor-summary">Inserts a navigation menu item at a given place in the hierarchy.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civi_mail_civix_insert_navigation_menu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$menu</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$path</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$item</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$menu</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>menu hierarchy</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$path</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>path to parent of this item, e.g. 'my_extension/submenu'
'Mailing', or 'Administer/System Settings'</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$item</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>the item to insert (parent/child attributes will be
filled for you)</li>
</ul>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civi_mail_civix_navigationMenu">
_civi_mail_civix_navigationMenu()
<a href="namespaces/default.html#function__civi_mail_civix_navigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_mail/civi_mail.civix.php"><a href="files/ext-civi-mail-civi-mail-civix.html"><abbr title="ext/civi_mail/civi_mail.civix.php">civi_mail.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">162</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_navigationMenu().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civi_mail_civix_navigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civi_mail_civix_fixNavigationMenu">
_civi_mail_civix_fixNavigationMenu()
<a href="namespaces/default.html#function__civi_mail_civix_fixNavigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_mail/civi_mail.civix.php"><a href="files/ext-civi-mail-civi-mail-civix.html"><abbr title="ext/civi_mail/civi_mail.civix.php">civi_mail.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">172</span>
</aside>
<p class="phpdocumentor-summary">Given a navigation menu, generate navIDs for any items which are
missing them.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civi_mail_civix_fixNavigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civi_mail_civix_fixNavigationMenuItems">
_civi_mail_civix_fixNavigationMenuItems()
<a href="namespaces/default.html#function__civi_mail_civix_fixNavigationMenuItems" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_mail/civi_mail.civix.php"><a href="files/ext-civi-mail-civi-mail-civix.html"><abbr title="ext/civi_mail/civi_mail.civix.php">civi_mail.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">182</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civi_mail_civix_fixNavigationMenuItems</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$maxNavID</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$parentID</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$maxNavID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$parentID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civi_member_civix_civicrm_config">
_civi_member_civix_civicrm_config()
<a href="namespaces/default.html#function__civi_member_civix_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_member/civi_member.civix.php"><a href="files/ext-civi-member-civi-member-civix.html"><abbr title="ext/civi_member/civi_member.civix.php">civi_member.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">87</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civi_member_civix_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$config</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civi_member_civix_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civi_member_civix_civicrm_install">
_civi_member_civix_civicrm_install()
<a href="namespaces/default.html#function__civi_member_civix_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_member/civi_member.civix.php"><a href="files/ext-civi-member-civi-member-civix.html"><abbr title="ext/civi_member/civi_member.civix.php">civi_member.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">105</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civi_member_civix_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civi_member_civix_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civi_member_civix_civicrm_enable">
_civi_member_civix_civicrm_enable()
<a href="namespaces/default.html#function__civi_member_civix_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_member/civi_member.civix.php"><a href="files/ext-civi-member-civi-member-civix.html"><abbr title="ext/civi_member/civi_member.civix.php">civi_member.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">115</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civi_member_civix_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civi_member_civix_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civi_member_civix_insert_navigation_menu">
_civi_member_civix_insert_navigation_menu()
<a href="namespaces/default.html#function__civi_member_civix_insert_navigation_menu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_member/civi_member.civix.php"><a href="files/ext-civi-member-civi-member-civix.html"><abbr title="ext/civi_member/civi_member.civix.php">civi_member.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">131</span>
</aside>
<p class="phpdocumentor-summary">Inserts a navigation menu item at a given place in the hierarchy.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civi_member_civix_insert_navigation_menu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$menu</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$path</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$item</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$menu</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>menu hierarchy</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$path</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>path to parent of this item, e.g. 'my_extension/submenu'
'Mailing', or 'Administer/System Settings'</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$item</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>the item to insert (parent/child attributes will be
filled for you)</li>
</ul>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civi_member_civix_navigationMenu">
_civi_member_civix_navigationMenu()
<a href="namespaces/default.html#function__civi_member_civix_navigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_member/civi_member.civix.php"><a href="files/ext-civi-member-civi-member-civix.html"><abbr title="ext/civi_member/civi_member.civix.php">civi_member.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">162</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_navigationMenu().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civi_member_civix_navigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civi_member_civix_fixNavigationMenu">
_civi_member_civix_fixNavigationMenu()
<a href="namespaces/default.html#function__civi_member_civix_fixNavigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_member/civi_member.civix.php"><a href="files/ext-civi-member-civi-member-civix.html"><abbr title="ext/civi_member/civi_member.civix.php">civi_member.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">172</span>
</aside>
<p class="phpdocumentor-summary">Given a navigation menu, generate navIDs for any items which are
missing them.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civi_member_civix_fixNavigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civi_member_civix_fixNavigationMenuItems">
_civi_member_civix_fixNavigationMenuItems()
<a href="namespaces/default.html#function__civi_member_civix_fixNavigationMenuItems" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_member/civi_member.civix.php"><a href="files/ext-civi-member-civi-member-civix.html"><abbr title="ext/civi_member/civi_member.civix.php">civi_member.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">182</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civi_member_civix_fixNavigationMenuItems</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$maxNavID</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$parentID</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$maxNavID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$parentID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civi_pledge_civix_civicrm_config">
_civi_pledge_civix_civicrm_config()
<a href="namespaces/default.html#function__civi_pledge_civix_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_pledge/civi_pledge.civix.php"><a href="files/ext-civi-pledge-civi-pledge-civix.html"><abbr title="ext/civi_pledge/civi_pledge.civix.php">civi_pledge.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">87</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civi_pledge_civix_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$config</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civi_pledge_civix_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civi_pledge_civix_civicrm_install">
_civi_pledge_civix_civicrm_install()
<a href="namespaces/default.html#function__civi_pledge_civix_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_pledge/civi_pledge.civix.php"><a href="files/ext-civi-pledge-civi-pledge-civix.html"><abbr title="ext/civi_pledge/civi_pledge.civix.php">civi_pledge.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">105</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civi_pledge_civix_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civi_pledge_civix_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civi_pledge_civix_civicrm_enable">
_civi_pledge_civix_civicrm_enable()
<a href="namespaces/default.html#function__civi_pledge_civix_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_pledge/civi_pledge.civix.php"><a href="files/ext-civi-pledge-civi-pledge-civix.html"><abbr title="ext/civi_pledge/civi_pledge.civix.php">civi_pledge.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">115</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civi_pledge_civix_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civi_pledge_civix_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civi_pledge_civix_insert_navigation_menu">
_civi_pledge_civix_insert_navigation_menu()
<a href="namespaces/default.html#function__civi_pledge_civix_insert_navigation_menu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_pledge/civi_pledge.civix.php"><a href="files/ext-civi-pledge-civi-pledge-civix.html"><abbr title="ext/civi_pledge/civi_pledge.civix.php">civi_pledge.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">131</span>
</aside>
<p class="phpdocumentor-summary">Inserts a navigation menu item at a given place in the hierarchy.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civi_pledge_civix_insert_navigation_menu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$menu</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$path</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$item</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$menu</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>menu hierarchy</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$path</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>path to parent of this item, e.g. 'my_extension/submenu'
'Mailing', or 'Administer/System Settings'</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$item</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>the item to insert (parent/child attributes will be
filled for you)</li>
</ul>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civi_pledge_civix_navigationMenu">
_civi_pledge_civix_navigationMenu()
<a href="namespaces/default.html#function__civi_pledge_civix_navigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_pledge/civi_pledge.civix.php"><a href="files/ext-civi-pledge-civi-pledge-civix.html"><abbr title="ext/civi_pledge/civi_pledge.civix.php">civi_pledge.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">162</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_navigationMenu().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civi_pledge_civix_navigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civi_pledge_civix_fixNavigationMenu">
_civi_pledge_civix_fixNavigationMenu()
<a href="namespaces/default.html#function__civi_pledge_civix_fixNavigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_pledge/civi_pledge.civix.php"><a href="files/ext-civi-pledge-civi-pledge-civix.html"><abbr title="ext/civi_pledge/civi_pledge.civix.php">civi_pledge.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">172</span>
</aside>
<p class="phpdocumentor-summary">Given a navigation menu, generate navIDs for any items which are
missing them.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civi_pledge_civix_fixNavigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civi_pledge_civix_fixNavigationMenuItems">
_civi_pledge_civix_fixNavigationMenuItems()
<a href="namespaces/default.html#function__civi_pledge_civix_fixNavigationMenuItems" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_pledge/civi_pledge.civix.php"><a href="files/ext-civi-pledge-civi-pledge-civix.html"><abbr title="ext/civi_pledge/civi_pledge.civix.php">civi_pledge.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">182</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civi_pledge_civix_fixNavigationMenuItems</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$maxNavID</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$parentID</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$maxNavID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$parentID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civi_report_civix_civicrm_config">
_civi_report_civix_civicrm_config()
<a href="namespaces/default.html#function__civi_report_civix_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_report/civi_report.civix.php"><a href="files/ext-civi-report-civi-report-civix.html"><abbr title="ext/civi_report/civi_report.civix.php">civi_report.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">87</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civi_report_civix_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$config</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civi_report_civix_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civi_report_civix_civicrm_install">
_civi_report_civix_civicrm_install()
<a href="namespaces/default.html#function__civi_report_civix_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_report/civi_report.civix.php"><a href="files/ext-civi-report-civi-report-civix.html"><abbr title="ext/civi_report/civi_report.civix.php">civi_report.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">105</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civi_report_civix_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civi_report_civix_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civi_report_civix_civicrm_enable">
_civi_report_civix_civicrm_enable()
<a href="namespaces/default.html#function__civi_report_civix_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_report/civi_report.civix.php"><a href="files/ext-civi-report-civi-report-civix.html"><abbr title="ext/civi_report/civi_report.civix.php">civi_report.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">115</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civi_report_civix_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civi_report_civix_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civi_report_civix_insert_navigation_menu">
_civi_report_civix_insert_navigation_menu()
<a href="namespaces/default.html#function__civi_report_civix_insert_navigation_menu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_report/civi_report.civix.php"><a href="files/ext-civi-report-civi-report-civix.html"><abbr title="ext/civi_report/civi_report.civix.php">civi_report.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">131</span>
</aside>
<p class="phpdocumentor-summary">Inserts a navigation menu item at a given place in the hierarchy.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civi_report_civix_insert_navigation_menu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$menu</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$path</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$item</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$menu</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>menu hierarchy</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$path</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>path to parent of this item, e.g. 'my_extension/submenu'
'Mailing', or 'Administer/System Settings'</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$item</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>the item to insert (parent/child attributes will be
filled for you)</li>
</ul>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civi_report_civix_navigationMenu">
_civi_report_civix_navigationMenu()
<a href="namespaces/default.html#function__civi_report_civix_navigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_report/civi_report.civix.php"><a href="files/ext-civi-report-civi-report-civix.html"><abbr title="ext/civi_report/civi_report.civix.php">civi_report.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">162</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_navigationMenu().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civi_report_civix_navigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civi_report_civix_fixNavigationMenu">
_civi_report_civix_fixNavigationMenu()
<a href="namespaces/default.html#function__civi_report_civix_fixNavigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_report/civi_report.civix.php"><a href="files/ext-civi-report-civi-report-civix.html"><abbr title="ext/civi_report/civi_report.civix.php">civi_report.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">172</span>
</aside>
<p class="phpdocumentor-summary">Given a navigation menu, generate navIDs for any items which are
missing them.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civi_report_civix_fixNavigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civi_report_civix_fixNavigationMenuItems">
_civi_report_civix_fixNavigationMenuItems()
<a href="namespaces/default.html#function__civi_report_civix_fixNavigationMenuItems" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_report/civi_report.civix.php"><a href="files/ext-civi-report-civi-report-civix.html"><abbr title="ext/civi_report/civi_report.civix.php">civi_report.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">182</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civi_report_civix_fixNavigationMenuItems</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$maxNavID</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$parentID</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$maxNavID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$parentID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_cv">
cv()
<a href="namespaces/default.html#function_cv" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civi_report/tests/phpunit/bootstrap.php"><a href="files/ext-civi-report-tests-phpunit-bootstrap.html"><abbr title="ext/civi_report/tests/phpunit/bootstrap.php">bootstrap.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">30</span>
</aside>
<p class="phpdocumentor-summary">Call the "cv" command.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">cv</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$cmd</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$decode</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">'json'</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$cmd</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The rest of the command to send.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$decode</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">'json'</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Ex: 'json' or 'phpcode'.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_cv#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\RuntimeException">RuntimeException</abbr></span>
<section class="phpdocumentor-description"><p>If the command terminates abnormally.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
—
<section class="phpdocumentor-description"><p>Response output (if the command executed normally).
For 'raw' or 'phpcode', this will be a string. For 'json', it could be any JSON value.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_admin_ui_civix_civicrm_config">
_civicrm_admin_ui_civix_civicrm_config()
<a href="namespaces/default.html#function__civicrm_admin_ui_civix_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civicrm_admin_ui/civicrm_admin_ui.civix.php"><a href="files/ext-civicrm-admin-ui-civicrm-admin-ui-civix.html"><abbr title="ext/civicrm_admin_ui/civicrm_admin_ui.civix.php">civicrm_admin_ui.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">87</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_admin_ui_civix_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$config</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_admin_ui_civix_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_admin_ui_civix_civicrm_install">
_civicrm_admin_ui_civix_civicrm_install()
<a href="namespaces/default.html#function__civicrm_admin_ui_civix_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civicrm_admin_ui/civicrm_admin_ui.civix.php"><a href="files/ext-civicrm-admin-ui-civicrm-admin-ui-civix.html"><abbr title="ext/civicrm_admin_ui/civicrm_admin_ui.civix.php">civicrm_admin_ui.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">105</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_admin_ui_civix_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_admin_ui_civix_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_admin_ui_civix_civicrm_enable">
_civicrm_admin_ui_civix_civicrm_enable()
<a href="namespaces/default.html#function__civicrm_admin_ui_civix_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civicrm_admin_ui/civicrm_admin_ui.civix.php"><a href="files/ext-civicrm-admin-ui-civicrm-admin-ui-civix.html"><abbr title="ext/civicrm_admin_ui/civicrm_admin_ui.civix.php">civicrm_admin_ui.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">115</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_admin_ui_civix_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_admin_ui_civix_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_admin_ui_civix_insert_navigation_menu">
_civicrm_admin_ui_civix_insert_navigation_menu()
<a href="namespaces/default.html#function__civicrm_admin_ui_civix_insert_navigation_menu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civicrm_admin_ui/civicrm_admin_ui.civix.php"><a href="files/ext-civicrm-admin-ui-civicrm-admin-ui-civix.html"><abbr title="ext/civicrm_admin_ui/civicrm_admin_ui.civix.php">civicrm_admin_ui.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">131</span>
</aside>
<p class="phpdocumentor-summary">Inserts a navigation menu item at a given place in the hierarchy.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_admin_ui_civix_insert_navigation_menu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$menu</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$path</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$item</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$menu</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>menu hierarchy</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$path</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>path to parent of this item, e.g. 'my_extension/submenu'
'Mailing', or 'Administer/System Settings'</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$item</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>the item to insert (parent/child attributes will be
filled for you)</li>
</ul>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_admin_ui_civix_navigationMenu">
_civicrm_admin_ui_civix_navigationMenu()
<a href="namespaces/default.html#function__civicrm_admin_ui_civix_navigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civicrm_admin_ui/civicrm_admin_ui.civix.php"><a href="files/ext-civicrm-admin-ui-civicrm-admin-ui-civix.html"><abbr title="ext/civicrm_admin_ui/civicrm_admin_ui.civix.php">civicrm_admin_ui.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">162</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_navigationMenu().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_admin_ui_civix_navigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_admin_ui_civix_fixNavigationMenu">
_civicrm_admin_ui_civix_fixNavigationMenu()
<a href="namespaces/default.html#function__civicrm_admin_ui_civix_fixNavigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civicrm_admin_ui/civicrm_admin_ui.civix.php"><a href="files/ext-civicrm-admin-ui-civicrm-admin-ui-civix.html"><abbr title="ext/civicrm_admin_ui/civicrm_admin_ui.civix.php">civicrm_admin_ui.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">172</span>
</aside>
<p class="phpdocumentor-summary">Given a navigation menu, generate navIDs for any items which are
missing them.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_admin_ui_civix_fixNavigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_admin_ui_civix_fixNavigationMenuItems">
_civicrm_admin_ui_civix_fixNavigationMenuItems()
<a href="namespaces/default.html#function__civicrm_admin_ui_civix_fixNavigationMenuItems" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civicrm_admin_ui/civicrm_admin_ui.civix.php"><a href="files/ext-civicrm-admin-ui-civicrm-admin-ui-civix.html"><abbr title="ext/civicrm_admin_ui/civicrm_admin_ui.civix.php">civicrm_admin_ui.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">182</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_admin_ui_civix_fixNavigationMenuItems</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$maxNavID</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$parentID</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$maxNavID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$parentID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_admin_ui_civicrm_config">
civicrm_admin_ui_civicrm_config()
<a href="namespaces/default.html#function_civicrm_admin_ui_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civicrm_admin_ui/civicrm_admin_ui.php"><a href="files/ext-civicrm-admin-ui-civicrm-admin-ui.html"><abbr title="ext/civicrm_admin_ui/civicrm_admin_ui.php">civicrm_admin_ui.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">13</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_admin_ui_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$config</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_admin_ui_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/ </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_admin_ui_civicrm_postProcess">
civicrm_admin_ui_civicrm_postProcess()
<a href="namespaces/default.html#function_civicrm_admin_ui_civicrm_postProcess" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civicrm_admin_ui/civicrm_admin_ui.php"><a href="files/ext-civicrm-admin-ui-civicrm-admin-ui.html"><abbr title="ext/civicrm_admin_ui/civicrm_admin_ui.php">civicrm_admin_ui.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">20</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_postProcess().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_admin_ui_civicrm_postProcess</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$className</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$form</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$className</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$form</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_cv">
cv()
<a href="namespaces/default.html#function_cv" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civicrm_admin_ui/tests/phpunit/bootstrap.php"><a href="files/ext-civicrm-admin-ui-tests-phpunit-bootstrap.html"><abbr title="ext/civicrm_admin_ui/tests/phpunit/bootstrap.php">bootstrap.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">30</span>
</aside>
<p class="phpdocumentor-summary">Call the "cv" command.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">cv</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$cmd</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$decode</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">'json'</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$cmd</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The rest of the command to send.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$decode</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">'json'</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Ex: 'json' or 'phpcode'.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_cv#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\RuntimeException">RuntimeException</abbr></span>
<section class="phpdocumentor-description"><p>If the command terminates abnormally.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
—
<section class="phpdocumentor-description"><p>Response output (if the command executed normally).
For 'raw' or 'phpcode', this will be a string. For 'json', it could be any JSON value.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_search_ui_civix_civicrm_config">
_civicrm_search_ui_civix_civicrm_config()
<a href="namespaces/default.html#function__civicrm_search_ui_civix_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civicrm_search_ui/civicrm_search_ui.civix.php"><a href="files/ext-civicrm-search-ui-civicrm-search-ui-civix.html"><abbr title="ext/civicrm_search_ui/civicrm_search_ui.civix.php">civicrm_search_ui.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">87</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_search_ui_civix_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$config</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_search_ui_civix_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_search_ui_civix_civicrm_install">
_civicrm_search_ui_civix_civicrm_install()
<a href="namespaces/default.html#function__civicrm_search_ui_civix_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civicrm_search_ui/civicrm_search_ui.civix.php"><a href="files/ext-civicrm-search-ui-civicrm-search-ui-civix.html"><abbr title="ext/civicrm_search_ui/civicrm_search_ui.civix.php">civicrm_search_ui.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">105</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_search_ui_civix_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_search_ui_civix_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_search_ui_civix_civicrm_enable">
_civicrm_search_ui_civix_civicrm_enable()
<a href="namespaces/default.html#function__civicrm_search_ui_civix_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civicrm_search_ui/civicrm_search_ui.civix.php"><a href="files/ext-civicrm-search-ui-civicrm-search-ui-civix.html"><abbr title="ext/civicrm_search_ui/civicrm_search_ui.civix.php">civicrm_search_ui.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">115</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_search_ui_civix_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_search_ui_civix_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_search_ui_civix_insert_navigation_menu">
_civicrm_search_ui_civix_insert_navigation_menu()
<a href="namespaces/default.html#function__civicrm_search_ui_civix_insert_navigation_menu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civicrm_search_ui/civicrm_search_ui.civix.php"><a href="files/ext-civicrm-search-ui-civicrm-search-ui-civix.html"><abbr title="ext/civicrm_search_ui/civicrm_search_ui.civix.php">civicrm_search_ui.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">131</span>
</aside>
<p class="phpdocumentor-summary">Inserts a navigation menu item at a given place in the hierarchy.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_search_ui_civix_insert_navigation_menu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$menu</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$path</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$item</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$menu</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>menu hierarchy</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$path</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>path to parent of this item, e.g. 'my_extension/submenu'
'Mailing', or 'Administer/System Settings'</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$item</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>the item to insert (parent/child attributes will be
filled for you)</li>
</ul>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_search_ui_civix_navigationMenu">
_civicrm_search_ui_civix_navigationMenu()
<a href="namespaces/default.html#function__civicrm_search_ui_civix_navigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civicrm_search_ui/civicrm_search_ui.civix.php"><a href="files/ext-civicrm-search-ui-civicrm-search-ui-civix.html"><abbr title="ext/civicrm_search_ui/civicrm_search_ui.civix.php">civicrm_search_ui.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">162</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_navigationMenu().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_search_ui_civix_navigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_search_ui_civix_fixNavigationMenu">
_civicrm_search_ui_civix_fixNavigationMenu()
<a href="namespaces/default.html#function__civicrm_search_ui_civix_fixNavigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civicrm_search_ui/civicrm_search_ui.civix.php"><a href="files/ext-civicrm-search-ui-civicrm-search-ui-civix.html"><abbr title="ext/civicrm_search_ui/civicrm_search_ui.civix.php">civicrm_search_ui.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">172</span>
</aside>
<p class="phpdocumentor-summary">Given a navigation menu, generate navIDs for any items which are
missing them.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_search_ui_civix_fixNavigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_search_ui_civix_fixNavigationMenuItems">
_civicrm_search_ui_civix_fixNavigationMenuItems()
<a href="namespaces/default.html#function__civicrm_search_ui_civix_fixNavigationMenuItems" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civicrm_search_ui/civicrm_search_ui.civix.php"><a href="files/ext-civicrm-search-ui-civicrm-search-ui-civix.html"><abbr title="ext/civicrm_search_ui/civicrm_search_ui.civix.php">civicrm_search_ui.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">182</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_search_ui_civix_fixNavigationMenuItems</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$maxNavID</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$parentID</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$maxNavID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$parentID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_search_ui_civicrm_config">
civicrm_search_ui_civicrm_config()
<a href="namespaces/default.html#function_civicrm_search_ui_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civicrm_search_ui/civicrm_search_ui.php"><a href="files/ext-civicrm-search-ui-civicrm-search-ui.html"><abbr title="ext/civicrm_search_ui/civicrm_search_ui.php">civicrm_search_ui.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">13</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_search_ui_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$config</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_search_ui_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/ </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_search_ui_civicrm_install">
civicrm_search_ui_civicrm_install()
<a href="namespaces/default.html#function_civicrm_search_ui_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civicrm_search_ui/civicrm_search_ui.php"><a href="files/ext-civicrm-search-ui-civicrm-search-ui.html"><abbr title="ext/civicrm_search_ui/civicrm_search_ui.php">civicrm_search_ui.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">22</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_search_ui_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_search_ui_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_search_ui_civicrm_enable">
civicrm_search_ui_civicrm_enable()
<a href="namespaces/default.html#function_civicrm_search_ui_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civicrm_search_ui/civicrm_search_ui.php"><a href="files/ext-civicrm-search-ui-civicrm-search-ui.html"><abbr title="ext/civicrm_search_ui/civicrm_search_ui.php">civicrm_search_ui.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">31</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_search_ui_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_search_ui_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_grant_create">
civicrm_api3_grant_create()
<a href="namespaces/default.html#function_civicrm_api3_grant_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civigrant/api/v3/Grant.php"><a href="files/ext-civigrant-api-v3-grant.html"><abbr title="ext/civigrant/api/v3/Grant.php">Grant.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">28</span>
</aside>
<p class="phpdocumentor-summary">Create/update Grant.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_grant_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields metadata.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_grant_create_spec">
_civicrm_api3_grant_create_spec()
<a href="namespaces/default.html#function__civicrm_api3_grant_create_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civigrant/api/v3/Grant.php"><a href="files/ext-civigrant-api-v3-grant.html"><abbr title="ext/civigrant/api/v3/Grant.php">Grant.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">40</span>
</aside>
<p class="phpdocumentor-summary">Adjust Metadata for Create action.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_grant_create_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The metadata is used for setting defaults, documentation & validation.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array of parameters determined by getfields.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_grant_get">
civicrm_api3_grant_get()
<a href="namespaces/default.html#function_civicrm_api3_grant_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civigrant/api/v3/Grant.php"><a href="files/ext-civigrant-api-v3-grant.html"><abbr title="ext/civigrant/api/v3/Grant.php">Grant.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">57</span>
</aside>
<p class="phpdocumentor-summary">Returns array of grants matching a set of one or more properties.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_grant_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Array per getfields metadata.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Array of matching grants</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_grant_delete">
civicrm_api3_grant_delete()
<a href="namespaces/default.html#function_civicrm_api3_grant_delete" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civigrant/api/v3/Grant.php"><a href="files/ext-civigrant-api-v3-grant.html"><abbr title="ext/civigrant/api/v3/Grant.php">Grant.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">70</span>
</aside>
<p class="phpdocumentor-summary">This method is used to delete an existing Grant.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_grant_delete</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Id of the Grant to be deleted is required.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API Result Array</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civigrant_civix_class_loader">
_civigrant_civix_class_loader()
<a href="namespaces/default.html#function__civigrant_civix_class_loader" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civigrant/civigrant.civix.php"><a href="files/ext-civigrant-civigrant-civix.html"><abbr title="ext/civigrant/civigrant.civix.php">civigrant.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">94</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civigrant_civix_class_loader</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$class</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$class</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civigrant_civix_civicrm_config">
_civigrant_civix_civicrm_config()
<a href="namespaces/default.html#function__civigrant_civix_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civigrant/civigrant.civix.php"><a href="files/ext-civigrant-civigrant-civix.html"><abbr title="ext/civigrant/civigrant.civix.php">civigrant.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">122</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civigrant_civix_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$config</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civigrant_civix_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civigrant_civix_civicrm_install">
_civigrant_civix_civicrm_install()
<a href="namespaces/default.html#function__civigrant_civix_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civigrant/civigrant.civix.php"><a href="files/ext-civigrant-civigrant-civix.html"><abbr title="ext/civigrant/civigrant.civix.php">civigrant.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">140</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civigrant_civix_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civigrant_civix_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civigrant_civix_civicrm_enable">
_civigrant_civix_civicrm_enable()
<a href="namespaces/default.html#function__civigrant_civix_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civigrant/civigrant.civix.php"><a href="files/ext-civigrant-civigrant-civix.html"><abbr title="ext/civigrant/civigrant.civix.php">civigrant.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">150</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civigrant_civix_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civigrant_civix_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civigrant_civix_insert_navigation_menu">
_civigrant_civix_insert_navigation_menu()
<a href="namespaces/default.html#function__civigrant_civix_insert_navigation_menu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civigrant/civigrant.civix.php"><a href="files/ext-civigrant-civigrant-civix.html"><abbr title="ext/civigrant/civigrant.civix.php">civigrant.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">166</span>
</aside>
<p class="phpdocumentor-summary">Inserts a navigation menu item at a given place in the hierarchy.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civigrant_civix_insert_navigation_menu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$menu</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$path</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$item</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$menu</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>menu hierarchy</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$path</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>path to parent of this item, e.g. 'my_extension/submenu'
'Mailing', or 'Administer/System Settings'</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$item</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>the item to insert (parent/child attributes will be
filled for you)</li>
</ul>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civigrant_civix_navigationMenu">
_civigrant_civix_navigationMenu()
<a href="namespaces/default.html#function__civigrant_civix_navigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civigrant/civigrant.civix.php"><a href="files/ext-civigrant-civigrant-civix.html"><abbr title="ext/civigrant/civigrant.civix.php">civigrant.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">197</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_navigationMenu().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civigrant_civix_navigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civigrant_civix_fixNavigationMenu">
_civigrant_civix_fixNavigationMenu()
<a href="namespaces/default.html#function__civigrant_civix_fixNavigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civigrant/civigrant.civix.php"><a href="files/ext-civigrant-civigrant-civix.html"><abbr title="ext/civigrant/civigrant.civix.php">civigrant.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">207</span>
</aside>
<p class="phpdocumentor-summary">Given a navigation menu, generate navIDs for any items which are
missing them.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civigrant_civix_fixNavigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civigrant_civix_fixNavigationMenuItems">
_civigrant_civix_fixNavigationMenuItems()
<a href="namespaces/default.html#function__civigrant_civix_fixNavigationMenuItems" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civigrant/civigrant.civix.php"><a href="files/ext-civigrant-civigrant-civix.html"><abbr title="ext/civigrant/civigrant.civix.php">civigrant.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">217</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civigrant_civix_fixNavigationMenuItems</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$maxNavID</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$parentID</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$maxNavID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$parentID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civigrant_civicrm_config">
civigrant_civicrm_config()
<a href="namespaces/default.html#function_civigrant_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civigrant/civigrant.php"><a href="files/ext-civigrant-civigrant.html"><abbr title="ext/civigrant/civigrant.php">civigrant.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">11</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civigrant_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$config</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civigrant_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/ </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civigrant_civicrm_links">
civigrant_civicrm_links()
<a href="namespaces/default.html#function_civigrant_civicrm_links" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civigrant/civigrant.php"><a href="files/ext-civigrant-civigrant.html"><abbr title="ext/civigrant/civigrant.php">civigrant.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">20</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_links().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civigrant_civicrm_links</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$context</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$name</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$id</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$links</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>Add shortcut link to create new grant.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$context</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$name</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$id</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$links</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civigrant_civicrm_summaryActions">
civigrant_civicrm_summaryActions()
<a href="namespaces/default.html#function_civigrant_civicrm_summaryActions" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civigrant/civigrant.php"><a href="files/ext-civigrant-civigrant.html"><abbr title="ext/civigrant/civigrant.php">civigrant.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">36</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_summaryActions().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civigrant_civicrm_summaryActions</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$menu</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$cid</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>Add contact summary link to create new grant.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$menu</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$cid</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civigrant_civicrm_permission">
civigrant_civicrm_permission()
<a href="namespaces/default.html#function_civigrant_civicrm_permission" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civigrant/civigrant.php"><a href="files/ext-civigrant-civigrant.html"><abbr title="ext/civigrant/civigrant.php">civigrant.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">55</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_permission().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civigrant_civicrm_permission</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$permissions</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>Define CiviGrant permissions.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$permissions</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civigrant_civicrm_alterAPIPermissions">
civigrant_civicrm_alterAPIPermissions()
<a href="namespaces/default.html#function_civigrant_civicrm_alterAPIPermissions" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civigrant/civigrant.php"><a href="files/ext-civigrant-civigrant.html"><abbr title="ext/civigrant/civigrant.php">civigrant.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">75</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_alterAPIPermissions().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civigrant_civicrm_alterAPIPermissions</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$entity</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$action</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$permissions</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>Set CiviGrant permissions for APIv3.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entity</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$action</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$permissions</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civigrant_civicrm_queryObjects">
civigrant_civicrm_queryObjects()
<a href="namespaces/default.html#function_civigrant_civicrm_queryObjects" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civigrant/civigrant.php"><a href="files/ext-civigrant-civigrant.html"><abbr title="ext/civigrant/civigrant.php">civigrant.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">97</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_queryObjects().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civigrant_civicrm_queryObjects</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$queryObjects</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$type</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>Adds query object for legacy screens like advanced search, search builder, etc.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$queryObjects</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$type</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_cv">
cv()
<a href="namespaces/default.html#function_cv" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civigrant/tests/phpunit/bootstrap.php"><a href="files/ext-civigrant-tests-phpunit-bootstrap.html"><abbr title="ext/civigrant/tests/phpunit/bootstrap.php">bootstrap.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">29</span>
</aside>
<p class="phpdocumentor-summary">Call the "cv" command.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">cv</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$cmd</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$decode</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">'json'</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$cmd</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The rest of the command to send.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$decode</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">'json'</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Ex: 'json' or 'phpcode'.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_cv#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\RuntimeException">RuntimeException</abbr></span>
<section class="phpdocumentor-description"><p>If the command terminates abnormally.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
—
<section class="phpdocumentor-description"><p>Response output (if the command executed normally).
For 'raw' or 'phpcode', this will be a string. For 'json', it could be any JSON value.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civiimport_civix_civicrm_config">
_civiimport_civix_civicrm_config()
<a href="namespaces/default.html#function__civiimport_civix_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civiimport/civiimport.civix.php"><a href="files/ext-civiimport-civiimport-civix.html"><abbr title="ext/civiimport/civiimport.civix.php">civiimport.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">87</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civiimport_civix_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$config</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civiimport_civix_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civiimport_civix_civicrm_install">
_civiimport_civix_civicrm_install()
<a href="namespaces/default.html#function__civiimport_civix_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civiimport/civiimport.civix.php"><a href="files/ext-civiimport-civiimport-civix.html"><abbr title="ext/civiimport/civiimport.civix.php">civiimport.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">105</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civiimport_civix_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civiimport_civix_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civiimport_civix_civicrm_enable">
_civiimport_civix_civicrm_enable()
<a href="namespaces/default.html#function__civiimport_civix_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civiimport/civiimport.civix.php"><a href="files/ext-civiimport-civiimport-civix.html"><abbr title="ext/civiimport/civiimport.civix.php">civiimport.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">115</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civiimport_civix_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civiimport_civix_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civiimport_civix_insert_navigation_menu">
_civiimport_civix_insert_navigation_menu()
<a href="namespaces/default.html#function__civiimport_civix_insert_navigation_menu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civiimport/civiimport.civix.php"><a href="files/ext-civiimport-civiimport-civix.html"><abbr title="ext/civiimport/civiimport.civix.php">civiimport.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">131</span>
</aside>
<p class="phpdocumentor-summary">Inserts a navigation menu item at a given place in the hierarchy.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civiimport_civix_insert_navigation_menu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$menu</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$path</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$item</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$menu</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>menu hierarchy</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$path</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>path to parent of this item, e.g. 'my_extension/submenu'
'Mailing', or 'Administer/System Settings'</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$item</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>the item to insert (parent/child attributes will be
filled for you)</li>
</ul>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civiimport_civix_navigationMenu">
_civiimport_civix_navigationMenu()
<a href="namespaces/default.html#function__civiimport_civix_navigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civiimport/civiimport.civix.php"><a href="files/ext-civiimport-civiimport-civix.html"><abbr title="ext/civiimport/civiimport.civix.php">civiimport.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">162</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_navigationMenu().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civiimport_civix_navigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civiimport_civix_fixNavigationMenu">
_civiimport_civix_fixNavigationMenu()
<a href="namespaces/default.html#function__civiimport_civix_fixNavigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civiimport/civiimport.civix.php"><a href="files/ext-civiimport-civiimport-civix.html"><abbr title="ext/civiimport/civiimport.civix.php">civiimport.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">172</span>
</aside>
<p class="phpdocumentor-summary">Given a navigation menu, generate navIDs for any items which are
missing them.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civiimport_civix_fixNavigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civiimport_civix_fixNavigationMenuItems">
_civiimport_civix_fixNavigationMenuItems()
<a href="namespaces/default.html#function__civiimport_civix_fixNavigationMenuItems" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civiimport/civiimport.civix.php"><a href="files/ext-civiimport-civiimport-civix.html"><abbr title="ext/civiimport/civiimport.civix.php">civiimport.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">182</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civiimport_civix_fixNavigationMenuItems</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$maxNavID</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$parentID</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$maxNavID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$parentID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civiimport_civicrm_config">
civiimport_civicrm_config()
<a href="namespaces/default.html#function_civiimport_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civiimport/civiimport.php"><a href="files/ext-civiimport-civiimport.html"><abbr title="ext/civiimport/civiimport.php">civiimport.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">21</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civiimport_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$config</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civiimport_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/ </a>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">noinspection</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>PhpUnused</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civiimport_civicrm_install">
civiimport_civicrm_install()
<a href="namespaces/default.html#function_civiimport_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civiimport/civiimport.php"><a href="files/ext-civiimport-civiimport.html"><abbr title="ext/civiimport/civiimport.php">civiimport.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">30</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civiimport_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civiimport_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civiimport_civicrm_enable">
civiimport_civicrm_enable()
<a href="namespaces/default.html#function_civiimport_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civiimport/civiimport.php"><a href="files/ext-civiimport-civiimport.html"><abbr title="ext/civiimport/civiimport.php">civiimport.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">39</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civiimport_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civiimport_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civiimport_civicrm_entityTypes">
civiimport_civicrm_entityTypes()
<a href="namespaces/default.html#function_civiimport_civicrm_entityTypes" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civiimport/civiimport.php"><a href="files/ext-civiimport-civiimport.html"><abbr title="ext/civiimport/civiimport.php">civiimport.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">52</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_entityTypes().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civiimport_civicrm_entityTypes</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$entityTypes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"><p>Declare each import table as an entity type. This function
was intended to be in the ImportSubscriber class but kept
getting errors when it was there so it's here, at least for now.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entityTypes</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civiimport_civicrm_entityTypes#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_entityTypes"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_entityTypes </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civiimport_civicrm_get_import_tables">
_civiimport_civicrm_get_import_tables()
<a href="namespaces/default.html#function__civiimport_civicrm_get_import_tables" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civiimport/civiimport.php"><a href="files/ext-civiimport-civiimport.html"><abbr title="ext/civiimport/civiimport.php">civiimport.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">84</span>
</aside>
<p class="phpdocumentor-summary">Get the available import tables.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civiimport_civicrm_get_import_tables</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section class="phpdocumentor-description"><p>Note this lives here as <code class="prettyprint">entityTypes</code> hook calls it - which may not fully
have class loading set up by the time it runs.</p>
<p>Where the database is fully booted already it is better to call
<code class="prettyprint">Civi\BAO\Import::getImportTables()</code> which is expected to have caching.</p>
<p>Currently both functions share the Civi::statics caching in this function -
but we have had lots of back & forth so the principle is - call this if
we know caching could be scary - call the other for 'whatever caching is
most performant'.</p>
</section>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civiimport_civicrm_alterTemplateFile">
civiimport_civicrm_alterTemplateFile()
<a href="namespaces/default.html#function_civiimport_civicrm_alterTemplateFile" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civiimport/civiimport.php"><a href="files/ext-civiimport-civiimport.html"><abbr title="ext/civiimport/civiimport.php">civiimport.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">140</span>
</aside>
<p class="phpdocumentor-summary">Alter the template for the contribution import mapping to use angular form.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civiimport_civicrm_alterTemplateFile</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$formName</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-Form.html"><abbr title="\CRM_Core_Form">CRM_Core_Form</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$form</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$type</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$templateFile</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$formName</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$form</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-Form.html"><abbr title="\CRM_Core_Form">CRM_Core_Form</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$type</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$templateFile</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civiimport_civicrm_alterTemplateFile#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">noinspection</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>PhpUnusedParameterInspection</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civiimport_civicrm_searchKitTasks">
civiimport_civicrm_searchKitTasks()
<a href="namespaces/default.html#function_civiimport_civicrm_searchKitTasks" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civiimport/civiimport.php"><a href="files/ext-civiimport-civiimport.html"><abbr title="ext/civiimport/civiimport.php">civiimport.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">179</span>
</aside>
<p class="phpdocumentor-summary">Implements search tasks hook to add the `validate` and `import` actions.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civiimport_civicrm_searchKitTasks</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$tasks</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$checkPermissions</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int|null </span><span class="phpdocumentor-signature__argument__name">$userId</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$tasks</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$checkPermissions</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$userId</span>
: <span class="phpdocumentor-signature__argument__return-type">int|null</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civiimport_civicrm_searchKitTasks#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">noinspection</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>PhpUnused</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civiimport_civicrm_buildForm">
civiimport_civicrm_buildForm()
<a href="namespaces/default.html#function_civiimport_civicrm_buildForm" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civiimport/civiimport.php"><a href="files/ext-civiimport-civiimport.html"><abbr title="ext/civiimport/civiimport.php">civiimport.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">215</span>
</aside>
<p class="phpdocumentor-summary">Load the angular app for our form.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civiimport_civicrm_buildForm</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$formName</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Contribute-Import-Form-MapField.html"><abbr title="\CRM_Contribute_Import_Form_MapField">CRM_Contribute_Import_Form_MapField</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$form</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$formName</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$form</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Contribute-Import-Form-MapField.html"><abbr title="\CRM_Contribute_Import_Form_MapField">CRM_Contribute_Import_Form_MapField</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civiimport_civicrm_buildForm#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_cv">
cv()
<a href="namespaces/default.html#function_cv" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/civiimport/tests/phpunit/bootstrap.php"><a href="files/ext-civiimport-tests-phpunit-bootstrap.html"><abbr title="ext/civiimport/tests/phpunit/bootstrap.php">bootstrap.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">30</span>
</aside>
<p class="phpdocumentor-summary">Call the "cv" command.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">cv</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$cmd</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$decode</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">'json'</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$cmd</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The rest of the command to send.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$decode</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">'json'</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Ex: 'json' or 'phpcode'.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_cv#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\RuntimeException">RuntimeException</abbr></span>
<section class="phpdocumentor-description"><p>If the command terminates abnormally.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
—
<section class="phpdocumentor-description"><p>Response output (if the command executed normally).
For 'raw' or 'phpcode', this will be a string. For 'json', it could be any JSON value.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__ckeditor4_civix_civicrm_config">
_ckeditor4_civix_civicrm_config()
<a href="namespaces/default.html#function__ckeditor4_civix_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/ckeditor4/ckeditor4.civix.php"><a href="files/ext-ckeditor4-ckeditor4-civix.html"><abbr title="ext/ckeditor4/ckeditor4.civix.php">ckeditor4.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">87</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_ckeditor4_civix_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$config</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__ckeditor4_civix_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__ckeditor4_civix_civicrm_install">
_ckeditor4_civix_civicrm_install()
<a href="namespaces/default.html#function__ckeditor4_civix_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/ckeditor4/ckeditor4.civix.php"><a href="files/ext-ckeditor4-ckeditor4-civix.html"><abbr title="ext/ckeditor4/ckeditor4.civix.php">ckeditor4.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">105</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_ckeditor4_civix_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__ckeditor4_civix_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__ckeditor4_civix_civicrm_enable">
_ckeditor4_civix_civicrm_enable()
<a href="namespaces/default.html#function__ckeditor4_civix_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/ckeditor4/ckeditor4.civix.php"><a href="files/ext-ckeditor4-ckeditor4-civix.html"><abbr title="ext/ckeditor4/ckeditor4.civix.php">ckeditor4.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">115</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_ckeditor4_civix_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__ckeditor4_civix_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__ckeditor4_civix_insert_navigation_menu">
_ckeditor4_civix_insert_navigation_menu()
<a href="namespaces/default.html#function__ckeditor4_civix_insert_navigation_menu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/ckeditor4/ckeditor4.civix.php"><a href="files/ext-ckeditor4-ckeditor4-civix.html"><abbr title="ext/ckeditor4/ckeditor4.civix.php">ckeditor4.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">131</span>
</aside>
<p class="phpdocumentor-summary">Inserts a navigation menu item at a given place in the hierarchy.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_ckeditor4_civix_insert_navigation_menu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$menu</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$path</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$item</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$menu</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>menu hierarchy</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$path</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>path to parent of this item, e.g. 'my_extension/submenu'
'Mailing', or 'Administer/System Settings'</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$item</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>the item to insert (parent/child attributes will be
filled for you)</li>
</ul>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__ckeditor4_civix_navigationMenu">
_ckeditor4_civix_navigationMenu()
<a href="namespaces/default.html#function__ckeditor4_civix_navigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/ckeditor4/ckeditor4.civix.php"><a href="files/ext-ckeditor4-ckeditor4-civix.html"><abbr title="ext/ckeditor4/ckeditor4.civix.php">ckeditor4.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">162</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_navigationMenu().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_ckeditor4_civix_navigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__ckeditor4_civix_fixNavigationMenu">
_ckeditor4_civix_fixNavigationMenu()
<a href="namespaces/default.html#function__ckeditor4_civix_fixNavigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/ckeditor4/ckeditor4.civix.php"><a href="files/ext-ckeditor4-ckeditor4-civix.html"><abbr title="ext/ckeditor4/ckeditor4.civix.php">ckeditor4.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">172</span>
</aside>
<p class="phpdocumentor-summary">Given a navigation menu, generate navIDs for any items which are
missing them.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_ckeditor4_civix_fixNavigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__ckeditor4_civix_fixNavigationMenuItems">
_ckeditor4_civix_fixNavigationMenuItems()
<a href="namespaces/default.html#function__ckeditor4_civix_fixNavigationMenuItems" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/ckeditor4/ckeditor4.civix.php"><a href="files/ext-ckeditor4-ckeditor4-civix.html"><abbr title="ext/ckeditor4/ckeditor4.civix.php">ckeditor4.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">182</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_ckeditor4_civix_fixNavigationMenuItems</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$maxNavID</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$parentID</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$maxNavID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$parentID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_ckeditor4_civicrm_config">
ckeditor4_civicrm_config()
<a href="namespaces/default.html#function_ckeditor4_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/ckeditor4/ckeditor4.php"><a href="files/ext-ckeditor4-ckeditor4.html"><abbr title="ext/ckeditor4/ckeditor4.php">ckeditor4.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">13</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">ckeditor4_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$config</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_ckeditor4_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/ </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_ckeditor4_civicrm_install">
ckeditor4_civicrm_install()
<a href="namespaces/default.html#function_ckeditor4_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/ckeditor4/ckeditor4.php"><a href="files/ext-ckeditor4-ckeditor4.html"><abbr title="ext/ckeditor4/ckeditor4.php">ckeditor4.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">22</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">ckeditor4_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_ckeditor4_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_ckeditor4_civicrm_enable">
ckeditor4_civicrm_enable()
<a href="namespaces/default.html#function_ckeditor4_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/ckeditor4/ckeditor4.php"><a href="files/ext-ckeditor4-ckeditor4.html"><abbr title="ext/ckeditor4/ckeditor4.php">ckeditor4.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">31</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">ckeditor4_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_ckeditor4_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_ckeditor4_civicrm_buildForm">
ckeditor4_civicrm_buildForm()
<a href="namespaces/default.html#function_ckeditor4_civicrm_buildForm" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/ckeditor4/ckeditor4.php"><a href="files/ext-ckeditor4-ckeditor4.html"><abbr title="ext/ckeditor4/ckeditor4.php">ckeditor4.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">35</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">ckeditor4_civicrm_buildForm</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$formName</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$form</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$formName</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$form</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_ckeditor4_civicrm_coreResourceList">
ckeditor4_civicrm_coreResourceList()
<a href="namespaces/default.html#function_ckeditor4_civicrm_coreResourceList" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/ckeditor4/ckeditor4.php"><a href="files/ext-ckeditor4-ckeditor4.html"><abbr title="ext/ckeditor4/ckeditor4.php">ckeditor4.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">54</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">ckeditor4_civicrm_coreResourceList</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$list</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$region</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$list</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$region</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__contributioncancelactions_civix_civicrm_config">
_contributioncancelactions_civix_civicrm_config()
<a href="namespaces/default.html#function__contributioncancelactions_civix_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/contributioncancelactions/contributioncancelactions.civix.php"><a href="files/ext-contributioncancelactions-contributioncancelactions-civix.html"><abbr title="ext/contributioncancelactions/contributioncancelactions.civix.php">contributioncancelactions.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">87</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_contributioncancelactions_civix_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$config</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__contributioncancelactions_civix_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__contributioncancelactions_civix_civicrm_install">
_contributioncancelactions_civix_civicrm_install()
<a href="namespaces/default.html#function__contributioncancelactions_civix_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/contributioncancelactions/contributioncancelactions.civix.php"><a href="files/ext-contributioncancelactions-contributioncancelactions-civix.html"><abbr title="ext/contributioncancelactions/contributioncancelactions.civix.php">contributioncancelactions.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">105</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_contributioncancelactions_civix_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__contributioncancelactions_civix_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__contributioncancelactions_civix_civicrm_enable">
_contributioncancelactions_civix_civicrm_enable()
<a href="namespaces/default.html#function__contributioncancelactions_civix_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/contributioncancelactions/contributioncancelactions.civix.php"><a href="files/ext-contributioncancelactions-contributioncancelactions-civix.html"><abbr title="ext/contributioncancelactions/contributioncancelactions.civix.php">contributioncancelactions.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">115</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_contributioncancelactions_civix_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__contributioncancelactions_civix_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__contributioncancelactions_civix_insert_navigation_menu">
_contributioncancelactions_civix_insert_navigation_menu()
<a href="namespaces/default.html#function__contributioncancelactions_civix_insert_navigation_menu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/contributioncancelactions/contributioncancelactions.civix.php"><a href="files/ext-contributioncancelactions-contributioncancelactions-civix.html"><abbr title="ext/contributioncancelactions/contributioncancelactions.civix.php">contributioncancelactions.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">131</span>
</aside>
<p class="phpdocumentor-summary">Inserts a navigation menu item at a given place in the hierarchy.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_contributioncancelactions_civix_insert_navigation_menu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$menu</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$path</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$item</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$menu</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>menu hierarchy</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$path</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>path to parent of this item, e.g. 'my_extension/submenu'
'Mailing', or 'Administer/System Settings'</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$item</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>the item to insert (parent/child attributes will be
filled for you)</li>
</ul>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__contributioncancelactions_civix_navigationMenu">
_contributioncancelactions_civix_navigationMenu()
<a href="namespaces/default.html#function__contributioncancelactions_civix_navigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/contributioncancelactions/contributioncancelactions.civix.php"><a href="files/ext-contributioncancelactions-contributioncancelactions-civix.html"><abbr title="ext/contributioncancelactions/contributioncancelactions.civix.php">contributioncancelactions.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">162</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_navigationMenu().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_contributioncancelactions_civix_navigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__contributioncancelactions_civix_fixNavigationMenu">
_contributioncancelactions_civix_fixNavigationMenu()
<a href="namespaces/default.html#function__contributioncancelactions_civix_fixNavigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/contributioncancelactions/contributioncancelactions.civix.php"><a href="files/ext-contributioncancelactions-contributioncancelactions-civix.html"><abbr title="ext/contributioncancelactions/contributioncancelactions.civix.php">contributioncancelactions.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">172</span>
</aside>
<p class="phpdocumentor-summary">Given a navigation menu, generate navIDs for any items which are
missing them.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_contributioncancelactions_civix_fixNavigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__contributioncancelactions_civix_fixNavigationMenuItems">
_contributioncancelactions_civix_fixNavigationMenuItems()
<a href="namespaces/default.html#function__contributioncancelactions_civix_fixNavigationMenuItems" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/contributioncancelactions/contributioncancelactions.civix.php"><a href="files/ext-contributioncancelactions-contributioncancelactions-civix.html"><abbr title="ext/contributioncancelactions/contributioncancelactions.civix.php">contributioncancelactions.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">182</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_contributioncancelactions_civix_fixNavigationMenuItems</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$maxNavID</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$parentID</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$maxNavID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$parentID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_contributioncancelactions_civicrm_post">
contributioncancelactions_civicrm_post()
<a href="namespaces/default.html#function_contributioncancelactions_civicrm_post" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/contributioncancelactions/contributioncancelactions.php"><a href="files/ext-contributioncancelactions-contributioncancelactions.html"><abbr title="ext/contributioncancelactions/contributioncancelactions.php">contributioncancelactions.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">22</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_preProcess().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">contributioncancelactions_civicrm_post</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$op</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$objectName</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$objectId</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$objectRef</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>This enacts the following</p>
<ul>
<li>find and cancel any related pending memberships</li>
<li>(not yet implemented) find and cancel any related pending participant
records</li>
<li>(not yet implemented) find any related pledge payment records. Remove the
contribution id.</li>
</ul>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$op</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$objectName</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$objectId</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$objectRef</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_contributioncancelactions_civicrm_post#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_post"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_post </a>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_contributioncancelactions_cancel_related_pending_participant_records">
contributioncancelactions_cancel_related_pending_participant_records()
<a href="namespaces/default.html#function_contributioncancelactions_cancel_related_pending_participant_records" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/contributioncancelactions/contributioncancelactions.php"><a href="files/ext-contributioncancelactions-contributioncancelactions.html"><abbr title="ext/contributioncancelactions/contributioncancelactions.php">contributioncancelactions.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">38</span>
</aside>
<p class="phpdocumentor-summary">Find and cancel any pending participant records.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">contributioncancelactions_cancel_related_pending_participant_records</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$contributionID</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$contributionID</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_contributioncancelactions_cancel_related_pending_participant_records#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_contributioncancelactions_cancel_related_pending_memberships">
contributioncancelactions_cancel_related_pending_memberships()
<a href="namespaces/default.html#function_contributioncancelactions_cancel_related_pending_memberships" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/contributioncancelactions/contributioncancelactions.php"><a href="files/ext-contributioncancelactions-contributioncancelactions.html"><abbr title="ext/contributioncancelactions/contributioncancelactions.php">contributioncancelactions.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">62</span>
</aside>
<p class="phpdocumentor-summary">Find and cancel any pending memberships.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">contributioncancelactions_cancel_related_pending_memberships</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$contributionID</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$contributionID</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_contributioncancelactions_cancel_related_pending_memberships#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_cv">
cv()
<a href="namespaces/default.html#function_cv" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/contributioncancelactions/tests/phpunit/bootstrap.php"><a href="files/ext-contributioncancelactions-tests-phpunit-bootstrap.html"><abbr title="ext/contributioncancelactions/tests/phpunit/bootstrap.php">bootstrap.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">27</span>
</aside>
<p class="phpdocumentor-summary">Call the "cv" command.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">cv</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$cmd</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$decode</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">'json'</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$cmd</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The rest of the command to send.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$decode</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">'json'</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Ex: 'json' or 'phpcode'.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_cv#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\RuntimeException">RuntimeException</abbr></span>
<section class="phpdocumentor-description"><p>If the command terminates abnormally.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
—
<section class="phpdocumentor-description"><p>Response output (if the command executed normally).</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__elavon_civix_civicrm_config">
_elavon_civix_civicrm_config()
<a href="namespaces/default.html#function__elavon_civix_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/elavon/elavon.civix.php"><a href="files/ext-elavon-elavon-civix.html"><abbr title="ext/elavon/elavon.civix.php">elavon.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">87</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_elavon_civix_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$config</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__elavon_civix_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__elavon_civix_civicrm_install">
_elavon_civix_civicrm_install()
<a href="namespaces/default.html#function__elavon_civix_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/elavon/elavon.civix.php"><a href="files/ext-elavon-elavon-civix.html"><abbr title="ext/elavon/elavon.civix.php">elavon.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">105</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_elavon_civix_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__elavon_civix_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__elavon_civix_civicrm_enable">
_elavon_civix_civicrm_enable()
<a href="namespaces/default.html#function__elavon_civix_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/elavon/elavon.civix.php"><a href="files/ext-elavon-elavon-civix.html"><abbr title="ext/elavon/elavon.civix.php">elavon.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">115</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_elavon_civix_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__elavon_civix_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__elavon_civix_insert_navigation_menu">
_elavon_civix_insert_navigation_menu()
<a href="namespaces/default.html#function__elavon_civix_insert_navigation_menu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/elavon/elavon.civix.php"><a href="files/ext-elavon-elavon-civix.html"><abbr title="ext/elavon/elavon.civix.php">elavon.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">131</span>
</aside>
<p class="phpdocumentor-summary">Inserts a navigation menu item at a given place in the hierarchy.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_elavon_civix_insert_navigation_menu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$menu</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$path</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$item</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$menu</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>menu hierarchy</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$path</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>path to parent of this item, e.g. 'my_extension/submenu'
'Mailing', or 'Administer/System Settings'</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$item</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>the item to insert (parent/child attributes will be
filled for you)</li>
</ul>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__elavon_civix_navigationMenu">
_elavon_civix_navigationMenu()
<a href="namespaces/default.html#function__elavon_civix_navigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/elavon/elavon.civix.php"><a href="files/ext-elavon-elavon-civix.html"><abbr title="ext/elavon/elavon.civix.php">elavon.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">162</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_navigationMenu().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_elavon_civix_navigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__elavon_civix_fixNavigationMenu">
_elavon_civix_fixNavigationMenu()
<a href="namespaces/default.html#function__elavon_civix_fixNavigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/elavon/elavon.civix.php"><a href="files/ext-elavon-elavon-civix.html"><abbr title="ext/elavon/elavon.civix.php">elavon.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">172</span>
</aside>
<p class="phpdocumentor-summary">Given a navigation menu, generate navIDs for any items which are
missing them.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_elavon_civix_fixNavigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__elavon_civix_fixNavigationMenuItems">
_elavon_civix_fixNavigationMenuItems()
<a href="namespaces/default.html#function__elavon_civix_fixNavigationMenuItems" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/elavon/elavon.civix.php"><a href="files/ext-elavon-elavon-civix.html"><abbr title="ext/elavon/elavon.civix.php">elavon.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">182</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_elavon_civix_fixNavigationMenuItems</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$maxNavID</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$parentID</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$maxNavID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$parentID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_elavon_civicrm_config">
elavon_civicrm_config()
<a href="namespaces/default.html#function_elavon_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/elavon/elavon.php"><a href="files/ext-elavon-elavon.html"><abbr title="ext/elavon/elavon.php">elavon.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">13</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">elavon_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$config</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_elavon_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/ </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_elavon_civicrm_install">
elavon_civicrm_install()
<a href="namespaces/default.html#function_elavon_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/elavon/elavon.php"><a href="files/ext-elavon-elavon.html"><abbr title="ext/elavon/elavon.php">elavon.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">22</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">elavon_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_elavon_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_elavon_civicrm_enable">
elavon_civicrm_enable()
<a href="namespaces/default.html#function_elavon_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/elavon/elavon.php"><a href="files/ext-elavon-elavon.html"><abbr title="ext/elavon/elavon.php">elavon.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">31</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">elavon_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_elavon_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_cv">
cv()
<a href="namespaces/default.html#function_cv" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/elavon/tests/phpunit/bootstrap.php"><a href="files/ext-elavon-tests-phpunit-bootstrap.html"><abbr title="ext/elavon/tests/phpunit/bootstrap.php">bootstrap.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">30</span>
</aside>
<p class="phpdocumentor-summary">Call the "cv" command.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">cv</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$cmd</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$decode</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">'json'</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$cmd</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The rest of the command to send.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$decode</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">'json'</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Ex: 'json' or 'phpcode'.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_cv#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\RuntimeException">RuntimeException</abbr></span>
<section class="phpdocumentor-description"><p>If the command terminates abnormally.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
—
<section class="phpdocumentor-description"><p>Response output (if the command executed normally).
For 'raw' or 'phpcode', this will be a string. For 'json', it could be any JSON value.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__eventcart_civix_class_loader">
_eventcart_civix_class_loader()
<a href="namespaces/default.html#function__eventcart_civix_class_loader" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/eventcart/eventcart.civix.php"><a href="files/ext-eventcart-eventcart-civix.html"><abbr title="ext/eventcart/eventcart.civix.php">eventcart.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">94</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_eventcart_civix_class_loader</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$class</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$class</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__eventcart_civix_civicrm_config">
_eventcart_civix_civicrm_config()
<a href="namespaces/default.html#function__eventcart_civix_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/eventcart/eventcart.civix.php"><a href="files/ext-eventcart-eventcart-civix.html"><abbr title="ext/eventcart/eventcart.civix.php">eventcart.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">122</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_eventcart_civix_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$config</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__eventcart_civix_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__eventcart_civix_civicrm_install">
_eventcart_civix_civicrm_install()
<a href="namespaces/default.html#function__eventcart_civix_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/eventcart/eventcart.civix.php"><a href="files/ext-eventcart-eventcart-civix.html"><abbr title="ext/eventcart/eventcart.civix.php">eventcart.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">140</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_eventcart_civix_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__eventcart_civix_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__eventcart_civix_civicrm_enable">
_eventcart_civix_civicrm_enable()
<a href="namespaces/default.html#function__eventcart_civix_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/eventcart/eventcart.civix.php"><a href="files/ext-eventcart-eventcart-civix.html"><abbr title="ext/eventcart/eventcart.civix.php">eventcart.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">150</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_eventcart_civix_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__eventcart_civix_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__eventcart_civix_insert_navigation_menu">
_eventcart_civix_insert_navigation_menu()
<a href="namespaces/default.html#function__eventcart_civix_insert_navigation_menu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/eventcart/eventcart.civix.php"><a href="files/ext-eventcart-eventcart-civix.html"><abbr title="ext/eventcart/eventcart.civix.php">eventcart.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">166</span>
</aside>
<p class="phpdocumentor-summary">Inserts a navigation menu item at a given place in the hierarchy.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_eventcart_civix_insert_navigation_menu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$menu</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$path</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$item</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$menu</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>menu hierarchy</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$path</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>path to parent of this item, e.g. 'my_extension/submenu'
'Mailing', or 'Administer/System Settings'</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$item</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>the item to insert (parent/child attributes will be
filled for you)</li>
</ul>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__eventcart_civix_navigationMenu">
_eventcart_civix_navigationMenu()
<a href="namespaces/default.html#function__eventcart_civix_navigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/eventcart/eventcart.civix.php"><a href="files/ext-eventcart-eventcart-civix.html"><abbr title="ext/eventcart/eventcart.civix.php">eventcart.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">197</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_navigationMenu().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_eventcart_civix_navigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__eventcart_civix_fixNavigationMenu">
_eventcart_civix_fixNavigationMenu()
<a href="namespaces/default.html#function__eventcart_civix_fixNavigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/eventcart/eventcart.civix.php"><a href="files/ext-eventcart-eventcart-civix.html"><abbr title="ext/eventcart/eventcart.civix.php">eventcart.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">207</span>
</aside>
<p class="phpdocumentor-summary">Given a navigation menu, generate navIDs for any items which are
missing them.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_eventcart_civix_fixNavigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__eventcart_civix_fixNavigationMenuItems">
_eventcart_civix_fixNavigationMenuItems()
<a href="namespaces/default.html#function__eventcart_civix_fixNavigationMenuItems" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/eventcart/eventcart.civix.php"><a href="files/ext-eventcart-eventcart-civix.html"><abbr title="ext/eventcart/eventcart.civix.php">eventcart.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">217</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_eventcart_civix_fixNavigationMenuItems</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$maxNavID</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$parentID</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$maxNavID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$parentID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_eventcart_civicrm_config">
eventcart_civicrm_config()
<a href="namespaces/default.html#function_eventcart_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/eventcart/eventcart.php"><a href="files/ext-eventcart-eventcart.html"><abbr title="ext/eventcart/eventcart.php">eventcart.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">11</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">eventcart_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$config</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_eventcart_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/ </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_eventcart_civicrm_install">
eventcart_civicrm_install()
<a href="namespaces/default.html#function_eventcart_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/eventcart/eventcart.php"><a href="files/ext-eventcart-eventcart.html"><abbr title="ext/eventcart/eventcart.php">eventcart.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">26</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">eventcart_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_eventcart_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_eventcart_civicrm_alterMailParams">
eventcart_civicrm_alterMailParams()
<a href="namespaces/default.html#function_eventcart_civicrm_alterMailParams" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/eventcart/eventcart.php"><a href="files/ext-eventcart-eventcart.html"><abbr title="ext/eventcart/eventcart.php">eventcart.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">36</span>
</aside>
<p class="phpdocumentor-summary">Add the conference session variable to the template.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">eventcart_civicrm_alterMailParams</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$template</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$template</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_eventcart_civicrm_enable">
eventcart_civicrm_enable()
<a href="namespaces/default.html#function_eventcart_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/eventcart/eventcart.php"><a href="files/ext-eventcart-eventcart.html"><abbr title="ext/eventcart/eventcart.php">eventcart.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">48</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">eventcart_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_eventcart_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_eventcart_civicrm_tabset">
eventcart_civicrm_tabset()
<a href="namespaces/default.html#function_eventcart_civicrm_tabset" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/eventcart/eventcart.php"><a href="files/ext-eventcart-eventcart.html"><abbr title="ext/eventcart/eventcart.php">eventcart.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">52</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">eventcart_civicrm_tabset</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$name</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$tabs</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$name</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$tabs</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__ewaysingle_civix_civicrm_config">
_ewaysingle_civix_civicrm_config()
<a href="namespaces/default.html#function__ewaysingle_civix_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/ewaysingle/ewaysingle.civix.php"><a href="files/ext-ewaysingle-ewaysingle-civix.html"><abbr title="ext/ewaysingle/ewaysingle.civix.php">ewaysingle.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">87</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_ewaysingle_civix_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$config</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__ewaysingle_civix_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__ewaysingle_civix_civicrm_install">
_ewaysingle_civix_civicrm_install()
<a href="namespaces/default.html#function__ewaysingle_civix_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/ewaysingle/ewaysingle.civix.php"><a href="files/ext-ewaysingle-ewaysingle-civix.html"><abbr title="ext/ewaysingle/ewaysingle.civix.php">ewaysingle.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">105</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_ewaysingle_civix_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__ewaysingle_civix_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__ewaysingle_civix_civicrm_enable">
_ewaysingle_civix_civicrm_enable()
<a href="namespaces/default.html#function__ewaysingle_civix_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/ewaysingle/ewaysingle.civix.php"><a href="files/ext-ewaysingle-ewaysingle-civix.html"><abbr title="ext/ewaysingle/ewaysingle.civix.php">ewaysingle.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">115</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_ewaysingle_civix_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__ewaysingle_civix_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__ewaysingle_civix_insert_navigation_menu">
_ewaysingle_civix_insert_navigation_menu()
<a href="namespaces/default.html#function__ewaysingle_civix_insert_navigation_menu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/ewaysingle/ewaysingle.civix.php"><a href="files/ext-ewaysingle-ewaysingle-civix.html"><abbr title="ext/ewaysingle/ewaysingle.civix.php">ewaysingle.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">131</span>
</aside>
<p class="phpdocumentor-summary">Inserts a navigation menu item at a given place in the hierarchy.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_ewaysingle_civix_insert_navigation_menu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$menu</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$path</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$item</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$menu</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>menu hierarchy</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$path</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>path to parent of this item, e.g. 'my_extension/submenu'
'Mailing', or 'Administer/System Settings'</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$item</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>the item to insert (parent/child attributes will be
filled for you)</li>
</ul>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__ewaysingle_civix_navigationMenu">
_ewaysingle_civix_navigationMenu()
<a href="namespaces/default.html#function__ewaysingle_civix_navigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/ewaysingle/ewaysingle.civix.php"><a href="files/ext-ewaysingle-ewaysingle-civix.html"><abbr title="ext/ewaysingle/ewaysingle.civix.php">ewaysingle.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">162</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_navigationMenu().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_ewaysingle_civix_navigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__ewaysingle_civix_fixNavigationMenu">
_ewaysingle_civix_fixNavigationMenu()
<a href="namespaces/default.html#function__ewaysingle_civix_fixNavigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/ewaysingle/ewaysingle.civix.php"><a href="files/ext-ewaysingle-ewaysingle-civix.html"><abbr title="ext/ewaysingle/ewaysingle.civix.php">ewaysingle.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">172</span>
</aside>
<p class="phpdocumentor-summary">Given a navigation menu, generate navIDs for any items which are
missing them.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_ewaysingle_civix_fixNavigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__ewaysingle_civix_fixNavigationMenuItems">
_ewaysingle_civix_fixNavigationMenuItems()
<a href="namespaces/default.html#function__ewaysingle_civix_fixNavigationMenuItems" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/ewaysingle/ewaysingle.civix.php"><a href="files/ext-ewaysingle-ewaysingle-civix.html"><abbr title="ext/ewaysingle/ewaysingle.civix.php">ewaysingle.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">182</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_ewaysingle_civix_fixNavigationMenuItems</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$maxNavID</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$parentID</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$maxNavID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$parentID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_ewaysingle_civicrm_config">
ewaysingle_civicrm_config()
<a href="namespaces/default.html#function_ewaysingle_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/ewaysingle/ewaysingle.php"><a href="files/ext-ewaysingle-ewaysingle.html"><abbr title="ext/ewaysingle/ewaysingle.php">ewaysingle.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">13</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">ewaysingle_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$config</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_ewaysingle_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/ </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_ewaysingle_civicrm_install">
ewaysingle_civicrm_install()
<a href="namespaces/default.html#function_ewaysingle_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/ewaysingle/ewaysingle.php"><a href="files/ext-ewaysingle-ewaysingle.html"><abbr title="ext/ewaysingle/ewaysingle.php">ewaysingle.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">22</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">ewaysingle_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_ewaysingle_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_ewaysingle_civicrm_enable">
ewaysingle_civicrm_enable()
<a href="namespaces/default.html#function_ewaysingle_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/ewaysingle/ewaysingle.php"><a href="files/ext-ewaysingle-ewaysingle.html"><abbr title="ext/ewaysingle/ewaysingle.php">ewaysingle.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">31</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">ewaysingle_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_ewaysingle_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_cv">
cv()
<a href="namespaces/default.html#function_cv" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/ewaysingle/tests/phpunit/bootstrap.php"><a href="files/ext-ewaysingle-tests-phpunit-bootstrap.html"><abbr title="ext/ewaysingle/tests/phpunit/bootstrap.php">bootstrap.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">27</span>
</aside>
<p class="phpdocumentor-summary">Call the "cv" command.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">cv</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$cmd</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$decode</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">'json'</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$cmd</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The rest of the command to send.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$decode</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">'json'</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Ex: 'json' or 'phpcode'.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_cv#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\RuntimeException">RuntimeException</abbr></span>
<section class="phpdocumentor-description"><p>If the command terminates abnormally.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
—
<section class="phpdocumentor-description"><p>Response output (if the command executed normally).</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__financialacls_civix_civicrm_config">
_financialacls_civix_civicrm_config()
<a href="namespaces/default.html#function__financialacls_civix_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/financialacls/financialacls.civix.php"><a href="files/ext-financialacls-financialacls-civix.html"><abbr title="ext/financialacls/financialacls.civix.php">financialacls.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">87</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_financialacls_civix_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$config</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__financialacls_civix_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__financialacls_civix_civicrm_install">
_financialacls_civix_civicrm_install()
<a href="namespaces/default.html#function__financialacls_civix_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/financialacls/financialacls.civix.php"><a href="files/ext-financialacls-financialacls-civix.html"><abbr title="ext/financialacls/financialacls.civix.php">financialacls.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">105</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_financialacls_civix_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__financialacls_civix_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__financialacls_civix_civicrm_enable">
_financialacls_civix_civicrm_enable()
<a href="namespaces/default.html#function__financialacls_civix_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/financialacls/financialacls.civix.php"><a href="files/ext-financialacls-financialacls-civix.html"><abbr title="ext/financialacls/financialacls.civix.php">financialacls.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">115</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_financialacls_civix_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__financialacls_civix_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__financialacls_civix_insert_navigation_menu">
_financialacls_civix_insert_navigation_menu()
<a href="namespaces/default.html#function__financialacls_civix_insert_navigation_menu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/financialacls/financialacls.civix.php"><a href="files/ext-financialacls-financialacls-civix.html"><abbr title="ext/financialacls/financialacls.civix.php">financialacls.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">131</span>
</aside>
<p class="phpdocumentor-summary">Inserts a navigation menu item at a given place in the hierarchy.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_financialacls_civix_insert_navigation_menu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$menu</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$path</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$item</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$menu</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>menu hierarchy</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$path</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>path to parent of this item, e.g. 'my_extension/submenu'
'Mailing', or 'Administer/System Settings'</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$item</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>the item to insert (parent/child attributes will be
filled for you)</li>
</ul>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__financialacls_civix_navigationMenu">
_financialacls_civix_navigationMenu()
<a href="namespaces/default.html#function__financialacls_civix_navigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/financialacls/financialacls.civix.php"><a href="files/ext-financialacls-financialacls-civix.html"><abbr title="ext/financialacls/financialacls.civix.php">financialacls.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">162</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_navigationMenu().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_financialacls_civix_navigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__financialacls_civix_fixNavigationMenu">
_financialacls_civix_fixNavigationMenu()
<a href="namespaces/default.html#function__financialacls_civix_fixNavigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/financialacls/financialacls.civix.php"><a href="files/ext-financialacls-financialacls-civix.html"><abbr title="ext/financialacls/financialacls.civix.php">financialacls.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">172</span>
</aside>
<p class="phpdocumentor-summary">Given a navigation menu, generate navIDs for any items which are
missing them.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_financialacls_civix_fixNavigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__financialacls_civix_fixNavigationMenuItems">
_financialacls_civix_fixNavigationMenuItems()
<a href="namespaces/default.html#function__financialacls_civix_fixNavigationMenuItems" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/financialacls/financialacls.civix.php"><a href="files/ext-financialacls-financialacls-civix.html"><abbr title="ext/financialacls/financialacls.civix.php">financialacls.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">182</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_financialacls_civix_fixNavigationMenuItems</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$maxNavID</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$parentID</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$maxNavID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$parentID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_financialacls_civicrm_config">
financialacls_civicrm_config()
<a href="namespaces/default.html#function_financialacls_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/financialacls/financialacls.php"><a href="files/ext-financialacls-financialacls.html"><abbr title="ext/financialacls/financialacls.php">financialacls.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">15</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">financialacls_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$config</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_financialacls_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/ </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_financialacls_civicrm_container">
financialacls_civicrm_container()
<a href="namespaces/default.html#function_financialacls_civicrm_container" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/financialacls/financialacls.php"><a href="files/ext-financialacls-financialacls.html"><abbr title="ext/financialacls/financialacls.php">financialacls.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">22</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">financialacls_civicrm_container</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><abbr title="\Symfony\Component\DependencyInjection\ContainerBuilder">ContainerBuilder</abbr> </span><span class="phpdocumentor-signature__argument__name">$container</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$container</span>
: <span class="phpdocumentor-signature__argument__return-type"><abbr title="\Symfony\Component\DependencyInjection\ContainerBuilder">ContainerBuilder</abbr></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_financialacls_civicrm_install">
financialacls_civicrm_install()
<a href="namespaces/default.html#function_financialacls_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/financialacls/financialacls.php"><a href="files/ext-financialacls-financialacls.html"><abbr title="ext/financialacls/financialacls.php">financialacls.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">33</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">financialacls_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_financialacls_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_financialacls_civicrm_enable">
financialacls_civicrm_enable()
<a href="namespaces/default.html#function_financialacls_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/financialacls/financialacls.php"><a href="files/ext-financialacls-financialacls.html"><abbr title="ext/financialacls/financialacls.php">financialacls.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">42</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">financialacls_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_financialacls_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_financialacls_civicrm_pre">
financialacls_civicrm_pre()
<a href="namespaces/default.html#function_financialacls_civicrm_pre" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/financialacls/financialacls.php"><a href="files/ext-financialacls-financialacls.html"><abbr title="ext/financialacls/financialacls.php">financialacls.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">56</span>
</aside>
<p class="phpdocumentor-summary">Intervene to prevent deletion, where permissions block it.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">financialacls_civicrm_pre</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$op</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$objectName</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int|null </span><span class="phpdocumentor-signature__argument__name">$id</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$op</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$objectName</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$id</span>
: <span class="phpdocumentor-signature__argument__return-type">int|null</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_financialacls_civicrm_pre#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_financialacls_civicrm_selectWhereClause">
financialacls_civicrm_selectWhereClause()
<a href="namespaces/default.html#function_financialacls_civicrm_selectWhereClause" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/financialacls/financialacls.php"><a href="files/ext-financialacls-financialacls.html"><abbr title="ext/financialacls/financialacls.php">financialacls.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">87</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_selectWhereClause().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">financialacls_civicrm_selectWhereClause</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$entity</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$clauses</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entity</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$clauses</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_financialacls_civicrm_selectWhereClause#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_selectWhereClause"> http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_selectWhereClause </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__financialacls_civicrm_get_accounts_clause">
_financialacls_civicrm_get_accounts_clause()
<a href="namespaces/default.html#function__financialacls_civicrm_get_accounts_clause" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/financialacls/financialacls.php"><a href="files/ext-financialacls-financialacls.html"><abbr title="ext/financialacls/financialacls.php">financialacls.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">125</span>
</aside>
<p class="phpdocumentor-summary">Get the clause to limit available types.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_financialacls_civicrm_get_accounts_clause</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__financialacls_civicrm_get_type_clause">
_financialacls_civicrm_get_type_clause()
<a href="namespaces/default.html#function__financialacls_civicrm_get_type_clause" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/financialacls/financialacls.php"><a href="files/ext-financialacls-financialacls.html"><abbr title="ext/financialacls/financialacls.php">financialacls.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">156</span>
</aside>
<p class="phpdocumentor-summary">Get the clause to limit available types.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_financialacls_civicrm_get_type_clause</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__financialacls_civicrm_get_accessible_financial_types">
_financialacls_civicrm_get_accessible_financial_types()
<a href="namespaces/default.html#function__financialacls_civicrm_get_accessible_financial_types" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/financialacls/financialacls.php"><a href="files/ext-financialacls-financialacls.html"><abbr title="ext/financialacls/financialacls.php">financialacls.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">167</span>
</aside>
<p class="phpdocumentor-summary">Get an array of the ids of accessible financial types.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_financialacls_civicrm_get_accessible_financial_types</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, int></span></code>
<section class="phpdocumentor-description"><p>If none then it will be [0]</p>
</section>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, int></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__financialacls_civicrm_get_inaccessible_financial_types">
_financialacls_civicrm_get_inaccessible_financial_types()
<a href="namespaces/default.html#function__financialacls_civicrm_get_inaccessible_financial_types" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/financialacls/financialacls.php"><a href="files/ext-financialacls-financialacls.html"><abbr title="ext/financialacls/financialacls.php">financialacls.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">183</span>
</aside>
<p class="phpdocumentor-summary">Get an array of the ids of accessible financial types.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_financialacls_civicrm_get_inaccessible_financial_types</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, int></span></code>
<section class="phpdocumentor-description"><p>If none then it will be [0]</p>
</section>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, int></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__financialacls_civicrm_get_membership_type_clause">
_financialacls_civicrm_get_membership_type_clause()
<a href="namespaces/default.html#function__financialacls_civicrm_get_membership_type_clause" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/financialacls/financialacls.php"><a href="files/ext-financialacls-financialacls.html"><abbr title="ext/financialacls/financialacls.php">financialacls.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">198</span>
</aside>
<p class="phpdocumentor-summary">Get the clause to limit available membership types.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_financialacls_civicrm_get_membership_type_clause</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__financialacls_civicrm_get_membership_type_clause#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">noinspection</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>PhpUnhandledExceptionInspection</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_financialacls_civicrm_buildAmount">
financialacls_civicrm_buildAmount()
<a href="namespaces/default.html#function_financialacls_civicrm_buildAmount" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/financialacls/financialacls.php"><a href="files/ext-financialacls-financialacls.html"><abbr title="ext/financialacls/financialacls.php">financialacls.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">217</span>
</aside>
<p class="phpdocumentor-summary">Remove unpermitted options.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">financialacls_civicrm_buildAmount</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$component</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-Form.html"><abbr title="\CRM_Core_Form">CRM_Core_Form</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$form</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$feeBlock</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$component</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$form</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-Form.html"><abbr title="\CRM_Core_Form">CRM_Core_Form</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$feeBlock</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_financialacls_civicrm_buildAmount#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_buildAmount"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_buildAmount </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_financialacls_civicrm_membershipTypeValues">
financialacls_civicrm_membershipTypeValues()
<a href="namespaces/default.html#function_financialacls_civicrm_membershipTypeValues" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/financialacls/financialacls.php"><a href="files/ext-financialacls-financialacls.html"><abbr title="ext/financialacls/financialacls.php">financialacls.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">250</span>
</aside>
<p class="phpdocumentor-summary">Remove unpermitted membership types from selection availability.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">financialacls_civicrm_membershipTypeValues</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-Form.html"><abbr title="\CRM_Core_Form">CRM_Core_Form</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$form</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$membershipTypeValues</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$form</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-Form.html"><abbr title="\CRM_Core_Form">CRM_Core_Form</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$membershipTypeValues</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_financialacls_civicrm_membershipTypeValues#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_membershipTypeValues"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_membershipTypeValues </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_financialacls_civicrm_permission">
financialacls_civicrm_permission()
<a href="namespaces/default.html#function_financialacls_civicrm_permission" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/financialacls/financialacls.php"><a href="files/ext-financialacls-financialacls.html"><abbr title="ext/financialacls/financialacls.php">financialacls.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">270</span>
</aside>
<p class="phpdocumentor-summary">Add permissions.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">financialacls_civicrm_permission</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$permissions</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$permissions</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_financialacls_civicrm_permission#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_permission/">https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_permission/</a></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__financialacls_civi_api4_authorizeContribution">
_financialacls_civi_api4_authorizeContribution()
<a href="namespaces/default.html#function__financialacls_civi_api4_authorizeContribution" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/financialacls/financialacls.php"><a href="files/ext-financialacls-financialacls.html"><abbr title="ext/financialacls/financialacls.php">financialacls.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">308</span>
</aside>
<p class="phpdocumentor-summary">Listener for 'civi.api4.authorizeRecord::Contribution'</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_financialacls_civi_api4_authorizeContribution</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/Civi-Api4-Event-AuthorizeRecordEvent.html"><abbr title="\Civi\Api4\Event\AuthorizeRecordEvent">AuthorizeRecordEvent</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$e</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$e</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/Civi-Api4-Event-AuthorizeRecordEvent.html"><abbr title="\Civi\Api4\Event\AuthorizeRecordEvent">AuthorizeRecordEvent</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__financialacls_civi_api4_authorizeContribution#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_financial_acls_check_permissioned_line_items">
_civicrm_financial_acls_check_permissioned_line_items()
<a href="namespaces/default.html#function__civicrm_financial_acls_check_permissioned_line_items" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/financialacls/financialacls.php"><a href="files/ext-financialacls-financialacls.html"><abbr title="ext/financialacls/financialacls.php">financialacls.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">340</span>
</aside>
<p class="phpdocumentor-summary">Function to check if lineitems present in a contribution have permissioned FTs.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_financial_acls_check_permissioned_line_items</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$id</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$op</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$force</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">TRUE</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$contactID</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$id</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>contribution id</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$op</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>the mode of operation, can be add, view, edit, delete</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$force</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
= <span class="phpdocumentor-signature__argument__default-value">TRUE</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$contactID</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__financialacls_getRequiredPermission">
_financialacls_getRequiredPermission()
<a href="namespaces/default.html#function__financialacls_getRequiredPermission" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/financialacls/financialacls.php"><a href="files/ext-financialacls-financialacls.html"><abbr title="ext/financialacls/financialacls.php">financialacls.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">369</span>
</aside>
<p class="phpdocumentor-summary">Get the permission required to perform this action on this financial type.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_financialacls_getRequiredPermission</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$financialTypeID</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$action</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$financialTypeID</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$action</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_financialacls_civicrm_fieldOptions">
financialacls_civicrm_fieldOptions()
<a href="namespaces/default.html#function_financialacls_civicrm_fieldOptions" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/financialacls/financialacls.php"><a href="files/ext-financialacls-financialacls.html"><abbr title="ext/financialacls/financialacls.php">financialacls.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">393</span>
</aside>
<p class="phpdocumentor-summary">Remove unpermitted financial types from field Options in search context.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">financialacls_civicrm_fieldOptions</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$entity</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$field</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$options</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>Search context is described as
'search' => "search: searchable options are returned; labels are translated.",
So this is appropriate to removing the options from search screens.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entity</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$field</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$options</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_financialacls_civicrm_fieldOptions#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_fieldOptions"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_fieldOptions </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_financialacls_is_acl_limiting_enabled">
financialacls_is_acl_limiting_enabled()
<a href="namespaces/default.html#function_financialacls_is_acl_limiting_enabled" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/financialacls/financialacls.php"><a href="files/ext-financialacls-financialacls.html"><abbr title="ext/financialacls/financialacls.php">financialacls.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">434</span>
</aside>
<p class="phpdocumentor-summary">Is financial acl limiting enabled.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">financialacls_is_acl_limiting_enabled</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<section class="phpdocumentor-description"><p>Once this extension is detangled enough to be optional this will go
and the status of the extension rather than the setting will dictate.</p>
</section>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_financialacls_toggle">
financialacls_toggle()
<a href="namespaces/default.html#function_financialacls_toggle" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/financialacls/financialacls.php"><a href="files/ext-financialacls-financialacls.html"><abbr title="ext/financialacls/financialacls.php">financialacls.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">445</span>
</aside>
<p class="phpdocumentor-summary">Clear the statics cache when the setting is enabled or disabled.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">financialacls_toggle</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>Note the setting will eventually disappear in favour of whether
the extension is enabled or disabled.</p>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_financialacls_civicrm_alterMenu">
financialacls_civicrm_alterMenu()
<a href="namespaces/default.html#function_financialacls_civicrm_alterMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/financialacls/financialacls.php"><a href="files/ext-financialacls-financialacls.html"><abbr title="ext/financialacls/financialacls.php">financialacls.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">454</span>
</aside>
<p class="phpdocumentor-summary">Require financial acl permissions for financial screens.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">financialacls_civicrm_alterMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$menu</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$menu</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_financialacls_civicrm_preProcess">
financialacls_civicrm_preProcess()
<a href="namespaces/default.html#function_financialacls_civicrm_preProcess" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/financialacls/financialacls.php"><a href="files/ext-financialacls-financialacls.html"><abbr title="ext/financialacls/financialacls.php">financialacls.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">465</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">financialacls_civicrm_preProcess</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$formName</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Event-Form-Registration.html"><abbr title="\CRM_Event_Form_Registration">CRM_Event_Form_Registration</abbr></a>|<a href="classes/CRM-Contribute-Form-Contribution.html"><abbr title="\CRM_Contribute_Form_Contribution">CRM_Contribute_Form_Contribution</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$form</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$formName</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$form</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Event-Form-Registration.html"><abbr title="\CRM_Event_Form_Registration">CRM_Event_Form_Registration</abbr></a>|<a href="classes/CRM-Contribute-Form-Contribution.html"><abbr title="\CRM_Contribute_Form_Contribution">CRM_Contribute_Form_Contribution</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_financialacls_civicrm_links">
financialacls_civicrm_links()
<a href="namespaces/default.html#function_financialacls_civicrm_links" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/financialacls/financialacls.php"><a href="files/ext-financialacls-financialacls.html"><abbr title="ext/financialacls/financialacls.php">financialacls.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">492</span>
</aside>
<p class="phpdocumentor-summary">Hide edit/enable/disable links for memberships of a given Financial Type
Note: The $objectID param can be an int, string or null, hence not typed</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">financialacls_civicrm_links</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$op</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string|null </span><span class="phpdocumentor-signature__argument__name">$objectName</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$objectID</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$links</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int|null </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$mask</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$values</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>Implements hook_civicrm_links()</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$op</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$objectName</span>
: <span class="phpdocumentor-signature__argument__return-type">string|null</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$objectID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$links</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$mask</span>
: <span class="phpdocumentor-signature__argument__return-type">int|null</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$values</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_cv">
cv()
<a href="namespaces/default.html#function_cv" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/financialacls/tests/phpunit/bootstrap.php"><a href="files/ext-financialacls-tests-phpunit-bootstrap.html"><abbr title="ext/financialacls/tests/phpunit/bootstrap.php">bootstrap.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">27</span>
</aside>
<p class="phpdocumentor-summary">Call the "cv" command.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">cv</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$cmd</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$decode</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">'json'</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$cmd</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The rest of the command to send.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$decode</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">'json'</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Ex: 'json' or 'phpcode'.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_cv#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\RuntimeException">RuntimeException</abbr></span>
<section class="phpdocumentor-description"><p>If the command terminates abnormally.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
—
<section class="phpdocumentor-description"><p>Response output (if the command executed normally).</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__flexmailer_civix_civicrm_config">
_flexmailer_civix_civicrm_config()
<a href="namespaces/default.html#function__flexmailer_civix_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/flexmailer/flexmailer.civix.php"><a href="files/ext-flexmailer-flexmailer-civix.html"><abbr title="ext/flexmailer/flexmailer.civix.php">flexmailer.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">87</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_flexmailer_civix_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$config</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__flexmailer_civix_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__flexmailer_civix_civicrm_install">
_flexmailer_civix_civicrm_install()
<a href="namespaces/default.html#function__flexmailer_civix_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/flexmailer/flexmailer.civix.php"><a href="files/ext-flexmailer-flexmailer-civix.html"><abbr title="ext/flexmailer/flexmailer.civix.php">flexmailer.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">105</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_flexmailer_civix_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__flexmailer_civix_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__flexmailer_civix_civicrm_enable">
_flexmailer_civix_civicrm_enable()
<a href="namespaces/default.html#function__flexmailer_civix_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/flexmailer/flexmailer.civix.php"><a href="files/ext-flexmailer-flexmailer-civix.html"><abbr title="ext/flexmailer/flexmailer.civix.php">flexmailer.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">115</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_flexmailer_civix_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__flexmailer_civix_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__flexmailer_civix_insert_navigation_menu">
_flexmailer_civix_insert_navigation_menu()
<a href="namespaces/default.html#function__flexmailer_civix_insert_navigation_menu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/flexmailer/flexmailer.civix.php"><a href="files/ext-flexmailer-flexmailer-civix.html"><abbr title="ext/flexmailer/flexmailer.civix.php">flexmailer.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">131</span>
</aside>
<p class="phpdocumentor-summary">Inserts a navigation menu item at a given place in the hierarchy.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_flexmailer_civix_insert_navigation_menu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$menu</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$path</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$item</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$menu</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>menu hierarchy</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$path</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>path to parent of this item, e.g. 'my_extension/submenu'
'Mailing', or 'Administer/System Settings'</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$item</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>the item to insert (parent/child attributes will be
filled for you)</li>
</ul>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__flexmailer_civix_navigationMenu">
_flexmailer_civix_navigationMenu()
<a href="namespaces/default.html#function__flexmailer_civix_navigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/flexmailer/flexmailer.civix.php"><a href="files/ext-flexmailer-flexmailer-civix.html"><abbr title="ext/flexmailer/flexmailer.civix.php">flexmailer.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">162</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_navigationMenu().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_flexmailer_civix_navigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__flexmailer_civix_fixNavigationMenu">
_flexmailer_civix_fixNavigationMenu()
<a href="namespaces/default.html#function__flexmailer_civix_fixNavigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/flexmailer/flexmailer.civix.php"><a href="files/ext-flexmailer-flexmailer-civix.html"><abbr title="ext/flexmailer/flexmailer.civix.php">flexmailer.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">172</span>
</aside>
<p class="phpdocumentor-summary">Given a navigation menu, generate navIDs for any items which are
missing them.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_flexmailer_civix_fixNavigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__flexmailer_civix_fixNavigationMenuItems">
_flexmailer_civix_fixNavigationMenuItems()
<a href="namespaces/default.html#function__flexmailer_civix_fixNavigationMenuItems" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/flexmailer/flexmailer.civix.php"><a href="files/ext-flexmailer-flexmailer-civix.html"><abbr title="ext/flexmailer/flexmailer.civix.php">flexmailer.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">182</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_flexmailer_civix_fixNavigationMenuItems</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$maxNavID</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$parentID</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$maxNavID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$parentID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_flexmailer_civicrm_config">
flexmailer_civicrm_config()
<a href="namespaces/default.html#function_flexmailer_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/flexmailer/flexmailer.php"><a href="files/ext-flexmailer-flexmailer.html"><abbr title="ext/flexmailer/flexmailer.php">flexmailer.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">14</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">flexmailer_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$config</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_flexmailer_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_config"> http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_config </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_flexmailer_civicrm_install">
flexmailer_civicrm_install()
<a href="namespaces/default.html#function_flexmailer_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/flexmailer/flexmailer.php"><a href="files/ext-flexmailer-flexmailer.html"><abbr title="ext/flexmailer/flexmailer.php">flexmailer.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">23</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">flexmailer_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_flexmailer_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_install"> http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_flexmailer_civicrm_enable">
flexmailer_civicrm_enable()
<a href="namespaces/default.html#function_flexmailer_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/flexmailer/flexmailer.php"><a href="files/ext-flexmailer-flexmailer.html"><abbr title="ext/flexmailer/flexmailer.php">flexmailer.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">32</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">flexmailer_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_flexmailer_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_enable"> http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_flexmailer_civicrm_container">
flexmailer_civicrm_container()
<a href="namespaces/default.html#function_flexmailer_civicrm_container" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/flexmailer/flexmailer.php"><a href="files/ext-flexmailer-flexmailer.html"><abbr title="ext/flexmailer/flexmailer.php">flexmailer.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">39</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_container().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">flexmailer_civicrm_container</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$container</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$container</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_flexmailer_civicrm_scanClasses">
flexmailer_civicrm_scanClasses()
<a href="namespaces/default.html#function_flexmailer_civicrm_scanClasses" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/flexmailer/flexmailer.php"><a href="files/ext-flexmailer-flexmailer.html"><abbr title="ext/flexmailer/flexmailer.php">flexmailer.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">47</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">flexmailer_civicrm_scanClasses</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$classes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$classes</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_flexmailer_civicrm_scanClasses#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Utils-Hook.html#method_scanClasses"><abbr title="\CRM_Utils_Hook::scanClasses()">CRM_Utils_Hook::scanClasses()</abbr></a></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_cv">
cv()
<a href="namespaces/default.html#function_cv" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/flexmailer/tests/phpunit/bootstrap.php"><a href="files/ext-flexmailer-tests-phpunit-bootstrap.html"><abbr title="ext/flexmailer/tests/phpunit/bootstrap.php">bootstrap.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">33</span>
</aside>
<p class="phpdocumentor-summary">Call the "cv" command.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">cv</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$cmd</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$decode</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">'json'</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$cmd</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The rest of the command to send.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$decode</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">'json'</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Ex: 'json' or 'phpcode'.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_cv#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\RuntimeException">RuntimeException</abbr></span>
<section class="phpdocumentor-description"><p>If the command terminates abnormally.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
—
<section class="phpdocumentor-description"><p>Response output (if the command executed normally).</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__greenwich_civix_civicrm_config">
_greenwich_civix_civicrm_config()
<a href="namespaces/default.html#function__greenwich_civix_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/greenwich/greenwich.civix.php"><a href="files/ext-greenwich-greenwich-civix.html"><abbr title="ext/greenwich/greenwich.civix.php">greenwich.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">87</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_greenwich_civix_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$config</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__greenwich_civix_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__greenwich_civix_civicrm_install">
_greenwich_civix_civicrm_install()
<a href="namespaces/default.html#function__greenwich_civix_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/greenwich/greenwich.civix.php"><a href="files/ext-greenwich-greenwich-civix.html"><abbr title="ext/greenwich/greenwich.civix.php">greenwich.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">105</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_greenwich_civix_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__greenwich_civix_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__greenwich_civix_civicrm_enable">
_greenwich_civix_civicrm_enable()
<a href="namespaces/default.html#function__greenwich_civix_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/greenwich/greenwich.civix.php"><a href="files/ext-greenwich-greenwich-civix.html"><abbr title="ext/greenwich/greenwich.civix.php">greenwich.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">115</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_greenwich_civix_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__greenwich_civix_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__greenwich_civix_insert_navigation_menu">
_greenwich_civix_insert_navigation_menu()
<a href="namespaces/default.html#function__greenwich_civix_insert_navigation_menu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/greenwich/greenwich.civix.php"><a href="files/ext-greenwich-greenwich-civix.html"><abbr title="ext/greenwich/greenwich.civix.php">greenwich.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">131</span>
</aside>
<p class="phpdocumentor-summary">Inserts a navigation menu item at a given place in the hierarchy.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_greenwich_civix_insert_navigation_menu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$menu</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$path</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$item</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$menu</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>menu hierarchy</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$path</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>path to parent of this item, e.g. 'my_extension/submenu'
'Mailing', or 'Administer/System Settings'</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$item</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>the item to insert (parent/child attributes will be
filled for you)</li>
</ul>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__greenwich_civix_navigationMenu">
_greenwich_civix_navigationMenu()
<a href="namespaces/default.html#function__greenwich_civix_navigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/greenwich/greenwich.civix.php"><a href="files/ext-greenwich-greenwich-civix.html"><abbr title="ext/greenwich/greenwich.civix.php">greenwich.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">162</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_navigationMenu().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_greenwich_civix_navigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__greenwich_civix_fixNavigationMenu">
_greenwich_civix_fixNavigationMenu()
<a href="namespaces/default.html#function__greenwich_civix_fixNavigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/greenwich/greenwich.civix.php"><a href="files/ext-greenwich-greenwich-civix.html"><abbr title="ext/greenwich/greenwich.civix.php">greenwich.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">172</span>
</aside>
<p class="phpdocumentor-summary">Given a navigation menu, generate navIDs for any items which are
missing them.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_greenwich_civix_fixNavigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__greenwich_civix_fixNavigationMenuItems">
_greenwich_civix_fixNavigationMenuItems()
<a href="namespaces/default.html#function__greenwich_civix_fixNavigationMenuItems" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/greenwich/greenwich.civix.php"><a href="files/ext-greenwich-greenwich-civix.html"><abbr title="ext/greenwich/greenwich.civix.php">greenwich.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">182</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_greenwich_civix_fixNavigationMenuItems</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$maxNavID</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$parentID</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$maxNavID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$parentID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_greenwich_civicrm_config">
greenwich_civicrm_config()
<a href="namespaces/default.html#function_greenwich_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/greenwich/greenwich.php"><a href="files/ext-greenwich-greenwich.html"><abbr title="ext/greenwich/greenwich.php">greenwich.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">13</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">greenwich_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$config</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_greenwich_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/ </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_greenwich_civicrm_themes">
greenwich_civicrm_themes()
<a href="namespaces/default.html#function_greenwich_civicrm_themes" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/greenwich/greenwich.php"><a href="files/ext-greenwich-greenwich.html"><abbr title="ext/greenwich/greenwich.php">greenwich.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">20</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_themes().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">greenwich_civicrm_themes</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$themes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$themes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_greenwich_civicrm_alterBundle">
greenwich_civicrm_alterBundle()
<a href="namespaces/default.html#function_greenwich_civicrm_alterBundle" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/greenwich/greenwich.php"><a href="files/ext-greenwich-greenwich.html"><abbr title="ext/greenwich/greenwich.php">greenwich.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">31</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_alterBundle().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">greenwich_civicrm_alterBundle</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-Resources-Bundle.html"><abbr title="\CRM_Core_Resources_Bundle">CRM_Core_Resources_Bundle</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$bundle</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$bundle</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-Resources-Bundle.html"><abbr title="\CRM_Core_Resources_Bundle">CRM_Core_Resources_Bundle</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__iframe_civix_civicrm_config">
_iframe_civix_civicrm_config()
<a href="namespaces/default.html#function__iframe_civix_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/iframe/iframe.civix.php"><a href="files/ext-iframe-iframe-civix.html"><abbr title="ext/iframe/iframe.civix.php">iframe.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">87</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_iframe_civix_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$config</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__iframe_civix_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__iframe_civix_civicrm_install">
_iframe_civix_civicrm_install()
<a href="namespaces/default.html#function__iframe_civix_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/iframe/iframe.civix.php"><a href="files/ext-iframe-iframe-civix.html"><abbr title="ext/iframe/iframe.civix.php">iframe.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">105</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_iframe_civix_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__iframe_civix_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__iframe_civix_civicrm_enable">
_iframe_civix_civicrm_enable()
<a href="namespaces/default.html#function__iframe_civix_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/iframe/iframe.civix.php"><a href="files/ext-iframe-iframe-civix.html"><abbr title="ext/iframe/iframe.civix.php">iframe.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">115</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_iframe_civix_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__iframe_civix_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__iframe_civix_insert_navigation_menu">
_iframe_civix_insert_navigation_menu()
<a href="namespaces/default.html#function__iframe_civix_insert_navigation_menu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/iframe/iframe.civix.php"><a href="files/ext-iframe-iframe-civix.html"><abbr title="ext/iframe/iframe.civix.php">iframe.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">131</span>
</aside>
<p class="phpdocumentor-summary">Inserts a navigation menu item at a given place in the hierarchy.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_iframe_civix_insert_navigation_menu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$menu</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$path</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$item</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$menu</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>menu hierarchy</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$path</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>path to parent of this item, e.g. 'my_extension/submenu'
'Mailing', or 'Administer/System Settings'</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$item</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>the item to insert (parent/child attributes will be
filled for you)</li>
</ul>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__iframe_civix_navigationMenu">
_iframe_civix_navigationMenu()
<a href="namespaces/default.html#function__iframe_civix_navigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/iframe/iframe.civix.php"><a href="files/ext-iframe-iframe-civix.html"><abbr title="ext/iframe/iframe.civix.php">iframe.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">162</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_navigationMenu().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_iframe_civix_navigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__iframe_civix_fixNavigationMenu">
_iframe_civix_fixNavigationMenu()
<a href="namespaces/default.html#function__iframe_civix_fixNavigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/iframe/iframe.civix.php"><a href="files/ext-iframe-iframe-civix.html"><abbr title="ext/iframe/iframe.civix.php">iframe.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">172</span>
</aside>
<p class="phpdocumentor-summary">Given a navigation menu, generate navIDs for any items which are
missing them.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_iframe_civix_fixNavigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__iframe_civix_fixNavigationMenuItems">
_iframe_civix_fixNavigationMenuItems()
<a href="namespaces/default.html#function__iframe_civix_fixNavigationMenuItems" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/iframe/iframe.civix.php"><a href="files/ext-iframe-iframe-civix.html"><abbr title="ext/iframe/iframe.civix.php">iframe.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">182</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_iframe_civix_fixNavigationMenuItems</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$maxNavID</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$parentID</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$maxNavID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$parentID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_iframe_civicrm_config">
iframe_civicrm_config()
<a href="namespaces/default.html#function_iframe_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/iframe/iframe.php"><a href="files/ext-iframe-iframe.html"><abbr title="ext/iframe/iframe.php">iframe.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">12</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">iframe_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$config</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed>|null </span><span class="phpdocumentor-signature__argument__name">$flags</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$flags</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed>|null</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_iframe_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/ </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_iframe_civicrm_install">
iframe_civicrm_install()
<a href="namespaces/default.html#function_iframe_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/iframe/iframe.php"><a href="files/ext-iframe-iframe.html"><abbr title="ext/iframe/iframe.php">iframe.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">29</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">iframe_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_iframe_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_iframe_civicrm_enable">
iframe_civicrm_enable()
<a href="namespaces/default.html#function_iframe_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/iframe/iframe.php"><a href="files/ext-iframe-iframe.html"><abbr title="ext/iframe/iframe.php">iframe.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">38</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">iframe_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_iframe_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__legacycustomsearches_civix_civicrm_config">
_legacycustomsearches_civix_civicrm_config()
<a href="namespaces/default.html#function__legacycustomsearches_civix_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/legacycustomsearches/legacycustomsearches.civix.php"><a href="files/ext-legacycustomsearches-legacycustomsearches-civix.html"><abbr title="ext/legacycustomsearches/legacycustomsearches.civix.php">legacycustomsearches.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">87</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_legacycustomsearches_civix_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$config</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__legacycustomsearches_civix_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__legacycustomsearches_civix_civicrm_install">
_legacycustomsearches_civix_civicrm_install()
<a href="namespaces/default.html#function__legacycustomsearches_civix_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/legacycustomsearches/legacycustomsearches.civix.php"><a href="files/ext-legacycustomsearches-legacycustomsearches-civix.html"><abbr title="ext/legacycustomsearches/legacycustomsearches.civix.php">legacycustomsearches.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">105</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_legacycustomsearches_civix_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__legacycustomsearches_civix_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__legacycustomsearches_civix_civicrm_enable">
_legacycustomsearches_civix_civicrm_enable()
<a href="namespaces/default.html#function__legacycustomsearches_civix_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/legacycustomsearches/legacycustomsearches.civix.php"><a href="files/ext-legacycustomsearches-legacycustomsearches-civix.html"><abbr title="ext/legacycustomsearches/legacycustomsearches.civix.php">legacycustomsearches.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">115</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_legacycustomsearches_civix_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__legacycustomsearches_civix_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__legacycustomsearches_civix_insert_navigation_menu">
_legacycustomsearches_civix_insert_navigation_menu()
<a href="namespaces/default.html#function__legacycustomsearches_civix_insert_navigation_menu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/legacycustomsearches/legacycustomsearches.civix.php"><a href="files/ext-legacycustomsearches-legacycustomsearches-civix.html"><abbr title="ext/legacycustomsearches/legacycustomsearches.civix.php">legacycustomsearches.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">131</span>
</aside>
<p class="phpdocumentor-summary">Inserts a navigation menu item at a given place in the hierarchy.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_legacycustomsearches_civix_insert_navigation_menu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$menu</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$path</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$item</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$menu</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>menu hierarchy</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$path</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>path to parent of this item, e.g. 'my_extension/submenu'
'Mailing', or 'Administer/System Settings'</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$item</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>the item to insert (parent/child attributes will be
filled for you)</li>
</ul>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__legacycustomsearches_civix_navigationMenu">
_legacycustomsearches_civix_navigationMenu()
<a href="namespaces/default.html#function__legacycustomsearches_civix_navigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/legacycustomsearches/legacycustomsearches.civix.php"><a href="files/ext-legacycustomsearches-legacycustomsearches-civix.html"><abbr title="ext/legacycustomsearches/legacycustomsearches.civix.php">legacycustomsearches.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">162</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_navigationMenu().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_legacycustomsearches_civix_navigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__legacycustomsearches_civix_fixNavigationMenu">
_legacycustomsearches_civix_fixNavigationMenu()
<a href="namespaces/default.html#function__legacycustomsearches_civix_fixNavigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/legacycustomsearches/legacycustomsearches.civix.php"><a href="files/ext-legacycustomsearches-legacycustomsearches-civix.html"><abbr title="ext/legacycustomsearches/legacycustomsearches.civix.php">legacycustomsearches.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">172</span>
</aside>
<p class="phpdocumentor-summary">Given a navigation menu, generate navIDs for any items which are
missing them.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_legacycustomsearches_civix_fixNavigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__legacycustomsearches_civix_fixNavigationMenuItems">
_legacycustomsearches_civix_fixNavigationMenuItems()
<a href="namespaces/default.html#function__legacycustomsearches_civix_fixNavigationMenuItems" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/legacycustomsearches/legacycustomsearches.civix.php"><a href="files/ext-legacycustomsearches-legacycustomsearches-civix.html"><abbr title="ext/legacycustomsearches/legacycustomsearches.civix.php">legacycustomsearches.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">182</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_legacycustomsearches_civix_fixNavigationMenuItems</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$maxNavID</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$parentID</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$maxNavID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$parentID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_legacycustomsearches_civicrm_config">
legacycustomsearches_civicrm_config()
<a href="namespaces/default.html#function_legacycustomsearches_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/legacycustomsearches/legacycustomsearches.php"><a href="files/ext-legacycustomsearches-legacycustomsearches.html"><abbr title="ext/legacycustomsearches/legacycustomsearches.php">legacycustomsearches.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">13</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">legacycustomsearches_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$config</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_legacycustomsearches_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/ </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_legacycustomsearches_civicrm_install">
legacycustomsearches_civicrm_install()
<a href="namespaces/default.html#function_legacycustomsearches_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/legacycustomsearches/legacycustomsearches.php"><a href="files/ext-legacycustomsearches-legacycustomsearches.html"><abbr title="ext/legacycustomsearches/legacycustomsearches.php">legacycustomsearches.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">22</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">legacycustomsearches_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_legacycustomsearches_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_legacycustomsearches_civicrm_enable">
legacycustomsearches_civicrm_enable()
<a href="namespaces/default.html#function_legacycustomsearches_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/legacycustomsearches/legacycustomsearches.php"><a href="files/ext-legacycustomsearches-legacycustomsearches.html"><abbr title="ext/legacycustomsearches/legacycustomsearches.php">legacycustomsearches.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">31</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">legacycustomsearches_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_legacycustomsearches_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_legacycustomsearches_civicrm_buildGroupContactCache">
legacycustomsearches_civicrm_buildGroupContactCache()
<a href="namespaces/default.html#function_legacycustomsearches_civicrm_buildGroupContactCache" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/legacycustomsearches/legacycustomsearches.php"><a href="files/ext-legacycustomsearches-legacycustomsearches.html"><abbr title="ext/legacycustomsearches/legacycustomsearches.php">legacycustomsearches.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">43</span>
</aside>
<p class="phpdocumentor-summary">Determine the sql</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">legacycustomsearches_civicrm_buildGroupContactCache</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$savedSearch</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$groupID</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$sql</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$savedSearch</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$groupID</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$sql</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_legacycustomsearches_civicrm_buildGroupContactCache#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_cv">
cv()
<a href="namespaces/default.html#function_cv" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/legacycustomsearches/tests/phpunit/bootstrap.php"><a href="files/ext-legacycustomsearches-tests-phpunit-bootstrap.html"><abbr title="ext/legacycustomsearches/tests/phpunit/bootstrap.php">bootstrap.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">29</span>
</aside>
<p class="phpdocumentor-summary">Call the "cv" command.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">cv</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$cmd</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$decode</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">'json'</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$cmd</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The rest of the command to send.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$decode</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">'json'</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Ex: 'json' or 'phpcode'.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_cv#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\RuntimeException">RuntimeException</abbr></span>
<section class="phpdocumentor-description"><p>If the command terminates abnormally.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
—
<section class="phpdocumentor-description"><p>Response output (if the command executed normally).
For 'raw' or 'phpcode', this will be a string. For 'json', it could be any JSON value.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__message_admin_civix_civicrm_config">
_message_admin_civix_civicrm_config()
<a href="namespaces/default.html#function__message_admin_civix_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/message_admin/message_admin.civix.php"><a href="files/ext-message-admin-message-admin-civix.html"><abbr title="ext/message_admin/message_admin.civix.php">message_admin.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">87</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_message_admin_civix_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$config</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__message_admin_civix_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__message_admin_civix_civicrm_install">
_message_admin_civix_civicrm_install()
<a href="namespaces/default.html#function__message_admin_civix_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/message_admin/message_admin.civix.php"><a href="files/ext-message-admin-message-admin-civix.html"><abbr title="ext/message_admin/message_admin.civix.php">message_admin.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">105</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_message_admin_civix_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__message_admin_civix_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__message_admin_civix_civicrm_enable">
_message_admin_civix_civicrm_enable()
<a href="namespaces/default.html#function__message_admin_civix_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/message_admin/message_admin.civix.php"><a href="files/ext-message-admin-message-admin-civix.html"><abbr title="ext/message_admin/message_admin.civix.php">message_admin.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">115</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_message_admin_civix_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__message_admin_civix_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__message_admin_civix_insert_navigation_menu">
_message_admin_civix_insert_navigation_menu()
<a href="namespaces/default.html#function__message_admin_civix_insert_navigation_menu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/message_admin/message_admin.civix.php"><a href="files/ext-message-admin-message-admin-civix.html"><abbr title="ext/message_admin/message_admin.civix.php">message_admin.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">131</span>
</aside>
<p class="phpdocumentor-summary">Inserts a navigation menu item at a given place in the hierarchy.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_message_admin_civix_insert_navigation_menu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$menu</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$path</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$item</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$menu</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>menu hierarchy</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$path</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>path to parent of this item, e.g. 'my_extension/submenu'
'Mailing', or 'Administer/System Settings'</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$item</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>the item to insert (parent/child attributes will be
filled for you)</li>
</ul>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__message_admin_civix_navigationMenu">
_message_admin_civix_navigationMenu()
<a href="namespaces/default.html#function__message_admin_civix_navigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/message_admin/message_admin.civix.php"><a href="files/ext-message-admin-message-admin-civix.html"><abbr title="ext/message_admin/message_admin.civix.php">message_admin.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">162</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_navigationMenu().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_message_admin_civix_navigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__message_admin_civix_fixNavigationMenu">
_message_admin_civix_fixNavigationMenu()
<a href="namespaces/default.html#function__message_admin_civix_fixNavigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/message_admin/message_admin.civix.php"><a href="files/ext-message-admin-message-admin-civix.html"><abbr title="ext/message_admin/message_admin.civix.php">message_admin.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">172</span>
</aside>
<p class="phpdocumentor-summary">Given a navigation menu, generate navIDs for any items which are
missing them.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_message_admin_civix_fixNavigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__message_admin_civix_fixNavigationMenuItems">
_message_admin_civix_fixNavigationMenuItems()
<a href="namespaces/default.html#function__message_admin_civix_fixNavigationMenuItems" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/message_admin/message_admin.civix.php"><a href="files/ext-message-admin-message-admin-civix.html"><abbr title="ext/message_admin/message_admin.civix.php">message_admin.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">182</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_message_admin_civix_fixNavigationMenuItems</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$maxNavID</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$parentID</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$maxNavID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$parentID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_message_admin_civicrm_config">
message_admin_civicrm_config()
<a href="namespaces/default.html#function_message_admin_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/message_admin/message_admin.php"><a href="files/ext-message-admin-message-admin.html"><abbr title="ext/message_admin/message_admin.php">message_admin.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">13</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">message_admin_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$config</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_message_admin_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/ </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_message_admin_civicrm_install">
message_admin_civicrm_install()
<a href="namespaces/default.html#function_message_admin_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/message_admin/message_admin.php"><a href="files/ext-message-admin-message-admin.html"><abbr title="ext/message_admin/message_admin.php">message_admin.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">22</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">message_admin_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_message_admin_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_message_admin_civicrm_enable">
message_admin_civicrm_enable()
<a href="namespaces/default.html#function_message_admin_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/message_admin/message_admin.php"><a href="files/ext-message-admin-message-admin.html"><abbr title="ext/message_admin/message_admin.php">message_admin.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">31</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">message_admin_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_message_admin_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_buildInputUrl">
buildInputUrl()
<a href="namespaces/default.html#function_buildInputUrl" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/oauth-client/bin/local-redir.php"><a href="files/ext-oauth-client-bin-local-redir.html"><abbr title="ext/oauth-client/bin/local-redir.php">local-redir.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">8</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">buildInputUrl</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$s</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$s</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_buildRedirectUrl">
buildRedirectUrl()
<a href="namespaces/default.html#function_buildRedirectUrl" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/oauth-client/bin/local-redir.php"><a href="files/ext-oauth-client-bin-local-redir.html"><abbr title="ext/oauth-client/bin/local-redir.php">local-redir.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">14</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">buildRedirectUrl</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$get</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$get</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__oauth_client_civix_civicrm_config">
_oauth_client_civix_civicrm_config()
<a href="namespaces/default.html#function__oauth_client_civix_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/oauth-client/oauth_client.civix.php"><a href="files/ext-oauth-client-oauth-client-civix.html"><abbr title="ext/oauth-client/oauth_client.civix.php">oauth_client.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">87</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_oauth_client_civix_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$config</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__oauth_client_civix_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__oauth_client_civix_civicrm_install">
_oauth_client_civix_civicrm_install()
<a href="namespaces/default.html#function__oauth_client_civix_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/oauth-client/oauth_client.civix.php"><a href="files/ext-oauth-client-oauth-client-civix.html"><abbr title="ext/oauth-client/oauth_client.civix.php">oauth_client.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">105</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_oauth_client_civix_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__oauth_client_civix_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__oauth_client_civix_civicrm_enable">
_oauth_client_civix_civicrm_enable()
<a href="namespaces/default.html#function__oauth_client_civix_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/oauth-client/oauth_client.civix.php"><a href="files/ext-oauth-client-oauth-client-civix.html"><abbr title="ext/oauth-client/oauth_client.civix.php">oauth_client.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">115</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_oauth_client_civix_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__oauth_client_civix_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__oauth_client_civix_insert_navigation_menu">
_oauth_client_civix_insert_navigation_menu()
<a href="namespaces/default.html#function__oauth_client_civix_insert_navigation_menu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/oauth-client/oauth_client.civix.php"><a href="files/ext-oauth-client-oauth-client-civix.html"><abbr title="ext/oauth-client/oauth_client.civix.php">oauth_client.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">131</span>
</aside>
<p class="phpdocumentor-summary">Inserts a navigation menu item at a given place in the hierarchy.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_oauth_client_civix_insert_navigation_menu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$menu</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$path</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$item</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$menu</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>menu hierarchy</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$path</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>path to parent of this item, e.g. 'my_extension/submenu'
'Mailing', or 'Administer/System Settings'</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$item</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>the item to insert (parent/child attributes will be
filled for you)</li>
</ul>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__oauth_client_civix_navigationMenu">
_oauth_client_civix_navigationMenu()
<a href="namespaces/default.html#function__oauth_client_civix_navigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/oauth-client/oauth_client.civix.php"><a href="files/ext-oauth-client-oauth-client-civix.html"><abbr title="ext/oauth-client/oauth_client.civix.php">oauth_client.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">162</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_navigationMenu().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_oauth_client_civix_navigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__oauth_client_civix_fixNavigationMenu">
_oauth_client_civix_fixNavigationMenu()
<a href="namespaces/default.html#function__oauth_client_civix_fixNavigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/oauth-client/oauth_client.civix.php"><a href="files/ext-oauth-client-oauth-client-civix.html"><abbr title="ext/oauth-client/oauth_client.civix.php">oauth_client.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">172</span>
</aside>
<p class="phpdocumentor-summary">Given a navigation menu, generate navIDs for any items which are
missing them.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_oauth_client_civix_fixNavigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__oauth_client_civix_fixNavigationMenuItems">
_oauth_client_civix_fixNavigationMenuItems()
<a href="namespaces/default.html#function__oauth_client_civix_fixNavigationMenuItems" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/oauth-client/oauth_client.civix.php"><a href="files/ext-oauth-client-oauth-client-civix.html"><abbr title="ext/oauth-client/oauth_client.civix.php">oauth_client.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">182</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_oauth_client_civix_fixNavigationMenuItems</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$maxNavID</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$parentID</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$maxNavID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$parentID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_oauth_client_civicrm_config">
oauth_client_civicrm_config()
<a href="namespaces/default.html#function_oauth_client_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/oauth-client/oauth_client.php"><a href="files/ext-oauth-client-oauth-client.html"><abbr title="ext/oauth-client/oauth_client.php">oauth_client.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">11</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">oauth_client_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$config</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_oauth_client_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/ </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_oauth_client_civicrm_permission">
oauth_client_civicrm_permission()
<a href="namespaces/default.html#function_oauth_client_civicrm_permission" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/oauth-client/oauth_client.php"><a href="files/ext-oauth-client-oauth-client.html"><abbr title="ext/oauth-client/oauth_client.php">oauth_client.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">21</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_permission().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">oauth_client_civicrm_permission</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$permissions</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$permissions</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_oauth_client_civicrm_permission#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Utils-Hook.html#method_permission"><abbr title="\CRM_Utils_Hook::permission()">CRM_Utils_Hook::permission()</abbr></a></span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Permission.html#method_getCorePermissions"><abbr title="\CRM_Core_Permission::getCorePermissions()">CRM_Core_Permission::getCorePermissions()</abbr></a></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_oauth_client_civicrm_container">
oauth_client_civicrm_container()
<a href="namespaces/default.html#function_oauth_client_civicrm_container" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/oauth-client/oauth_client.php"><a href="files/ext-oauth-client-oauth-client.html"><abbr title="ext/oauth-client/oauth_client.php">oauth_client.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">49</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">oauth_client_civicrm_container</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><abbr title="\Symfony\Component\DependencyInjection\ContainerBuilder">ContainerBuilder</abbr> </span><span class="phpdocumentor-signature__argument__name">$container</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$container</span>
: <span class="phpdocumentor-signature__argument__return-type"><abbr title="\Symfony\Component\DependencyInjection\ContainerBuilder">ContainerBuilder</abbr></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_oauth_client_civicrm_oauthProviders">
oauth_client_civicrm_oauthProviders()
<a href="namespaces/default.html#function_oauth_client_civicrm_oauthProviders" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/oauth-client/oauth_client.php"><a href="files/ext-oauth-client-oauth-client.html"><abbr title="ext/oauth-client/oauth_client.php">oauth_client.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">60</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_oauthProviders().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">oauth_client_civicrm_oauthProviders</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$providers</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$providers</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_oauth_client_civicrm_mailSetupActions">
oauth_client_civicrm_mailSetupActions()
<a href="namespaces/default.html#function_oauth_client_civicrm_mailSetupActions" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/oauth-client/oauth_client.php"><a href="files/ext-oauth-client-oauth-client.html"><abbr title="ext/oauth-client/oauth_client.php">oauth_client.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">86</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_mailSetupActions().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">oauth_client_civicrm_mailSetupActions</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$setupActions</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$setupActions</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_oauth_client_civicrm_mailSetupActions#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Utils-Hook.html#method_mailSetupActions"><abbr title="\CRM_Utils_Hook::mailSetupActions()">CRM_Utils_Hook::mailSetupActions()</abbr></a></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_oauth_client_civicrm_oauthReturn">
oauth_client_civicrm_oauthReturn()
<a href="namespaces/default.html#function_oauth_client_civicrm_oauthReturn" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/oauth-client/oauth_client.php"><a href="files/ext-oauth-client-oauth-client.html"><abbr title="ext/oauth-client/oauth_client.php">oauth_client.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">93</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_oauthReturn().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">oauth_client_civicrm_oauthReturn</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$token</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nextUrl</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$token</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nextUrl</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_oauth_client_civicrm_alterMailStore">
oauth_client_civicrm_alterMailStore()
<a href="namespaces/default.html#function_oauth_client_civicrm_alterMailStore" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/oauth-client/oauth_client.php"><a href="files/ext-oauth-client-oauth-client.html"><abbr title="ext/oauth-client/oauth_client.php">oauth_client.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">102</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_alterMailStore().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">oauth_client_civicrm_alterMailStore</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$mailSettings</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$mailSettings</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_oauth_client_civicrm_alterMailStore#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Utils-Hook.html#method_alterMailStore"><abbr title="\CRM_Utils_Hook::alterMailStore()">CRM_Utils_Hook::alterMailStore()</abbr></a></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_cv">
cv()
<a href="namespaces/default.html#function_cv" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/oauth-client/tests/phpunit/bootstrap.php"><a href="files/ext-oauth-client-tests-phpunit-bootstrap.html"><abbr title="ext/oauth-client/tests/phpunit/bootstrap.php">bootstrap.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">28</span>
</aside>
<p class="phpdocumentor-summary">Call the "cv" command.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">cv</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$cmd</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$decode</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">'json'</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$cmd</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The rest of the command to send.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$decode</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">'json'</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Ex: 'json' or 'phpcode'.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_cv#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\RuntimeException">RuntimeException</abbr></span>
<section class="phpdocumentor-description"><p>If the command terminates abnormally.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
—
<section class="phpdocumentor-description"><p>Response output (if the command executed normally).</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__oembed_civix_civicrm_config">
_oembed_civix_civicrm_config()
<a href="namespaces/default.html#function__oembed_civix_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/oembed/oembed.civix.php"><a href="files/ext-oembed-oembed-civix.html"><abbr title="ext/oembed/oembed.civix.php">oembed.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">87</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_oembed_civix_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$config</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__oembed_civix_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__oembed_civix_civicrm_install">
_oembed_civix_civicrm_install()
<a href="namespaces/default.html#function__oembed_civix_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/oembed/oembed.civix.php"><a href="files/ext-oembed-oembed-civix.html"><abbr title="ext/oembed/oembed.civix.php">oembed.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">105</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_oembed_civix_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__oembed_civix_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__oembed_civix_civicrm_enable">
_oembed_civix_civicrm_enable()
<a href="namespaces/default.html#function__oembed_civix_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/oembed/oembed.civix.php"><a href="files/ext-oembed-oembed-civix.html"><abbr title="ext/oembed/oembed.civix.php">oembed.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">115</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_oembed_civix_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__oembed_civix_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__oembed_civix_insert_navigation_menu">
_oembed_civix_insert_navigation_menu()
<a href="namespaces/default.html#function__oembed_civix_insert_navigation_menu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/oembed/oembed.civix.php"><a href="files/ext-oembed-oembed-civix.html"><abbr title="ext/oembed/oembed.civix.php">oembed.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">131</span>
</aside>
<p class="phpdocumentor-summary">Inserts a navigation menu item at a given place in the hierarchy.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_oembed_civix_insert_navigation_menu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$menu</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$path</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$item</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$menu</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>menu hierarchy</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$path</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>path to parent of this item, e.g. 'my_extension/submenu'
'Mailing', or 'Administer/System Settings'</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$item</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>the item to insert (parent/child attributes will be
filled for you)</li>
</ul>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__oembed_civix_navigationMenu">
_oembed_civix_navigationMenu()
<a href="namespaces/default.html#function__oembed_civix_navigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/oembed/oembed.civix.php"><a href="files/ext-oembed-oembed-civix.html"><abbr title="ext/oembed/oembed.civix.php">oembed.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">162</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_navigationMenu().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_oembed_civix_navigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__oembed_civix_fixNavigationMenu">
_oembed_civix_fixNavigationMenu()
<a href="namespaces/default.html#function__oembed_civix_fixNavigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/oembed/oembed.civix.php"><a href="files/ext-oembed-oembed-civix.html"><abbr title="ext/oembed/oembed.civix.php">oembed.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">172</span>
</aside>
<p class="phpdocumentor-summary">Given a navigation menu, generate navIDs for any items which are
missing them.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_oembed_civix_fixNavigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__oembed_civix_fixNavigationMenuItems">
_oembed_civix_fixNavigationMenuItems()
<a href="namespaces/default.html#function__oembed_civix_fixNavigationMenuItems" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/oembed/oembed.civix.php"><a href="files/ext-oembed-oembed-civix.html"><abbr title="ext/oembed/oembed.civix.php">oembed.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">182</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_oembed_civix_fixNavigationMenuItems</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$maxNavID</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$parentID</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$maxNavID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$parentID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_oembed_civicrm_config">
oembed_civicrm_config()
<a href="namespaces/default.html#function_oembed_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/oembed/oembed.php"><a href="files/ext-oembed-oembed.html"><abbr title="ext/oembed/oembed.php">oembed.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">12</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">oembed_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$config</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_oembed_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/ </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_oembed_civicrm_install">
oembed_civicrm_install()
<a href="namespaces/default.html#function_oembed_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/oembed/oembed.php"><a href="files/ext-oembed-oembed.html"><abbr title="ext/oembed/oembed.php">oembed.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">21</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">oembed_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_oembed_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_oembed_civicrm_enable">
oembed_civicrm_enable()
<a href="namespaces/default.html#function_oembed_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/oembed/oembed.php"><a href="files/ext-oembed-oembed.html"><abbr title="ext/oembed/oembed.php">oembed.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">30</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">oembed_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_oembed_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_cv">
cv()
<a href="namespaces/default.html#function_cv" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/oembed/tests/phpunit/bootstrap.php"><a href="files/ext-oembed-tests-phpunit-bootstrap.html"><abbr title="ext/oembed/tests/phpunit/bootstrap.php">bootstrap.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">30</span>
</aside>
<p class="phpdocumentor-summary">Call the "cv" command.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">cv</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$cmd</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$decode</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">'json'</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$cmd</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The rest of the command to send.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$decode</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">'json'</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Ex: 'json' or 'phpcode'.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_cv#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\RuntimeException">RuntimeException</abbr></span>
<section class="phpdocumentor-description"><p>If the command terminates abnormally.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
—
<section class="phpdocumentor-description"><p>Response output (if the command executed normally).
For 'raw' or 'phpcode', this will be a string. For 'json', it could be any JSON value.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__payflowpro_civix_civicrm_config">
_payflowpro_civix_civicrm_config()
<a href="namespaces/default.html#function__payflowpro_civix_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/payflowpro/payflowpro.civix.php"><a href="files/ext-payflowpro-payflowpro-civix.html"><abbr title="ext/payflowpro/payflowpro.civix.php">payflowpro.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">87</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_payflowpro_civix_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$config</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__payflowpro_civix_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__payflowpro_civix_civicrm_install">
_payflowpro_civix_civicrm_install()
<a href="namespaces/default.html#function__payflowpro_civix_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/payflowpro/payflowpro.civix.php"><a href="files/ext-payflowpro-payflowpro-civix.html"><abbr title="ext/payflowpro/payflowpro.civix.php">payflowpro.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">105</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_payflowpro_civix_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__payflowpro_civix_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__payflowpro_civix_civicrm_enable">
_payflowpro_civix_civicrm_enable()
<a href="namespaces/default.html#function__payflowpro_civix_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/payflowpro/payflowpro.civix.php"><a href="files/ext-payflowpro-payflowpro-civix.html"><abbr title="ext/payflowpro/payflowpro.civix.php">payflowpro.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">115</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_payflowpro_civix_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__payflowpro_civix_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__payflowpro_civix_insert_navigation_menu">
_payflowpro_civix_insert_navigation_menu()
<a href="namespaces/default.html#function__payflowpro_civix_insert_navigation_menu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/payflowpro/payflowpro.civix.php"><a href="files/ext-payflowpro-payflowpro-civix.html"><abbr title="ext/payflowpro/payflowpro.civix.php">payflowpro.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">131</span>
</aside>
<p class="phpdocumentor-summary">Inserts a navigation menu item at a given place in the hierarchy.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_payflowpro_civix_insert_navigation_menu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$menu</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$path</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$item</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$menu</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>menu hierarchy</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$path</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>path to parent of this item, e.g. 'my_extension/submenu'
'Mailing', or 'Administer/System Settings'</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$item</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>the item to insert (parent/child attributes will be
filled for you)</li>
</ul>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__payflowpro_civix_navigationMenu">
_payflowpro_civix_navigationMenu()
<a href="namespaces/default.html#function__payflowpro_civix_navigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/payflowpro/payflowpro.civix.php"><a href="files/ext-payflowpro-payflowpro-civix.html"><abbr title="ext/payflowpro/payflowpro.civix.php">payflowpro.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">162</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_navigationMenu().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_payflowpro_civix_navigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__payflowpro_civix_fixNavigationMenu">
_payflowpro_civix_fixNavigationMenu()
<a href="namespaces/default.html#function__payflowpro_civix_fixNavigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/payflowpro/payflowpro.civix.php"><a href="files/ext-payflowpro-payflowpro-civix.html"><abbr title="ext/payflowpro/payflowpro.civix.php">payflowpro.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">172</span>
</aside>
<p class="phpdocumentor-summary">Given a navigation menu, generate navIDs for any items which are
missing them.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_payflowpro_civix_fixNavigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__payflowpro_civix_fixNavigationMenuItems">
_payflowpro_civix_fixNavigationMenuItems()
<a href="namespaces/default.html#function__payflowpro_civix_fixNavigationMenuItems" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/payflowpro/payflowpro.civix.php"><a href="files/ext-payflowpro-payflowpro-civix.html"><abbr title="ext/payflowpro/payflowpro.civix.php">payflowpro.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">182</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_payflowpro_civix_fixNavigationMenuItems</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$maxNavID</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$parentID</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$maxNavID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$parentID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_payflowpro_civicrm_config">
payflowpro_civicrm_config()
<a href="namespaces/default.html#function_payflowpro_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/payflowpro/payflowpro.php"><a href="files/ext-payflowpro-payflowpro.html"><abbr title="ext/payflowpro/payflowpro.php">payflowpro.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">13</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">payflowpro_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$config</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_payflowpro_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/ </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_payflowpro_civicrm_install">
payflowpro_civicrm_install()
<a href="namespaces/default.html#function_payflowpro_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/payflowpro/payflowpro.php"><a href="files/ext-payflowpro-payflowpro.html"><abbr title="ext/payflowpro/payflowpro.php">payflowpro.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">22</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">payflowpro_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_payflowpro_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_payflowpro_civicrm_enable">
payflowpro_civicrm_enable()
<a href="namespaces/default.html#function_payflowpro_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/payflowpro/payflowpro.php"><a href="files/ext-payflowpro-payflowpro.html"><abbr title="ext/payflowpro/payflowpro.php">payflowpro.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">31</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">payflowpro_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_payflowpro_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_cv">
cv()
<a href="namespaces/default.html#function_cv" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/payflowpro/tests/phpunit/bootstrap.php"><a href="files/ext-payflowpro-tests-phpunit-bootstrap.html"><abbr title="ext/payflowpro/tests/phpunit/bootstrap.php">bootstrap.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">27</span>
</aside>
<p class="phpdocumentor-summary">Call the "cv" command.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">cv</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$cmd</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$decode</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">'json'</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$cmd</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The rest of the command to send.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$decode</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">'json'</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Ex: 'json' or 'phpcode'.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_cv#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\RuntimeException">RuntimeException</abbr></span>
<section class="phpdocumentor-description"><p>If the command terminates abnormally.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
—
<section class="phpdocumentor-description"><p>Response output (if the command executed normally).</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__recaptcha_qsencode">
_recaptcha_qsencode()
<a href="namespaces/default.html#function__recaptcha_qsencode" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/recaptcha/lib/recaptcha/recaptchalib.php"><a href="files/ext-recaptcha-lib-recaptcha-recaptchalib.html"><abbr title="ext/recaptcha/lib/recaptcha/recaptchalib.php">recaptchalib.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">49</span>
</aside>
<p class="phpdocumentor-summary">Encodes the given data into a query string format</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_recaptcha_qsencode</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$data</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$data</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>array of string elements to be encoded</li>
</ul>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
—
<section class="phpdocumentor-description"><ul>
<li>encoded request</li>
</ul>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__recaptcha_http_post">
_recaptcha_http_post()
<a href="namespaces/default.html#function__recaptcha_http_post" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/recaptcha/lib/recaptcha/recaptchalib.php"><a href="files/ext-recaptcha-lib-recaptcha-recaptchalib.html"><abbr title="ext/recaptcha/lib/recaptcha/recaptchalib.php">recaptchalib.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">67</span>
</aside>
<p class="phpdocumentor-summary">Submits an HTTP POST to a reCAPTCHA server</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_recaptcha_http_post</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$host</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$path</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$data</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$host</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$path</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$data</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
—
<section class="phpdocumentor-description"><p>response</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_recaptcha_get_html">
recaptcha_get_html()
<a href="namespaces/default.html#function_recaptcha_get_html" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/recaptcha/lib/recaptcha/recaptchalib.php"><a href="files/ext-recaptcha-lib-recaptcha-recaptchalib.html"><abbr title="ext/recaptcha/lib/recaptcha/recaptchalib.php">recaptchalib.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">88</span>
</aside>
<p class="phpdocumentor-summary">Gets the challenge HTML (javascript and non-javascript version).</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">recaptcha_get_html</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$pubkey</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$error</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$use_ssl</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">FALSE</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<section class="phpdocumentor-description"><p>This is called from the browser, and the resulting reCAPTCHA HTML widget
is embedded within the HTML form it was called from.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$pubkey</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>A public key for reCAPTCHA</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$error</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The error given by reCAPTCHA (optional, default is null)</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$use_ssl</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
= <span class="phpdocumentor-signature__argument__default-value">FALSE</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Should the request be made over ssl? (optional, default is false)</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
—
<section class="phpdocumentor-description"><ul>
<li>The HTML to be embedded in the user's form.</li>
</ul>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_recaptcha_check_answer">
recaptcha_check_answer()
<a href="namespaces/default.html#function_recaptcha_check_answer" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/recaptcha/lib/recaptcha/recaptchalib.php"><a href="files/ext-recaptcha-lib-recaptcha-recaptchalib.html"><abbr title="ext/recaptcha/lib/recaptcha/recaptchalib.php">recaptchalib.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">130</span>
</aside>
<p class="phpdocumentor-summary">Calls an HTTP POST function to verify if the user's guess was correct</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">recaptcha_check_answer</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$privkey</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$remoteip</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$response</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$extra_params</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">array()</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/ReCaptchaResponse.html"><abbr title="\ReCaptchaResponse">ReCaptchaResponse</abbr></a></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$privkey</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$remoteip</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$response</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$extra_params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
= <span class="phpdocumentor-signature__argument__default-value">array()</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>an array of extra variables to post to the server</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/ReCaptchaResponse.html"><abbr title="\ReCaptchaResponse">ReCaptchaResponse</abbr></a></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_recaptcha_get_signup_url">
recaptcha_get_signup_url()
<a href="namespaces/default.html#function_recaptcha_get_signup_url" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/recaptcha/lib/recaptcha/recaptchalib.php"><a href="files/ext-recaptcha-lib-recaptcha-recaptchalib.html"><abbr title="ext/recaptcha/lib/recaptcha/recaptchalib.php">recaptchalib.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">171</span>
</aside>
<p class="phpdocumentor-summary">gets a URL where the user can sign up for reCAPTCHA. If your application
has a configuration page where you enter a key, you should provide a link
using this function.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">recaptcha_get_signup_url</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$domain</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$appname</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$domain</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The domain where the page is hosted</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$appname</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The name of your application</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__recaptcha_aes_pad">
_recaptcha_aes_pad()
<a href="namespaces/default.html#function__recaptcha_aes_pad" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/recaptcha/lib/recaptcha/recaptchalib.php"><a href="files/ext-recaptcha-lib-recaptcha-recaptchalib.html"><abbr title="ext/recaptcha/lib/recaptcha/recaptchalib.php">recaptchalib.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">175</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_recaptcha_aes_pad</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$val</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$val</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__recaptcha_aes_encrypt">
_recaptcha_aes_encrypt()
<a href="namespaces/default.html#function__recaptcha_aes_encrypt" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/recaptcha/lib/recaptcha/recaptchalib.php"><a href="files/ext-recaptcha-lib-recaptcha-recaptchalib.html"><abbr title="ext/recaptcha/lib/recaptcha/recaptchalib.php">recaptchalib.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">184</span>
</aside>
<p class="phpdocumentor-summary">Mailhide related code</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_recaptcha_aes_encrypt</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$val</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$ky</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$val</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$ky</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__recaptcha_mailhide_urlbase64">
_recaptcha_mailhide_urlbase64()
<a href="namespaces/default.html#function__recaptcha_mailhide_urlbase64" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/recaptcha/lib/recaptcha/recaptchalib.php"><a href="files/ext-recaptcha-lib-recaptcha-recaptchalib.html"><abbr title="ext/recaptcha/lib/recaptcha/recaptchalib.php">recaptchalib.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">194</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_recaptcha_mailhide_urlbase64</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$x</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$x</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_recaptcha_mailhide_url">
recaptcha_mailhide_url()
<a href="namespaces/default.html#function_recaptcha_mailhide_url" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/recaptcha/lib/recaptcha/recaptchalib.php"><a href="files/ext-recaptcha-lib-recaptcha-recaptchalib.html"><abbr title="ext/recaptcha/lib/recaptcha/recaptchalib.php">recaptchalib.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">201</span>
</aside>
<p class="phpdocumentor-summary">gets the reCAPTCHA Mailhide url for a given email, public key and private key</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">recaptcha_mailhide_url</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$pubkey</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$privkey</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$email</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$pubkey</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$privkey</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$email</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__recaptcha_mailhide_email_parts">
_recaptcha_mailhide_email_parts()
<a href="namespaces/default.html#function__recaptcha_mailhide_email_parts" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/recaptcha/lib/recaptcha/recaptchalib.php"><a href="files/ext-recaptcha-lib-recaptcha-recaptchalib.html"><abbr title="ext/recaptcha/lib/recaptcha/recaptchalib.php">recaptchalib.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">218</span>
</aside>
<p class="phpdocumentor-summary">gets the parts of the email to expose to the user.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_recaptcha_mailhide_email_parts</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$email</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>eg, given johndoe@example,com return ["john", "example.com"].
the email is then displayed as john...@example.com</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$email</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_recaptcha_mailhide_html">
recaptcha_mailhide_html()
<a href="namespaces/default.html#function_recaptcha_mailhide_html" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/recaptcha/lib/recaptcha/recaptchalib.php"><a href="files/ext-recaptcha-lib-recaptcha-recaptchalib.html"><abbr title="ext/recaptcha/lib/recaptcha/recaptchalib.php">recaptchalib.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">239</span>
</aside>
<p class="phpdocumentor-summary">Gets html to display an email address given a public an private key.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">recaptcha_mailhide_html</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$pubkey</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$privkey</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$email</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>to get a key, go to:</p>
<p>http://www.google.com/recaptcha/mailhide/apikey</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$pubkey</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$privkey</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$email</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__recaptcha_civix_civicrm_config">
_recaptcha_civix_civicrm_config()
<a href="namespaces/default.html#function__recaptcha_civix_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/recaptcha/recaptcha.civix.php"><a href="files/ext-recaptcha-recaptcha-civix.html"><abbr title="ext/recaptcha/recaptcha.civix.php">recaptcha.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">87</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_recaptcha_civix_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$config</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__recaptcha_civix_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__recaptcha_civix_civicrm_install">
_recaptcha_civix_civicrm_install()
<a href="namespaces/default.html#function__recaptcha_civix_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/recaptcha/recaptcha.civix.php"><a href="files/ext-recaptcha-recaptcha-civix.html"><abbr title="ext/recaptcha/recaptcha.civix.php">recaptcha.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">105</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_recaptcha_civix_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__recaptcha_civix_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__recaptcha_civix_civicrm_enable">
_recaptcha_civix_civicrm_enable()
<a href="namespaces/default.html#function__recaptcha_civix_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/recaptcha/recaptcha.civix.php"><a href="files/ext-recaptcha-recaptcha-civix.html"><abbr title="ext/recaptcha/recaptcha.civix.php">recaptcha.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">115</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_recaptcha_civix_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__recaptcha_civix_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__recaptcha_civix_insert_navigation_menu">
_recaptcha_civix_insert_navigation_menu()
<a href="namespaces/default.html#function__recaptcha_civix_insert_navigation_menu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/recaptcha/recaptcha.civix.php"><a href="files/ext-recaptcha-recaptcha-civix.html"><abbr title="ext/recaptcha/recaptcha.civix.php">recaptcha.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">131</span>
</aside>
<p class="phpdocumentor-summary">Inserts a navigation menu item at a given place in the hierarchy.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_recaptcha_civix_insert_navigation_menu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$menu</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$path</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$item</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$menu</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>menu hierarchy</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$path</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>path to parent of this item, e.g. 'my_extension/submenu'
'Mailing', or 'Administer/System Settings'</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$item</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>the item to insert (parent/child attributes will be
filled for you)</li>
</ul>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__recaptcha_civix_navigationMenu">
_recaptcha_civix_navigationMenu()
<a href="namespaces/default.html#function__recaptcha_civix_navigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/recaptcha/recaptcha.civix.php"><a href="files/ext-recaptcha-recaptcha-civix.html"><abbr title="ext/recaptcha/recaptcha.civix.php">recaptcha.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">162</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_navigationMenu().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_recaptcha_civix_navigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__recaptcha_civix_fixNavigationMenu">
_recaptcha_civix_fixNavigationMenu()
<a href="namespaces/default.html#function__recaptcha_civix_fixNavigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/recaptcha/recaptcha.civix.php"><a href="files/ext-recaptcha-recaptcha-civix.html"><abbr title="ext/recaptcha/recaptcha.civix.php">recaptcha.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">172</span>
</aside>
<p class="phpdocumentor-summary">Given a navigation menu, generate navIDs for any items which are
missing them.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_recaptcha_civix_fixNavigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__recaptcha_civix_fixNavigationMenuItems">
_recaptcha_civix_fixNavigationMenuItems()
<a href="namespaces/default.html#function__recaptcha_civix_fixNavigationMenuItems" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/recaptcha/recaptcha.civix.php"><a href="files/ext-recaptcha-recaptcha-civix.html"><abbr title="ext/recaptcha/recaptcha.civix.php">recaptcha.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">182</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_recaptcha_civix_fixNavigationMenuItems</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$maxNavID</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$parentID</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$maxNavID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$parentID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_recaptcha_civicrm_config">
recaptcha_civicrm_config()
<a href="namespaces/default.html#function_recaptcha_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/recaptcha/recaptcha.php"><a href="files/ext-recaptcha-recaptcha.html"><abbr title="ext/recaptcha/recaptcha.php">recaptcha.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">13</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">recaptcha_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$config</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_recaptcha_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/ </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_recaptcha_civicrm_install">
recaptcha_civicrm_install()
<a href="namespaces/default.html#function_recaptcha_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/recaptcha/recaptcha.php"><a href="files/ext-recaptcha-recaptcha.html"><abbr title="ext/recaptcha/recaptcha.php">recaptcha.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">22</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">recaptcha_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_recaptcha_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_recaptcha_civicrm_enable">
recaptcha_civicrm_enable()
<a href="namespaces/default.html#function_recaptcha_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/recaptcha/recaptcha.php"><a href="files/ext-recaptcha-recaptcha.html"><abbr title="ext/recaptcha/recaptcha.php">recaptcha.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">31</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">recaptcha_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_recaptcha_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_recaptcha_civicrm_buildForm">
recaptcha_civicrm_buildForm()
<a href="namespaces/default.html#function_recaptcha_civicrm_buildForm" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/recaptcha/recaptcha.php"><a href="files/ext-recaptcha-recaptcha.html"><abbr title="ext/recaptcha/recaptcha.php">recaptcha.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">38</span>
</aside>
<p class="phpdocumentor-summary">Intercept form functions</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">recaptcha_civicrm_buildForm</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$formName</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$form</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$formName</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$form</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__scheduled_communications_civix_civicrm_config">
_scheduled_communications_civix_civicrm_config()
<a href="namespaces/default.html#function__scheduled_communications_civix_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/scheduled_communications/scheduled_communications.civix.php"><a href="files/ext-scheduled-communications-scheduled-communications-civix.html"><abbr title="ext/scheduled_communications/scheduled_communications.civix.php">scheduled_communications.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">87</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_scheduled_communications_civix_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$config</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__scheduled_communications_civix_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__scheduled_communications_civix_civicrm_install">
_scheduled_communications_civix_civicrm_install()
<a href="namespaces/default.html#function__scheduled_communications_civix_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/scheduled_communications/scheduled_communications.civix.php"><a href="files/ext-scheduled-communications-scheduled-communications-civix.html"><abbr title="ext/scheduled_communications/scheduled_communications.civix.php">scheduled_communications.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">105</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_scheduled_communications_civix_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__scheduled_communications_civix_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__scheduled_communications_civix_civicrm_enable">
_scheduled_communications_civix_civicrm_enable()
<a href="namespaces/default.html#function__scheduled_communications_civix_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/scheduled_communications/scheduled_communications.civix.php"><a href="files/ext-scheduled-communications-scheduled-communications-civix.html"><abbr title="ext/scheduled_communications/scheduled_communications.civix.php">scheduled_communications.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">115</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_scheduled_communications_civix_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__scheduled_communications_civix_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__scheduled_communications_civix_insert_navigation_menu">
_scheduled_communications_civix_insert_navigation_menu()
<a href="namespaces/default.html#function__scheduled_communications_civix_insert_navigation_menu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/scheduled_communications/scheduled_communications.civix.php"><a href="files/ext-scheduled-communications-scheduled-communications-civix.html"><abbr title="ext/scheduled_communications/scheduled_communications.civix.php">scheduled_communications.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">131</span>
</aside>
<p class="phpdocumentor-summary">Inserts a navigation menu item at a given place in the hierarchy.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_scheduled_communications_civix_insert_navigation_menu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$menu</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$path</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$item</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$menu</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>menu hierarchy</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$path</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>path to parent of this item, e.g. 'my_extension/submenu'
'Mailing', or 'Administer/System Settings'</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$item</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>the item to insert (parent/child attributes will be
filled for you)</li>
</ul>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__scheduled_communications_civix_navigationMenu">
_scheduled_communications_civix_navigationMenu()
<a href="namespaces/default.html#function__scheduled_communications_civix_navigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/scheduled_communications/scheduled_communications.civix.php"><a href="files/ext-scheduled-communications-scheduled-communications-civix.html"><abbr title="ext/scheduled_communications/scheduled_communications.civix.php">scheduled_communications.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">162</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_navigationMenu().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_scheduled_communications_civix_navigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__scheduled_communications_civix_fixNavigationMenu">
_scheduled_communications_civix_fixNavigationMenu()
<a href="namespaces/default.html#function__scheduled_communications_civix_fixNavigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/scheduled_communications/scheduled_communications.civix.php"><a href="files/ext-scheduled-communications-scheduled-communications-civix.html"><abbr title="ext/scheduled_communications/scheduled_communications.civix.php">scheduled_communications.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">172</span>
</aside>
<p class="phpdocumentor-summary">Given a navigation menu, generate navIDs for any items which are
missing them.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_scheduled_communications_civix_fixNavigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__scheduled_communications_civix_fixNavigationMenuItems">
_scheduled_communications_civix_fixNavigationMenuItems()
<a href="namespaces/default.html#function__scheduled_communications_civix_fixNavigationMenuItems" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/scheduled_communications/scheduled_communications.civix.php"><a href="files/ext-scheduled-communications-scheduled-communications-civix.html"><abbr title="ext/scheduled_communications/scheduled_communications.civix.php">scheduled_communications.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">182</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_scheduled_communications_civix_fixNavigationMenuItems</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$maxNavID</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$parentID</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$maxNavID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$parentID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_scheduled_communications_civicrm_config">
scheduled_communications_civicrm_config()
<a href="namespaces/default.html#function_scheduled_communications_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/scheduled_communications/scheduled_communications.php"><a href="files/ext-scheduled-communications-scheduled-communications.html"><abbr title="ext/scheduled_communications/scheduled_communications.php">scheduled_communications.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">11</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">scheduled_communications_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$config</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_scheduled_communications_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/ </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_scheduled_communications_civicrm_install">
scheduled_communications_civicrm_install()
<a href="namespaces/default.html#function_scheduled_communications_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/scheduled_communications/scheduled_communications.php"><a href="files/ext-scheduled-communications-scheduled-communications.html"><abbr title="ext/scheduled_communications/scheduled_communications.php">scheduled_communications.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">20</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">scheduled_communications_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_scheduled_communications_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_scheduled_communications_civicrm_enable">
scheduled_communications_civicrm_enable()
<a href="namespaces/default.html#function_scheduled_communications_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/scheduled_communications/scheduled_communications.php"><a href="files/ext-scheduled-communications-scheduled-communications.html"><abbr title="ext/scheduled_communications/scheduled_communications.php">scheduled_communications.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">29</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">scheduled_communications_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_scheduled_communications_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_scheduled_communications_civicrm_permission">
scheduled_communications_civicrm_permission()
<a href="namespaces/default.html#function_scheduled_communications_civicrm_permission" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/scheduled_communications/scheduled_communications.php"><a href="files/ext-scheduled-communications-scheduled-communications.html"><abbr title="ext/scheduled_communications/scheduled_communications.php">scheduled_communications.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">36</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">scheduled_communications_civicrm_permission</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$permissions</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$permissions</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_scheduled_communications_civicrm_permission#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">implements</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>CRM_Utils_Hook::permission().</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_scheduled_communications_civicrm_pre">
scheduled_communications_civicrm_pre()
<a href="namespaces/default.html#function_scheduled_communications_civicrm_pre" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/scheduled_communications/scheduled_communications.php"><a href="files/ext-scheduled-communications-scheduled-communications.html"><abbr title="ext/scheduled_communications/scheduled_communications.php">scheduled_communications.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">46</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_pre().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">scheduled_communications_civicrm_pre</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$op</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$entity</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$id</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$op</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entity</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$id</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_scheduled_communications_civicrm_post">
scheduled_communications_civicrm_post()
<a href="namespaces/default.html#function_scheduled_communications_civicrm_post" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/scheduled_communications/scheduled_communications.php"><a href="files/ext-scheduled-communications-scheduled-communications.html"><abbr title="ext/scheduled_communications/scheduled_communications.php">scheduled_communications.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">73</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_post().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">scheduled_communications_civicrm_post</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$op</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$entity</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$id</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$object</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$op</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entity</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$id</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$object</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_cv">
cv()
<a href="namespaces/default.html#function_cv" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/scheduled_communications/tests/phpunit/bootstrap.php"><a href="files/ext-scheduled-communications-tests-phpunit-bootstrap.html"><abbr title="ext/scheduled_communications/tests/phpunit/bootstrap.php">bootstrap.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">30</span>
</aside>
<p class="phpdocumentor-summary">Call the "cv" command.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">cv</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$cmd</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$decode</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">'json'</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$cmd</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The rest of the command to send.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$decode</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">'json'</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Ex: 'json' or 'phpcode'.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_cv#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\RuntimeException">RuntimeException</abbr></span>
<section class="phpdocumentor-description"><p>If the command terminates abnormally.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
—
<section class="phpdocumentor-description"><p>Response output (if the command executed normally).
For 'raw' or 'phpcode', this will be a string. For 'json', it could be any JSON value.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__search_kit_civix_class_loader">
_search_kit_civix_class_loader()
<a href="namespaces/default.html#function__search_kit_civix_class_loader" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/search_kit/search_kit.civix.php"><a href="files/ext-search-kit-search-kit-civix.html"><abbr title="ext/search_kit/search_kit.civix.php">search_kit.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">94</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_search_kit_civix_class_loader</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$class</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$class</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__search_kit_civix_civicrm_config">
_search_kit_civix_civicrm_config()
<a href="namespaces/default.html#function__search_kit_civix_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/search_kit/search_kit.civix.php"><a href="files/ext-search-kit-search-kit-civix.html"><abbr title="ext/search_kit/search_kit.civix.php">search_kit.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">122</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_search_kit_civix_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$config</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__search_kit_civix_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__search_kit_civix_civicrm_install">
_search_kit_civix_civicrm_install()
<a href="namespaces/default.html#function__search_kit_civix_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/search_kit/search_kit.civix.php"><a href="files/ext-search-kit-search-kit-civix.html"><abbr title="ext/search_kit/search_kit.civix.php">search_kit.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">140</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_search_kit_civix_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__search_kit_civix_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__search_kit_civix_civicrm_enable">
_search_kit_civix_civicrm_enable()
<a href="namespaces/default.html#function__search_kit_civix_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/search_kit/search_kit.civix.php"><a href="files/ext-search-kit-search-kit-civix.html"><abbr title="ext/search_kit/search_kit.civix.php">search_kit.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">150</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_search_kit_civix_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__search_kit_civix_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__search_kit_civix_insert_navigation_menu">
_search_kit_civix_insert_navigation_menu()
<a href="namespaces/default.html#function__search_kit_civix_insert_navigation_menu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/search_kit/search_kit.civix.php"><a href="files/ext-search-kit-search-kit-civix.html"><abbr title="ext/search_kit/search_kit.civix.php">search_kit.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">166</span>
</aside>
<p class="phpdocumentor-summary">Inserts a navigation menu item at a given place in the hierarchy.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_search_kit_civix_insert_navigation_menu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$menu</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$path</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$item</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$menu</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>menu hierarchy</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$path</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>path to parent of this item, e.g. 'my_extension/submenu'
'Mailing', or 'Administer/System Settings'</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$item</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>the item to insert (parent/child attributes will be
filled for you)</li>
</ul>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__search_kit_civix_navigationMenu">
_search_kit_civix_navigationMenu()
<a href="namespaces/default.html#function__search_kit_civix_navigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/search_kit/search_kit.civix.php"><a href="files/ext-search-kit-search-kit-civix.html"><abbr title="ext/search_kit/search_kit.civix.php">search_kit.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">197</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_navigationMenu().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_search_kit_civix_navigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__search_kit_civix_fixNavigationMenu">
_search_kit_civix_fixNavigationMenu()
<a href="namespaces/default.html#function__search_kit_civix_fixNavigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/search_kit/search_kit.civix.php"><a href="files/ext-search-kit-search-kit-civix.html"><abbr title="ext/search_kit/search_kit.civix.php">search_kit.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">207</span>
</aside>
<p class="phpdocumentor-summary">Given a navigation menu, generate navIDs for any items which are
missing them.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_search_kit_civix_fixNavigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__search_kit_civix_fixNavigationMenuItems">
_search_kit_civix_fixNavigationMenuItems()
<a href="namespaces/default.html#function__search_kit_civix_fixNavigationMenuItems" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/search_kit/search_kit.civix.php"><a href="files/ext-search-kit-search-kit-civix.html"><abbr title="ext/search_kit/search_kit.civix.php">search_kit.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">217</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_search_kit_civix_fixNavigationMenuItems</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$maxNavID</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$parentID</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$maxNavID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$parentID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_search_kit_civicrm_config">
search_kit_civicrm_config()
<a href="namespaces/default.html#function_search_kit_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/search_kit/search_kit.php"><a href="files/ext-search-kit-search-kit.html"><abbr title="ext/search_kit/search_kit.php">search_kit.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">11</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">search_kit_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$config</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_search_kit_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/ </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_search_kit_civicrm_permission">
search_kit_civicrm_permission()
<a href="namespaces/default.html#function_search_kit_civicrm_permission" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/search_kit/search_kit.php"><a href="files/ext-search-kit-search-kit.html"><abbr title="ext/search_kit/search_kit.php">search_kit.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">21</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_permission().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">search_kit_civicrm_permission</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$permissions</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>Define SearchKit permissions.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$permissions</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_search_kit_civicrm_angularModules">
search_kit_civicrm_angularModules()
<a href="namespaces/default.html#function_search_kit_civicrm_angularModules" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/search_kit/search_kit.php"><a href="files/ext-search-kit-search-kit.html"><abbr title="ext/search_kit/search_kit.php">search_kit.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">39</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_angularModules().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">search_kit_civicrm_angularModules</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$angularModules</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>Generate a list of Angular modules.</p>
<p>Note: This hook only runs in CiviCRM 4.5+. It may
use features only available in v4.6+.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$angularModules</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_search_kit_civicrm_angularModules#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_angularModules"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_angularModules </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_search_kit_civicrm_pre">
search_kit_civicrm_pre()
<a href="namespaces/default.html#function_search_kit_civicrm_pre" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/search_kit/search_kit.php"><a href="files/ext-search-kit-search-kit.html"><abbr title="ext/search_kit/search_kit.php">search_kit.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">62</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_pre().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">search_kit_civicrm_pre</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$op</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$entity</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$id</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$op</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entity</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$id</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_search_kit_civicrm_post">
search_kit_civicrm_post()
<a href="namespaces/default.html#function_search_kit_civicrm_post" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/search_kit/search_kit.php"><a href="files/ext-search-kit-search-kit.html"><abbr title="ext/search_kit/search_kit.php">search_kit.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">76</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_post().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">search_kit_civicrm_post</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$op</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$entity</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$id</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$object</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$op</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entity</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$id</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$object</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_search_kit_civicrm_entityTypes">
search_kit_civicrm_entityTypes()
<a href="namespaces/default.html#function_search_kit_civicrm_entityTypes" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/search_kit/search_kit.php"><a href="files/ext-search-kit-search-kit.html"><abbr title="ext/search_kit/search_kit.php">search_kit.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">87</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_entityTypes().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">search_kit_civicrm_entityTypes</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$entityTypes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entityTypes</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__getSearchKitDisplayTableName">
_getSearchKitDisplayTableName()
<a href="namespaces/default.html#function__getSearchKitDisplayTableName" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/search_kit/search_kit.php"><a href="files/ext-search-kit-search-kit.html"><abbr title="ext/search_kit/search_kit.php">search_kit.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">104</span>
</aside>
<p class="phpdocumentor-summary">Returns a SQL-safe table name for a display (for use with displays of type "entity")</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_getSearchKitDisplayTableName</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$displayName</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$displayName</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__getSearchKitEntityDisplays">
_getSearchKitEntityDisplays()
<a href="namespaces/default.html#function__getSearchKitEntityDisplays" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/search_kit/search_kit.php"><a href="files/ext-search-kit-search-kit.html"><abbr title="ext/search_kit/search_kit.php">search_kit.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">114</span>
</aside>
<p class="phpdocumentor-summary">Uncached function to fetch displays of type "entity" to be used by boot-level code</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_getSearchKitEntityDisplays</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$name</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$name</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__getSearchKitEntityDisplays#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_cv">
cv()
<a href="namespaces/default.html#function_cv" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/search_kit/tests/phpunit/bootstrap.php"><a href="files/ext-search-kit-tests-phpunit-bootstrap.html"><abbr title="ext/search_kit/tests/phpunit/bootstrap.php">bootstrap.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">27</span>
</aside>
<p class="phpdocumentor-summary">Call the "cv" command.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">cv</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$cmd</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$decode</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">'json'</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$cmd</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The rest of the command to send.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$decode</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">'json'</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Ex: 'json' or 'phpcode'.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_cv#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\RuntimeException">RuntimeException</abbr></span>
<section class="phpdocumentor-description"><p>If the command terminates abnormally.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
—
<section class="phpdocumentor-description"><p>Response output (if the command executed normally).</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__sequentialcreditnotes_civix_civicrm_config">
_sequentialcreditnotes_civix_civicrm_config()
<a href="namespaces/default.html#function__sequentialcreditnotes_civix_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/sequentialcreditnotes/sequentialcreditnotes.civix.php"><a href="files/ext-sequentialcreditnotes-sequentialcreditnotes-civix.html"><abbr title="ext/sequentialcreditnotes/sequentialcreditnotes.civix.php">sequentialcreditnotes.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">87</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_sequentialcreditnotes_civix_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$config</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__sequentialcreditnotes_civix_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__sequentialcreditnotes_civix_civicrm_install">
_sequentialcreditnotes_civix_civicrm_install()
<a href="namespaces/default.html#function__sequentialcreditnotes_civix_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/sequentialcreditnotes/sequentialcreditnotes.civix.php"><a href="files/ext-sequentialcreditnotes-sequentialcreditnotes-civix.html"><abbr title="ext/sequentialcreditnotes/sequentialcreditnotes.civix.php">sequentialcreditnotes.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">105</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_sequentialcreditnotes_civix_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__sequentialcreditnotes_civix_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__sequentialcreditnotes_civix_civicrm_enable">
_sequentialcreditnotes_civix_civicrm_enable()
<a href="namespaces/default.html#function__sequentialcreditnotes_civix_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/sequentialcreditnotes/sequentialcreditnotes.civix.php"><a href="files/ext-sequentialcreditnotes-sequentialcreditnotes-civix.html"><abbr title="ext/sequentialcreditnotes/sequentialcreditnotes.civix.php">sequentialcreditnotes.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">115</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_sequentialcreditnotes_civix_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__sequentialcreditnotes_civix_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__sequentialcreditnotes_civix_insert_navigation_menu">
_sequentialcreditnotes_civix_insert_navigation_menu()
<a href="namespaces/default.html#function__sequentialcreditnotes_civix_insert_navigation_menu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/sequentialcreditnotes/sequentialcreditnotes.civix.php"><a href="files/ext-sequentialcreditnotes-sequentialcreditnotes-civix.html"><abbr title="ext/sequentialcreditnotes/sequentialcreditnotes.civix.php">sequentialcreditnotes.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">131</span>
</aside>
<p class="phpdocumentor-summary">Inserts a navigation menu item at a given place in the hierarchy.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_sequentialcreditnotes_civix_insert_navigation_menu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$menu</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$path</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$item</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$menu</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>menu hierarchy</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$path</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>path to parent of this item, e.g. 'my_extension/submenu'
'Mailing', or 'Administer/System Settings'</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$item</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>the item to insert (parent/child attributes will be
filled for you)</li>
</ul>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__sequentialcreditnotes_civix_navigationMenu">
_sequentialcreditnotes_civix_navigationMenu()
<a href="namespaces/default.html#function__sequentialcreditnotes_civix_navigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/sequentialcreditnotes/sequentialcreditnotes.civix.php"><a href="files/ext-sequentialcreditnotes-sequentialcreditnotes-civix.html"><abbr title="ext/sequentialcreditnotes/sequentialcreditnotes.civix.php">sequentialcreditnotes.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">162</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_navigationMenu().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_sequentialcreditnotes_civix_navigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__sequentialcreditnotes_civix_fixNavigationMenu">
_sequentialcreditnotes_civix_fixNavigationMenu()
<a href="namespaces/default.html#function__sequentialcreditnotes_civix_fixNavigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/sequentialcreditnotes/sequentialcreditnotes.civix.php"><a href="files/ext-sequentialcreditnotes-sequentialcreditnotes-civix.html"><abbr title="ext/sequentialcreditnotes/sequentialcreditnotes.civix.php">sequentialcreditnotes.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">172</span>
</aside>
<p class="phpdocumentor-summary">Given a navigation menu, generate navIDs for any items which are
missing them.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_sequentialcreditnotes_civix_fixNavigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__sequentialcreditnotes_civix_fixNavigationMenuItems">
_sequentialcreditnotes_civix_fixNavigationMenuItems()
<a href="namespaces/default.html#function__sequentialcreditnotes_civix_fixNavigationMenuItems" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/sequentialcreditnotes/sequentialcreditnotes.civix.php"><a href="files/ext-sequentialcreditnotes-sequentialcreditnotes-civix.html"><abbr title="ext/sequentialcreditnotes/sequentialcreditnotes.civix.php">sequentialcreditnotes.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">182</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_sequentialcreditnotes_civix_fixNavigationMenuItems</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$maxNavID</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$parentID</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$maxNavID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$parentID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_sequentialcreditnotes_civicrm_pre">
sequentialcreditnotes_civicrm_pre()
<a href="namespaces/default.html#function_sequentialcreditnotes_civicrm_pre" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/sequentialcreditnotes/sequentialcreditnotes.php"><a href="files/ext-sequentialcreditnotes-sequentialcreditnotes.html"><abbr title="ext/sequentialcreditnotes/sequentialcreditnotes.php">sequentialcreditnotes.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">20</span>
</aside>
<p class="phpdocumentor-summary">Add a creditnote_id if appropriate.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">sequentialcreditnotes_civicrm_pre</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-DAO.html"><abbr title="\CRM_Core_DAO">CRM_Core_DAO</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$op</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$objectName</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int|null </span><span class="phpdocumentor-signature__argument__name">$id</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>If the contribution is created with cancelled or refunded status, add credit note id
do the same for chargeback</p>
<ul>
<li>creditnotes for chargebacks entered the code 'accidentally' but since it did we maintain it.</li>
</ul>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$op</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-DAO.html"><abbr title="\CRM_Core_DAO">CRM_Core_DAO</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$objectName</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$id</span>
: <span class="phpdocumentor-signature__argument__return-type">int|null</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_sequentialcreditnotes_civicrm_pre#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_sequentialcreditnotes_create_credit_note_id">
sequentialcreditnotes_create_credit_note_id()
<a href="namespaces/default.html#function_sequentialcreditnotes_create_credit_note_id" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/sequentialcreditnotes/sequentialcreditnotes.php"><a href="files/ext-sequentialcreditnotes-sequentialcreditnotes.html"><abbr title="ext/sequentialcreditnotes/sequentialcreditnotes.php">sequentialcreditnotes.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">45</span>
</aside>
<p class="phpdocumentor-summary">Generate credit note id with next available number</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">sequentialcreditnotes_create_credit_note_id</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_sequentialcreditnotes_create_credit_note_id#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
—
<section class="phpdocumentor-description"><p>Credit Note Id.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_cv">
cv()
<a href="namespaces/default.html#function_cv" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/sequentialcreditnotes/tests/phpunit/bootstrap.php"><a href="files/ext-sequentialcreditnotes-tests-phpunit-bootstrap.html"><abbr title="ext/sequentialcreditnotes/tests/phpunit/bootstrap.php">bootstrap.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">27</span>
</aside>
<p class="phpdocumentor-summary">Call the "cv" command.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">cv</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$cmd</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$decode</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">'json'</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$cmd</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The rest of the command to send.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$decode</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">'json'</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Ex: 'json' or 'phpcode'.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_cv#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\RuntimeException">RuntimeException</abbr></span>
<section class="phpdocumentor-description"><p>If the command terminates abnormally.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
—
<section class="phpdocumentor-description"><p>Response output (if the command executed normally).</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__standaloneusers_civix_class_loader">
_standaloneusers_civix_class_loader()
<a href="namespaces/default.html#function__standaloneusers_civix_class_loader" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/standaloneusers/standaloneusers.civix.php"><a href="files/ext-standaloneusers-standaloneusers-civix.html"><abbr title="ext/standaloneusers/standaloneusers.civix.php">standaloneusers.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">94</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_standaloneusers_civix_class_loader</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$class</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$class</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__standaloneusers_civix_civicrm_config">
_standaloneusers_civix_civicrm_config()
<a href="namespaces/default.html#function__standaloneusers_civix_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/standaloneusers/standaloneusers.civix.php"><a href="files/ext-standaloneusers-standaloneusers-civix.html"><abbr title="ext/standaloneusers/standaloneusers.civix.php">standaloneusers.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">122</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_standaloneusers_civix_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$config</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__standaloneusers_civix_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__standaloneusers_civix_civicrm_install">
_standaloneusers_civix_civicrm_install()
<a href="namespaces/default.html#function__standaloneusers_civix_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/standaloneusers/standaloneusers.civix.php"><a href="files/ext-standaloneusers-standaloneusers-civix.html"><abbr title="ext/standaloneusers/standaloneusers.civix.php">standaloneusers.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">140</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_standaloneusers_civix_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__standaloneusers_civix_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__standaloneusers_civix_civicrm_enable">
_standaloneusers_civix_civicrm_enable()
<a href="namespaces/default.html#function__standaloneusers_civix_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/standaloneusers/standaloneusers.civix.php"><a href="files/ext-standaloneusers-standaloneusers-civix.html"><abbr title="ext/standaloneusers/standaloneusers.civix.php">standaloneusers.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">150</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_standaloneusers_civix_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__standaloneusers_civix_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__standaloneusers_civix_insert_navigation_menu">
_standaloneusers_civix_insert_navigation_menu()
<a href="namespaces/default.html#function__standaloneusers_civix_insert_navigation_menu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/standaloneusers/standaloneusers.civix.php"><a href="files/ext-standaloneusers-standaloneusers-civix.html"><abbr title="ext/standaloneusers/standaloneusers.civix.php">standaloneusers.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">166</span>
</aside>
<p class="phpdocumentor-summary">Inserts a navigation menu item at a given place in the hierarchy.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_standaloneusers_civix_insert_navigation_menu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$menu</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$path</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$item</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$menu</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>menu hierarchy</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$path</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>path to parent of this item, e.g. 'my_extension/submenu'
'Mailing', or 'Administer/System Settings'</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$item</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>the item to insert (parent/child attributes will be
filled for you)</li>
</ul>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__standaloneusers_civix_navigationMenu">
_standaloneusers_civix_navigationMenu()
<a href="namespaces/default.html#function__standaloneusers_civix_navigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/standaloneusers/standaloneusers.civix.php"><a href="files/ext-standaloneusers-standaloneusers-civix.html"><abbr title="ext/standaloneusers/standaloneusers.civix.php">standaloneusers.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">197</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_navigationMenu().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_standaloneusers_civix_navigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__standaloneusers_civix_fixNavigationMenu">
_standaloneusers_civix_fixNavigationMenu()
<a href="namespaces/default.html#function__standaloneusers_civix_fixNavigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/standaloneusers/standaloneusers.civix.php"><a href="files/ext-standaloneusers-standaloneusers-civix.html"><abbr title="ext/standaloneusers/standaloneusers.civix.php">standaloneusers.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">207</span>
</aside>
<p class="phpdocumentor-summary">Given a navigation menu, generate navIDs for any items which are
missing them.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_standaloneusers_civix_fixNavigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__standaloneusers_civix_fixNavigationMenuItems">
_standaloneusers_civix_fixNavigationMenuItems()
<a href="namespaces/default.html#function__standaloneusers_civix_fixNavigationMenuItems" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/standaloneusers/standaloneusers.civix.php"><a href="files/ext-standaloneusers-standaloneusers-civix.html"><abbr title="ext/standaloneusers/standaloneusers.civix.php">standaloneusers.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">217</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_standaloneusers_civix_fixNavigationMenuItems</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$maxNavID</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$parentID</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$maxNavID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$parentID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_standaloneusers_civicrm_alterBundle">
standaloneusers_civicrm_alterBundle()
<a href="namespaces/default.html#function_standaloneusers_civicrm_alterBundle" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/standaloneusers/standaloneusers.php"><a href="files/ext-standaloneusers-standaloneusers.html"><abbr title="ext/standaloneusers/standaloneusers.php">standaloneusers.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">11</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">standaloneusers_civicrm_alterBundle</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-Resources-Bundle.html"><abbr title="\CRM_Core_Resources_Bundle">CRM_Core_Resources_Bundle</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$bundle</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$bundle</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-Resources-Bundle.html"><abbr title="\CRM_Core_Resources_Bundle">CRM_Core_Resources_Bundle</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_standaloneusers_civicrm_buildForm">
standaloneusers_civicrm_buildForm()
<a href="namespaces/default.html#function_standaloneusers_civicrm_buildForm" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/standaloneusers/standaloneusers.php"><a href="files/ext-standaloneusers-standaloneusers.html"><abbr title="ext/standaloneusers/standaloneusers.php">standaloneusers.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">27</span>
</aside>
<p class="phpdocumentor-summary">Hide the inherit CMS language on the Settings - Localization form.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">standaloneusers_civicrm_buildForm</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$formName</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-Form.html"><abbr title="\CRM_Core_Form">CRM_Core_Form</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$form</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>Implements hook_civicrm_buildForm().</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$formName</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$form</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Core-Form.html"><abbr title="\CRM_Core_Form">CRM_Core_Form</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_standaloneusers_civicrm_buildForm#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_buildForm/"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_buildForm/ </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_standaloneusers_civicrm_config">
standaloneusers_civicrm_config()
<a href="namespaces/default.html#function_standaloneusers_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/standaloneusers/standaloneusers.php"><a href="files/ext-standaloneusers-standaloneusers.html"><abbr title="ext/standaloneusers/standaloneusers.php">standaloneusers.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">41</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">standaloneusers_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$config</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_standaloneusers_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/ </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_standaloneusers_civicrm_install">
standaloneusers_civicrm_install()
<a href="namespaces/default.html#function_standaloneusers_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/standaloneusers/standaloneusers.php"><a href="files/ext-standaloneusers-standaloneusers.html"><abbr title="ext/standaloneusers/standaloneusers.php">standaloneusers.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">59</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">standaloneusers_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_standaloneusers_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_standaloneusers_civicrm_enable">
standaloneusers_civicrm_enable()
<a href="namespaces/default.html#function_standaloneusers_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/standaloneusers/standaloneusers.php"><a href="files/ext-standaloneusers-standaloneusers.html"><abbr title="ext/standaloneusers/standaloneusers.php">standaloneusers.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">68</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">standaloneusers_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_standaloneusers_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_standaloneusers_civicrm_permission">
standaloneusers_civicrm_permission()
<a href="namespaces/default.html#function_standaloneusers_civicrm_permission" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/standaloneusers/standaloneusers.php"><a href="files/ext-standaloneusers-standaloneusers.html"><abbr title="ext/standaloneusers/standaloneusers.php">standaloneusers.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">75</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_permission().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">standaloneusers_civicrm_permission</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$permissions</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$permissions</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_standaloneusers_civicrm_navigationMenu">
standaloneusers_civicrm_navigationMenu()
<a href="namespaces/default.html#function_standaloneusers_civicrm_navigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/standaloneusers/standaloneusers.php"><a href="files/ext-standaloneusers-standaloneusers.html"><abbr title="ext/standaloneusers/standaloneusers.php">standaloneusers.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">89</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">standaloneusers_civicrm_navigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$menu</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$menu</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_cv">
cv()
<a href="namespaces/default.html#function_cv" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/standaloneusers/tests/phpunit/bootstrap.php"><a href="files/ext-standaloneusers-tests-phpunit-bootstrap.html"><abbr title="ext/standaloneusers/tests/phpunit/bootstrap.php">bootstrap.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">30</span>
</aside>
<p class="phpdocumentor-summary">Call the "cv" command.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">cv</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$cmd</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$decode</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">'json'</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$cmd</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The rest of the command to send.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$decode</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">'json'</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Ex: 'json' or 'phpcode'.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_cv#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\RuntimeException">RuntimeException</abbr></span>
<section class="phpdocumentor-description"><p>If the command terminates abnormally.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
—
<section class="phpdocumentor-description"><p>Response output (if the command executed normally).
For 'raw' or 'phpcode', this will be a string. For 'json', it could be any JSON value.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__tellafriend_civix_civicrm_config">
_tellafriend_civix_civicrm_config()
<a href="namespaces/default.html#function__tellafriend_civix_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/tellafriend/tellafriend.civix.php"><a href="files/ext-tellafriend-tellafriend-civix.html"><abbr title="ext/tellafriend/tellafriend.civix.php">tellafriend.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">87</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_tellafriend_civix_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$config</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__tellafriend_civix_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__tellafriend_civix_civicrm_install">
_tellafriend_civix_civicrm_install()
<a href="namespaces/default.html#function__tellafriend_civix_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/tellafriend/tellafriend.civix.php"><a href="files/ext-tellafriend-tellafriend-civix.html"><abbr title="ext/tellafriend/tellafriend.civix.php">tellafriend.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">105</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_tellafriend_civix_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__tellafriend_civix_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__tellafriend_civix_civicrm_enable">
_tellafriend_civix_civicrm_enable()
<a href="namespaces/default.html#function__tellafriend_civix_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/tellafriend/tellafriend.civix.php"><a href="files/ext-tellafriend-tellafriend-civix.html"><abbr title="ext/tellafriend/tellafriend.civix.php">tellafriend.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">115</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_tellafriend_civix_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__tellafriend_civix_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__tellafriend_civix_insert_navigation_menu">
_tellafriend_civix_insert_navigation_menu()
<a href="namespaces/default.html#function__tellafriend_civix_insert_navigation_menu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/tellafriend/tellafriend.civix.php"><a href="files/ext-tellafriend-tellafriend-civix.html"><abbr title="ext/tellafriend/tellafriend.civix.php">tellafriend.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">131</span>
</aside>
<p class="phpdocumentor-summary">Inserts a navigation menu item at a given place in the hierarchy.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_tellafriend_civix_insert_navigation_menu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$menu</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$path</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$item</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$menu</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>menu hierarchy</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$path</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>path to parent of this item, e.g. 'my_extension/submenu'
'Mailing', or 'Administer/System Settings'</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$item</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>the item to insert (parent/child attributes will be
filled for you)</li>
</ul>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__tellafriend_civix_navigationMenu">
_tellafriend_civix_navigationMenu()
<a href="namespaces/default.html#function__tellafriend_civix_navigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/tellafriend/tellafriend.civix.php"><a href="files/ext-tellafriend-tellafriend-civix.html"><abbr title="ext/tellafriend/tellafriend.civix.php">tellafriend.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">162</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_navigationMenu().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_tellafriend_civix_navigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__tellafriend_civix_fixNavigationMenu">
_tellafriend_civix_fixNavigationMenu()
<a href="namespaces/default.html#function__tellafriend_civix_fixNavigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/tellafriend/tellafriend.civix.php"><a href="files/ext-tellafriend-tellafriend-civix.html"><abbr title="ext/tellafriend/tellafriend.civix.php">tellafriend.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">172</span>
</aside>
<p class="phpdocumentor-summary">Given a navigation menu, generate navIDs for any items which are
missing them.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_tellafriend_civix_fixNavigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__tellafriend_civix_fixNavigationMenuItems">
_tellafriend_civix_fixNavigationMenuItems()
<a href="namespaces/default.html#function__tellafriend_civix_fixNavigationMenuItems" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/tellafriend/tellafriend.civix.php"><a href="files/ext-tellafriend-tellafriend-civix.html"><abbr title="ext/tellafriend/tellafriend.civix.php">tellafriend.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">182</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_tellafriend_civix_fixNavigationMenuItems</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$maxNavID</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$parentID</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$maxNavID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$parentID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_tellafriend_civicrm_config">
tellafriend_civicrm_config()
<a href="namespaces/default.html#function_tellafriend_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/tellafriend/tellafriend.php"><a href="files/ext-tellafriend-tellafriend.html"><abbr title="ext/tellafriend/tellafriend.php">tellafriend.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">12</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">tellafriend_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$config</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_tellafriend_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/ </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_tellafriend_civicrm_install">
tellafriend_civicrm_install()
<a href="namespaces/default.html#function_tellafriend_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/tellafriend/tellafriend.php"><a href="files/ext-tellafriend-tellafriend.html"><abbr title="ext/tellafriend/tellafriend.php">tellafriend.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">21</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">tellafriend_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_tellafriend_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_tellafriend_civicrm_enable">
tellafriend_civicrm_enable()
<a href="namespaces/default.html#function_tellafriend_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/tellafriend/tellafriend.php"><a href="files/ext-tellafriend-tellafriend.html"><abbr title="ext/tellafriend/tellafriend.php">tellafriend.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">30</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">tellafriend_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_tellafriend_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_tellafriend_civicrm_tabset">
tellafriend_civicrm_tabset()
<a href="namespaces/default.html#function_tellafriend_civicrm_tabset" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/tellafriend/tellafriend.php"><a href="files/ext-tellafriend-tellafriend.html"><abbr title="ext/tellafriend/tellafriend.php">tellafriend.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">39</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_tabset().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">tellafriend_civicrm_tabset</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$tabsetName</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$tabs</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$context</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$tabsetName</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$tabs</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$context</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_tellafriend_civicrm_tabset#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_tabset"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_tabset </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_tellafriend_civicrm_check">
tellafriend_civicrm_check()
<a href="namespaces/default.html#function_tellafriend_civicrm_check" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/tellafriend/tellafriend.php"><a href="files/ext-tellafriend-tellafriend.html"><abbr title="ext/tellafriend/tellafriend.php">tellafriend.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">67</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_check().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">tellafriend_civicrm_check</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$messages</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$messages</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__user_dashboard_civix_civicrm_config">
_user_dashboard_civix_civicrm_config()
<a href="namespaces/default.html#function__user_dashboard_civix_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/user_dashboard/user_dashboard.civix.php"><a href="files/ext-user-dashboard-user-dashboard-civix.html"><abbr title="ext/user_dashboard/user_dashboard.civix.php">user_dashboard.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">87</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_user_dashboard_civix_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$config</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__user_dashboard_civix_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__user_dashboard_civix_civicrm_install">
_user_dashboard_civix_civicrm_install()
<a href="namespaces/default.html#function__user_dashboard_civix_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/user_dashboard/user_dashboard.civix.php"><a href="files/ext-user-dashboard-user-dashboard-civix.html"><abbr title="ext/user_dashboard/user_dashboard.civix.php">user_dashboard.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">105</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_user_dashboard_civix_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__user_dashboard_civix_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__user_dashboard_civix_civicrm_enable">
_user_dashboard_civix_civicrm_enable()
<a href="namespaces/default.html#function__user_dashboard_civix_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/user_dashboard/user_dashboard.civix.php"><a href="files/ext-user-dashboard-user-dashboard-civix.html"><abbr title="ext/user_dashboard/user_dashboard.civix.php">user_dashboard.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">115</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_user_dashboard_civix_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__user_dashboard_civix_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__user_dashboard_civix_insert_navigation_menu">
_user_dashboard_civix_insert_navigation_menu()
<a href="namespaces/default.html#function__user_dashboard_civix_insert_navigation_menu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/user_dashboard/user_dashboard.civix.php"><a href="files/ext-user-dashboard-user-dashboard-civix.html"><abbr title="ext/user_dashboard/user_dashboard.civix.php">user_dashboard.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">131</span>
</aside>
<p class="phpdocumentor-summary">Inserts a navigation menu item at a given place in the hierarchy.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_user_dashboard_civix_insert_navigation_menu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$menu</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$path</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$item</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$menu</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>menu hierarchy</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$path</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>path to parent of this item, e.g. 'my_extension/submenu'
'Mailing', or 'Administer/System Settings'</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$item</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>the item to insert (parent/child attributes will be
filled for you)</li>
</ul>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__user_dashboard_civix_navigationMenu">
_user_dashboard_civix_navigationMenu()
<a href="namespaces/default.html#function__user_dashboard_civix_navigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/user_dashboard/user_dashboard.civix.php"><a href="files/ext-user-dashboard-user-dashboard-civix.html"><abbr title="ext/user_dashboard/user_dashboard.civix.php">user_dashboard.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">162</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_navigationMenu().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_user_dashboard_civix_navigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__user_dashboard_civix_fixNavigationMenu">
_user_dashboard_civix_fixNavigationMenu()
<a href="namespaces/default.html#function__user_dashboard_civix_fixNavigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/user_dashboard/user_dashboard.civix.php"><a href="files/ext-user-dashboard-user-dashboard-civix.html"><abbr title="ext/user_dashboard/user_dashboard.civix.php">user_dashboard.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">172</span>
</aside>
<p class="phpdocumentor-summary">Given a navigation menu, generate navIDs for any items which are
missing them.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_user_dashboard_civix_fixNavigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__user_dashboard_civix_fixNavigationMenuItems">
_user_dashboard_civix_fixNavigationMenuItems()
<a href="namespaces/default.html#function__user_dashboard_civix_fixNavigationMenuItems" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/user_dashboard/user_dashboard.civix.php"><a href="files/ext-user-dashboard-user-dashboard-civix.html"><abbr title="ext/user_dashboard/user_dashboard.civix.php">user_dashboard.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">182</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_user_dashboard_civix_fixNavigationMenuItems</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$maxNavID</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$parentID</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$maxNavID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$parentID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_user_dashboard_civicrm_config">
user_dashboard_civicrm_config()
<a href="namespaces/default.html#function_user_dashboard_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/user_dashboard/user_dashboard.php"><a href="files/ext-user-dashboard-user-dashboard.html"><abbr title="ext/user_dashboard/user_dashboard.php">user_dashboard.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">11</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">user_dashboard_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$config</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_user_dashboard_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/ </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_user_dashboard_civicrm_install">
user_dashboard_civicrm_install()
<a href="namespaces/default.html#function_user_dashboard_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/user_dashboard/user_dashboard.php"><a href="files/ext-user-dashboard-user-dashboard.html"><abbr title="ext/user_dashboard/user_dashboard.php">user_dashboard.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">20</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">user_dashboard_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_user_dashboard_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_user_dashboard_civicrm_enable">
user_dashboard_civicrm_enable()
<a href="namespaces/default.html#function_user_dashboard_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/user_dashboard/user_dashboard.php"><a href="files/ext-user-dashboard-user-dashboard.html"><abbr title="ext/user_dashboard/user_dashboard.php">user_dashboard.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">29</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">user_dashboard_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_user_dashboard_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_user_dashboard_civicrm_post">
user_dashboard_civicrm_post()
<a href="namespaces/default.html#function_user_dashboard_civicrm_post" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="ext/user_dashboard/user_dashboard.php"><a href="files/ext-user-dashboard-user-dashboard.html"><abbr title="ext/user_dashboard/user_dashboard.php">user_dashboard.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">45</span>
</aside>
<p class="phpdocumentor-summary">Tag SavedSearches with the "UserDashboard" tag.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">user_dashboard_civicrm_post</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$action</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$entity</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$id</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$savedSearch</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>The reason for using this hook is that it's write-once (just during insert),
and after that the user can freely tag and untag searches.</p>
<p>If the tag was part of the .mgd.php file for each search then it would "stick" and
the user would not be able to remove tags without their changes reverting on every managed reconcile.
Also, adding it to the .mgd.php file requires hacking the exported api call with a 'chain', etc.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$action</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entity</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$id</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$savedSearch</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_user_dashboard_civicrm_post#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">implements</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>CRM_Utils_Hook::post()</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_ts">
ts()
<a href="namespaces/default.html#function_ts" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="functions.php"><a href="files/functions.html">functions.php</a></abbr>
:
<span class="phpdocumentor-element-found-in__line">34</span>
</aside>
<p class="phpdocumentor-summary">Short-named function for string translation, defined in global scope so it's available everywhere.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">ts</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$text</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$text</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>String for translating.
Ex: 'Hello, %1!'</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
= <span class="phpdocumentor-signature__argument__default-value">[]</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>An array of additional parameters, as per <code class="prettyprint">crm_translate()</code>.
Ex: [1 => 'Dave']</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_ts#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-I18n.html#method_crm_translate"><abbr title="\CRM_Core_I18n::crm_translate()">CRM_Core_I18n::crm_translate()</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
—
<section class="phpdocumentor-description"><p>The translated string
Ex: '¡Buenos días Dave!`</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_makeDAOs">
makeDAOs()
<a href="namespaces/default.html#function_makeDAOs" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="mixin/entity-types-php@1/example/make-dao.php"><a href="files/mixin-entity-types-php-1-example-make-dao.html"><abbr title="mixin/entity-types-php@1/example/make-dao.php">make-dao.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">32</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">makeDAOs</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$basedir</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$xmlSchemasGlob</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$basedir</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Where to find XML's and put DAO's.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$xmlSchemasGlob</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Expression to find XML's.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__corereqadapter_addMessages">
_corereqadapter_addMessages()
<a href="namespaces/default.html#function__corereqadapter_addMessages" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="setup/plugins/checkRequirements/CoreRequirementsAdapter.civi-setup.php"><a href="files/setup-plugins-checkrequirements-corerequirementsadapter-civi-setup.html"><abbr title="setup/plugins/checkRequirements/CoreRequirementsAdapter.civi-setup.php">CoreRequirementsAdapter.civi-setup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">45</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_corereqadapter_addMessages</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/Civi-Setup-Event-CheckRequirementsEvent.html"><abbr title="\Civi\Setup\Event\CheckRequirementsEvent">CheckRequirementsEvent</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$e</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$section</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$msgs</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$e</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/Civi-Setup-Event-CheckRequirementsEvent.html"><abbr title="\Civi\Setup\Event\CheckRequirementsEvent">CheckRequirementsEvent</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Symbolic machine name for this group of messages.
Ex: 'database' or 'system'.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$section</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$msgs</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>A list of messages in the format used by \Civi\Install\Requirements</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__backdrop_civisetup_getPublicFiles">
_backdrop_civisetup_getPublicFiles()
<a href="namespaces/default.html#function__backdrop_civisetup_getPublicFiles" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="setup/plugins/init/Backdrop.civi-setup.php"><a href="files/setup-plugins-init-backdrop-civi-setup.html"><abbr title="setup/plugins/init/Backdrop.civi-setup.php">Backdrop.civi-setup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">72</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_backdrop_civisetup_getPublicFiles</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__backdrop_civisetup_getPrivateFiles">
_backdrop_civisetup_getPrivateFiles()
<a href="namespaces/default.html#function__backdrop_civisetup_getPrivateFiles" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="setup/plugins/init/Backdrop.civi-setup.php"><a href="files/setup-plugins-init-backdrop-civi-setup.html"><abbr title="setup/plugins/init/Backdrop.civi-setup.php">Backdrop.civi-setup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">88</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_backdrop_civisetup_getPrivateFiles</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__drupal_civisetup_getPublicFiles">
_drupal_civisetup_getPublicFiles()
<a href="namespaces/default.html#function__drupal_civisetup_getPublicFiles" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="setup/plugins/init/Drupal.civi-setup.php"><a href="files/setup-plugins-init-drupal-civi-setup.html"><abbr title="setup/plugins/init/Drupal.civi-setup.php">Drupal.civi-setup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">70</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_drupal_civisetup_getPublicFiles</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__drupal_civisetup_getPrivateFiles">
_drupal_civisetup_getPrivateFiles()
<a href="namespaces/default.html#function__drupal_civisetup_getPrivateFiles" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="setup/plugins/init/Drupal.civi-setup.php"><a href="files/setup-plugins-init-drupal-civi-setup.html"><abbr title="setup/plugins/init/Drupal.civi-setup.php">Drupal.civi-setup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">82</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_drupal_civisetup_getPrivateFiles</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__drupal8_civisetup_getPublicFiles">
_drupal8_civisetup_getPublicFiles()
<a href="namespaces/default.html#function__drupal8_civisetup_getPublicFiles" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="setup/plugins/init/Drupal8.civi-setup.php"><a href="files/setup-plugins-init-drupal8-civi-setup.html"><abbr title="setup/plugins/init/Drupal8.civi-setup.php">Drupal8.civi-setup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">72</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_drupal8_civisetup_getPublicFiles</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__drupal8_civisetup_getPrivateFiles">
_drupal8_civisetup_getPrivateFiles()
<a href="namespaces/default.html#function__drupal8_civisetup_getPrivateFiles" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="setup/plugins/init/Drupal8.civi-setup.php"><a href="files/setup-plugins-init-drupal8-civi-setup.html"><abbr title="setup/plugins/init/Drupal8.civi-setup.php">Drupal8.civi-setup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">85</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_drupal8_civisetup_getPrivateFiles</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__standalone_setup_scheme">
_standalone_setup_scheme()
<a href="namespaces/default.html#function__standalone_setup_scheme" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="setup/plugins/init/Standalone.civi-setup.php"><a href="files/setup-plugins-init-standalone-civi-setup.html"><abbr title="setup/plugins/init/Standalone.civi-setup.php">Standalone.civi-setup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">12</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_standalone_setup_scheme</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_wordpress_plugin_file">
_civicrm_wordpress_plugin_file()
<a href="namespaces/default.html#function__civicrm_wordpress_plugin_file" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="setup/plugins/init/WordPress.civi-setup.php"><a href="files/setup-plugins-init-wordpress-civi-setup.html"><abbr title="setup/plugins/init/WordPress.civi-setup.php">WordPress.civi-setup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">92</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_wordpress_plugin_file</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_install_set_backdrop_perms">
civicrm_install_set_backdrop_perms()
<a href="namespaces/default.html#function_civicrm_install_set_backdrop_perms" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="setup/plugins/installDatabase/FlushBackdrop.civi-setup.php"><a href="files/setup-plugins-installdatabase-flushbackdrop-civi-setup.html"><abbr title="setup/plugins/installDatabase/FlushBackdrop.civi-setup.php">FlushBackdrop.civi-setup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">32</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_install_set_backdrop_perms</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_install_set_drupal_perms">
civicrm_install_set_drupal_perms()
<a href="namespaces/default.html#function_civicrm_install_set_drupal_perms" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="setup/plugins/installDatabase/FlushDrupal.civi-setup.php"><a href="files/setup-plugins-installdatabase-flushdrupal-civi-setup.html"><abbr title="setup/plugins/installDatabase/FlushDrupal.civi-setup.php">FlushDrupal.civi-setup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">33</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_install_set_drupal_perms</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_install_set_drupal8_perms">
civicrm_install_set_drupal8_perms()
<a href="namespaces/default.html#function_civicrm_install_set_drupal8_perms" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="setup/plugins/installDatabase/FlushDrupal8.civi-setup.php"><a href="files/setup-plugins-installdatabase-flushdrupal8-civi-setup.html"><abbr title="setup/plugins/installDatabase/FlushDrupal8.civi-setup.php">FlushDrupal8.civi-setup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">26</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_install_set_drupal8_perms</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_generateRandomDate">
generateRandomDate()
<a href="namespaces/default.html#function_generateRandomDate" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="sql/GenerateMailing.php"><a href="files/sql-generatemailing.html"><abbr title="sql/GenerateMailing.php">GenerateMailing.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">81</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">generateRandomDate</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_user_access">
user_access()
<a href="namespaces/default.html#function_user_access" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="sql/GenerateReportData.php"><a href="files/sql-generatereportdata.html"><abbr title="sql/GenerateReportData.php">GenerateReportData.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1695</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">user_access</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">null </span><span class="phpdocumentor-signature__argument__name">$str</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$str</span>
: <span class="phpdocumentor-signature__argument__return-type">null</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_module_list">
module_list()
<a href="namespaces/default.html#function_module_list" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="sql/GenerateReportData.php"><a href="files/sql-generatereportdata.html"><abbr title="sql/GenerateReportData.php">GenerateReportData.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">1702</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">module_list</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__shimmy_civix_mixin_polyfill">
_shimmy_civix_mixin_polyfill()
<a href="namespaces/default.html#function__shimmy_civix_mixin_polyfill" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tests/extensions/shimmy/shimmy.civix.php"><a href="files/tests-extensions-shimmy-shimmy-civix.html"><abbr title="tests/extensions/shimmy/shimmy.civix.php">shimmy.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">82</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_shimmy_civix_mixin_polyfill</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__shimmy_civix_civicrm_config">
_shimmy_civix_civicrm_config()
<a href="namespaces/default.html#function__shimmy_civix_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tests/extensions/shimmy/shimmy.civix.php"><a href="files/tests-extensions-shimmy-shimmy-civix.html"><abbr title="tests/extensions/shimmy/shimmy.civix.php">shimmy.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">94</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_shimmy_civix_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$config</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__shimmy_civix_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__shimmy_civix_civicrm_install">
_shimmy_civix_civicrm_install()
<a href="namespaces/default.html#function__shimmy_civix_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tests/extensions/shimmy/shimmy.civix.php"><a href="files/tests-extensions-shimmy-shimmy-civix.html"><abbr title="tests/extensions/shimmy/shimmy.civix.php">shimmy.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">113</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_shimmy_civix_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__shimmy_civix_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__shimmy_civix_civicrm_postInstall">
_shimmy_civix_civicrm_postInstall()
<a href="namespaces/default.html#function__shimmy_civix_civicrm_postInstall" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tests/extensions/shimmy/shimmy.civix.php"><a href="files/tests-extensions-shimmy-shimmy-civix.html"><abbr title="tests/extensions/shimmy/shimmy.civix.php">shimmy.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">126</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_postInstall().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_shimmy_civix_civicrm_postInstall</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__shimmy_civix_civicrm_postInstall#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_postInstall"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_postInstall </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__shimmy_civix_civicrm_uninstall">
_shimmy_civix_civicrm_uninstall()
<a href="namespaces/default.html#function__shimmy_civix_civicrm_uninstall" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tests/extensions/shimmy/shimmy.civix.php"><a href="files/tests-extensions-shimmy-shimmy-civix.html"><abbr title="tests/extensions/shimmy/shimmy.civix.php">shimmy.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">140</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_uninstall().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_shimmy_civix_civicrm_uninstall</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__shimmy_civix_civicrm_uninstall#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_uninstall"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_uninstall </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__shimmy_civix_civicrm_enable">
_shimmy_civix_civicrm_enable()
<a href="namespaces/default.html#function__shimmy_civix_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tests/extensions/shimmy/shimmy.civix.php"><a href="files/tests-extensions-shimmy-shimmy-civix.html"><abbr title="tests/extensions/shimmy/shimmy.civix.php">shimmy.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">152</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_shimmy_civix_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__shimmy_civix_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__shimmy_civix_civicrm_disable">
_shimmy_civix_civicrm_disable()
<a href="namespaces/default.html#function__shimmy_civix_civicrm_disable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tests/extensions/shimmy/shimmy.civix.php"><a href="files/tests-extensions-shimmy-shimmy-civix.html"><abbr title="tests/extensions/shimmy/shimmy.civix.php">shimmy.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">168</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_disable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_shimmy_civix_civicrm_disable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__shimmy_civix_civicrm_disable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_disable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_disable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__shimmy_civix_civicrm_upgrade">
_shimmy_civix_civicrm_upgrade()
<a href="namespaces/default.html#function__shimmy_civix_civicrm_upgrade" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tests/extensions/shimmy/shimmy.civix.php"><a href="files/tests-extensions-shimmy-shimmy-civix.html"><abbr title="tests/extensions/shimmy/shimmy.civix.php">shimmy.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">189</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_upgrade().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_shimmy_civix_civicrm_upgrade</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$op</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$queue</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$op</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>string, the type of operation being performed; 'check' or 'enqueue'</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$queue</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>CRM_Queue_Queue, (for 'enqueue') the modifiable list of pending up upgrade tasks</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__shimmy_civix_civicrm_upgrade#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_upgrade"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_upgrade </a>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
—
<section class="phpdocumentor-description"><p>based on op. for 'check', returns array(boolean) (TRUE if upgrades are pending)
for 'enqueue', returns void</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__shimmy_civix_upgrader">
_shimmy_civix_upgrader()
<a href="namespaces/default.html#function__shimmy_civix_upgrader" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tests/extensions/shimmy/shimmy.civix.php"><a href="files/tests-extensions-shimmy-shimmy-civix.html"><abbr title="tests/extensions/shimmy/shimmy.civix.php">shimmy.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">198</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_shimmy_civix_upgrader</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><abbr title="\CRM_Shimmy_Upgrader">CRM_Shimmy_Upgrader</abbr></span></code>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><abbr title="\CRM_Shimmy_Upgrader">CRM_Shimmy_Upgrader</abbr></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__shimmy_civix_insert_navigation_menu">
_shimmy_civix_insert_navigation_menu()
<a href="namespaces/default.html#function__shimmy_civix_insert_navigation_menu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tests/extensions/shimmy/shimmy.civix.php"><a href="files/tests-extensions-shimmy-shimmy-civix.html"><abbr title="tests/extensions/shimmy/shimmy.civix.php">shimmy.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">218</span>
</aside>
<p class="phpdocumentor-summary">Inserts a navigation menu item at a given place in the hierarchy.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_shimmy_civix_insert_navigation_menu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$menu</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$path</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$item</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$menu</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>menu hierarchy</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$path</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>path to parent of this item, e.g. 'my_extension/submenu'
'Mailing', or 'Administer/System Settings'</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$item</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>the item to insert (parent/child attributes will be
filled for you)</li>
</ul>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__shimmy_civix_navigationMenu">
_shimmy_civix_navigationMenu()
<a href="namespaces/default.html#function__shimmy_civix_navigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tests/extensions/shimmy/shimmy.civix.php"><a href="files/tests-extensions-shimmy-shimmy-civix.html"><abbr title="tests/extensions/shimmy/shimmy.civix.php">shimmy.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">249</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_navigationMenu().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_shimmy_civix_navigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__shimmy_civix_fixNavigationMenu">
_shimmy_civix_fixNavigationMenu()
<a href="namespaces/default.html#function__shimmy_civix_fixNavigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tests/extensions/shimmy/shimmy.civix.php"><a href="files/tests-extensions-shimmy-shimmy-civix.html"><abbr title="tests/extensions/shimmy/shimmy.civix.php">shimmy.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">259</span>
</aside>
<p class="phpdocumentor-summary">Given a navigation menu, generate navIDs for any items which are
missing them.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_shimmy_civix_fixNavigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__shimmy_civix_fixNavigationMenuItems">
_shimmy_civix_fixNavigationMenuItems()
<a href="namespaces/default.html#function__shimmy_civix_fixNavigationMenuItems" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tests/extensions/shimmy/shimmy.civix.php"><a href="files/tests-extensions-shimmy-shimmy-civix.html"><abbr title="tests/extensions/shimmy/shimmy.civix.php">shimmy.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">269</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_shimmy_civix_fixNavigationMenuItems</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$maxNavID</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$parentID</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$maxNavID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$parentID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__shimmy_civix_civicrm_entityTypes">
_shimmy_civix_civicrm_entityTypes()
<a href="namespaces/default.html#function__shimmy_civix_civicrm_entityTypes" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tests/extensions/shimmy/shimmy.civix.php"><a href="files/tests-extensions-shimmy-shimmy-civix.html"><abbr title="tests/extensions/shimmy/shimmy.civix.php">shimmy.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">296</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_entityTypes().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_shimmy_civix_civicrm_entityTypes</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$entityTypes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>Find any *.entityType.php files, merge their content, and return.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entityTypes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__shimmy_civix_civicrm_entityTypes#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_entityTypes"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_entityTypes </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_shimmy_civicrm_config">
shimmy_civicrm_config()
<a href="namespaces/default.html#function_shimmy_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tests/extensions/shimmy/shimmy.php"><a href="files/tests-extensions-shimmy-shimmy.html"><abbr title="tests/extensions/shimmy/shimmy.php">shimmy.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">13</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">shimmy_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$config</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_shimmy_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/ </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_shimmy_civicrm_install">
shimmy_civicrm_install()
<a href="namespaces/default.html#function_shimmy_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tests/extensions/shimmy/shimmy.php"><a href="files/tests-extensions-shimmy-shimmy.html"><abbr title="tests/extensions/shimmy/shimmy.php">shimmy.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">22</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">shimmy_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_shimmy_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_shimmy_civicrm_postInstall">
shimmy_civicrm_postInstall()
<a href="namespaces/default.html#function_shimmy_civicrm_postInstall" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tests/extensions/shimmy/shimmy.php"><a href="files/tests-extensions-shimmy-shimmy.html"><abbr title="tests/extensions/shimmy/shimmy.php">shimmy.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">31</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_postInstall().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">shimmy_civicrm_postInstall</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_shimmy_civicrm_postInstall#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_postInstall"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_postInstall </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_shimmy_civicrm_uninstall">
shimmy_civicrm_uninstall()
<a href="namespaces/default.html#function_shimmy_civicrm_uninstall" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tests/extensions/shimmy/shimmy.php"><a href="files/tests-extensions-shimmy-shimmy.html"><abbr title="tests/extensions/shimmy/shimmy.php">shimmy.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">40</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_uninstall().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">shimmy_civicrm_uninstall</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_shimmy_civicrm_uninstall#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_uninstall"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_uninstall </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_shimmy_civicrm_enable">
shimmy_civicrm_enable()
<a href="namespaces/default.html#function_shimmy_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tests/extensions/shimmy/shimmy.php"><a href="files/tests-extensions-shimmy-shimmy.html"><abbr title="tests/extensions/shimmy/shimmy.php">shimmy.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">49</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">shimmy_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_shimmy_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_shimmy_civicrm_disable">
shimmy_civicrm_disable()
<a href="namespaces/default.html#function_shimmy_civicrm_disable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tests/extensions/shimmy/shimmy.php"><a href="files/tests-extensions-shimmy-shimmy.html"><abbr title="tests/extensions/shimmy/shimmy.php">shimmy.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">58</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_disable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">shimmy_civicrm_disable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_shimmy_civicrm_disable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_disable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_disable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_shimmy_civicrm_upgrade">
shimmy_civicrm_upgrade()
<a href="namespaces/default.html#function_shimmy_civicrm_upgrade" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tests/extensions/shimmy/shimmy.php"><a href="files/tests-extensions-shimmy-shimmy.html"><abbr title="tests/extensions/shimmy/shimmy.php">shimmy.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">67</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_upgrade().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">shimmy_civicrm_upgrade</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$op</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Queue-Queue.html"><abbr title="\CRM_Queue_Queue">CRM_Queue_Queue</abbr></a>|null </span><span class="phpdocumentor-signature__argument__name">$queue</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$op</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$queue</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/CRM-Queue-Queue.html"><abbr title="\CRM_Queue_Queue">CRM_Queue_Queue</abbr></a>|null</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_shimmy_civicrm_upgrade#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_upgrade"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_upgrade </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_shimmy_civicrm_entityTypes">
shimmy_civicrm_entityTypes()
<a href="namespaces/default.html#function_shimmy_civicrm_entityTypes" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tests/extensions/shimmy/shimmy.php"><a href="files/tests-extensions-shimmy-shimmy.html"><abbr title="tests/extensions/shimmy/shimmy.php">shimmy.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">78</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_entityTypes().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">shimmy_civicrm_entityTypes</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$entityTypes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>Declare entity types provided by this module.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entityTypes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_shimmy_civicrm_entityTypes#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_entityTypes"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_entityTypes </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__shimmy_assert_service_object">
_shimmy_assert_service_object()
<a href="namespaces/default.html#function__shimmy_assert_service_object" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tests/extensions/shimmy/shimmy.php"><a href="files/tests-extensions-shimmy-shimmy.html"><abbr title="tests/extensions/shimmy/shimmy.php">shimmy.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">90</span>
</aside>
<p class="phpdocumentor-summary">Assert that there is a service with a given name+type.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_shimmy_assert_service_object</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$class</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$expectServiceName</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$notServiceName</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$class</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$expectServiceName</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$notServiceName</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__shimmy_assert_service_object#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\Exception">Exception</abbr></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_cv">
cv()
<a href="namespaces/default.html#function_cv" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tests/extensions/shimmy/tests/phpunit/bootstrap.php"><a href="files/tests-extensions-shimmy-tests-phpunit-bootstrap.html"><abbr title="tests/extensions/shimmy/tests/phpunit/bootstrap.php">bootstrap.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">29</span>
</aside>
<p class="phpdocumentor-summary">Call the "cv" command.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">cv</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$cmd</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$decode</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">'json'</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$cmd</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The rest of the command to send.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$decode</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">'json'</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Ex: 'json' or 'phpcode'.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_cv#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\RuntimeException">RuntimeException</abbr></span>
<section class="phpdocumentor-description"><p>If the command terminates abnormally.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
—
<section class="phpdocumentor-description"><p>Response output (if the command executed normally).
For 'raw' or 'phpcode', this will be a string. For 'json', it could be any JSON value.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_moduletest_civicrm_install">
moduletest_civicrm_install()
<a href="namespaces/default.html#function_moduletest_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tests/extensions/test.extension.manager.moduletest/moduletest.php"><a href="files/tests-extensions-test-extension-manager-moduletest-moduletest.html"><abbr title="tests/extensions/test.extension.manager.moduletest/moduletest.php">moduletest.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">6</span>
</aside>
<p class="phpdocumentor-summary">Implements civicrm_install</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">moduletest_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_moduletest_civicrm_postInstall">
moduletest_civicrm_postInstall()
<a href="namespaces/default.html#function_moduletest_civicrm_postInstall" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tests/extensions/test.extension.manager.moduletest/moduletest.php"><a href="files/tests-extensions-test-extension-manager-moduletest-moduletest.html"><abbr title="tests/extensions/test.extension.manager.moduletest/moduletest.php">moduletest.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">13</span>
</aside>
<p class="phpdocumentor-summary">Implements civicrm_postInstall</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">moduletest_civicrm_postInstall</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_moduletest_civicrm_uninstall">
moduletest_civicrm_uninstall()
<a href="namespaces/default.html#function_moduletest_civicrm_uninstall" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tests/extensions/test.extension.manager.moduletest/moduletest.php"><a href="files/tests-extensions-test-extension-manager-moduletest-moduletest.html"><abbr title="tests/extensions/test.extension.manager.moduletest/moduletest.php">moduletest.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">20</span>
</aside>
<p class="phpdocumentor-summary">Implements civicrm_uninstall</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">moduletest_civicrm_uninstall</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_moduletest_civicrm_enable">
moduletest_civicrm_enable()
<a href="namespaces/default.html#function_moduletest_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tests/extensions/test.extension.manager.moduletest/moduletest.php"><a href="files/tests-extensions-test-extension-manager-moduletest-moduletest.html"><abbr title="tests/extensions/test.extension.manager.moduletest/moduletest.php">moduletest.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">27</span>
</aside>
<p class="phpdocumentor-summary">Implements civicrm_enable</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">moduletest_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_moduletest_civicrm_disable">
moduletest_civicrm_disable()
<a href="namespaces/default.html#function_moduletest_civicrm_disable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tests/extensions/test.extension.manager.moduletest/moduletest.php"><a href="files/tests-extensions-test-extension-manager-moduletest-moduletest.html"><abbr title="tests/extensions/test.extension.manager.moduletest/moduletest.php">moduletest.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">34</span>
</aside>
<p class="phpdocumentor-summary">Implements civicrm_disable</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">moduletest_civicrm_disable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_mailing_provider_data_get">
civicrm_api3_mailing_provider_data_get()
<a href="namespaces/default.html#function_civicrm_api3_mailing_provider_data_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tests/phpunit/api/v3/custom_api/MailingProviderData.php"><a href="files/tests-phpunit-api-v3-custom-api-mailingproviderdata.html"><abbr title="tests/phpunit/api/v3/custom_api/MailingProviderData.php">MailingProviderData.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">257</span>
</aside>
<p class="phpdocumentor-summary">MailingProviderData.get API</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_mailing_provider_data_get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_mailing_provider_data_get#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result descriptor</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__civicrm_api3_mailing_provider_data_get_spec">
_civicrm_api3_mailing_provider_data_get_spec()
<a href="namespaces/default.html#function__civicrm_api3_mailing_provider_data_get_spec" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tests/phpunit/api/v3/custom_api/MailingProviderData.php"><a href="files/tests-phpunit-api-v3-custom-api-mailingproviderdata.html"><abbr title="tests/phpunit/api/v3/custom_api/MailingProviderData.php">MailingProviderData.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">270</span>
</aside>
<p class="phpdocumentor-summary">Metadata for MailingProviderData.get API</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_civicrm_api3_mailing_provider_data_get_spec</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__civicrm_api3_mailing_provider_data_get_spec#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_mailing_provider_data_create">
civicrm_api3_mailing_provider_data_create()
<a href="namespaces/default.html#function_civicrm_api3_mailing_provider_data_create" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tests/phpunit/api/v3/custom_api/MailingProviderData.php"><a href="files/tests-phpunit-api-v3-custom-api-mailingproviderdata.html"><abbr title="tests/phpunit/api/v3/custom_api/MailingProviderData.php">MailingProviderData.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">283</span>
</aside>
<p class="phpdocumentor-summary">MailingProviderData.create API</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_mailing_provider_data_create</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_civicrm_api3_mailing_provider_data_create#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/CRM-Core-Exception.html"><abbr title="\CRM_Core_Exception">CRM_Core_Exception</abbr></a></span>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>API result descriptor</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_contact_example_action2">
civicrm_api3_contact_example_action2()
<a href="namespaces/default.html#function_civicrm_api3_contact_example_action2" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tests/phpunit/api/v3/dataset/resolver/api/v3/Contact/ExampleAction2.php"><a href="files/tests-phpunit-api-v3-dataset-resolver-api-v3-contact-exampleaction2.html"><abbr title="tests/phpunit/api/v3/dataset/resolver/api/v3/Contact/ExampleAction2.php">ExampleAction2.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">8</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_contact_example_action2</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_generic_example_action1">
civicrm_api3_generic_example_action1()
<a href="namespaces/default.html#function_civicrm_api3_generic_example_action1" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tests/phpunit/api/v3/dataset/resolver/api/v3/Generic/ExampleAction1.php"><a href="files/tests-phpunit-api-v3-dataset-resolver-api-v3-generic-exampleaction1.html"><abbr title="tests/phpunit/api/v3/dataset/resolver/api/v3/Generic/ExampleAction1.php">ExampleAction1.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">8</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_generic_example_action1</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$apiRequest</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$apiRequest</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_generic_example_action2">
civicrm_api3_generic_example_action2()
<a href="namespaces/default.html#function_civicrm_api3_generic_example_action2" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tests/phpunit/api/v3/dataset/resolver/api/v3/Generic/ExampleAction2.php"><a href="files/tests-phpunit-api-v3-dataset-resolver-api-v3-generic-exampleaction2.html"><abbr title="tests/phpunit/api/v3/dataset/resolver/api/v3/Generic/ExampleAction2.php">ExampleAction2.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">10</span>
</aside>
<p class="phpdocumentor-summary">Example result for API Test.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_generic_example_action2</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$apiRequest</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$apiRequest</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civicrm_api3_test_entity_example_action3">
civicrm_api3_test_entity_example_action3()
<a href="namespaces/default.html#function_civicrm_api3_test_entity_example_action3" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tests/phpunit/api/v3/dataset/resolver/api/v3/TestEntity.php"><a href="files/tests-phpunit-api-v3-dataset-resolver-api-v3-testentity.html"><abbr title="tests/phpunit/api/v3/dataset/resolver/api/v3/TestEntity.php">TestEntity.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">10</span>
</aside>
<p class="phpdocumentor-summary">Example result for API Test.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civicrm_api3_test_entity_example_action3</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_civitest_civicrm_scanClasses">
civitest_civicrm_scanClasses()
<a href="namespaces/default.html#function_civitest_civicrm_scanClasses" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tests/phpunit/CiviTest/bootstrap.php"><a href="files/tests-phpunit-civitest-bootstrap.html"><abbr title="tests/phpunit/CiviTest/bootstrap.php">bootstrap.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">17</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">civitest_civicrm_scanClasses</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$classes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$classes</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__phpunit_mockoloader">
_phpunit_mockoloader()
<a href="namespaces/default.html#function__phpunit_mockoloader" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tests/phpunit/CiviTest/bootstrap.php"><a href="files/tests-phpunit-civitest-bootstrap.html"><abbr title="tests/phpunit/CiviTest/bootstrap.php">bootstrap.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">54</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_phpunit_mockoloader</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$prefix</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$base_dir</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$class</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$prefix</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$base_dir</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$class</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_cv">
cv()
<a href="namespaces/default.html#function_cv" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tests/phpunit/CiviTest/bootstrap.php"><a href="files/tests-phpunit-civitest-bootstrap.html"><abbr title="tests/phpunit/CiviTest/bootstrap.php">bootstrap.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">80</span>
</aside>
<p class="phpdocumentor-summary">Call the "cv" command.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">cv</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$cmd</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$decode</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">'json'</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$cmd</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The rest of the command to send.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$decode</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">'json'</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Ex: 'json' or 'phpcode'.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_cv#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\RuntimeException">RuntimeException</abbr></span>
<section class="phpdocumentor-description"><p>If the command terminates abnormally.</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
—
<section class="phpdocumentor-description"><p>Response output (if the command executed normally).</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_hooktesta_civicrm_testRunHooks_outer">
hooktesta_civicrm_testRunHooks_outer()
<a href="namespaces/default.html#function_hooktesta_civicrm_testRunHooks_outer" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tests/phpunit/CRM/Utils/HookTest.php"><a href="files/tests-phpunit-crm-utils-hooktest.html"><abbr title="tests/phpunit/CRM/Utils/HookTest.php">HookTest.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">93</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_testRunHooks_outer().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">hooktesta_civicrm_testRunHooks_outer</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_hooktestb_civicrm_testRunHooks_outer">
hooktestb_civicrm_testRunHooks_outer()
<a href="namespaces/default.html#function_hooktestb_civicrm_testRunHooks_outer" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tests/phpunit/CRM/Utils/HookTest.php"><a href="files/tests-phpunit-crm-utils-hooktest.html"><abbr title="tests/phpunit/CRM/Utils/HookTest.php">HookTest.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">98</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">hooktestb_civicrm_testRunHooks_outer</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_hooktestc_civicrm_testRunHooks_outer">
hooktestc_civicrm_testRunHooks_outer()
<a href="namespaces/default.html#function_hooktestc_civicrm_testRunHooks_outer" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tests/phpunit/CRM/Utils/HookTest.php"><a href="files/tests-phpunit-crm-utils-hooktest.html"><abbr title="tests/phpunit/CRM/Utils/HookTest.php">HookTest.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">106</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">hooktestc_civicrm_testRunHooks_outer</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_hooktesta_civicrm_testRunHooks_inner">
hooktesta_civicrm_testRunHooks_inner()
<a href="namespaces/default.html#function_hooktesta_civicrm_testRunHooks_inner" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tests/phpunit/CRM/Utils/HookTest.php"><a href="files/tests-phpunit-crm-utils-hooktest.html"><abbr title="tests/phpunit/CRM/Utils/HookTest.php">HookTest.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">111</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">hooktesta_civicrm_testRunHooks_inner</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_hooktestb_civicrm_testRunHooks_inner">
hooktestb_civicrm_testRunHooks_inner()
<a href="namespaces/default.html#function_hooktestb_civicrm_testRunHooks_inner" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tests/phpunit/CRM/Utils/HookTest.php"><a href="files/tests-phpunit-crm-utils-hooktest.html"><abbr title="tests/phpunit/CRM/Utils/HookTest.php">HookTest.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">116</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">hooktestb_civicrm_testRunHooks_inner</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_hooktesta_civicrm_testRunHooks_merge">
hooktesta_civicrm_testRunHooks_merge()
<a href="namespaces/default.html#function_hooktesta_civicrm_testRunHooks_merge" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tests/phpunit/CRM/Utils/HookTest.php"><a href="files/tests-phpunit-crm-utils-hooktest.html"><abbr title="tests/phpunit/CRM/Utils/HookTest.php">HookTest.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">124</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">hooktesta_civicrm_testRunHooks_merge</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_hooktestc_civicrm_testRunHooks_merge">
hooktestc_civicrm_testRunHooks_merge()
<a href="namespaces/default.html#function_hooktestc_civicrm_testRunHooks_merge" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tests/phpunit/CRM/Utils/HookTest.php"><a href="files/tests-phpunit-crm-utils-hooktest.html"><abbr title="tests/phpunit/CRM/Utils/HookTest.php">HookTest.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">133</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_testRunHooks_merge().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">hooktestc_civicrm_testRunHooks_merge</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_hooktestd_civicrm_testRunHooks_merge">
hooktestd_civicrm_testRunHooks_merge()
<a href="namespaces/default.html#function_hooktestd_civicrm_testRunHooks_merge" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tests/phpunit/CRM/Utils/HookTest.php"><a href="files/tests-phpunit-crm-utils-hooktest.html"><abbr title="tests/phpunit/CRM/Utils/HookTest.php">HookTest.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">140</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">hooktestd_civicrm_testRunHooks_merge</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">null</span></code>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">null</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_hookteste_civicrm_testRunHooks_merge">
hookteste_civicrm_testRunHooks_merge()
<a href="namespaces/default.html#function_hookteste_civicrm_testRunHooks_merge" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tests/phpunit/CRM/Utils/HookTest.php"><a href="files/tests-phpunit-crm-utils-hooktest.html"><abbr title="tests/phpunit/CRM/Utils/HookTest.php">HookTest.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">147</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">hookteste_civicrm_testRunHooks_merge</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_updateFile">
updateFile()
<a href="namespaces/default.html#function_updateFile" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/bin/scripts/set-version.php"><a href="files/tools-bin-scripts-set-version.html"><abbr title="tools/bin/scripts/set-version.php">set-version.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">120</span>
</aside>
<p class="phpdocumentor-summary">Update the content of a file.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">updateFile</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$file</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">callable </span><span class="phpdocumentor-signature__argument__name">$callback</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$file</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$callback</span>
: <span class="phpdocumentor-signature__argument__return-type">callable</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Function(string $originalContent) => string $newContent.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_updateXmlFile">
updateXmlFile()
<a href="namespaces/default.html#function_updateXmlFile" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/bin/scripts/set-version.php"><a href="files/tools-bin-scripts-set-version.html"><abbr title="tools/bin/scripts/set-version.php">set-version.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">137</span>
</aside>
<p class="phpdocumentor-summary">Update the content of an XML file</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">updateXmlFile</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$file</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">callable </span><span class="phpdocumentor-signature__argument__name">$callback</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$file</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$callback</span>
: <span class="phpdocumentor-signature__argument__return-type">callable</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Function(DOMDocument $dom)</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_initFile">
initFile()
<a href="namespaces/default.html#function_initFile" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/bin/scripts/set-version.php"><a href="files/tools-bin-scripts-set-version.html"><abbr title="tools/bin/scripts/set-version.php">set-version.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">154</span>
</aside>
<p class="phpdocumentor-summary">Initialize a file (if it doesn't already exist).</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">initFile</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$file</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">callable </span><span class="phpdocumentor-signature__argument__name">$callback</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$file</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$callback</span>
: <span class="phpdocumentor-signature__argument__return-type">callable</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Function() => string $newContent.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_makeVerName">
makeVerName()
<a href="namespaces/default.html#function_makeVerName" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/bin/scripts/set-version.php"><a href="files/tools-bin-scripts-set-version.html"><abbr title="tools/bin/scripts/set-version.php">set-version.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">174</span>
</aside>
<p class="phpdocumentor-summary">Render a pretty string for a major/minor version number.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">makeVerName</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$version</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$version</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Ex: '5.10.alpha1'</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
—
<section class="phpdocumentor-description"><p>Ex: 'FiveTen'.</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_isVersionValid">
isVersionValid()
<a href="namespaces/default.html#function_isVersionValid" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/bin/scripts/set-version.php"><a href="files/tools-bin-scripts-set-version.html"><abbr title="tools/bin/scripts/set-version.php">set-version.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">180</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">isVersionValid</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$v</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$v</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_fatal">
fatal()
<a href="namespaces/default.html#function_fatal" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/bin/scripts/set-version.php"><a href="files/tools-bin-scripts-set-version.html"><abbr title="tools/bin/scripts/set-version.php">set-version.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">187</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">fatal</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$error</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$error</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_parseArgs">
parseArgs()
<a href="namespaces/default.html#function_parseArgs" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/bin/scripts/set-version.php"><a href="files/tools-bin-scripts-set-version.html"><abbr title="tools/bin/scripts/set-version.php">set-version.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">207</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">parseArgs</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$argv</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$argv</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Ex: ['myscript.php', '--no-commit', '5.6.7']</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
—
<section class="phpdocumentor-description"><p>Ex: ['scriptFile' => 'myscript.php', 'doCommit' => FALSE, 'newVersion' => '5.6.7', 'releaseDate' => '2039-01-01']</p>
</section>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__event_check_civix_civicrm_config">
_event_check_civix_civicrm_config()
<a href="namespaces/default.html#function__event_check_civix_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/extensions/event_check/event_check.civix.php"><a href="files/tools-extensions-event-check-event-check-civix.html"><abbr title="tools/extensions/event_check/event_check.civix.php">event_check.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">87</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_event_check_civix_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$config</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__event_check_civix_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__event_check_civix_civicrm_install">
_event_check_civix_civicrm_install()
<a href="namespaces/default.html#function__event_check_civix_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/extensions/event_check/event_check.civix.php"><a href="files/tools-extensions-event-check-event-check-civix.html"><abbr title="tools/extensions/event_check/event_check.civix.php">event_check.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">105</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_event_check_civix_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__event_check_civix_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__event_check_civix_civicrm_enable">
_event_check_civix_civicrm_enable()
<a href="namespaces/default.html#function__event_check_civix_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/extensions/event_check/event_check.civix.php"><a href="files/tools-extensions-event-check-event-check-civix.html"><abbr title="tools/extensions/event_check/event_check.civix.php">event_check.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">115</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_event_check_civix_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__event_check_civix_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__event_check_civix_insert_navigation_menu">
_event_check_civix_insert_navigation_menu()
<a href="namespaces/default.html#function__event_check_civix_insert_navigation_menu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/extensions/event_check/event_check.civix.php"><a href="files/tools-extensions-event-check-event-check-civix.html"><abbr title="tools/extensions/event_check/event_check.civix.php">event_check.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">131</span>
</aside>
<p class="phpdocumentor-summary">Inserts a navigation menu item at a given place in the hierarchy.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_event_check_civix_insert_navigation_menu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$menu</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$path</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$item</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$menu</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>menu hierarchy</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$path</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>path to parent of this item, e.g. 'my_extension/submenu'
'Mailing', or 'Administer/System Settings'</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$item</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>the item to insert (parent/child attributes will be
filled for you)</li>
</ul>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__event_check_civix_navigationMenu">
_event_check_civix_navigationMenu()
<a href="namespaces/default.html#function__event_check_civix_navigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/extensions/event_check/event_check.civix.php"><a href="files/tools-extensions-event-check-event-check-civix.html"><abbr title="tools/extensions/event_check/event_check.civix.php">event_check.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">162</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_navigationMenu().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_event_check_civix_navigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__event_check_civix_fixNavigationMenu">
_event_check_civix_fixNavigationMenu()
<a href="namespaces/default.html#function__event_check_civix_fixNavigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/extensions/event_check/event_check.civix.php"><a href="files/tools-extensions-event-check-event-check-civix.html"><abbr title="tools/extensions/event_check/event_check.civix.php">event_check.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">172</span>
</aside>
<p class="phpdocumentor-summary">Given a navigation menu, generate navIDs for any items which are
missing them.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_event_check_civix_fixNavigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__event_check_civix_fixNavigationMenuItems">
_event_check_civix_fixNavigationMenuItems()
<a href="namespaces/default.html#function__event_check_civix_fixNavigationMenuItems" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/extensions/event_check/event_check.civix.php"><a href="files/tools-extensions-event-check-event-check-civix.html"><abbr title="tools/extensions/event_check/event_check.civix.php">event_check.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">182</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_event_check_civix_fixNavigationMenuItems</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$maxNavID</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$parentID</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$maxNavID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$parentID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_event_check_civicrm_config">
event_check_civicrm_config()
<a href="namespaces/default.html#function_event_check_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/extensions/event_check/event_check.php"><a href="files/tools-extensions-event-check-event-check.html"><abbr title="tools/extensions/event_check/event_check.php">event_check.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">11</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">event_check_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$config</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed>|null </span><span class="phpdocumentor-signature__argument__name">$flags</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$flags</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed>|null</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_event_check_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/ </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__demoqueue_civix_civicrm_config">
_demoqueue_civix_civicrm_config()
<a href="namespaces/default.html#function__demoqueue_civix_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/extensions/org.civicrm.demoqueue/demoqueue.civix.php"><a href="files/tools-extensions-org-civicrm-demoqueue-demoqueue-civix.html"><abbr title="tools/extensions/org.civicrm.demoqueue/demoqueue.civix.php">demoqueue.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">9</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implementation of hook_civicrm_config</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_demoqueue_civix_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$config</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__demoqueue_civix_civicrm_xmlMenu">
_demoqueue_civix_civicrm_xmlMenu()
<a href="namespaces/default.html#function__demoqueue_civix_civicrm_xmlMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/extensions/org.civicrm.demoqueue/demoqueue.civix.php"><a href="files/tools-extensions-org-civicrm-demoqueue-demoqueue-civix.html"><abbr title="tools/extensions/org.civicrm.demoqueue/demoqueue.civix.php">demoqueue.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">31</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implementation of hook_civicrm_xmlMenu</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_demoqueue_civix_civicrm_xmlMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$files</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$files</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>array(string)</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_demoqueue_civicrm_config">
demoqueue_civicrm_config()
<a href="namespaces/default.html#function_demoqueue_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/extensions/org.civicrm.demoqueue/demoqueue.php"><a href="files/tools-extensions-org-civicrm-demoqueue-demoqueue.html"><abbr title="tools/extensions/org.civicrm.demoqueue/demoqueue.php">demoqueue.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">9</span>
</aside>
<p class="phpdocumentor-summary">Implementation of hook_civicrm_config</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">demoqueue_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$config</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_demoqueue_civicrm_xmlMenu">
demoqueue_civicrm_xmlMenu()
<a href="namespaces/default.html#function_demoqueue_civicrm_xmlMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/extensions/org.civicrm.demoqueue/demoqueue.php"><a href="files/tools-extensions-org-civicrm-demoqueue-demoqueue.html"><abbr title="tools/extensions/org.civicrm.demoqueue/demoqueue.php">demoqueue.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">18</span>
</aside>
<p class="phpdocumentor-summary">Implementation of hook_civicrm_xmlMenu</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">demoqueue_civicrm_xmlMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$files</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$files</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>array(string)</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__phpstorm_civix_civicrm_config">
_phpstorm_civix_civicrm_config()
<a href="namespaces/default.html#function__phpstorm_civix_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/extensions/phpstorm/phpstorm.civix.php"><a href="files/tools-extensions-phpstorm-phpstorm-civix.html"><abbr title="tools/extensions/phpstorm/phpstorm.civix.php">phpstorm.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">87</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_phpstorm_civix_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$config</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__phpstorm_civix_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__phpstorm_civix_civicrm_install">
_phpstorm_civix_civicrm_install()
<a href="namespaces/default.html#function__phpstorm_civix_civicrm_install" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/extensions/phpstorm/phpstorm.civix.php"><a href="files/tools-extensions-phpstorm-phpstorm-civix.html"><abbr title="tools/extensions/phpstorm/phpstorm.civix.php">phpstorm.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">105</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_install().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_phpstorm_civix_civicrm_install</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__phpstorm_civix_civicrm_install#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__phpstorm_civix_civicrm_enable">
_phpstorm_civix_civicrm_enable()
<a href="namespaces/default.html#function__phpstorm_civix_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/extensions/phpstorm/phpstorm.civix.php"><a href="files/tools-extensions-phpstorm-phpstorm-civix.html"><abbr title="tools/extensions/phpstorm/phpstorm.civix.php">phpstorm.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">115</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_enable().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_phpstorm_civix_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function__phpstorm_civix_civicrm_enable#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__phpstorm_civix_insert_navigation_menu">
_phpstorm_civix_insert_navigation_menu()
<a href="namespaces/default.html#function__phpstorm_civix_insert_navigation_menu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/extensions/phpstorm/phpstorm.civix.php"><a href="files/tools-extensions-phpstorm-phpstorm-civix.html"><abbr title="tools/extensions/phpstorm/phpstorm.civix.php">phpstorm.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">131</span>
</aside>
<p class="phpdocumentor-summary">Inserts a navigation menu item at a given place in the hierarchy.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_phpstorm_civix_insert_navigation_menu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$menu</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$path</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$item</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$menu</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>menu hierarchy</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$path</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>path to parent of this item, e.g. 'my_extension/submenu'
'Mailing', or 'Administer/System Settings'</li>
</ul>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$item</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><ul>
<li>the item to insert (parent/child attributes will be
filled for you)</li>
</ul>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__phpstorm_civix_navigationMenu">
_phpstorm_civix_navigationMenu()
<a href="namespaces/default.html#function__phpstorm_civix_navigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/extensions/phpstorm/phpstorm.civix.php"><a href="files/tools-extensions-phpstorm-phpstorm-civix.html"><abbr title="tools/extensions/phpstorm/phpstorm.civix.php">phpstorm.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">162</span>
</aside>
<p class="phpdocumentor-summary">(Delegated) Implements hook_civicrm_navigationMenu().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_phpstorm_civix_navigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__phpstorm_civix_fixNavigationMenu">
_phpstorm_civix_fixNavigationMenu()
<a href="namespaces/default.html#function__phpstorm_civix_fixNavigationMenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/extensions/phpstorm/phpstorm.civix.php"><a href="files/tools-extensions-phpstorm-phpstorm-civix.html"><abbr title="tools/extensions/phpstorm/phpstorm.civix.php">phpstorm.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">172</span>
</aside>
<p class="phpdocumentor-summary">Given a navigation menu, generate navIDs for any items which are
missing them.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_phpstorm_civix_fixNavigationMenu</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__phpstorm_civix_fixNavigationMenuItems">
_phpstorm_civix_fixNavigationMenuItems()
<a href="namespaces/default.html#function__phpstorm_civix_fixNavigationMenuItems" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/extensions/phpstorm/phpstorm.civix.php"><a href="files/tools-extensions-phpstorm-phpstorm-civix.html"><abbr title="tools/extensions/phpstorm/phpstorm.civix.php">phpstorm.civix.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">182</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_phpstorm_civix_fixNavigationMenuItems</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$nodes</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$maxNavID</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$parentID</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$nodes</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$maxNavID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$parentID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_phpstorm_metadata_dir">
phpstorm_metadata_dir()
<a href="namespaces/default.html#function_phpstorm_metadata_dir" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/extensions/phpstorm/phpstorm.php"><a href="files/tools-extensions-phpstorm-phpstorm.html"><abbr title="tools/extensions/phpstorm/phpstorm.php">phpstorm.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">20</span>
</aside>
<p class="phpdocumentor-summary">Determine the folder where we will store PhpStorm metadata files.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">phpstorm_metadata_dir</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<section class="phpdocumentor-description"><p>Not 100% sure which is best. These options trade-off in edge-cases of writability and readability:</p>
<ul>
<li>'[civicrm.files]/.phpstorm.meta.php'</li>
<li>'[civicrm.compile]/.phpstorm.meta.php'</li>
<li>'[civicrm.root]/.phpstorm.meta.php'</li>
</ul>
</section>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__phpstorm_metadata_dirs">
_phpstorm_metadata_dirs()
<a href="namespaces/default.html#function__phpstorm_metadata_dirs" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/extensions/phpstorm/phpstorm.php"><a href="files/tools-extensions-phpstorm-phpstorm.html"><abbr title="tools/extensions/phpstorm/phpstorm.php">phpstorm.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">34</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_phpstorm_metadata_dirs</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_phpstorm_civicrm_config">
phpstorm_civicrm_config()
<a href="namespaces/default.html#function_phpstorm_civicrm_config" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/extensions/phpstorm/phpstorm.php"><a href="files/tools-extensions-phpstorm-phpstorm.html"><abbr title="tools/extensions/phpstorm/phpstorm.php">phpstorm.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">49</span>
</aside>
<p class="phpdocumentor-summary">Implements hook_civicrm_config().</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">phpstorm_civicrm_config</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$config</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$config</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="namespaces/default.html#function_phpstorm_civicrm_config#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/"> https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/ </a>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_phpstorm_civicrm_container">
phpstorm_civicrm_container()
<a href="namespaces/default.html#function_phpstorm_civicrm_container" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/extensions/phpstorm/phpstorm.php"><a href="files/tools-extensions-phpstorm-phpstorm.html"><abbr title="tools/extensions/phpstorm/phpstorm.php">phpstorm.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">53</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">phpstorm_civicrm_container</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><abbr title="\Symfony\Component\DependencyInjection\ContainerBuilder">ContainerBuilder</abbr> </span><span class="phpdocumentor-signature__argument__name">$container</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$container</span>
: <span class="phpdocumentor-signature__argument__return-type"><abbr title="\Symfony\Component\DependencyInjection\ContainerBuilder">ContainerBuilder</abbr></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_phpstorm_civicrm_managed">
phpstorm_civicrm_managed()
<a href="namespaces/default.html#function_phpstorm_civicrm_managed" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/extensions/phpstorm/phpstorm.php"><a href="files/tools-extensions-phpstorm-phpstorm.html"><abbr title="tools/extensions/phpstorm/phpstorm.php">phpstorm.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">57</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">phpstorm_civicrm_managed</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$entities</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$modules</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$entities</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$modules</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_phpstorm_civicrm_enable">
phpstorm_civicrm_enable()
<a href="namespaces/default.html#function_phpstorm_civicrm_enable" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/extensions/phpstorm/phpstorm.php"><a href="files/tools-extensions-phpstorm-phpstorm.html"><abbr title="tools/extensions/phpstorm/phpstorm.php">phpstorm.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">66</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">phpstorm_civicrm_enable</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_phpstorm_civicrm_uninstall">
phpstorm_civicrm_uninstall()
<a href="namespaces/default.html#function_phpstorm_civicrm_uninstall" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/extensions/phpstorm/phpstorm.php"><a href="files/tools-extensions-phpstorm-phpstorm.html"><abbr title="tools/extensions/phpstorm/phpstorm.php">phpstorm.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">71</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">phpstorm_civicrm_uninstall</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function__phpstorm_cleanup">
_phpstorm_cleanup()
<a href="namespaces/default.html#function__phpstorm_cleanup" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/extensions/phpstorm/phpstorm.php"><a href="files/tools-extensions-phpstorm-phpstorm.html"><abbr title="tools/extensions/phpstorm/phpstorm.php">phpstorm.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">75</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">_phpstorm_cleanup</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_compareFile">
compareFile()
<a href="namespaces/default.html#function_compareFile" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/scripts/check-angular.php"><a href="files/tools-scripts-check-angular.html"><abbr title="tools/scripts/check-angular.php">check-angular.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">38</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">compareFile</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$file</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$diffCmd</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$file</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$diffCmd</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_parseLog">
parseLog()
<a href="namespaces/default.html#function_parseLog" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/scripts/generate-deleted-files-list.php"><a href="files/tools-scripts-generate-deleted-files-list.html"><abbr title="tools/scripts/generate-deleted-files-list.php">generate-deleted-files-list.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">16</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">parseLog</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$logString</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$deletedFiles</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$prefix</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">''</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$logString</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$deletedFiles</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$prefix</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">''</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_splitContactIDs">
splitContactIDs()
<a href="namespaces/default.html#function_splitContactIDs" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/scripts/solr/createSolrJSON.php"><a href="files/tools-scripts-solr-createsolrjson.html"><abbr title="tools/scripts/solr/createSolrJSON.php">createSolrJSON.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">27</span>
</aside>
<p class="phpdocumentor-summary">Split a large array of contactIDs into more manageable smaller chunks</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__reference-operator">&</span> <span class="phpdocumentor-signature__name">splitContactIDs</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$contactIDs</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$contactIDs</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_generateSolrJSON">
generateSolrJSON()
<a href="namespaces/default.html#function_generateSolrJSON" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/scripts/solr/createSolrJSON.php"><a href="files/tools-scripts-solr-createsolrjson.html"><abbr title="tools/scripts/solr/createSolrJSON.php">createSolrJSON.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">58</span>
</aside>
<p class="phpdocumentor-summary">Given an array of values, generate the JSON in the Solr format</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__reference-operator">&</span> <span class="phpdocumentor-signature__name">generateSolrJSON</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$values</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$values</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_escapeJsonString">
escapeJsonString()
<a href="namespaces/default.html#function_escapeJsonString" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/scripts/solr/createSolrJSON.php"><a href="files/tools-scripts-solr-createsolrjson.html"><abbr title="tools/scripts/solr/createSolrJSON.php">createSolrJSON.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">102</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">escapeJsonString</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$value</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_getValues">
getValues()
<a href="namespaces/default.html#function_getValues" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/scripts/solr/createSolrJSON.php"><a href="files/tools-scripts-solr-createsolrjson.html"><abbr title="tools/scripts/solr/createSolrJSON.php">createSolrJSON.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">114</span>
</aside>
<p class="phpdocumentor-summary">Given a set of contact IDs get the values</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">getValues</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$contactIDs</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$values</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$contactIDs</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$values</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_getTableInfo">
getTableInfo()
<a href="namespaces/default.html#function_getTableInfo" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/scripts/solr/createSolrJSON.php"><a href="files/tools-scripts-solr-createsolrjson.html"><abbr title="tools/scripts/solr/createSolrJSON.php">createSolrJSON.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">138</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">getTableInfo</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$contactIDs</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$values</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$tableName</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$fields</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$whereField</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string|null </span><span class="phpdocumentor-signature__argument__name">$additionalWhereCond</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$contactIDs</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$values</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$tableName</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fields</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$whereField</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$additionalWhereCond</span>
: <span class="phpdocumentor-signature__argument__return-type">string|null</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_getContactInfo">
getContactInfo()
<a href="namespaces/default.html#function_getContactInfo" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/scripts/solr/createSolrJSON.php"><a href="files/tools-scripts-solr-createsolrjson.html"><abbr title="tools/scripts/solr/createSolrJSON.php">createSolrJSON.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">165</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">getContactInfo</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$contactIDs</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$values</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$contactIDs</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$values</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_getNoteInfo">
getNoteInfo()
<a href="namespaces/default.html#function_getNoteInfo" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/scripts/solr/createSolrJSON.php"><a href="files/tools-scripts-solr-createsolrjson.html"><abbr title="tools/scripts/solr/createSolrJSON.php">createSolrJSON.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">187</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">getNoteInfo</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$contactIDs</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$values</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$contactIDs</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$values</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_getPhoneInfo">
getPhoneInfo()
<a href="namespaces/default.html#function_getPhoneInfo" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/scripts/solr/createSolrJSON.php"><a href="files/tools-scripts-solr-createsolrjson.html"><abbr title="tools/scripts/solr/createSolrJSON.php">createSolrJSON.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">212</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">getPhoneInfo</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$contactIDs</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$values</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$contactIDs</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$values</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_getEmailInfo">
getEmailInfo()
<a href="namespaces/default.html#function_getEmailInfo" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/scripts/solr/createSolrJSON.php"><a href="files/tools-scripts-solr-createsolrjson.html"><abbr title="tools/scripts/solr/createSolrJSON.php">createSolrJSON.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">252</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">getEmailInfo</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$contactIDs</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$values</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$contactIDs</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$values</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_getAddressInfo">
getAddressInfo()
<a href="namespaces/default.html#function_getAddressInfo" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/scripts/solr/createSolrJSON.php"><a href="files/tools-scripts-solr-createsolrjson.html"><abbr title="tools/scripts/solr/createSolrJSON.php">createSolrJSON.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">284</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">getAddressInfo</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$contactIDs</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$values</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$contactIDs</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$values</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_appendValue">
appendValue()
<a href="namespaces/default.html#function_appendValue" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/scripts/solr/createSolrJSON.php"><a href="files/tools-scripts-solr-createsolrjson.html"><abbr title="tools/scripts/solr/createSolrJSON.php">createSolrJSON.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">337</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">appendValue</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$values</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$contactID</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$name</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$values</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$contactID</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$name</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$value</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_run">
run()
<a href="namespaces/default.html#function_run" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/scripts/solr/createSolrJSON.php"><a href="files/tools-scripts-solr-createsolrjson.html"><abbr title="tools/scripts/solr/createSolrJSON.php">createSolrJSON.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">358</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">run</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$contactIDs</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$contactIDs</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_splitContactIDs">
splitContactIDs()
<a href="namespaces/default.html#function_splitContactIDs" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/scripts/solr/createSolrXML.php"><a href="files/tools-scripts-solr-createsolrxml.html"><abbr title="tools/scripts/solr/createSolrXML.php">createSolrXML.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">27</span>
</aside>
<p class="phpdocumentor-summary">Split a large array of contactIDs into more manageable smaller chunks</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__reference-operator">&</span> <span class="phpdocumentor-signature__name">splitContactIDs</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$contactIDs</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$contactIDs</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_generateSolrXML">
generateSolrXML()
<a href="namespaces/default.html#function_generateSolrXML" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/scripts/solr/createSolrXML.php"><a href="files/tools-scripts-solr-createsolrxml.html"><abbr title="tools/scripts/solr/createSolrXML.php">createSolrXML.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">58</span>
</aside>
<p class="phpdocumentor-summary">Given an array of values, generate the XML in the Solr format</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__reference-operator">&</span> <span class="phpdocumentor-signature__name">generateSolrXML</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$values</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$values</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_getValues">
getValues()
<a href="namespaces/default.html#function_getValues" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/scripts/solr/createSolrXML.php"><a href="files/tools-scripts-solr-createsolrxml.html"><abbr title="tools/scripts/solr/createSolrXML.php">createSolrXML.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">90</span>
</aside>
<p class="phpdocumentor-summary">Given a set of contact IDs get the values</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">getValues</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$contactIDs</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$values</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$contactIDs</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$values</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_getTableInfo">
getTableInfo()
<a href="namespaces/default.html#function_getTableInfo" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/scripts/solr/createSolrXML.php"><a href="files/tools-scripts-solr-createsolrxml.html"><abbr title="tools/scripts/solr/createSolrXML.php">createSolrXML.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">111</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">getTableInfo</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$contactIDs</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$values</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$tableName</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$fields</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$whereField</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string|null </span><span class="phpdocumentor-signature__argument__name">$additionalWhereCond</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$contactIDs</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$values</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$tableName</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fields</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$whereField</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$additionalWhereCond</span>
: <span class="phpdocumentor-signature__argument__return-type">string|null</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_getContactInfo">
getContactInfo()
<a href="namespaces/default.html#function_getContactInfo" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/scripts/solr/createSolrXML.php"><a href="files/tools-scripts-solr-createsolrxml.html"><abbr title="tools/scripts/solr/createSolrXML.php">createSolrXML.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">143</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">getContactInfo</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$contactIDs</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$values</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$contactIDs</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$values</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_getLocationInfo">
getLocationInfo()
<a href="namespaces/default.html#function_getLocationInfo" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/scripts/solr/createSolrXML.php"><a href="files/tools-scripts-solr-createsolrxml.html"><abbr title="tools/scripts/solr/createSolrXML.php">createSolrXML.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">183</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">getLocationInfo</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$contactIDs</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$values</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$contactIDs</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$values</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_run">
run()
<a href="namespaces/default.html#function_run" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/scripts/solr/createSolrXML.php"><a href="files/tools-scripts-solr-createsolrxml.html"><abbr title="tools/scripts/solr/createSolrXML.php">createSolrXML.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">236</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">run</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$contactIDs</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$contactIDs</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_splitContactIDs">
splitContactIDs()
<a href="namespaces/default.html#function_splitContactIDs" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/scripts/solr/createSyncJSON.php"><a href="files/tools-scripts-solr-createsyncjson.html"><abbr title="tools/scripts/solr/createSyncJSON.php">createSyncJSON.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">27</span>
</aside>
<p class="phpdocumentor-summary">Split a large array of contactIDs into more manageable smaller chunks</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__reference-operator">&</span> <span class="phpdocumentor-signature__name">splitContactIDs</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$contactIDs</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$contactIDs</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_getValues">
getValues()
<a href="namespaces/default.html#function_getValues" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/scripts/solr/createSyncJSON.php"><a href="files/tools-scripts-solr-createsyncjson.html"><abbr title="tools/scripts/solr/createSyncJSON.php">createSyncJSON.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">61</span>
</aside>
<p class="phpdocumentor-summary">Given a set of contact IDs get the values</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">getValues</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$contactIDs</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$values</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$allContactIDs</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$addditionalContactIDs</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$contactIDs</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$values</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$allContactIDs</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$addditionalContactIDs</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
</section>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_getTableInfo">
getTableInfo()
<a href="namespaces/default.html#function_getTableInfo" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/scripts/solr/createSyncJSON.php"><a href="files/tools-scripts-solr-createsyncjson.html"><abbr title="tools/scripts/solr/createSyncJSON.php">createSyncJSON.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">90</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">getTableInfo</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$contactIDs</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$values</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$tableName</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$fields</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$whereField</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string|null </span><span class="phpdocumentor-signature__argument__name">$additionalWhereCond</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">NULL</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$flat</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">FALSE</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$contactIDs</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$values</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$tableName</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fields</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$whereField</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$additionalWhereCond</span>
: <span class="phpdocumentor-signature__argument__return-type">string|null</span>
= <span class="phpdocumentor-signature__argument__default-value">NULL</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$flat</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
= <span class="phpdocumentor-signature__argument__default-value">FALSE</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_getContactInfo">
getContactInfo()
<a href="namespaces/default.html#function_getContactInfo" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/scripts/solr/createSyncJSON.php"><a href="files/tools-scripts-solr-createsyncjson.html"><abbr title="tools/scripts/solr/createSyncJSON.php">createSyncJSON.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">127</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">getContactInfo</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$contactIDs</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$values</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$contactIDs</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$values</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_getNoteInfo">
getNoteInfo()
<a href="namespaces/default.html#function_getNoteInfo" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/scripts/solr/createSyncJSON.php"><a href="files/tools-scripts-solr-createsyncjson.html"><abbr title="tools/scripts/solr/createSyncJSON.php">createSyncJSON.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">150</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">getNoteInfo</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$contactIDs</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$values</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$contactIDs</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$values</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_getPhoneInfo">
getPhoneInfo()
<a href="namespaces/default.html#function_getPhoneInfo" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/scripts/solr/createSyncJSON.php"><a href="files/tools-scripts-solr-createsyncjson.html"><abbr title="tools/scripts/solr/createSyncJSON.php">createSyncJSON.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">180</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">getPhoneInfo</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$contactIDs</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$values</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$contactIDs</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$values</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_getEmailInfo">
getEmailInfo()
<a href="namespaces/default.html#function_getEmailInfo" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/scripts/solr/createSyncJSON.php"><a href="files/tools-scripts-solr-createsyncjson.html"><abbr title="tools/scripts/solr/createSyncJSON.php">createSyncJSON.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">217</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">getEmailInfo</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$contactIDs</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$values</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$contactIDs</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$values</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_getAddressInfo">
getAddressInfo()
<a href="namespaces/default.html#function_getAddressInfo" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/scripts/solr/createSyncJSON.php"><a href="files/tools-scripts-solr-createsyncjson.html"><abbr title="tools/scripts/solr/createSyncJSON.php">createSyncJSON.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">249</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">getAddressInfo</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$contactIDs</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$values</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$contactIDs</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$values</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_getRelationshipInfo">
getRelationshipInfo()
<a href="namespaces/default.html#function_getRelationshipInfo" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/scripts/solr/createSyncJSON.php"><a href="files/tools-scripts-solr-createsyncjson.html"><abbr title="tools/scripts/solr/createSyncJSON.php">createSyncJSON.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">301</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">getRelationshipInfo</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$contactIDs</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$values</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$allContactIDs</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$additionalContacts</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$contactIDs</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$values</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$allContactIDs</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$additionalContacts</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_getActivityInfo">
getActivityInfo()
<a href="namespaces/default.html#function_getActivityInfo" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/scripts/solr/createSyncJSON.php"><a href="files/tools-scripts-solr-createsyncjson.html"><abbr title="tools/scripts/solr/createSyncJSON.php">createSyncJSON.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">353</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">getActivityInfo</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$contactIDs</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$values</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$allContactIDs</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$additionalContacts</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$contactIDs</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$values</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$allContactIDs</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$additionalContacts</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_appendValue">
appendValue()
<a href="namespaces/default.html#function_appendValue" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/scripts/solr/createSyncJSON.php"><a href="files/tools-scripts-solr-createsyncjson.html"><abbr title="tools/scripts/solr/createSyncJSON.php">createSyncJSON.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">443</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">appendValue</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$values</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$id</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$name</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$value</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$ignored</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">FALSE</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$values</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$id</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$name</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$value</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$ignored</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
= <span class="phpdocumentor-signature__argument__default-value">FALSE</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_getDBFields">
getDBFields()
<a href="namespaces/default.html#function_getDBFields" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/scripts/solr/createSyncJSON.php"><a href="files/tools-scripts-solr-createsyncjson.html"><abbr title="tools/scripts/solr/createSyncJSON.php">createSyncJSON.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">460</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">getDBFields</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$daoName</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$daoName</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_addAdditionalContacts">
addAdditionalContacts()
<a href="namespaces/default.html#function_addAdditionalContacts" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/scripts/solr/createSyncJSON.php"><a href="files/tools-scripts-solr-createsyncjson.html"><abbr title="tools/scripts/solr/createSyncJSON.php">createSyncJSON.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">490</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">addAdditionalContacts</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$contactIDs</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$allContactIDs</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$additionalContacts</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$contactIDs</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$allContactIDs</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$additionalContacts</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_run">
run()
<a href="namespaces/default.html#function_run" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="tools/scripts/solr/createSyncJSON.php"><a href="files/tools-scripts-solr-createsyncjson.html"><abbr title="tools/scripts/solr/createSyncJSON.php">createSyncJSON.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">506</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">run</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$values</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$contactIDs</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$allContactIDs</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$values</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$contactIDs</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$allContactIDs</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_smarty_block_ts">
smarty_block_ts()
<a href="namespaces/default.html#function_smarty_block_ts" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="xml/plugins/block.ts.php"><a href="files/xml-plugins-block-ts.html"><abbr title="xml/plugins/block.ts.php">block.ts.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">10</span>
</aside>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">smarty_block_ts</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$text</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$smarty</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$params</span>
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$text</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$smarty</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
</section>
</article>
</section>
</section>
</div>
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
<section class="phpdocumentor-search-results__dialog">
<header class="phpdocumentor-search-results__header">
<h2 class="phpdocumentor-search-results__title">Search results</h2>
<button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
</header>
<section class="phpdocumentor-search-results__body">
<ul class="phpdocumentor-search-results__entries"></ul>
</section>
</section>
</section>
</div>
<a href="index.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
</main>
<script>
cssVars({});
</script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
</body>
</html>