Ninja Forms Developer Docs

Class

AbstractCiviObject

__construct public: Call protected child method that instantiates CiviCRM object
getFields public: @inheritDoc
getCiviObject protected

Class

AbstractCiviObjectCreateable

__construct public: Construct with calls to protected methods defining required objects
The CiviCrm and CreateObjectResponse objects are instantiated in protected methods required by this parent class.
create public: @inheritDoc
constructParentNameValuePairs protected: Construct name=>value pairs given parent ids keyed on entity name
This method is a function hook that can be overridden by concrete implementations. By default, there are no links provided for parent/child record linking. A concrete implementation can override this default behavior by providing such key-value pairs.
An array of entity=>recordId pairs are passed in. Should any of the given keys be parents of this class's entity, this method should return the fieldKey=>recordId that links this class's entity to that parent.

Param
array $parentIds Array of parent ids keyed on entity e.g. 'Contact'=>'000'
Return
array Name value pairs of parent ids for the object
getResponse public: Return the CreateObjectResponse
Return
CreateObjectResponse

Class

AbstractCiviObjectRetrievable

__construct public: Construct with calls to protected methods defining required objects
The CiviCrm and GetRecordsResponse objects are instantiated in protected methods required by this parent class.
getGetRecordsResponse protected
getRecords public: Request records from CiviCrm using its API
Return
array

Class

Activity

Honors NinjaForms' Contracts activity using CiviCRM's API v4

getCiviObject protected: @inheritDoc
constructParentNameValuePairs protected: Given parent ids keyed on entity, constructs name=>value pairs
Incoming array receives key with record Id for association. $parentIds specify the key under which the incoming id will be set 'ActivityAddedByContact'=>'123' will be mapped as 'source_contact_id'=>123 'ActivityWithContact'=>'456' will be mapped as 'target_contact_id'=>[456]

Class

Address

Honors NinjaForms' Contracts Address using CiviCRM's API v4

getCiviObject protected: @inheritDoc
constructParentNameValuePairs protected: @inheritDoc

Class

Contact

Honors NinjaForms' Contracts contact using CiviCRM's API v4

getCiviObject protected: @inheritDoc
hasMatch public: @inheritDoc
getMatchingId public: @inheritDoc
peformUfMatch protected: Perform UfMatch check to determine logged in user match

Return
void

Class

ContactType

Honors NinjaForms' Contracts ContactType using CiviCRM's API v4

getCiviObject protected: @inheritDoc
getGetRecordsResponse protected: @inheritDoc

Class

Country

Honors NinjaForms' Contracts Country using CiviCRM's API v4

getCiviObject protected: @inheritDoc
getGetRecordsResponse protected: @inheritDoc

Class

DedupeRule

Honors NinjaForms' Contracts DedupeRule using CiviCRM's API v4

getCiviObject protected: @inheritDoc
getGetRecordsResponse protected: @inheritDoc

Class

DedupeRuleGroup

Honors NinjaForms' Contracts DedupeRuleGroup using CiviCRM's API v4

getCiviObject protected: @inheritDoc
getGetRecordsResponse protected: @inheritDoc

Class

Email

Honors NinjaForms' Contracts email using CiviCRM's API v4

getCiviObject protected: @inheritDoc
constructParentNameValuePairs protected: @inheritDoc

Class

Event

Honors NinjaForms' Contracts event using CiviCRM's API v4

getCiviObject protected: @inheritDoc
getGetRecordsResponse protected: @inheritDoc

Class

Group

Honors NinjaForms' Contracts group using CiviCRM's API v4

getCiviObject protected: @inheritDoc
getGetRecordsResponse protected: @inheritDoc

Class

GroupContact

Honors NinjaForms' Contracts groupContact using CiviCRM's API v4

getCiviObject protected: @inheritDoc
constructParentNameValuePairs protected: @inheritDoc

Class

Im

Honors NinjaForms' Contracts IM using CiviCRM's API v4

getCiviObject protected: @inheritDoc
constructParentNameValuePairs protected: @inheritDoc

Class

LineItem

@inheritDoc

constructLineItemForOrder public: @inheritDoc
validateConstructedLineItem protected: Check for required construction, set HandledResponse flags

Return
void
setValues protected: Set lineItem values from incoming parameters

Return
void
validateParameters protected: Ensures required parameters are set

Param
array $parameterArray
Return
void
initializeLineItemForOrder protected: Initialize the basic Line Item construct

Class

Note

Honors NinjaForms' Contracts note using CiviCRM's API v4

getCiviObject protected: @inheritDoc
constructParentNameValuePairs protected: @inheritDoc

Class

OptionGroup

Honors NinjaForms' Contracts OptionGroup using CiviCRM's API v4

getCiviObject protected: @inheritDoc
getGetRecordsResponse protected: @inheritDoc

Class

OptionValue

Honors NinjaForms' Contracts OptionValue using CiviCRM's API v4

getCiviObject protected: @inheritDoc
getGetRecordsResponse protected: @inheritDoc

Class

Order

createOrder public

Class

Participant

Honors NinjaForms' Contracts participant using CiviCRM's API v4

getCiviObject protected: @inheritDoc
constructParentNameValuePairs protected: @inheritDoc

Class

Phone

Honors NinjaForms' Contracts phone using CiviCRM's API v4

getCiviObject protected: @inheritDoc
constructParentNameValuePairs protected: @inheritDoc

Class

Tag

Honors NinjaForms' Contracts tag using CiviCRM's API v4

getCiviObject protected: @inheritDoc
getGetRecordsResponse protected: @inheritDoc

Class

TagEntity

Honors NinjaForms' Contracts tagEntity using CiviCRM's API v4

getCiviObject protected: @inheritDoc
constructParentNameValuePairs protected: @inheritDoc

Class

Website

Honors NinjaForms' Contracts website using CiviCRM's API v4

getCiviObject protected: @inheritDoc
constructParentNameValuePairs protected: @inheritDoc

Class

CiviMockObject

Generic Civi Entity object that can be used as stand-in
If CiviCrm plugin is not installed, Ninja Form's form action would stall as it relies on Civi's entity objects for setup. By providing an option to use a mock object, Ninja Form's form action can be set up to a certain extent without Civi being installed. This class honors the contracts of all the implemented contracts specified by returning empty values of all requests.

See

\NinjaForms\CiviCrmSdk\Factories\CiviObjectsFactory

getFields public: @inheritDoc
create public: @inheritDoc
getRecords public: @inheritDoc
hasMatch public: @inheritDoc
getMatchingId public: @inheritDoc
getResponse public: @inheritDoc

Class

CiviMockObject

getFields public: Get field definitions as indexed array of CiviFieldDefinition->toArray()
Return
array

Class

CiviMockObject

create public: Create a new record of the object
Param
array $values Civi field 'name' => form value pairs
Param
array $parentIds Array keyed on entity=> (string) id
Return
CreateObjectResponse CreateObjectResponse
getResponse public: Return the CreateObjectResponse
Return
CreateObjectResponse

Class

CiviMockObject

getRecords public: Request records from CiviCrm
Records are returned as a indexed collection of associative arrays. The requestor is responsible for interpreting the returned data into its desired structure.
Return
array

Class

CiviMockObject

contact public: Make Contract\Contact object

Return
ContractsContact
contactType public: Make Contract\ContactType object

Return
ContractsContactType
optionGroup public: Make Contract\OptionGroup object

Return
ContractsOptionGroup
dedupeRuleGroup public: Make Contract\DedupeRuleGroup object

Return
ContractsDedupeRuleGroup
optionValue public: Make Contract\OptionValue object

Return
ContractsOptionValue
dedupeRule public: Make Contract\DedupeRule object

Return
ContractsDedupeRule
activity public: Make Contracts\Activity object

Return
ContractsActivity
event public: Make Contracts\Event object

Return
ContractsEvent
note public: Make Contracts\Note object

Return
ContractsNote
country public: Make Contracts\Country object

Return
ContractsCountry
tag public: Make Contracts\Tag object

Return
ContractsTag
participant public: Make Contracts\Participant object

Return
ContractsParticipant
email public: Make Contracts\Email object

Return
ContractsEmail
phone public: Make Contracts\Phone object

Return
ContractsPhone
iM public: Make Contracts\Im object

Return
ContractsIm
website public: Make Contracts\Website object

Return
ContractsWebsite
address public: Make Contracts\Address object

Return
ContractsAddress
group public: Make Contracts\Group object

Return
ContractsGroup
groupContact public: Make Contract\GroupContact object

Return
ContractsGroupContact
tagEntity public: Make Contract\TagEntity object

Return
ContractsTagEntity
lineItem public: Make Contract\LineItem object
Return
ContractsLineItem
order public: Make Contract\Order object
Return
ContractsOrder
setBypassCivi public: Set boolean to bypass CiviCrm, using mocks

Param
bool $bypassCivi Boolean to bypass CiviCrm, using mocks
Return
CiviObjectsFactory

Class

CiviMockObject

hasMatch public: Does contact have a match
getMatchingId public: Return the matching contact id

Class

CiviMockObject

constructLineItemForOrder public: Construct a line item request to be included in Order

Param
array $parameterArray
Return
array

Class

CiviMockObject

createOrder public: Construct a line item request to be included in Order

Param
array $parameterArray
Return
array

Class

CiviFieldDefinition

Field definition for a CiviCRM field Uses CiviCRM property names

getName public: Return
string
getLabel public: Return
string
getEntity public: Return
string
isRequired public: Return
bool
getDataType public: Return
string
getInputType public: Return
string
fromArray public
__set public: Set defined properties

Class

CreateObjectResponse

getId public: Get id of the created object

Return
string
setId public: Set id of the created object

Param
string $id Id of the created object

Return
self
getEntity public: Get entity of the created object

Return
string
setEntity public: Set entity of the created object

Param
string $entity Entity of the created object

Return
self

Class

GetContactTypesResponse

Extend Records response with needed ContactTypes properties

getName public: Get the value of name
getLabel public: Get the value of label
getDescription public: Get the value of description
getImage_URL public: Get the value of image_URL
getParent_id public: Get the value of parent_id
getIs_active public: Get the value of is_active
getIs_reserved public: Get the value of is_reserved

Class

GetCountriesResponse

Extend Records response with needed Country properties

getName public: Get the value of name
getIso_code public: Get the value of iso_code
getCountry_code public: Get the value of country_code
getAddress_format_id public: Get the value of address_format_id
getIdd_prefix public: Get the value of idd_prefix
getNdd_prefix public: Get the value of ndd_prefix
getRegion_id public: Get the value of region_id
getIs_province_abbreviated public: Get the value of is_province_abbreviated
getIs_active public: Get the value of is_active

Class

GetDedupeRuleGroupsResponse

Extend Records response with needed DedupeRuleGroups properties

getName public: Get the value of name
getTitle public: Get the value of title
getContactType public: Get the value of contact type
getThreshold public: Get the value of threshold
getUsed public: Get the value of used
getIs_reserved public: Get the value of is_reserved

Class

GetDedupeRulesResponse

Extend Records response with needed DedupeRule properties

getRuleTable public: Get the value of rule_table
getDedupeRuleGroupId public: Get the value of dedupe_rule_group_id
getRuleField public: Get the value of rule_field
getRuleLength public: Get the value of rule_length
getRuleWeight public: Get the value of rule_weight

Class

GetEventsResponse

getTitle public: Get the value of title
getSummary public: Get the value of summary
getDescription public: Get the value of description

Class

GetGroupsResponse

Entity describing a collection of 'Group' records

getName public: Get the value of name
getTitle public: Get the value of title
getDescription public: Get the value of description

Class

GetOptionGroupsResponse

Extend Records response with needed OptionGroups properties

getName public: Get the value of name
getTitle public: Get the value of title
getDescription public: Get the value of description
getDataType public: Get the value of data_type
getParent_id public: Get the value of parent_id
getIs_active public: Get the value of is_active
getIs_reserved public: Get the value of is_reserved
getIs_locked public: Get the value of is_locked

Class

GetOptionValuesResponse

Extend Records response with needed OptionValues properties

getName public: Get the value of name
getLabel public: Get the value of label
getDescription public: Get the value of description
getValue public: Get the value of value
getOption_group_id public: Get the value of option_group_id
getIs_active public: Get the value of is_active
getIs_reserved public: Get the value of is_reserved

Class

GetRecordsResponse

Define an entity for a getRecords response
Each entity has field names specific to it, however they all have an id field, which is defined here. Specific entities extend this object with properties and methods to get the fields.

getId public: Get id of the retrieved object

Return
string
fromArray public
__set public: Set defined properties
Return
GetRecordsResponse

Class

GetTagsResponse

Extend Records response with needed Tags properties

getName public: Get the value of name
getDescription public: Get the value of description

Class

CiviObjectsFactory

Provides entity objects for CiviCrm plugin requests
If a bypass is not requested, provides the entity objects used to make requests of CiviCrm plugin. If bypassing is requested, such as when CiviCrm plugin is not active, this factory provides a mock version that returns empty data.

activity public: @inheritDoc
event public: @inheritDoc
note public: @inheritDoc
country public: @inheritDoc
contactType public: @inheritDoc
optionGroup public: @inheritDoc
dedupeRuleGroup public: @inheritDoc
optionValue public: @inheritDoc
dedupeRule public: @inheritDoc
tag public: @inheritDoc
contact public: @inheritDoc
email public: @inheritDoc
phone public: @inheritDoc
iM public: @inheritDoc
website public: @inheritDoc
address public: @inheritDoc
participant public: @inheritDoc
group public: @inheritDoc
groupContact public: @inheritDoc
tagEntity public: @inheritDoc
lineItem public: @inheritDoc
order public: @inheritDoc
setBypassCivi public: Set boolean to bypass CiviCrm, using mocks

Param
bool $bypassCivi Boolean to bypass CiviCrm, using mocks

Return
ContractsCiviObjectsFactory

Class

Master

Master class for CiviCrm SDK

registerServices public: @inheritDoc

Class

function

Class

AjaxHandler

__construct public: Construct with rootDirectory

Param
string $rootDirectory
handle public: Receive request and return response @inheritDoc This abstract requires child methods to process the request and return a keyed array of response values, which this parent structures and returns to the JS script.

Return
void
processAjaxRequest protected
initializeLocalizedArray protected
setScriptUrl protected: Set the script URL
Script URL is defined by the child class and is given as a relative directory and includes file extension; usually we store such JS files in assets/js. This protected method constructs the full URL on ->handle() and is done by the parent class.
(
ex: 'assets/js/nfpluginsettings.js'
)
end protected: End AJAX handler per WP's requirements
Passing data back to the JS script ends with echoing a JSON string and calling the die() function. This is handled automatically by the parent class, leaving the child to focus on constructing and return an associative array of the returned values.

Param
array $returnParams
Return
void
getPostData protected: Filter and return POST data for supplied keys
An AJAX request is triggered by a POST call. This class extracts the requested data from that POST call. A child class can put the following code in its implementation of the processAjaxRequest() method to easily extract the data it wants: ``` $keys = [ 'wpRestNonce', 'context' ];
$postData = $this->getPostData($keys);
\extract($postData); ```
The data will now be available as `$wpRestNonce` and `$context`
Param
array $keys
Return
array
getHandle public: @inheritDoc
getScriptUrl public: @inheritDoc
getVersion public: @inheritDoc
getObjectName public: @inheritDoc
getLocalizedArray public: @inheritDoc

Class

FilterSettingsOutput

__construct public
handle public: Modify plugin settings at time of render

Return
FilterSettingsOutput
modifyConfiguredSettings protected
filter public: Modify configured settings at time of output

Param
array $incomingSettings
Return
array

Class

FormActionProcessor

__construct public: Construct with action configuration array

Param
array $actionConfiguration Action configuration array
getActionConfiguration public: Return the action configuration array
process public: @inheritDoc
finalizeActionSettings public: Modify and return the action settings at run time If this method appears in a child object, then the default functionality is being overridden, in which the action configuraion settings are being modified at run time
Return
void
processSubmissionData abstract: Process the submission data, (optionally) update NF form process $data as $this->data

Return
void
extractSubmissionData protected: Extract submission data as defined by the action configuration
Stores value in $this->submissionData
Param
array $action_settings
Return
FormActionProcessor
save public: @inheritDoc

Class

Master

registerServices public
setRootDirectory public: Set root directory for the file and associated Configure class

Param
string $rootDir
Return
Master
registerPluginSettings public
registerAdvancedSettings public
registerAction public: Registers a form action with NF Core

Param
FormAction $formAction
Return
Master
configure protected
getRootDirectory public: Get root directory

Return
string

Class

SimpleEntity

Simple entity abstract upon which all entities are built
Entities are classes that pass well defined data honoring contracts. Single parameters and arrays, when passed into an entity, can be relied upon to provide the data defined by the entity, even if the original data did not fully define values.

toArray public: Constructs an array representation
jsonSerialize public: Sets data for json_encode

Return
void

Class

SubmissionMetabox

__construct public
render_metabox public: Output the metabox as called by NF Core

Param
[type] $post
Param
[type] $metabox
Return
void
outputHandledResponse protected
outputActionHeading protected
addNoResponseDataMarkup protected

Class

SubmissionMetabox

handle public: Call methods to handle AJAX requests from settings page This method is registered as the AJAX callback, thus the POSTed request from the AJAX script is sent here. Implementations can then trigger whatever tasks must be performed and return the corresponding response.
getHandle public: Get AJAX script handle

Return
string
getScriptUrl public: Get URL of script

Return
string
getVersion public: Get script version

Return
string
getObjectName public: Get object name of the JS object

Return
string
getLocalizedArray public: Get key value pairs of data passed into JS object

Return
$params

Class

SubmissionMetabox

columnsFromCollection public: Provide multi-dim array - indexed=>keyed Given an indexed array of associative arrays, returns indexed array of associative arrays containing only the specified keys. Collection requests often include full entity definitions, but we may need only a couple of keys within that full definition. This method iterates through each item in the collection to validate the data in process rather than some more powerful array functions because this method cannot be certain of the data's validity. [ {key1=>val1a, key2=>val2a, key3=>val3a }, {key1=>val1b, key2=>val2b, key3=>val3b } ... ]

Param
array $collection
Param
array $keys
Return
array
keyValuePairsFromCollection public: Provide key value pair from a multidimentional array Given an indexed array of associative arrays, returns key value pairs of data within each element

Param
array $collection
Param
array $keys
Return
array
labelValuePairsFromCollection public: Provide label-value pairs as indexed arrays This is the structure used by NF core to construct such features as select options. Given an indexed array of associative arrays, returns indexed array of label-value pairs.

Param
array $collection
Param
string $label Key containing the indended label
Param
string $value Key containing the intended value
Return
array

Class

SubmissionMetabox

getActionConfiguration public: Return the action configuration array
finalizeActionSettings public: Modify and return the action settings at run time
Return
void
process public: Process the submitted form, returning updated $data
Param
array $action_settings
Param
type $form_id
Param
array $data
save public: Modify the action settings at time of form save
Var
array $action_settings Form action settings before save
Return
array Form action settings modified for saving

Class

SubmissionMetabox

getLogCollection public: Load the existing log collection from transient
clearLog public: Clear the log's storage location

Class

SubmissionMetabox

registerPluginSettings public: Register plugin settings with NF core

Param
string $configFilename
Return
string Filter tag for modifying registered settings
registerAdvancedSettings public: Register advanced settings with NF core

Param
string $configFilename
Return
string Filter tag for modifying registered settings
registerServices public: Register Services

Return
Master

Class

SubmissionMetabox

keyValuePairs public: Provide Key => Value pairs markup
Used when integration requires a programmatic key instead of the human-readable form, this output highlights the key such that the user can readily get the needed value; the value is not highlighted because that is not the intended data, although eyes will be naturally drawn to it as it is recognizable.

Param
array $idValues
Return
string
tableColumns public: Output a table of multidimensional array
Given indexed array of arrays, outputs a table, a row for each indexed array, a cell for each element within that array

Param
array $array
Param
integer|null $columnCount
Return
string
markupButton public: Markup button with id and button text

Param
string $buttonText
Return
string

Class

SubmissionMetabox

setUrl public: Set HTTP request URL

Param
string $url
Return
\SaturdayDrive\EmailCRM\AmoCrm\Handlers\RemoteRequest
setHttpArg public: Set an HTTP argument

Param
string $arg
Param
mixed $value
Return
RemoteRequest
addQueryArg public: Set an HTTP argument

Param
string $arg
Param
mixed $value
Return
RemoteRequest
setBody public: Set HTTP request body
Param
mixed $body
Return
RemoteRequest
setHeaderParameter public: Set an HTTP header parameter
Param
string $arg
Param
mixed $value
Return
RemoteRequest
handle public: Return
HandledResponse

Class

SubmissionMetabox

handle public: Given template name and option repeater columns, constructs template script

Param
string $templateName
Param
array $columns
Return
string

Class

AdvancedSetting

Single plugin setting in form design's Advanced section

Package

Settings

getName public: Return Advanced setting Name
Return
string
getLabel public: Return Advanced setting label
Return
string
getType public: Return Advanced setting data type
Return
string
getWidth public: Return Advanced setting width
Return
string
getGroup public: Return Advanced setting group
Return
string
getTemplateRow public: Return Advanced setting template row
Return
string
getColumns public: Return Advanced setting columns
Return
string
getValue public: Get the value for the AdvancedSetting
Return
mixed
setName public: Set Advanced setting Name
Param
string $stringValue
Return
AdvancedSetting
setLabel public: Set Advanced setting label
Param
string $stringValue
Return
AdvancedSetting
setType public: Set Advanced setting expected data type

Param
string $stringValue
Return
AdvancedSetting
setWidth public: Set Advanced setting width
Param
string $stringValue
Return
AdvancedSetting
setGroup public: Set Advanced setting Group
Param
string $stringValue
Return
AdvancedSetting
setTemplateRow public: Set Advanced setting template row
Param
string $stringValue
Return
AdvancedSetting
setColumns public: Set Advanced setting column
Param
array $arrayValue
Return
AdvancedSetting
setValue public: Set the value for the AdvancedSetting

Param
type $param
fromArray public
__set public: Set defined properties

Class

AdvancedSettings

Describes a collection of Advanced Setting entities

Package

Settings

getId public: Return Advanced settings Id
Return
string
getNicename public: Return Advanced setting nicename
Return
string
setId public: Set Advanced setting Id
Param
string $stringValue
Return
AdvancedSettings
setLabel public: Set Advanced setting label
Param
string $stringValue
Return
AdvancedSettings
fromArray public
toArray public: Convert AdvancedEttings object into associative array

Return
array
addAdvancedSetting public: Add an Advanced Setting to collection

Param
AdvancedSetting $advancedSetting

Return
AdvancedSettings
getAdvancedSetting public: Get a Plugin Setting from collection

Param
string $key

Return
AdvancedSetting
Throws
Exception
getAdvancedSettings public: Get all Plugin Settings in collection

Return
AdvancedSetting[]
getAdvancedSettingsArray public: Get all Plugin Settings as keyed array of AdvancedSetting arrays

Return
array
__set public: Set defined properties

Class

HandledResponse

Provides standardized response for Requests
Enables any source a response to minimally handle the response and pass it on to the requester, which will know how to process it as required

setContext public: Set the context

Param
string|null $string
Return
HandledResponse
getContext public: Get the context

Return
string
setRecordCount public: Set the record count
Param
integer|null $int
Return
HandledResponse
getRecordCount public: Get the record count
Return
int
setRecords public: Set the records collection

Param
array|null $array
Return
HandledResponse
appendRecord public: Append a single record to the record collection

Param
string|null $string
Return
HandledResponse
appendRecords public: Append a array of records to the collection

Param
array|null $array
Return
HandledResponse
getRecords public: Get the record collection

Return
array
setTimestamp public: Set the timestamp

Param
integer|null $int
Return
HandledResponse
getTimestamp public: Get the timestamp
Return
int
setIsSuccessful public: Set IsSuccessful

Param
boolean|null $bool
Return
HandledResponse
isSuccessful public: Get IsSuccessful

Return
bool
setIsWpError public: Set IsWpError

Param
boolean|null $bool
Return
HandledResponse
isWpError public: Get IsWpError
Return
bool
setIsApiError public: Set IsApiError

Param
boolean|null $bool
Return
HandledResponse
isApiError public: Get IsApiError

Return
bool
setIsException public: Set IsException

Param
boolean|null $bool
Return
HandledResponse
isException public: Get IsException

Return
bool
setHasNoData public: Set HasNoData

Param
boolean|null $bool
Return
HandledResponse
hasNoData public: Get HasNoData

Return
bool
setErrorCode public: Set ErrorCode

Param
integer|null $int
Return
HandledResponse
getErrorCode public: Get ErrorCode

Return
int
setErrorMessages public: Get ErrorMessages

Param
array|null $array
Return
HandledResponse
appendErrorMessage public: Append a single error message to collection

Param
string|null $string
Return
HandledResponse
getErrorMessages public: Get ErrorMessages

Return
array
setResponseBody public: Set ResponseBody

Param
string|null $string
Return
HandledResponse
getResponseBody public: Get ResponseBody

Return
string
fromArray public
__set public: Set defined properties

Class

PluginSetting

Single plugin setting in NF Settings This entity describes a piece of data that the plugin requires. NF is responsible for storing and delivering this entity.

Package

Settings

getId public: Return Plugin setting Id
Return
string
getLabel public: Return Plugin setting label
Return
string
getType public: Return Plugin setting data type
Return
string
getHtml public: Return Plugin setting html
Return
string
getValue public: Get the value for the PluginSetting
Return
mixed
setId public: Set Plugin setting Id
Param
string $stringValue
Return
PluginSetting
setLabel public: Set Plugin setting label
Param
string $stringValue
Return
PluginSetting
setType public: Set Plugin setting expected data type

Param
string $stringValue
Return
PluginSetting
setHtml public: Set Plugin setting HTML
Param
string $stringValue
Return
PluginSetting
setValue public: Set the value for the PluginSetting

Param
type $param
fromArray public
__set public: Set defined properties

Class

PluginSettings

Describes a collection of Plugin Setting entities

Package

Settings

getId public: Return Plugin settings Id
Return
string
getLabel public: Return Plugin setting label
Return
string
setId public: Set Plugin setting Id
Param
string $stringValue
Return
PluginSettings
setLabel public: Set Plugin setting label
Param
string $stringValue
Return
PluginSettings
fromArray public
toArray public: Convert PluginSettings object into associative array

Return
array
addPluginSetting public: Add an Plugin Setting to collection

Param
PluginSetting $pluginSetting

Return
PluginSettings
getPluginSetting public: Get a Plugin Setting from collection

Param
string $key

Return
PluginSetting
Throws
Exception
getPluginSettings public: Get all Plugin Settings in collection

Return
PluginSetting[]
getPluginSettingsArray public: Get all Plugin Settings as keyed array of PluginSetting arrays

Return
array
__set public: Set defined properties

Class

ActionRegistrar

Registers a form action, given a FormAction class Also calls standard builder templates

handle public: Registers a new plugin action

Return
void
registerCss public: Register CSS for form builder if on form builder page
Caller verifies that cssFilename is set before calling because this method is hooked into admin_init and there is no need to hook if no CSS is specified for loading. Check for admin page is done here because admin_init ensures that page URl is established.

Return
void
builderTemplates public: Loads a template for admin display

Return
void
setRootDirectory public: Set root directory

Param
string $rootDirectory
Return
ActionRegistrar
setTemplateAutobuilder public: Set template Autobuilder

Param
TemplateAutobuilder $templateAutobuilder

Return
ActionRegistrar

Class

AdvancedSettingsRegistrar

Registers settings for forms' Advanced Provides a filter tag and passes the configured data such that methods calling the tag can modify the configured settings at run time.

__construct public: Construct with Settings Group and Settings arrays

Param
array $settingsGroupArray
Param
array $settingsArray
handle public: Register the configured settings with NF core Also passes data to a filter at run time

Return
AdvancedSettingsRegistrar
addAdvancedSettingsGroup public: Add configured settings group to the NF groups
Param
array $groups
Return
array
addAdvancedSettings public: Add configured settings to the gropu
Param
array $settings
Return
array
wrapAddNew protected: Add the markup to Add New option repeater entries This is a helper function. Option repeaters require this markup for the JS builder to add the Add New UI. Given the string of option repeater text, this method adds the necessary markup.

Param
array $advancedSetting
Return
array
builderTemplates public: Loads a template for admin display

Return
void
setRootDirectory public: Set root directory

Param
string $rootDirectory
Return
AdvancedSettingsRegistrar
getFilterTag public: Get tag used to filter settings

Return
string

Class

AjaxRegistrar

__construct public
initializeScripts public: Load, enqueue, localize scripts

Class

Configure

Load configuration files as arrays and present on demand
Instantiated with a plugin's root directory, Configure has a method called `configure` that accepts the name of a configuration file stored in the root directory's `Config` folder. By default, it will look for a php file delivering an array, but an optional parameter for extension enables the use of a JSON file, which will be converted into an array. The file is loaded once and stored such that future requests for the same configuration do not need an additional file load.

__construct public
configure public: Return a configured array, storing configuration for reuse
Param
string $configurationName
Param
string|null $extension
Return
array

Class

Container

Basic service container

doesProvide public: @inheritdoc
bind public: @inheritdoc
make public: @inheritdoc
isUnBoundSingleton private
singleton public
resolve private: Resolve dependencies.

Param
$class
Return
object
has public
bound public: Determine if the given abstract type has been bound.

Param
string $abstract
Return
bool
isAlias public: Determine if a given string is an alias.

Param
string $name
Return
bool

Class

DataModelProvider

Provides standard data model structures API requests have some common structures when delivering data, and NF diagnostics have common structures for presenting that data for support. This class enables standardization by taking known data inputs and structuring them for known data outputs.

columnsFromCollection public: @inheritDoc
keyValuePairsFromCollection public: @inheritDoc
labelValuePairsFromCollection public: @inheritDoc

Class

ExtraDataHandler

Standardized methods for adding "extra" submission data
Actions, during the submission process, have the opportunity to add additional data ("extra") to the submitted data, which can not only be stored, but also used by downstream actions. This class provides a standardized method for storing and retrieving such data.

Package

FormProcessing

__construct public: Construct with incoming data and an action key
The action key is the id of the action. All extra data for a given action is stored under this key.
Param
array $data Data array provided at process time
Param
string $actionKey Action Id
appendHandledResponse public: Append HandledResponse array to form process data
Data is stored as a _collection_ of HandledResponse arrays because any given action can make multiple requests. In addition, because there can be more than one of the same action on a form, the option is given to key each instance of the action. Thus the data can store multiple instances of actions under individual keys, and store a collection of HandledResponses under those.
Data is structured as a HandledResponse array. By having a common entity structure, the end user of the stored data can convert the data into an entity and rely on known methods and data types.

Param
array $handledResponse Entity as an array
See
NinjaForms\CiviCrmShared\Entities\HandledResponse
overrideExtraData public: Completely re-write of the action key's extra data
This can be used to write the action data in one request, or to complete remove the extra data for the action key

Param
array|null $override
Return
ExtraDataHandler
setData public: Set nF Process Data passed to action

Param
array $data NF Process Data passed to action

Return
self
getData public: Return complete NF process `$data` for passing back to form processing
Return
array Complete form processing data

Class

FormAction

Form action object Initialized with a configuration array and a Form Actions Processor. The config defines parameters to initialize the form action. The processor handles functionality unique to the action, such as modifying the action settings, processing the submission, appending data to the form submissions' data

__construct public
finalizeSettings public: Adjust action settings at run time

Return
void
save public: @inheritDoc
process public: Process the submitted form
Param
array $action_settings
Param
type $form_id
Param
array $data
get_name public: Return action name
Return
string
getActionCssFilename public: Returns custom form builder CSS filename relative to root NOTE: full name including extension relative to the root directory Returns empty string if not set
Return
string

Class

NfAdminMarkup

Provide standardized markup for settings output Many integrating plugins share common data structures that can be presented to the form designer for effective form setup. This class provides standard markup for display on the NF Settings page. Ultimately this could be replaced with a template or migrated to React JS, but this will help define the UX we need for effective customer guidance towards the form design they wish.

keyValuePairs public: @inheritDoc
tableColumns public: @inheritDoc
markupButton public: @inheritDoc
spanMarkup protected: Wraps provided content with span tags, optional class and id

Param
string $data
Param
string|null $elementId
Param
string|null $class
Return
string
idMarkup protected: Markup id, when id is optional

Param
string|null $id
Return
string
classMarkup protected: Markup class, when class is optional

Param
string|null $class
Return
string

Class

PluginSettingsRegistrar

__construct public: Construct with Settings Group and Settings arrays

Param
array $settingsGroupArray
Param
array $settingsArray
handle public
addPluginSettingsGroup public: Add configured settings group to the NF groups
Param
array $groups
Return
array
addPluginSettings public: Add configured settings to the gropu
Param
array $settings
Return
array
getFilterTag public: Get tag used to filter settings

Return
string

Class

TemplateAutobuilder

@inheritDoc

handle public: @inheritDoc
openScript protected: Open script tag with icon for handle

Return
void
appendColumnScripts protected: Add each column as a template, based on column type
Single column version; each column is on its own row with a line break in between.

Return
void
closeScript protected: Close script with delete icon and closing script tag

Return
void

Class

TransientLogger

Provides logging to a transient stored in WP table for one week

__construct public: Construct with transient key

Param
string $transientKey
log public: Logs with an arbitrary level.

Param
mixed $level
Param
string $message
Param
mixed[] $context

Return
void

Throws
\Psr\Log\InvalidArgumentException
storeLogCollection protected: Store the log as a transient for one week
getLogCollection public: @inheritDoc
clearLog public: @inheritDoc
constructLogEntry protected: Get the current log from the transient
Return
array

Class

WpRemoteRequest

Make an HTTP request using wp_remote_request

__construct public: Make an HTTP request to return a response array
setUrl public
setHttpArg public
addQueryArg public
setBody public
setHeaderParameter public
finalizeRequest protected
handle public: Return
HandledResponse
setDefaultHttpArgs protected: Set default arguments

Class

WpRemoteRequest

nf_civicrm_plugins_loaded
nf_civicrm_setup_license

Class

InitLate

Bootstrap functionality hooked at init priority 15
Default priority is 10; this runs after all init functions not explicitly prioritized.
The bootstrap file calls this class with an action hook at 'init' priority 15. This enables anything in the class to run after any init hooks not explicitly prioritized after init 15. This can be used for situations where other plugins must be loaded and initialized before the functionality contained herein.

Package

Initializing

__construct public
pluginSettings protected: Register plugin setings and filter output
Plugin settings are initialized from a configured array using the PluginSettingsRegistrar. A FilterSettingsOutput class, which extends a shared abstract class, is instantiated and gets passed those plugin settings at run time, enabling it to dynamically adjust the configured array values. Finally, an NfPluginSettingsAjax class, which extends a shared abstract class, activates AJAX functionality for the plugin settings using a standardized hook and enqueuing.

See
\NinjaForms\CiviCrmShared\Handlers\PluginSettingsRegistrar
See
\NinjaForms\CiviCrm\Handlers\FilterSettingsOutput
See
\NinjaForms\CiviCrm\Handlers\NfPluginSettingsAjax

Class

preRegistrationCheck protected: Check that any required external functionality is present
For example, if other plugins are required, perform a check here; The plugins may be active, but may not have initialized fully, so ensure that the required specific functionality is available. If it is not yet available, move the dependent method to a later action hook.
Since CivCrmSdk has added a 'bypass' function, we don't have to stop functionality, instead we set the bypass that tells CiviCrmSdk to provide the mock object instead of actual CiviObjects.

Class

PluginsLoadedEarly

Bootstrap functionality hooked at plugins_loaded priority 5
Runs before any plugins_loaded hooks not explicitly prioritized earlier than 5. The bootstrap file calls this class with an action hook at 'plugins_loaded' priority 5. This enables anything in the class to run before any hooks not explicitly prioritized before plugin_loaded 5. This can be used for situations where the functionality container herein must be present for downstream classes.

Package

Initializing

__construct public: Instantiate with a master class Factory class is made to produce runtime dependencies
Param
Master $master
registerActions public: Register plugin actions
Create a FormAction class and pass it into master class's registerActions method

Return
void
registerSubmissionMetaboxes public: Instantiate the submission metabox

See
\NinjaForms\CiviCrm\Handlers\SubmissionMetabox
Return
void
preRegistrationCheck protected: Check that any required external functionality is present
For example, if other plugins are required, perform a check here; The plugins may be active, but may not have initialized fully, so ensure that the required specific functionality is available. If it is not yet available, move the dependent method to a later action hook.
In this plugin, there is currently no pre-Registration check required, but process flow is kept to ensure that it can easily be added with minimal change after initial release.

Class

PluginsLoadedEarly

getFieldDefinitionIdLabelPairs public: Get Id Label pairs for the entity
Id-label pairs can be id=>label associative array by default, or as an indexed array [ 'value'=>$id, 'label'=>$label ], The indexed array is the construct used when create NF select options
Return
array

Class

PluginsLoadedEarly

getRecords public: Get array of all Events

Return
array

Class

PluginsLoadedEarly

contact public: Provide Contact Data Access object

Return
DataAccessContact
activity public: Provide Activity Data Access object

Return
DataAccessActivity
event public: Provide Event Data Access object

Return
DataAccessEvent
note public: Provide Note Data Access object

Return
DataAccessNote
tag public: Provide Tag Data Access object

Return
DataAccessTag
email public: Provide Email Data Access object

Return
DataAccessEmail
phone public: Provide Phone Data Access object

Return
DataAccessPhone
iM public: Provide Im Data Access object

Return
DataAccessIm
participant public: Provide Participant Data Access object

Return
DataAccessParticipant
address public: Provide Address Data Access object

Return
DataAccessAddress
group public: Provide Group Data Access object

Return
DataAccessGroup
groupContact public: Provide GroupContact Data Access object

Return
DataAccessGroupContact

Class

PluginsLoadedEarly

getRecords public: Get array of all Groups

Return
array

Class

PluginsLoadedEarly

getRecords public: Get array of all Tags

Return
array

Class

PluginsLoadedEarly

process public: Process the form submission data

Return
ModuleProcessor
setSubmissionData public: Set submission Data array

Param
array $submissionData Submission Data array

Return
ModuleProcessor
setRecordIds public: Set array of previously constructed (or matched) Ids

Param
array $recordIds Array of previously constructed (or matched) Ids

Return
ModuleProcessor
getRecordIds public: Get array of previously constructed (or matched) Ids

Return
array
getResponses public: Get collection of CreateObjectResponse objects

Return
CreateObjectResponse[]
isDupe public: Is this processing a previously matched duplicate?
Indicates if the processor will be working on a previously matched duplicate. Important because some processors, like an email, won't run if previously matched on an email.

Return
boolean
setIsDupe public: Sets bool - is this processing a previously matched duplicate

Param
boolean|null $isDupe
Return
ModuleProcessor

Class

PluginsLoadedEarly

getObject public: Return current ModuleProcessor

Param
int $position
Return
ModuleProcessor|null
addObject public: Add a Module Processor to the collection

Param
ModuleProcessor $moduleProcessor
Return
ModuleProcessorCollection

Class

PluginsLoadedEarly

getModuleProcessors public

Class

Activity

__construct public

Class

Address

__construct public

Class

Contact

__construct public

Class

DataAccessAbstract

__construct public
getFieldDefinitionIdLabelPairs public: Get Id Label pairs for the entity
ID = name for a given field
Return
array
constructIdLabelPairs protected: Construct the Id Label pairs

Return
void
initializeFields protected

Class

Email

__construct public

Class

Event

__construct public
getRecords public

Class

Group

__construct public
getRecords public: Get Group records

Return
array

Class

GroupContact

__construct public

Class

Im

__construct public

Class

Note

__construct public

Class

Participant

__construct public

Class

Phone

__construct public

Class

Tag

__construct public
getRecords public

Class

Website

__construct public

Class

DataAccessFactory

Provide DataAccess objects per Contract

__construct public
contact public: @inheritDoc
activity public: @inheritDoc
event public: @inheritDoc
tag public: @inheritDoc
participant public: @inheritDoc
email public: @inheritDoc
phone public: @inheritDoc
iM public: @inheritDoc
website public: @inheritDoc
note public: @inheritDoc
address public: @inheritDoc
group public: @inheritDoc
groupContact public: @inheritDoc

Class

MasterFactory

Instantiates and provides requested objects
Primarily this factory is used for objects that require complex construction dependent on other classes, or require runtime-only construction.

__construct public: Construct with a configure object and CiviCrm Factory
Param
Configure $configure
Param
CiviObjectsFactory $civiObjectsFactory
createContactFormAction public: Construct CreateChainedContacts form action

Return
FormAction
createOrderAction public: Construct CreateOrder form action

Return
FormAction
submissionMetaboxCreateEntries public: Constructs object that outputs submission metabox

Return
SubmissionMetabox
dataAccessFactory public: Provide DataAccessFactory

Return
ContractsDataAccessFactory
verifyDbConnection public: Construct VerifyDbConnection object

Return
VerifyDbConnection
moduleProcesorFactory protected: Construct ModuleProcessorFactory

Return
ModuleProcessorFactory
constructCreateContactActionConfiguration protected: Consolidate the action settings required for the CreateChainedContact action Each
constructCreateOrderActionSettings protected: Merge CreateOrder settings into single ActionSettings configuration
setBypassCivi public: Set boolean to bypass CiviCrm, using mocks

Param
bool $bypassCivi Boolean to bypass CiviCrm, using mocks

Return
MasterFactory

Class

ModuleProcessorFactory

__construct public
getModuleProcessors public: Provide a collection of Module Processors Constructs required form processors in processing order

Return
ContractsModuleProcessorCollection

Class

FilterSettingsOutput

Modify the configured plugin settings
By extending the shared abstract class, this class is responsible for a single method `modifyConfiguredSettings` to dynamically alter the plugin settings. This class creates a collection of UI buttons which, when coupled with the AJAX handler class, provides single page UI functionality.

Package

Settings

__construct public: Construct with filter tag and Markup object

Param
string $filterTag
Param
NfAdminMarkup $markup
modifyConfiguredSettings protected: @inheritDoc
markupButtonControls protected: Add buttons to Settings page

Class

ModuleProcessorCollection

Collection of ModuleProcessors

getObject public: @inheritDoc
addObject public: @inheritDoc
count public: Return count of objects in collection

Return
integer
current public: Return current module processor

Return
ModuleProcessor
next public: Move to next ModuleProcessor

Return
void
key public: Return current index position in collection

Return
integer
valid public: Ensure element at current position is a valid object of the aggregate

Return
boolean
rewind public: Move pointer back to initial position

Return
void

Class

NfPluginSettingsAjax

Provide AJAX functionality for the plugin settings Functionality provided includes: 1. Button click to toggle diagnostics view 2. Button click to verify DB connectivity 3. Button click to display available events 4. Button click to display available groups 5. Button click to display available tags 6. Button click to display log

__construct public: Handle AJAX calls on NF Plugin Settings page

Param
string $rootDirectory
Param
VerifyDbConnection $verifyDbConnection
Param
DataAccessEvent $dataAccessEvent
Param
DataModelProvider $dataModelProvider
Param
NfAdminMarkup $nfSettingsMarkup
Param
LoggerInterface $logger
initializeLocalizedArray protected: Initialize data sent to JS with a nonce and current `showDiagnostics` preference
Generate and pass a nonce tagged with this class's (string) handle. Also, this retrieves the stored NF setting of a boolean value on whether to display or hide the diagnostics.
processAjaxRequest protected: Process the AJAX request, returning keyed array
Expecting keyed values for wpRestNonce, context, and showDiagnostics. After verifying nonce, this method uses the context to switch among the allowed functionality; in this case, the options are to toggle the diagnostics, verify the database connect, and retrieve events.
markupLog protected: Markup log for settings page output
Because timestamp values are not unique, it cannot be used as a key for the key->value standardized markup. This method provides similar markup and may get standardized into the Shared folder if it becomes use in multiple locations.
Param
array $log
Return
string

Class

SubmissionMetabox

Add SubmissionMetabox to output ExtraDataHandler data
This class iterates through each each of the HandledResponses to output the information into the submission metabox.

See

NinjaForms\CiviCrmShared\Handlers\ExtraDataHandler

__construct public: @inheritDoc
outputHandledResponse protected: Output the pertinent handled response data for a given response

Param
array $handledResponse
Return
string
successfulResponseOutput protected: Markup HTML for a successful submission response

Param
HandledResponse $objectResponse
Return
string
outputActionHeading protected: Output the action heading, with plural text option
Return
string
addNoResponseDataMarkup protected: @inheritDoc

Class

VerifyDbConnection

Verifies DB connection by retrieving a contact field definition

__construct public
handle public: Run verification process

Return
VerifyDbConnection
verified public: Return boolean - is connection verified?

Return
boolean
getProof public: Get connection proof - key value pairs Returns key-value pairs of a contact field definition

Return
array
getVerificationDescription public

Class

Master

Master class for Ninja Forms CiviCrm
The Master class is the primary class for a given package. The plugin will have a master class and packages such as an internal SDK for integration can also have its own master class, depending on the complexity.
The Master class extends the abstract Master class in the Shared directory; the abstract class standardizes common functionality such as registering plugin settings or advanced form settings. In doing so, the package developer can focus on the specific plugin functionality.
The `registerServices` method uses a Container to register and provide dependent classes downstream. In certain cases, such as complex class construction, classes requiring run-time construction, or a large family of similar classes, this class can register a factory, which then delivers the other classes as requested.

registerServices public: @inheritDoc

Class

function

Class

ActivityProcessor

__construct public: Construct

Param
SdkObject $sdkObject
Param
DataModelProvider $dataModelProvider
Param
LoggerInterface $logger
process public: @inheritDoc

Class

AddressProcessor

__construct public: Construct

Param
SdkObject $sdkObject
Param
LoggerInterface $logger
process public: @inheritDoc
extractSubmissionData protected: Extract field mapping data from SubmissionData
Where a key substitute is required (ex:a key structure we don't want to use as a select field lookup key), the lookup values replace our safe value with the API's value.

Return
array

Class

ContactProcessor

__construct public: Construct

Param
SdkObject $sdkObject
process public: @inheritDoc

Class

'_process'

createNewContact protected: Create a new contact from submission data

Return
void
constructFieldMapping protected: Construct contact field mapping from dataModelProvider

Return
array
contactDedupe protected

Class

CreateChainedContact

Create CiviCRM Contact with chained child objects ### Functionality ### 1. Create a new Contact 2. Create multiple emails linked to Contact using pre-defined 'location names' 3. Create multiple address linked to Contact using pre-defined 'location names' 4. Create a new Activity linked to Contact 5. Subscribe contact to a group 6. Add tags to contact and activity 7. Add line items for events and memberships 8. Add participants directly to free events 9. Add note to contact or participant 10. Uniquely identify contact when creating multiple contacts on same form 11. Option to disable storage of communication diagnostics data (not the actual submission data)

Package

FormProcessing

__construct public: Construct
Param
array $actionConfiguration
Param
ContractsCiviObjectsFactory $civiObjectsFactory
Param
DataModelProvider $dataModelProvider
Param
ExtraDataHandler $extraDataHandler
Param
ModuleProcessorFactory $moduleProcessFactory
Param
LoggerInterface $logger
finalizeActionSettings public: Override the parent's action settings with runtime values
Update the field map drop down values with constructed values from Civi Objects. CiviCrm is not initialized by the time the action settings must be registered, so only get the field values when the actual output is being generated in a form build. The dataModelProvider class handles the structuring of the data.
See
\NinjaForms\CiviCrmShared\Contracts\DataModelProvider
Return
array
finalizeContactFields protected: Populate contact fields

Return
void
finalizeContactTypes protected: Populate contact type and subtype
types/subtypes contained in one object; differentiator is presence of a parent_id, which designates it as a sub type
Return
void
finalizeAddressFields protected: Adds select options with common name label and ISO country code value
Not currently used; this option was switched out to enable merge tags to set value; this option can be used if a hard-coded mapping is required

Return
void
finalizeActivityFields protected: Populate activity fields

Return
void
modifyActivityFieldMap protected: Retrieve label value pairs for all Activity fields, except status and type

Return
void
modifyActivityLookups protected: Populate the Actity Stype dropdown with available statuses (sp?) for Contacts

Return
void
findActivityGroupIds protected: Get OptionGroup Ids for activity type and status

Return
array Indexed array of [activityTypeGroupId,activityStatusGroupId]
findActivityLookups protected: Finds lookups for Activity type and status

Return
array Indexed array of [ activityTypeNameLabel, activityStatusNameLabel]
finalizeCreateGroupContact protected: Populate group dropdown select values

Return
void
finalizeCreateEntityTag protected: Populate tag field map as dropdown

Return
void
finalizeContactMatchOptions protected: Populate ContactMatchOptions with DedupeRuleGroups for `Individuals`

Return
void
findDedupeRuleGroupsForIndividuals protected: Returns collection of DedupeRuleGroup where contact type is Individual
Returns indexed array of DedupeRuleGroup-as-associative array. Each element is ensured to have `contact_type`, `id` and `title`, so these can be referenced without checking isset

Return
array
processSubmissionData public: @inheritDoc

Class

CreateOrder

Create CiviCRM Order from all line items ### Functionality ###

Package

FormProcessing

__construct public: Param
array $actionConfiguration Action configuration array
Param
ContractsCiviObjectsFactory $civiObjectsFactory Factory to provide SDK objects for making API requests
Param
DataModelProvider $dataModelProvider
Param
ExtraDataHandler $extraDataHandler
finalizeActionSettings public: Override the parent's action settings with runtime values
Update the field map drop down values with constructed values from Civi Objects. CiviCrm is not initialized by the time the action settings must be registered, so only get the field values when the actual output is being generated in a form build. The dataModelProvider class handles the structuring of the data.
See
\NinjaForms\CiviCrmShared\Contracts\DataModelProvider
Return
array
processSubmissionData public: @inheritDoc
consolidateLineItems protected: Consolidate all line items from preceding actions

Return
void

Class

EmailProcessor

__construct public: Construct

Param
SdkObject $sdkObject
Param
LoggerInterface $logger
process public: @inheritDoc
extractSubmissionData protected: Extract field mapping data from SubmissionData
Where a key substitute is required (ex:a key structure we don't want to use as a select field lookup key), the lookup values replace our safe value with the API's value.

Return
array

Class

GroupContactProcessor

__construct public: Construct

Param
SdkObject $sdkObject
Param
LoggerInterface $logger
process public: @inheritDoc

Class

ImProcessor

__construct public: Construct

Param
SdkObject $sdkObject
Param
LoggerInterface $logger
process public: @inheritDoc
extractSubmissionData protected: Extract field mapping data from SubmissionData
Where a key substitute is required (ex:a key structure we don't want to use as a select field lookup key), the lookup values replace our safe value with the API's value.

Return
array

Class

LineItemProcessor

__construct public: Construct

Param
SdkObject $sdkObject
Param
LoggerInterface $logger
process public: @inheritDoc
getLineItemsSubmissionData protected: Manually construct each line item from option repeater row This should be refactored into something more scalable; this is meant to test data structures only

Param
string $actionSettingKey
Return
array

Class

ModuleProcessorAbstract

process public
setSubmissionData public: @inheritDoc
setRecordIds public: @inheritDoc
getRecordIds public: @inheritDoc
getResponses public: @inheritDoc
isDupe public: @inheritDoc
setIsDupe public: @inheritDoc

Class

NoteProcessor

__construct public: Construct

Param
SdkObject $sdkObject
Param
LoggerInterface $logger
process public: @inheritDoc

Class

ParticipantProcessor

__construct public: Construct

Param
SdkObject $sdkObject
Param
LoggerInterface $logger
process public: @inheritDoc

Class

PhoneProcessor

__construct public: Construct

Param
SdkObject $sdkObject
Param
LoggerInterface $logger
process public: @inheritDoc
extractSubmissionData protected: Extract field mapping data from SubmissionData
Where a key substitute is required (ex:a key structure we don't want to use as a select field lookup key), the lookup values replace our safe value with the API's value.

Return
array

Class

TagEntityProcessor

__construct public: Construct

Param
SdkObject $sdkObject
Param
LoggerInterface $logger
process public: @inheritDoc
createTag protected: Request SDK object to create tag

Param
array $array
Return
void

Class

WebsiteProcessor

__construct public: Construct

Param
SdkObject $sdkObject
Param
LoggerInterface $logger
process public: @inheritDoc
extractSubmissionData protected: Extract field mapping data from SubmissionData
Where a key substitute is required (ex:a key structure we don't want to use as a select field lookup key), the lookup values replace our safe value with the API's value.

Return
array

Class

ContactsTest

getFieldDefinitionIdLabelPairsEmpty public: Ensure IdLabel pairs are constructed correctly on empty array @test
getFieldDefinitionIdLabelPairsTypical public: Ensure IdLabel pairs are constructed correctly on with values @test
contractsContact protected

Class

$fieldsCollection

__construct public
getFields public
create public
hasMatch public: Does contact have a match
getMatchingId public: Return the matching contact id
getResponse public: Return the CreateObjectResponse
Return
CreateObjectResponse

Class

DataAccessFactoryTest

testConstructsInBypass public: Test that all required methods produce objects while in bypass
Only bypass mode can work in unit tests since there is no CiviCrm plugin to provide the working classes. @test

Class

setUp public: @inheritDoc

Class

ModuleProcessorCollectionTest

testEmptyUsersCollection public: @test
testUsersCollectionWithUserElements public: @test

Class

$collection

getMockModuleProcessor protected: Return mocked ModuleProcessor

Return
ModuleProcessor
process public: Process the form submission data

Return
ModuleProcessor
setSubmissionData public: Set submission Data array

Param
array $submissionData Submission Data array

Return
ModuleProcessor
setRecordIds public: Set array of previously constructed (or matched) Ids

Param
array $recordIds Array of previously constructed (or matched) Ids

Return
ModuleProcessor
getRecordIds public: Get array of previously constructed (or matched) Ids

Return
array
getResponses public: Get collection of CreateObjectResponse objects

Return
CreateObjectResponse[]
isDupe public: Is this processing a previously matched duplicate?
Indicates if the processor will be working on a previously matched duplicate. Important because some processors, like an email, won't run if previously matched on an email.

Return
boolean
setIsDupe public: Sets bool - is this processing a previously matched duplicate

Param
boolean|null $isDupe
Return
ModuleProcessor

Class

MasterTest

ensureServicesRegistered public: Ensure that all required services are register @test
/

Class

PluginTestCase

setUpUnitTestMockEnvironment public: Sets up a mock environment for unit tests Adds just enough function shims to do unit testing in specific areas. Unit tests must not rely upon any of the shimmed functions, which are present only to prevent construction errors from missing function dependencies.

Return
void
defineAbspath protected: Set ABSPATH to the Wordpress directory

Return
void
UnitShims protected: Include WP shims not handled by Brain Monkey

Return
void
shimNinjaForms protected: Shim basic Ninja_Forms() functionality to enable unit testing

Return
void
configureGetOption public: Mock get_option and update_option with global array variable

Param
array $incomingOptions
Return
void
configure public: Return a configuration array
Param
string $configurationName
Param
string $extension
Return
array

Class

GroupContactProcessorTest

ensureObjectToTestConstruct public: @test

Class

ensureMissingEntityTagDataContinuesWithoutErrors public: @test
constructObjectToTest protected: Return mocked ModuleProcessor

Return
void
__construct public
createGroup protected

Class

NoteProcessorTest

ensureObjectToTestConstruct public: @test

Class

ensureMissingEntityTagDataContinuesWithoutErrors public: @test
constructObjectToTest protected: Return mocked ModuleProcessor

Return
void
__construct public
createNote protected

Class

TagEntityProcessorTest

ensureObjectToTestConstruct public: @test

Class

ensureMissingEntityTagDataContinuesWithoutErrors public: @test
constructObjectToTest protected: Return mocked ModuleProcessor

Return
void
__construct public
createTag protected

Class

add_shortcode <?php

Class

esc_html__ <?php

Class

get_option
update_option

Class

Ninja_Forms

This is a shim for Ninja Forms; it does not function, but it provides the named functionality such that unit tests for classes that call Ninja_Forms() on construct can be instantiated without errors. The unit tests calling this instance MUST NOT use any Ninja_Forms() functionality as the results cannot be trusted. Such integration tests will require an environment in which a true Ninja_Forms() class can operate.

instance public
form public: Form Model Factory Wrapper

Param
$id
Return
NF_Abstracts_ModelFactory
logger public: Logger Class Wrapper
Example Use: Ninja_Forms()->logger()->log( 'debug', "Hello, {name}!", array( 'name' => 'world' ) ); Ninja_Forms()->logger()->debug( "Hello, {name}!", array( 'name' => 'world' ) );

Return
string
dispatcher public
eos public
session public
request public
background_process public
get_setting public: Get a setting

Param
string $key
Param
bool|false $default
Return
bool
get_settings public: Get all the settings

Return
array
update_setting public: Update a setting

Param
string $key
Param
mixed $value
Param
bool|false $defer_update Defer the database update of all settings
update_settings public: Save settings to database

Param
array $settings
template public
config public
Ninja_Forms /** * The main function responsible for returning The Highlander Ninja_Forms * Instance to functions everywhere. * * Use this function like you would a global variable, except without needing * to declare the global. * * Example: <?php $nf = Ninja_Forms(); ?> * * @since 2.7 * @return Ninja_Forms Highlander Instance */

Class

Ninja_Forms

plugins_url <?php
is_ssl

Class

Ninja_Forms

__

Class

Ninja_Forms

remove_all_filters /** * Remove all of the hooks from a filter. * * @since 2.7.0 * * @global WP_Hook[] $wp_filter Stores all of the filters and actions. * * @param string $tag The filter to remove hooks from. * @param int|false $priority Optional. The priority number to remove. Default false. * @return true True when finished. */: The plugin API is located in this file, which allows for creating actions and filters and hooking functions, and methods. The functions or methods will then be run when the action or filter is called.
The API callback examples reference functions, but can be methods of classes. To hook methods, you'll need to pass an array one of two ways.
Any of the syntaxes explained in the PHP documentation for the {
Link
https://www.php.net/manual/en/language.pseudo-types.php#language.types.callback 'callback'} type are valid.
Also see the {
Link
https://developer.wordpress.org/plugins/ Plugin API} for more information and examples on how to use a lot of these functions.
This file should have no external dependencies.

Package
WordPress
Subpackage
Plugin
Since
1.5.0
current_action /** * Retrieve the name of the current action. * * @since 3.9.0 * * @return string Hook name of the current action. */
remove_all_actions /** * Remove all of the hooks from an action. * * @since 2.7.0 * * @param string $tag The action to remove hooks from. * @param int|false $priority The priority number to remove them from. Default false. * @return true True when finished. */
plugin_basename /** * Gets the basename of a plugin. * * This method extracts the name of a plugin from its filename. * * @since 1.5.0 * * @global array $wp_plugin_paths * * @param string $file The filename of plugin. * @return string The name of a plugin. */
wp_register_plugin_realpath /** * Register a plugin's real path. * * This is used in plugin_basename() to resolve symlinked paths. * * @since 3.9.0 * * @see wp_normalize_path() * * @global array $wp_plugin_paths * * @param string $file Known path to the file. * @return bool Whether the path was able to be registered. */
plugin_dir_path /** * Get the filesystem directory path (with trailing slash) for the plugin __FILE__ passed in. * * @since 2.8.0 * * @param string $file The filename of the plugin (__FILE__). * @return string the filesystem path of the directory that contains the plugin. */
plugin_dir_url /** * Get the URL directory path (with trailing slash) for the plugin __FILE__ passed in. * * @since 2.8.0 * * @param string $file The filename of the plugin (__FILE__). * @return string the URL path of the directory that contains the plugin. */
register_activation_hook /** * Set the activation hook for a plugin. * * When a plugin is activated, the action 'activate_PLUGINNAME' hook is * called. In the name of this hook, PLUGINNAME is replaced with the name * of the plugin, including the optional subdirectory. For example, when the * plugin is located in wp-content/plugins/sampleplugin/sample.php, then * the name of this hook will become 'activate_sampleplugin/sample.php'. * * When the plugin consists of only one file and is (as by default) located at * wp-content/plugins/sample.php the name of this hook will be * 'activate_sample.php'. * * @since 2.0.0 * * @param string $file The filename of the plugin including the path. * @param callable $function The function hooked to the 'activate_PLUGIN' action. */
register_deactivation_hook /** * Set the deactivation hook for a plugin. * * When a plugin is deactivated, the action 'deactivate_PLUGINNAME' hook is * called. In the name of this hook, PLUGINNAME is replaced with the name * of the plugin, including the optional subdirectory. For example, when the * plugin is located in wp-content/plugins/sampleplugin/sample.php, then * the name of this hook will become 'deactivate_sampleplugin/sample.php'. * * When the plugin consists of only one file and is (as by default) located at * wp-content/plugins/sample.php the name of this hook will be * 'deactivate_sample.php'. * * @since 2.0.0 * * @param string $file The filename of the plugin including the path. * @param callable $function The function hooked to the 'deactivate_PLUGIN' action. */
register_uninstall_hook /** * Set the uninstallation hook for a plugin. * * Registers the uninstall hook that will be called when the user clicks on the * uninstall link that calls for the plugin to uninstall itself. The link won't * be active unless the plugin hooks into the action. * * The plugin should not run arbitrary code outside of functions, when * registering the uninstall hook. In order to run using the hook, the plugin * will have to be included, which means that any code laying outside of a * function will be run during the uninstallation process. The plugin should not * hinder the uninstallation process. * * If the plugin can not be written without running code within the plugin, then * the plugin should create a file named 'uninstall.php' in the base plugin * folder. This file will be called, if it exists, during the uninstallation process * bypassing the uninstall hook. The plugin, when using the 'uninstall.php' * should always check for the 'WP_UNINSTALL_PLUGIN' constant, before * executing. * * @since 2.7.0 * * @param string $file Plugin file. * @param callable $callback The callback to run when the hook is called. Must be * a static method or function. */
_wp_call_all_hook /** * Call the 'all' hook, which will process the functions hooked into it. * * The 'all' hook passes all of the arguments or parameters that were used for * the hook, which this function was called for. * * This function is used internally for apply_filters(), do_action(), and * do_action_ref_array() and is not meant to be used from outside those * functions. This function does not check for the existence of the all hook, so * it will fail unless the all hook exists prior to this function call. * * @since 2.5.0 * @access private * * @global WP_Hook[] $wp_filter Stores all of the filters and actions. * * @param array $args The collected parameters from the hook that was called. */
_wp_filter_build_unique_id /** * Build Unique ID for storage and retrieval. * * The old way to serialize the callback caused issues and this function is the * solution. It works by checking for objects and creating a new property in * the class to keep track of the object and new objects of the same class that * need to be added. * * It also allows for the removal of actions and filters for objects after they * change class properties. It is possible to include the property $wp_filter_id * in your class and set it to "null" or a number to bypass the workaround. * However this will prevent you from adding new classes and any new classes * will overwrite the previous hook by the same class. * * Functions and static method callbacks are just returned as strings and * shouldn't have any speed penalty. * * @link https://core.trac.wordpress.org/ticket/3875 * * @since 2.2.3 * @since 5.3.0 Removed workarounds for spl_object_hash(). * `$tag` and `$priority` are no longer used, * and the function always returns a string. * @access private * * @param string $tag Unused. The name of the filter to build ID for. * @param callable $function The function to generate ID for. * @param int $priority Unused. The order in which the functions * associated with a particular action are executed. * @return string Unique function ID for usage as array key. */

Class

VerifyTestStructureTest

ensureTestSuiteRuns public: @test

Class

CiviFieldDefinitionTest

constructFromExpectedValues public: Ensure valid construction @test
constructFromEmptyValues public: Ensure valid construction from empty array, with isApiError set @test

Class

CiviFieldDefinitionTest

constructFromEmptyArray public: Empty array constructs entity and returns array @test
/
constructFromFullArray public: Full array constructs entity and returns array @test
/
constructFromNullArray public: Null array constructs entity and returns array @test
/

Class

CreateObjectResponseTest

Test CreateObjectResponse - child extensions only Parent class has its own test

constructFromEmptyArray public: Empty array constructs entity and returns array @test
/
constructFromFullArray public: Full array constructs entity and returns array @test
/
constructFromNullArray public: Null array constructs entity and returns array @test
/

Class

GetEventsResponseTest

constructFromEmptyArray public: Empty array constructs entity and returns array @test
/
constructFromFullArray public: Full array constructs entity and returns array @test
/
constructFromNullArray public: Null array constructs entity and returns array @test
/

Class

GetGroupsResponseTest

constructFromEmptyArray public: Empty array constructs entity and returns array @test
/
constructFromFullArray public: Full array constructs entity and returns array @test
/
constructFromNullArray public: Null array constructs entity and returns array @test
/

Class

GetTagsResponseTest

constructFromEmptyArray public: Empty array constructs entity and returns array @test
/
constructFromFullArray public: Full array constructs entity and returns array @test
/
constructFromNullArray public: Null array constructs entity and returns array @test
/

Class

MasterTest

ensureServicesRegistered public: Ensure that all required services are register @test
/

Class

FormActionProcessorTest

ensureObjectToTestConstruction public: Ensure object construction
@test
Return
void

Class

testUndefinedKey public: Ensures that submissions without keys don't throw warnings
@test
Return
void
constructObjectToTest protected

Class

$actionConfiguration

processSubmissionData /** @inheritDoc */
exposeExtractSubmissionData public

Class

HandledResponseTest

constructFromEmptyArray public: Empty array constructs entity and returns array @test
/
constructFromFullyDefinedArray public: Construct from a fully defined array @test
constructFromNullArray public: Null array constructs entity and returns array @test
/

Class

PluginSettingTest

constructFromEmptyArray public: Empty array constructs entity and returns array @test
/
constructFromFullyDefinedArray public: Construct from a fully defined array @test

Class

PluginSettingsTest

constructFromEmptyArray public: Empty array constructs entity and returns array @test
/
constructFromFullyDefinedArray public: Construct from a fully defined array @test
addPluginSetting public: @test
getPluginSettings public: Ensure getPluginSettings returns array of PluginSetting objects keyed on ids @test

Return
void
getPluginSettingsArray public: Ensure getPluginSettingsArray returns array of PluginSetting arrays keyed on ids
@test
Return
void

Class

DataModelsTest

fullyFormedColumnsFromCollected public: columnsFromExpected when data is fully formed @test
/
missingKeysColumnsFromCollected public: columnsFromExpected when collection is missing keys @test
/
emptyCollectionColumnsFromCollected public: columnsFromExpected when collection is empty @test
/
nullCollectionColumnsFromCollected public: columnsFromExpected when collection is null @test
/
fullyFormedKeyValuePairsFromCollection public: keyValuePairsFromCollection when data is fully formed @test
/