Ninja Forms Developer Docs

Class

Configure

Provides configured ApiModule-specific entities

__construct public: Instantiate with top-level file directory to provide access throughout

Param
string $dir
globalSettings public: Return ApiModule's configured GlobalSettings entity

Return
GlobalSettings
formFields public: Return ApiModule's configured FormFields entity

Return
FormFields
moduleConfig public: Return module configuration specifying module data requirements

Class

CreateRecordsFormActionHandler

Handle a submitted form's action request to create records in the API account This class is activated for the form action handling process. It is instantiated with the standard fields; shortly after, the custom fields are set by the instantiating plugin. When the form is submitted, the SubmissionData provides the form submission data and this class can match up submission data with the ApiFormFields to make the requests.

__construct public: Instantiate with top level API Module
Param
Hubspot $apiModule
handle public: Make requests to CreateRecords based on SubmissionData instructions
Param
SubmissionDataContract $submissionData
Param
FormContract $form
preHandle protected: Perform platform specific pre-handling required This method provides access to the properties during the handling process such that NF or CF child classes can adjust values as required.
Return
void
postHandle protected: Perform platform specific post-handling required This method provides access to the properties during the handling process such that NF or CF child classes can adjust values as required.
Return
void
extractGlobalSettings protected: Extract required Global Settings from SubmissionData Hubspot does not refresh the API Key so the initial value stored in the SDK at initialization suffices. Hubspot does offer an OAuth integration, which we may at some point need to implement. With this standard method already implemented, we know that we have a method of retrieving dynamic settings from the submission, which OAuth (and possibly other API implementations) require
extractStandardFields protected: Extract standard fields from SubmissionData
extractCustomFields protected: Extract custom fields from SubmissionData
validateValueByFieldType protected: Given raw value and field type, validate value for API compliance

Param
mixed $rawValue
Param
string $fieldType
Return
void
formatDateField protected: Given a raw value, convert it to a UNIX timestamp with microseconds

See
https://salferrarello.com/hubspot-api-call-fail-invalid_date-not-midnight/
Param
mixed $rawValue
Return
integer
setStandardApiFormFields protected: Get the standard ApiFormFields, configured by top level API Module
setCustomApiFormFields public: Set the custom FormFields
Param
FormFields $customApiFormFields
Return
FormActionHandler

Class

Hubspot

Exposes the top-level API of the package

getGlobalSettings public: Return GlobalSettings configured for the ApiModule
May NOT include values, as that must be provided by integrating plugin.

Return
GlobalSettings
setGlobalSettings public: Set GlobalSettings from external source, with values from data source
ApiKey authorization does not need storage capability as OpenAuth does, so we need only the GlobalSettings with values as initiated.

Param
GlobalSettings $globalSettings

Return
HubspotContract
getRemoteRequest public: Return the RemoteRequest
If not explicitly set by external source, default remote request used

Return
RemoteRequestContract
setRemoteRequest public: Set RemoteRequest

Param
RemoteRequestContract $remoteRequest
Return
HubspotContract
getModuleConfig public: Return Module Configuration

Return
array
sdk public: Provide the SDK for communication access to the API

Return
HubspotSdk
getFormFields public: Return standard FormFields configured for the ApiModule

Return
FormFields
getIdentifier public: @inheritDoc
registerServices public: Register the module's services

Return
Module

Class

HubspotSdk

Handles communication to and from the Api This class is constructed by the ApiModule with a RemoteRequest and ApiKey, after which it can be provided to the Integrating Plugin for use.

__construct public: Instantiate the ApiModule SDK
Param
RemoteRequestContract $remoteRequest
Param
string $apiKey
Param
array $moduleConfig
getContactFields public: Return all standard and custom Contact fields
Return
FormFields
getCompanyFields public: Return all standard and custom Contact fields
Return
FormFields
getDealFields public: Return all standard and custom Deal fields
Return
FormFields
getTicketFields public: Return all standard and custom Ticket fields
Return
FormFields
createEntry public: Make request to create entry(ies) from form submission
Param
array $unsortedRequest
Return
array
createModules protected: Iterate unsorted request to make requests to add entries
Param
array $unsortedRequest
createModule protected: Make request to create the given module using the unsorted request data
Param
string $module
Return
HandledResponse|null
extractIds protected: Extract Id of newly created entry with which to construct associations
Param
string $module
buildAssociations protected: Check if two entries have Ids that can be linked; add them to association array
Param
string $associationKey
Return
void
createAssociations protected: Make all associations requests Associations link created entries together
Return
void
getPropertiesRoute protected: Return Properties route
Return
Properties
getContactsRoute protected: Return Contacts route
Return
Contacts
getCompaniesRoute protected: Return Companies route
Return
Companies
getDealsRoute protected: Return Deals route
Return
Deals
getTicketsRoute protected: Return Tickets route
Return
Tickets
getAssociationsRoute protected: Return Associations route
Return
Associations
getIdArray public: Return ID array - collection of Ids of newly created entries
Return
array
getAssociations public: Return associations array of links between newly created entries
Return
array

Class

ApiClient

__construct public: Construct instance that handles API requests

Param
RemoteRequestContract $remoteRequest
Param
String $apiKey

Return
Void
setEndpoint protected
makeRequest protected: Make request to the specified enpoint, returning the handled response

Return
HandledResponse
constructRequestHeader protected: Construct request header

Return
Void
getAccessToken protected: Returns the Access Token

Return
String
hasAccessToken protected: Checks if access token exists

Return
Bool

Class

Associations

Handles requests made to the Associations route of the API Module

setEndpoint protected: Set fully constructed URL for contact related requests

Param
string $endpoint

Return
Void
createAssociation public: Create a batch of associations

Return
HandledResponse
buildBatchBody protected: Build batch body

Param
Array $association

Return
Array

Class

Companies

Handles requests made to the Companies route of the API Module

setEndpoint protected: Set fully constructed URL for contact related requests

Param
String $endpoint

Return
Void
createCompany public: Create new company entry

Param
String $body

Return
HandledResponse

Class

Contacts

Handles requests made to the Contact route of the API Module

setEndpoint protected: Set fully constructed URL for contact related requests

Param
String $endpoint

Return
Void
createContact public: Create new contact entry

Param
String $body

Return
HandledResponse

Class

ConvertFieldPropertiesIntoFormFields

Converts API-structured response body into standardized FormFields

handle public: Converts API-structured response body into standardized FormFields
Param
string $responseBody
Param
string|null $module
Return
type
extractFields protected: Extract field collection into into field definition keyed on field id
Param
string $module
Param
array $fieldsCollection
extractFieldDefinitions protected: Extract field definition into a FormField structure
Param
string $module
Param
string $key
Param
array $fieldDefinitionArray
appendApiFormField protected: Append field definition array into FormFields collection
Param
array $definitions
getFieldType protected: Determine FormField type from FieldType code Lookup values provided only in API specifications; requires manual method to convert into known FormField types
Param
array $fieldDefinitionArray
Return
string
extractCustomFieldArray protected: Extract custom field array from known location inside API response body

Class

Deals

Handles requests made to the Contact route of the API Module

setEndpoint protected: Set fully constructed URL for related requests

Param
String $endpoint

Return
Void
createDeal public: Create new deal entry

Param
String $body

Return
HandledResponse

Class

ExtractAssociationResponse

Extract Association results from HandledResponse

extractResults public: Extract pertinent information provided in the HandledResponse Used extensively for troubleshooting rejections and other failures
Param
HandledResponse $handledResponse
Return
HandledResponse
checkComplete protected: Check if association is successfully completed
Return
bool
extractErrorData protected: Extract error data when error is previously confirmed

Class

ExtractCreateEntryResults

Extract CreateEntry results from HandledResponse

extractResults public: Extracts success response and troubleshooting support data on rejection
Param
HandledResponse $handledResponse
Return
HandledResponse
extractId protected: Extract returned Id If request is accepted, response includes Id of newly created entry
Return
bool True fi Id extracted, false if not extracted
extractBodyMessages protected: Extract body messages, if present, into error messages array
decodeMessage protected: Check for/extract for encoded troubleshooting data within message
Param
string $message
Return
string

Class

Properties

Handles requests made to the Contact route of the API Module

setEndpoint protected: Set fully constructed URL for contact related requests

Param
String $endpoint

Return
Void
getContactProperties public: Get Contact properties (standard and custom field definitions)

Return
HandledResponse
getCompanyProperties public: Get Companies properties (standard and custom field definitions)

Return
HandledResponse
getDealProperties public: Get Deal properties (standard and custom field definitions)

Return
HandledResponse
getTicketProperties public: Get Ticket properties (standard and custom field definitions)

Return
HandledResponse

Class

Tickets

Handles requests made to the Contact route of the API Module

setEndpoint protected: Set fully constructed URL for related requests

Param
String $endpoint

Return
Void
createTicket public: Create new ticket entry

Param
String $body

Return
HandledResponse

Class

AutogenerateForm

Autogenerates a Ninja Form

__construct public: Construct AutogenerateForm

Param
array $actionEntity
Param
FormFields $standardApiFormFields
Param
FormFields $customApiFormFields
handle public: Construct a Ninja Form per set FormFields, Action Configuration, and title
Param
string $listId
Param
string $formTitle
constructApiFields protected: Combine standard- and custom- ApiFormFields into a single collection
constructNinjaFormWithAction public: Construct a new NF form per FormField and ActionConfiguration

Return
void
initializeForm protected: Initialize a new form
setNfFormTitle protected: Set the NF form title
addFormFields protected: Add form fields
addSubmitButton protected: Add submit button to the form
Return
void
addActionFieldMap protected: Add action field map for given field key
Param
string $key
Return
void
addCreateEntryAction protected: Add the action to the form
addSaveAction protected: Add Store Submission (programmatic name: save) to the form
addSuccessMessageAction protected: Add Store Submission (programmatic name: save) to the form
getFormId public: Get the newly created form Id
Return
int
getNinjaForm public: Get the constructed Ninja Form
Return
NF_Abstracts_ModelFactory

Class

ConfigureApiSettings

Construct NF settings configuration from ApiSettings

__construct public: Construct NF settings configuration from ApiSettings
Param
ApiSettings $apiSettings
constructSettingsConfig protected: Iterate ApiSettings to construct NF Settings
selectSettingType protected: Return the correct NF setting field type for the expected data type
Param
string $expectedDataType
Return
string
getSettingsConfig public: Return configured NF settings array
Return
array

Class

ConstructActionEntity

Creates the ActionEntity object from which a NF action can be constructed An ActionEntity object is the complete definition of a Ninja Form action. It defines labels and programmatic slugs used for identification.

__construct public: Param
array $actionConfiguration
Param
GlobalSettingsStorageContract $globalSettingsStorage
Param
FormFields $standardApiFormFields
Param
FormFields $customApiFormFields
convertGlobalSettingsToApiSettings protected: Construct ActionEntity's API settings from the global settings The API's global settings are shared construction between CF and NF. API Settings are specific to NF and is used to construct the plugin settings. GlobalSettings and ApiSettings have similar structures and can be passed straight through. This may not always be the case as other integrations or CF may require additional data or structural changes in the GlobalSettings. This method provides a means to convert the GlobalSetting into the standard NF structure in that scenario.
appendIntegrationSpecificGlobalSettings protected: Add Custom Field and Reauthorization buttons to the GlobalSettings By default, no additional settings are appended. An integrating plugin can extend this class and override this method to customize this behavior.
addActionSettings protected: Construct ActionEntity's Action Settings Action Settings are form-specific settings. For CRM applications, this consists primarily of field mapping.
addStandardApiFormFields protected: Add standard API fields to Action Settings
appendCustomFormFields protected: Appends the injected custom FormFields to the action settings
constructActionSettingFromFormField protected: Create a single field map setting for an ApiFormField
Param
FormField $apiFormField
Return
ActionSettings
determineActionSettingGroup protected: Determine the group location for a given FormField Default group is 'primary'. Integrating plugins can extend and override this method to specify custom action settings group.
Param
FormField $apiFormField
Return
string
createActionSettingsGroups public: Create groupings for the action field mapping Enables large lists of field maps to be organized into manageable groups. Default group is 'primary'. Integrating plugins can extend and override this method to specify custom action settings group.
instantiateActionEntity protected: Initialize an ActionEntity with standard values
getActionEntity public: Get the constructed Action Entity
Return
ActionEntity

Class

ConstructActionSetting

Construct a single action setting

createTextboxFieldMap public: Adds field mapping textbox to action settings
Param
string $name
Param
string $label
Param
string $value
createToggleSetting public: Adds toggle setting to action settings
Param
string $name
Param
string $label
Param
int $value

Class

ConstructActionSettings

Construct collection of action settings

__construct public: Construct collection of action settings
addTextboxFieldMap public: Adds field mapping textbox to action settings
Param
string $name
Param
string $label
Param
string $value
addToggleSetting public: Adds toggle setting to action settings
Param
string $name
Param
string $label
Param
int $value
getActionSettings public: Return
ActionSettings

Class

CreateAddNewModal

Generate markup that constructs a Modal entity for Add New forms

handle public: Construct and return the modal
Return
Modal
constructModalContent protected: Construct full markup from incoming modal content
Incoming modal content does not include markup for button or title input This method adds opening and closing div along with input box for title and button with link to endpoint
addFormTitleInput protected: Append form title input box
generateFormTitleTextbox public: Generate HTML for form title text box
Return
string
closeModalContent protected: Close modal content HTML

Class

GetApiSettingsValues

Get API settings per ApiSettings Entity specification
This is the NF version; could be abstracted with contract when compared with CF

__construct public: Inject ApiSettings entity to retrieve values from Ninja Forms
Param
ApiSettings $apiSettings
getApiSettingsValues public: Get API settings stored in core plugin

Return
array

Class

HandleProcessData

Handle NF Process Data
Heavily based on NF_Stripe_Checkout_FormData

__construct public: Incoming NF Process data
Param
array $data
Param
string $actionKey
addFormError public: Add a form error
Param
string $message
Return
\NFHubspot\EmailCRM\NfBridge\Actions\HandleProcessData
appendResponseData public: Append ResponseData array
Param
array $responseData
toArray public: Return process $data array
Return
array

Class

MarkupResponseDataMetabox

Given HandledResponse entity, adds HTML markup for Diagnostic Metabox This class constructs HTML that outputs a given HandledResponse for display inside a Ninja Forms submission metabox. It only provides the markup for a specific handled response, NOT the entire metabox. It is thus constructed such that multiple responses can be displayed inside a single metabox (which would be required in more complex submissions that make multiple requests for a given form submission)

markupHandledResponse public: Returns metabox markup for given HandledResponse
Param
HandledResponse $handledResponse
Return
string
constructMarkup protected: Constructs markup from Handled Response Wraps context as term, with result, record, and error messages as definitions.
constructContext protected: Construct human-readable context - remove underscores/add capitalization
$str array_map
constructResult protected: Construct human readable result as determined by HandledResponse flags
constructRecord protected: Construct string output for a record id if record id is present
constructErrorMessages protected: Construct error meassages from HandledResponse
initialize protected: initialize values for markup, ensuring known default values

Class

NfAction

__construct public: Constructs NF Action for Registration

Param
ActionEntity $actionEntity
Param
NfActionProcessHandlerContract $processHandler
Param
FormProcessorsFactoryContract $formProcessorsFactory
Param
WpHooksContract $wpHooks
extractParameters protected: Extract action entity to properties
initActionSettings public: Initialize action settings
constructPluginSettings protected: Construct plugins settings for the NF Action
constructPluginSettingsGroup protected: Construct group for the plugin settings
getPluginSettings public: Return NF Action plugin settings
Return
array
getPluginSettingsGroup public: Return NF Action plugin settings group
Return
array
save public: Save
process public: NF method called at form submission

Param
array $actionSettings NF Action settings at form submission
Param
int $formId
Param
array $data NF $data passed at form submission
Return
array
get_timing public: Get Timing
Returns the timing for an action.

Return
mixed
get_priority public: Get Priority
Returns the priority for an action.

Return
int
get_name public: Get Name
Returns the name of an action.

Return
string
get_nicename public: Get Nicename
Returns the nicename of an action.

Return
string
get_section public: Get Section
Returns the drawer section for an action.

Return
string
get_image public: Get Image
Returns the url of a branded action's image.

Return
string
get_settings public: Get Settings
Returns the settings for an action.

Return
array|mixed
sort_actions public
loadSettings protected: Loads settings array from FieldSettings config file
Param
array $onlySettings
Return
array

Class

NfNewsletterAction

__construct public: Constructor

Param
ActionEntity $actionEntity
Param
NfActionProcessHandlerContract $processHandler
Param
FormProcessorsFactoryContract $formProcessorsFactory
Param
WpHooksContract $wpHooks
Param
NewsletterExtensionContract $newsletterExtension
extractParameters protected: Extract action entity to properties
initActionSettings public: Initialize action settings
constructPluginSettings protected: Construct plugins settings for the NF Action
constructPluginSettingsGroup protected: Construct group for the plugin settings
getPluginSettings public: Return NF Action plugin settings
Return
array
getPluginSettingsGroup public: Return NF Action plugin settings group
Return
array
save public: Save
process public: NF method called at form submission

Param
array $actionSettings NF Action settings at form submission
Param
int $formId
Param
array $data NF $data passed at form submission
Return
array
get_timing public: Get Timing
Returns the timing for an action.

Return
mixed
get_priority public: Get Priority
Returns the priority for an action.

Return
int
get_name public: Get Name
Returns the name of an action.

Return
string
get_nicename public: Get Nicename
Returns the nicename of an action.

Return
string
get_section public: Get Section
Returns the drawer section for an action.

Return
string
get_image public: Get Image
Returns the url of a branded action's image.

Return
string
get_settings public: Get Settings
Returns the settings for an action.

Return
array|mixed
sort_actions public
loadSettings protected: Loads settings array from FieldSettings config file
Param
array $onlySettings
Return
array
getLists public: Retrieve, cache, return via JSON echo list
getListSettings private: Construct list settings for NF Action
cacheLists private: Cache lists
Param
array $lists

Class

NfSettingsGlobalSettingsStorage

Store and retrieve GlobalSettings using Ninja_Forms()->

__construct public
setGlobalSettings public: @inheritDoc
getGlobalSettings public: @inheritDoc
storeGlobalSettings public: @inheritDoc
retrieveGlobalSettings public: @inheritDoc
storeGlobalSetting public: @inheritDoc
retrieveGlobalSetting public: @inheritDoc

Class

OutputResponseDataMetabox

__construct public: Param
string $extraValueKey
Param
string $label
Param
mixed $markupResponseDataMetabox
render_metabox public: Ninja Forms method that outputs metabox
Param
mixed $post
Param
mixed $metabox
extractResponseData protected: Construct collection of ResponseData entities
addNoResponseDataMarkup protected: Add markup for no response data available

Class

RegisterAction

Registers actions added here with Ninja Forms

__construct public: Register NF Actions with Ninja Forms
Param
WPContract
addNfAction public: Add a NF action for registration
Param
NfActionContract $nfAction
registerActions public: Register actions in the Ninja Forms action registry
Param
array $actions
Return
array
registerPluginSettings public: Merge new API settings into settings collection
Param
array $settings
Return
array
registerPluginSettingsGroups public: Merge new action's settings groups into settings groups collection
Param
array $groups
Return
array

Class

RegisterAction

autogenerateModalMarkup public: Provide a Modal entity for Autogenerating a form from the Add New menu

Return
Modal
actionEntity public: Provide ActionEntity defining the primary action of the integrating plugin

Return
ActionEntity

Class

RegisterAction

constructActionSetting public: Provide an object to construct action setting
constructActionSettings public: Provide an object to construct action settings

Class

RegisterAction

fromNinjaForms public: Create form object form Ninja Forms model factory

Param
\NF_Abstracts_ModelFactory $form
Return
Form

Class

RegisterAction

getWpHooks public: Return a WPContract object
Provide access to Wordpress methods or mocked version
Return
WPContract
getSubmissionData public: Create submission data from a NF form submission

Param
array $formActionSubmissionArray
Param
FormActionFieldCollection $actionSettings
Param
ApiSettings $apiSettings
Return
SubmissionDataContract
getConfigureApiSettings public: Construct NF settings configuration from ApiSettings
Param
ApiSettings $apiSettings
getForm public: Return a form contract from a given NF form model factory
Param
NF_Abstracts_ModelFactory $nfFormModelFactory
Return
FormContract
getGetApiSettingsValues public: Param
ApiSettings $apiSettings
Return
getApiSettingsValues

Class

RegisterAction

getLists public: Get a collection of lists
Param
bool $cacheOkay
Return
array
getMergeVars public: Get Merge Vars for a given list id
Param
string $listId
Return
array
getListInterestCategories public: Get Interest Categories for a given list id
Param
string $listId
Return
array
getInterests public: Get Interests for a given list id and interest category id
Param
string $listId
Param
string $interestCategoryId

Class

RegisterAction

save public: Param
array $action_settings
Return
mixed
process public: Param
string $action_id
Param
int $form_id
Param
array$data
Return
mixed
get_timing public: Get Timing
Returns the timing for an action.

Return
int
get_priority public: Get Priority
Returns the priority for an action.

Return
int
get_name public: Get Name
Returns the name of an action.

Return
string
get_nicename public: Get Nicename
Returns the nicename of an action.

Return
string
get_section public: Get Section
Returns the drawer section for an action.

Return
string
get_image public: Get Image
Returns the url of a branded action's image.

Return
string
get_settings public: Get Settings
Returns the settings for an action.

Return
array|mixed
getPluginSettings public: Return NF Action plugin settings
Return
array
getPluginSettingsGroup public: Return NF Action plugin settings group
Return
array

Class

RegisterAction

constructNinjaFormsAction public: Create NfActionContract from our ActionEntity

Param
ActionEntity $actionEntity
Param
NfActionProcessHandlerContract $processHandler
Param
FormProcessorsFactoryContract $formProcessorsFactory
Param
WpHooksApi $wordpress
Return
NfActionContract
constructNinjaFormsNewsletterAction public: Create Newsletter-extended NfActionContract from our ActionEntity

Param
ActionEntity $actionEntity
Param
NfActionProcessHandlerContract $processHandler
Param
FormProcessorsFactoryContract $formProcessorsFactory
Param
WpHooksApi $wordpress
Param
NewsletterExtensionContract $newsletterExtension
Return
NfActionContract

Class

RegisterAction

getPostProcessData public: Return Ninja Forms $data submission after processing
Return
array
extractFormFieldProcessingData public: Extract processing data from form fields to return key-value pairs
Some data required by submission action is contained within form fields. Given the form fields data upon submission, extract the required data to return it as key-value pairs such that it can be added to the submission data and processed
Param
array $data Form field process data
Return
array

Class

RegisterAction

getSubmissionData public: Creates submission data from a NF form submission
Param
array $formActionSubmissionArray
Param
FormActionFieldCollection $actionSettings
Return
SubmissionDataContract

Class

ActionEntity

Entity to construct NF action

fromArray public
getName public: Return action name
Return
string
getNicename public: Return action nicename
Return
string
getTags public: Return action tags
Return
string
getTiming public: Return action timing
Return
string
getPriority public: Return action priority
Return
int
getActionSettings public: Return action settings
Return
ActionSettings
getApiSettings public: Return API settings
Return
ApiSettings
setName public: Set action name
Param
string $stringValue
Return
ActionEntity
setNicename public: Set action nice name
Param
string $stringValue
Return
ActionEntity
setTags public: Set action type
Param
array $arrayValue
Return
ActionEntity
setTiming public: Set action timing
Param
string $stringValue
Return
ActionEntity
setPriority public: Set action priority
Param
int $intValue
Return
ActionEntity
setActionSettings public: Set action settings
Param
array $keyedSettingsArray
Return
ActionEntity
setApiSettings public: Set API settings settings
Param
array $keyedSettingsArray
Return
ActionEntity

Class

ActionSetting

Single action setting in form design
Field map connect NF form submission data to a specific location by passing the form submission value keyed on the FormActionField's programmatic name

fromArray public
getName public: Return action settings name
Return
string
getType public: Return action settings type
Return
string
getLabel public: Return action settings label
Return
string
getWidth public: Return action settings width
Return
string
getGroup public: Return action settings group
Return
string
getValue public: Return action settings value
Return
string
getHelp public: Return action settings help
Return
string
getOptions public: Return action settings options
Return
Options
getMask public: Return action settings mask
Return
string
getDeps public: Return action settings dependencies
Return
array
getUseMergeTags public: Return action settings useMergeTags
Return
mixed
getSettings public: Return action settings settings
Return
array
getColumns public: Return action settings columns
Return
array
getTmplRow public: Return action settings template row
Return
string
setName public: Set action settings name
Param
string $stringValue
Return
ActionSetting
setType public: Set action settings type
Param
string $stringValue
Return
ActionSetting
setLabel public: Set action settings label
Param
string $stringValue
Return
ActionSetting
setWidth public: Set action settings width
Param
string $stringValue
Return
ActionSetting
setGroup public: Set action settings group
Param
string $stringValue
Return
ActionSetting
setValue public: Set action settings value
Param
string $stringValue
Return
ActionSetting
setHelp public: Set action settings help
Param
string $stringValue
Return
ActionSetting
setOptions public: Set action settings options
Param
Options $options
Return
ActionSetting
setMask public: Set action settings mask
Param
string $stringValue
Return
ActionSetting
setDeps public: Set action settings dependencies
Param
array $arrayValue
Return
ActionSetting
setUseMergeTags public: Set action settings dependencies
Param
mixed $value
Return
ActionSetting
setSettings public: Set action settings settings
Param
array $arrayValue
Return
ActionSetting
setColumns public: Set action settings columns
Param
array $arrayValue
Return
ActionSetting
outputConfiguration public: Return action setting configured for NF Action
Removes unset/null values to enable default NF settings
Return
array

Class

ActionSettings

Describes a collection of NF Bridge Action Settings

__construct public
fromArray public
addActionSetting public: Add an Action Setting to collection

Param
ActionSetting $actionSetting

Return
ActionSettings
getActionSetting public: Get an Action Setting from collection

Param
string $name

Return
ActionSetting
Throws
Exception
getActionSettings public: Get all Action Settings in collection

Return
ActionSetting[]
outputConfiguration public: Return action settings configured for NF Action
Removes unset/null values to enable default NF settings
Return
array

Class

ApiSetting

Single API setting in form design
This entity describes a piece of data that the API requires. NF / CF is responsible for storing and delivering this data back to the API.

fromArray public
getId public: Return API setting Id
Return
string
getLabel public: Return API setting label
Return
string
getExpectedDataType public: Return API setting data type
Return
string
getValue public: Get the value for the ApiSetting
Return
mixed
setId public: Set API setting Id
Param
string $stringValue
Return
ApiSetting
setLabel public: Set API setting label
Param
string $stringValue
Return
ApiSetting
setExpectedDataType public: Set API setting expected data type
Param
string $stringValue
Return
ApiSetting
setValue public: Set the value for the ApiSetting

Param
mixed|null $param
Return
ApiSetting

Class

ApiSettings

Describes a collection of NF Bridge API Settings

__construct public
getId public: Return API setting Id
Return
string
getLabel public: Return API setting label
Return
string
setId public: Set API setting Id
Param
string $stringValue
Return
ApiSettings
setLabel public: Set API setting label
Param
string $stringValue
Return
ApiSettings
fromArray public
toArray public: Convert ApiSettings object into associative array

Return
array
addApiSetting public: Add an API Setting to collection

Param
ApiSetting $apiSetting

Return
ApiSettings
getApiSetting public: Get an API Setting from collection

Param
string $key

Return
ApiSetting
Throws
Exception
getApiSettings public: Get all API Settings in collection

Return
ApiSetting[]

Class

Form

Form object enforcing contract for NF Form object

getName public: Get the name of the form

Return
string
setId public
getId public: Get the id of the form

Return
string

Class

Forms

Collection of NF forms objects

addForm public: Add a form to this collection

Param
FormContract $form
Return
FormCollection
getForm public: Get a form from this collection

Param
string $formId
Return
Form
Throws
Exception
hasForm public: Does collection have a form of this ID?

Param
string $formId
Return
bool
removeForm public: Remove a form from the collection

Param
string $formId
Return
FormCollection
Throws
Exception

Class

Modal

Entity that constructs a Ninja forms modal

setModalContent public: Set modal content
Param
string $content
Return
\NFHubspot\NinjaForms\Mailchimp\Entities\Modal
appendModalContent public: Append modal content
Param
string $content
Return
\NFHubspot\NinjaForms\Mailchimp\Entities\Modal
toArray public: @inheritdoc
getId public: Get modal Id
Return
string

Class

NFBridgeEntity

Class

Option

NF option entity
This entity is used to construct a Ninja Forms option

getLabel public: Return option label
Return
string
getValue public: Return option value
Return
string
setLabel public: Set option label
Param
string $stringValue
Return
Option
setValue public: Set option label
Param
string $stringValue
Return
Option

Class

Options

Collection of option entities

addOption public: Add Option to the collection
Param
Option $option
Return
\NFHubspot\EmailCRM\NfBridge\Entities\options
toArray public: Return option collection as array
Return
array
fromArray public

Class

SubmissionData

Represents one form's submission data

getSubmissionKeys public: Return array of action setting keys
Return
array
getKeyedSubmissionData public: Return submission values matching field collection keys
Return
array

Class

Exception

Class

ConstructEntityFactory

Factory to provide actions that construct or configure entities

constructActionSetting public: Return
ConstructActionSetting
constructActionSettings public: Return
ConstructActionSettings

Class

FormFactory

Class FormFactory
Converts Ninja Forms objects to standard Form object

fromNinjaForms public: @inheritdoc

Class

FormProcessorsFactory

Provides classes for NF form processing

__construct public: Param
WpHooksApi $wpHooks
getWpHooks public: @inheritdoc
getSubmissionData public: @inheritDoc
getConfigureApiSettings public: @inheritDoc
getForm public: @inheritdoc
getGetApiSettingsValues public: @inheritdoc

Class

NfActionFactory

Factory for creating an NF Action

constructNinjaFormsAction public: @inheritdoc
constructNinjaFormsNewsletterAction public: @inheritdoc

Class

SubmissionDataFactory

getSubmissionData public: @inheritdoc

Class

NfBridge

Exposes the top-level API of the package

setWpHooks public: Set WpHooks to provide WP action hooks and filters
Param
WpHooksContract $wpHooks
getIdentifier public: @inheritDoc
getContainer public: @inheritDoc
registerServices public: Register the module's services

Return
Module

Class

CachedEndpoint

__construct public: CachedEndpoint constructor.
Param
EndpointContract $proxyEndpoint Endpoint to use for cache misses
Param
ArrayStore $cache Key/value cache store
handleRequest public: Handles request from cache or passes to proxy endpoint

Param
RequestContract $request
Return
ResponseContract
cacheKey protected: Determine cache key

Param
RequestContract $request
Return
string
authorizeRequest public: @inheritDoc
getUri public: @inheritDoc
getArgs public: @inheritDoc
getHttpMethod public: @inheritDoc
setUri public: @inheritDoc
setArgs public: @inheritDoc
setHttpMethod public: @inheritDoc
getToken public: @inheritDoc

Class

CachedEndpoint

authorizeRequest public: Is request authorized or not?

Param
RequestContract $request

Return
bool
Throws
Exception

Class

CachedEndpoint

getUri public: Get route URI

Return
string
getArgs public: Get route arguments

Return
array
getHttpMethod public: Get HTTP method for endpoint

Return
string
setUri public: Param
string $uri

Return
EndpointContract
setArgs public: Param
array $args

Return
EndpointContract
setHttpMethod public: Param
string $httpMethod

Return
HttpContract|EndpointContract
handleRequest public: Handle request

Param
RequestContract $request

Return
ResponseContract
getToken public: Get CSFR/JWT token string from request

Param
RequestContract $request

Return
TokenContract

Class

CachedEndpoint

getGuzzleClient public: Return
GuzzleClientContract
setGuzzleClient public: Param
Client $client
Return
GuzzleClientContract

Class

CachedEndpoint

send public: Send request

Param
Request $request
Param
string $uri
Return
ResponseContract

Class

CachedEndpoint

getParam public: Get parameter from request

Param
string $paramName

Return
mixed
getParams public: Get all params of request

Return
array
setParam public: Set parameter in request

Param
string $paramName
Param
mixed $paramValue

Return
HttpRequestContract
setParams public: Set parameters of request

Param
array $params

Return
HttpRequestContract
hasParam public: Does request have param?

Param
string $paramName

Return
bool
getHeader public: Get header from request

Param
string $headerName

Return
mixed
getHeaders public: Get all headers

Return
array
setHeader public: Set header in request

Param
string $headerName
Param
mixed $headerValue

Return
HttpContract
hasHeader public: Does request have header?

Param
string $headerName

Return
bool
getHttpMethod public: Set the HTTP method for the request or response

Return
string
setHttpMethod public: Set the HTTP method for the request or response

Param
string $method

Return
HttpContract
setHeaders public: Set the request headers

Param
array $headers

Return
HttpContract

Class

CachedEndpoint

fromArray public
getData public: Get response data

Return
array
getHeaders public: Get response headers

Return
array
getStatus public: Get the HTTP status code

Return
int
setStatus public: Set the HTTP status code

Param
int $code

Return
HttpResponseContract
setHeaders public: Set the request headers

Param
array $headers

Return
HttpContract
setData public: Set the response body data

Param
array $data

Return
HttpResponseContract
getHttpMethod public: Set the HTTP method for the request or response

Return
string
setHttpMethod public: Set the HTTP method for the request or response

Param
string $method

Return
HttpResponseContract

Class

CachedEndpoint

getToken public: Generate a token, returning its public

Return
string
validateToken public: Test if string is a valid public for a token of current manager

Param
string $tokenStringToValidate

Return
bool

Class

Endpoint

getUri public: @inheritDoc
setUri public: @inheritDoc
getArgs public: @inheritDoc
setArgs public: @inheritDoc
getToken public: @inheritDoc

Class

Exception

Class

Psr7

This factory provides a bridge between the PSR-7 standard for HTTP messages that Guzzle uses, and our system.

fromPsr7Response public: Translate a PSR-7 request to our Response object

Param
ResponseInterface $response
Return
ResponseContract
toPsr7Request public: Translate our response to a PSR-7 response

Param
RequestContract $request
Param
string|null $uri
Return
\GuzzleHttp\Psr7\Request

Class

HttpClient

Guzzle-based HTTP client

__construct public: HttpClient constructor.

Param
Client $guzzle
Param
Psr7 $factory
send public: @inheritDoc
getGuzzleClient public: @inheritDoc
setGuzzleClient public: @inheritDoc

Class

Request

fromArray public

Class

Response

fromArray public
getData public: @inheritDoc
setData public: @inheritDoc
getStatus public: @inheritDoc
setStatus public: @inheritDoc

Class

Response

constructParameterUri protected: Construct a parameter with REGEX to accept required param/value

Param
string $param Parameter requested
Param
string $mask `numeric` `alphanumeric`
Return
string

Class

Response

getHeader public: Get header from request

Param
string $headerName

Return
string|null
hasHeader public: Param
string $headerName

Return
bool
setHeader public: Set header in request

Param
string $headerName
Param
mixed $headerValue

Return
HttpContract
getHeaders public: @inheritdoc
setHeaders public: Bulk assign headers

Param
array $headers
Return
HttpContract

Class

Response

getHttpMethod public: Set the HTTP method for the request or response

Return
string
setHttpMethod public: Set the HTTP method for the request or response

Param
string $method

Return
HttpContract

Class

Response

getParam public: Get parameter from request

Param
string $paramName

Return
mixed
setParam public: Set parameter in request

Param
string $paramName
Param
mixed $paramValue

Return
$this
hasParam public: Does request have param?

Param
string $paramName

Return
bool
getParams public: Get all params of request

Return
array
setParams public: Set parameters of request

Param
array $params

Return
HttpRequestContract

Class

ApiModuleOpenAuthorizationAbstract

__construct public: Param
OpenAuthImplementationContract $openAuthImplementation
Param
GlobalSettingsStorageContract $globalSettingsStorage
Param
OpenAuthCredentials $openAuthCredentialsLookup
setURLs abstract: Set fully formed endpoints for authorization requests grant_type=authorization_code endpoint grant_type=refresh_token endpoint
initialize protected: Initialize OpenAuth implementation with credentials and endpoint URLs
getGlobalSettings public: Return the GlobalSettings with values In returning the full GlobalSettings, the Integrating Plugin is relieved of the responsibility of knowing the responsibility of managing any specific value.
Return
GlobalSettings
getAccessToken public: Return Access Token
Return
string
authorizeFromAuthorizationToken public: Request authorization using grant_type=authorization_code
Return
ApiModuleOpenAuthorizationContract
authorizeFromRefreshToken public: Request authorization using grant_type=refresh_token
Return
ApiModuleOpenAuthorizationContract
finalize protected: Update credentials and store GlobalSettings Done after authorization request is made, this sets the new credentials in both this instance and requests that the GlobalSettingsStorage class update the data source as well.
extractOpenAuthCredentials protected: Extract credentials from GlobalSettings using OpenAuthCredentials lookup
setNewGlobalSettingsValues protected: Update GlobalSettings with updated OpenAuthCredentials values Refresh token and access token are updated with new values while Authorization Code is reset to an empty string as the code is only good for a single request.

Class

OpenAuthImplementation

Makes OpenAuthorization requests meeting OAuth 2 standards
Requests for authorization following OAuth 2 follows standards that can be shared among all integrating plugins that require that standard. This class
This class structures the requests per the OAuth standard and standardizes the response into a shared handledResponse entity. Each integration must provide the incoming credentials and endpoint URLs with which this class will make the authorization request. The integration must also provide a RemoteRequest object to provide the means with which the requests are sent and received.

__construct public: Construct implementation class with RemoteRequest object for communication
Param
RemoteRequestInterface $remoteRequest
setCredentials public: Set OpenAuth credentials with which to generate authorization

Param
OpenAuthCredentials $openAuthCredentials
Return
OpenAuthenticatorContract
getCredentials public: Return OpenAuthCredentials
The authentication process generates new refresh_ and access_ tokens.
These values are updated in the originally supplied credentials. The requesting class can retrieve the updated credentials, store the refresh token, and use the access token for immediate authorization.

Return
OpenAuthCredentials
setGrantTypeAuthCodeUrl public: Set URL for making grant_type = authorization_code request

Param
string $grantTypeAuthCodeUrl
Return
OpenAuthenticatorContract
setGrantTypeRefreshTokenUrl public: Set URL for making grant_type = refresh_token request

Param
string $grantTypeRefreshTokenUrl
Return
OpenAuthenticatorContract
authorizeFromAuthorizationCode public: Makes a grant_type = Authorization request per OAuth standards
Return
HandledResponse
authorizeFromRefreshToken public: Makes a grant_type = refresh_token request per OAuth standards
Return
HandledResponse
evaluateResponseData protected: Evaluates the response from endpoint to put data in known locations

Note

that the credentials are, per OAuth specification, modified in the making of a authorization request.
An authorization token can only be used once
A refresh token is only used once but, when making an authorization request, a new token is returned along with the access_token that is intended for immediate authorization.

Param
HandledResponse $handledResponse
Return
HandledResponse
constructGrantTypeAuthCodeBody protected: Construct request body per OAuth specifications
Return
array
constructGrantTypeRefreshTokenBody protected: Construct request body per OAuth specifications
Return
array
setRequestSettings protected: Set HTTP settings required for making HTTP request

Class

ArrayLike

Class ArrayLike
Implementation of ArrayAccess for objects we are not ready to type.

__construct public: ArrayLike constructor.
Param
array $items
toArray public: @inheritDoc
offsetSet public: @inheritDoc
offsetExists public: @inheritDoc
offsetUnset public: @inheritDoc
offsetGet public: @inheritDoc
jsonSerialize public: @inheritDoc

Class

CommData

__construct public
initializeCommData public: Retrieves existing CommData from db
If incoming value is not an array, sets CommData as empty array
resetKey public: Removes existing data in key and initializes empty array
Param
string $key
append public: Appends an entry to the indexed array in a given key
Param
string $key Comm Data key storing the data
Param
mixed $entry Value to be appended as array element
set public: Replaces existing value with a new value
Param
string $key
Param
mixed $entry New value to be stored in key
storeCommData public: Stores CommData array in WP options table under given key

Class

ServiceContainer

Basic service container
SEE: docs/container.md

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

ToDo
use Doctrine Insanitator?

Param
$class
Return
object

Class

ServiceFactoryContainer

Service factory container
This container can be used to group related factories
SEE: docs/container.md

addFactory public: @inheritDoc
useFactory public: @inheritDoc
hasFactory public: @inheritDoc

Class

ServiceFactoryContainer

getGlobalSettings public: Return configured GlobalSettings for the ApiModule
By definition as a 'configured' entity, it does not include any stored values and is standardized across all integrations and implementations

Return
GlobalSettings
getFormFields public: Return configured standard API FormFields for the ApiModule
By definition as a 'configured' entity, it does not include any custom values and is standardized across all integrations and implementations

Return
FormFields

Class

ServiceFactoryContainer

getGlobalSettings public: Return the GlobalSettings with values In returning the full GlobalSettings, the Integrating Plugin is relieved of the responsibility of knowing the responsibility of managing any specific value.
Return
GlobalSettings
getAccessToken public: Get Access Token
Access Token is expected to be generated inside this class.
Return
string
authorizeFromAuthorizationToken public: Request authorization via the authorization_code OpenAuth standard
Return
OpenAuthorizationContract
authorizeFromRefreshToken public: Request authorization via the refresh_token OpenAuth standard
Return
OpenAuthorizationContract

Class

ServiceFactoryContainer

getKey public: The name of the key -- WordPress option name, database identifier, etc. -- used to store data

Return
string
getData public: Get saved data

Return
array
saveData public: Get the saved data

Param
array $data Data to save

Class

ServiceFactoryContainer

toArray public: Convert object to array

Return
array

Class

ServiceFactoryContainer

handle public: Process the data

Param
SubmissionData $submissionData
Param
FormContract $form
Return
mixed

Class

ServiceFactoryContainer

getFieldKeys public
getSlug public: Get the processor's slug/ identifier

Return
string

Class

ServiceFactoryContainer

setTitle public: Set the form title
Param
string $title Form Title
Return
\NFHubspot\EmailCRM\Shared\Contracts\FormBuilder
addFormField public: Add form field to the form
Param
FormField $formField
Return
\NFHubspot\EmailCRM\Shared\Contracts\FormBuilder
getTitle public: Get form builder title
Return
string
getFormFields public: Get form fields
Return
FormFields
toArray public: Return FormBuilder entity as associative array
Return
array

Class

ServiceFactoryContainer

addForm public: Param
FormContract $form
Return
FormCollection
getForm public: Get a form from this collection

Param
string $formId
Return
Form
Throws
\Exception
hasForm public: Does collection have a form of this ID?

Param
string $formId
Return
bool
removeForm public: Remove a form from the collection

Param
string $formId
Return
FormCollection
Throws
Exception

Class

ServiceFactoryContainer

getName public: Get the name of the form

Return
string
getId public: Get the id of the form

Return
string

Class

ServiceFactoryContainer

setGlobalSettings public
getGlobalSettings public: Get GlobalSettings from this class, does NOT retrieve from storage location

Return
GlobalSettings
storeGlobalSettings public: Store entire collection of GlobalSettings in a storage location

Return
GlobalSettingsStorageContract
retrieveGlobalSettings public: Retrieve entire collection of GlobalSettings from a storage location

Return
GlobalSettingsStorageContract
storeGlobalSetting public: Store a specified GlobalSetting in a storage location
Param
string $id
Return
GlobalSettingsStorageContract
retrieveGlobalSetting public: Retrieve a global setting from a storage location

Param
string $id
Return
GlobalSettingsStorageContract

Class

ServiceFactoryContainer

registerServices public: Register all services

Return
Module
getIdentifier public: Get a module's identifier

Return
string

Class

ServiceFactoryContainer

setCredentials public: Set OpenAuth credentials with which to generate authorization

Param
OpenAuthCredentials $credentials
Return
OpenAuthenticatorContract
getCredentials public: Return OpenAuthCredentials
The authentication process generates new refresh_ and access_ tokens.
These values are updated in the originally supplied credentials. The requesting class can retrieve the updated credentials, store the refresh token, and use the access token for immediate authorization.

Return
OpenAuthCredentials
setGrantTypeAuthCodeUrl public: Set URL for making grant_type = authorization_code request

Param
string $grantTypeAuthCodeUrl
Return
OpenAuthenticatorContract
setGrantTypeRefreshTokenUrl public: Set URL for making grant_type = refresh_token request

Param
string $grantTypeRefreshTokenUrl
Return
OpenAuthenticatorContract
authorizeFromAuthorizationCode public: Return
HandledResponse
authorizeFromRefreshToken public: Return
HandledResponse

Class

ServiceFactoryContainer

setUrl public: Set HTTP request URL

Param
string $url
Return
\NFHubspot\EmailCRM\WpBridge\Contracts\RemoteRequestContract
setHttpArg public: Set an HTTP argument

Param
string $arg
Param
type $value
Return
\NFHubspot\EmailCRM\WpBridge\Contracts\RemoteRequestContract
addQueryArg public: Add a querystring argument

Param
string $arg
Param
type $value
Return
\NFHubspot\EmailCRM\WpBridge\Contracts\RemoteRequestContract
setBody public: Set HTTP request body

Param
type $body
Return
\NFHubspot\EmailCRM\WpBridge\Contracts\RemoteRequestContract
setHeaderParameter public: Set an HTTP header parameter

Param
type $arg

Param
type $value

Return
\NFHubspot\EmailCRM\WpBridge\Contracts\RemoteRequestContract
handle public

Class

ServiceFactoryContainer

bind public: Bind a service to the container.

Param
string $alias Alias for class
Param
object|\Closure $concrete Concrete class
make public: Request a service from the container.

Param
string $alias Alias for class
Return
object|mixed
singleton public: Bind a singleton instance to the container.

Param
string $alias Alias for class
Param
object $binding Single instance of object to bind

Class

ServiceFactoryContainer

addFactory public: Add a factory to the container

Param
string $service Name of service factory
Param
ServiceFactoryContract $serviceFactory
Return
ServiceFactoryContainerContract
useFactory public: Use a factory from the container

Param
string $service Name of service factory
Param
array $args
Return
mixed
hasFactory public: Does container contain factory?

Param
string $service Name of service factory
Return
bool

Class

ServiceFactoryContainer

handle public: Handle a request for this factory

Param
array $args Arguments for factory
Param
ServiceFactoryContainer $container Container that contains this factory
Return
mixed

Class

ServiceFactoryContainer

getValue public: Get value or default

Param
string $key
Param
null $default
Return
mixed|null

Class

ServiceFactoryContainer

applyFilters public: Apply filters to given property
Param
string $tag
Param
mixed $incoming
Param
int $priority
Param
int $acceptedArgs
addFilter public: Add filter to given tag
Param
string $tag
Param
type $hook
addAction public: Param
string $tag
Param
type $hook
updateOption public: Wrap update_option
Param
string $key
Param
type $data

Class

FormBuilder

Shared form entity that can be transported across bridges

__construct public: Construct a new FormBuilder object
setTitle public: Set form title
Param
string $title
Return
FormBuilder
addFormField public: Add form field to the form builder
Param
FormField $formField
Return
FormBuilder
getTitle public: Get form builder title
Return
string
getFormFields public: Get form fields
Return
FormFields
toArray public: Return FormBuilder entity as associative array
Return
array

Class

FormField

Form field entity shared by CF and NF

setId public: Set the field Id
Param
string $id Field Id
Return
SimpleEntity
setLabel public: Set the field label
Param
string $label Field label
Return
SimpleEntity
setType public: Set the field type
Param
string $type Field type
Return
SimpleEntity
setDefault public: Set the default value
Param
type $default Default value
Return
SimpleEntity
setRequired public: Set Required parameter
Param
bool $required Boolean of `is required?`
Return
SimpleEntity
setDescription public: Set the field description
Param
string $description Field description
Return
SimpleEntity
setCharacterLimit public: Set the character limit for the field
Param
int $limit
Return
SimpleEntity
setOptions public: Set field options
Param
Options $options
Return
SimpleEntity
getId public: Get field id
Return
string
getLabel public: Get field label
Return
string
getType public: Get field type
Return
string
getDefault public: Get field default value
Return
mixed
getRequired public: Get field required boolean
Return
bool
getDescription public: Get field description
Return
string
getOptions public: Get options
Return
Options
getCharacterLimit public: Get character limit for the field; 0 indicates no limit

Return
int
fromArray public

Class

FormFields

Collection of form field entities shared by CF and NF

addFormField public: Add a form field the fields collection
Param
FormField $field
Return
\NFHubspot\EmailCRM\Shared\Entities\FormFields
getField public: Get form field specified by Id
Param
string $id Id of field
Return
FormField
Throws
Exception
getFields public: Return collection of all form fields
Return
array
toArray public: Return array of all form fields
Return
array
fromArray public

Class

GlobalSetting

Single Global setting in form design
This entity describes a piece of data that the Global requires. NF / CF is responsible for storing and delivering this data back to the Global.

fromArray public
getId public: Return Global setting Id
Return
string
getLabel public: Return Global setting label
Return
string
getExpectedDataType public: Return Global setting data type
Return
string
getValue public: Get the value for the GlobalSetting
Return
mixed
setId public: Set Global setting Id
Param
string $stringValue
Return
GlobalSetting
setLabel public: Set Global setting label
Param
string $stringValue
Return
GlobalSetting
setExpectedDataType public: Set Global setting expected data type

Param
string $stringValue
Return
GlobalSetting
setValue public: Set the value for the GlobalSetting

Param
type $param
Return
\NFMailchimp\EmailCRM\Shared\Entities\GlobalSetting

Class

GlobalSettings

Describes a collection of Global Settings
Global settings are shared among all the forms, not form-specific

__construct public
getId public: Return Global setting Id
Return
string
getLabel public: Return Global setting label
Return
string
setId public: Set Global setting Id
Param
string $stringValue
Return
GlobalSettings
setLabel public: Set Global setting label
Param
string $stringValue
Return
GlobalSettings
fromArray public
toArray public: Convert GlobalSetting object into associative array

Return
array
addGlobalSetting public: Add an Global Setting to collection

Param
GlobalSetting $globalSetting

Return
GlobalSettings
getGlobalSetting public: Get a Global Setting from collection

Param
string $key

Return
GlobalSetting
Throws
Exception
getGlobalSettings public: Get all Global Settings in collection

Return
GlobalSetting[]

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 $string
Return
\NFHubspot\EmailCRM\Shared\Entities\HandledResponse
getContext public: Get the context

Return
string
setRecordCount public: Set the record count
Param
int $int
Return
\NFHubspot\EmailCRM\Shared\Entities\HandledResponse
getRecordCount public: Get the record count
Return
int
setRecords public: Set the records collection

Param
array $array
Return
\NFHubspot\EmailCRM\Shared\Entities\HandledResponse
appendRecord public: Append a single record to the record collection

Param
string $string
Return
\NFHubspot\EmailCRM\Shared\Entities\HandledResponse
appendRecords public: Append a array of records to the collection

Param
array $array
Return
\NFHubspot\EmailCRM\Shared\Entities\HandledResponse
getRecords public: Get the record collection

Return
array
setTimestamp public: Set the timestamp

Param
int $int
Return
\NFHubspot\EmailCRM\Shared\Entities\HandledResponse
getTimestamp public: Get the timestamp
Return
int
setIsSuccessful public: Set IsSuccessful

Param
bool $bool
Return
\NFHubspot\EmailCRM\Shared\Entities\HandledResponse
isSuccessful public: Get IsSuccessful

Return
bool
setIsWpError public: Set IsWpError

Param
bool $bool
Return
\NFHubspot\EmailCRM\Shared\Entities\HandledResponse
isWpError public: Get IsWpError
Return
bool
setIsApiError public: Set IsApiError

Param
bool $bool
Return
\NFHubspot\EmailCRM\Shared\Entities\HandledResponse
isApiError public: Get IsApiError

Return
bool
setIsException public: Set IsException

Param
bool $bool
Return
\NFHubspot\EmailCRM\Shared\Entities\HandledResponse
isException public: Get IsException

Return
bool
setHasNoData public: Set HasNoData

Param
bool $bool
Return
\NFHubspot\EmailCRM\Shared\Entities\HandledResponse
hasNoData public: Get HasNoData

Return
bool
setErrorCode public: Set ErrorCode

Param
int $int
Return
\NFHubspot\EmailCRM\Shared\Entities\HandledResponse
getErrorCode public: Get ErrorCode

Return
int
setErrorMessages public: Get ErrorMessages

Param
array $array
Return
\NFHubspot\EmailCRM\Shared\Entities\HandledResponse
appendErrorMessage public: Append a single error message to collection

Param
string $string
Return
\NFHubspot\EmailCRM\Shared\Entities\HandledResponse
getErrorMessages public: Get ErrorMessages

Return
array
setResponseBody public: Set ResponseBody

Param
string $string
Return
\NFHubspot\EmailCRM\Shared\Entities\HandledResponse
getResponseBody public: Get ResponseBody

Return
string

Class

OpenAuthCredentials

Entity to accept and provide data for Open Authorization protocol

setClientId public: Set client id

Param
string $clientId
Return
SimpleEntity
getClientId public: Get client id
Return
string
setClientSecret public: Set client secret

Param
string $clientSecret
Return
SimpleEntity
getClientSecret public: Get client secret

Return
string
setAuthorizationCode public: Set authorization code

Param
string|null $authorizationCode
Return
SimpleEntity
getAuthorizationCode public: Get authorization code

Return
string
setRedirectUri public: Set redirect URI

Param
string|null $redirectUri
Return
SimpleEntity
getRedirectUri public: Get redirect URI

Return
string
setRefreshToken public: Set refresh token

Param
string|null $refreshToken
Return
SimpleEntity
getRefreshToken public: Get refresh token

Return
string
setAccessToken public: Set access token

Param
string|null $accesstoken
Return
SimpleEntity
getAccessToken public: Get access token

Return
string

Class

Option

Option entity
This entity is used to construct an option

getLabel public: Return option label
Return
string
getValue public: Return option value
Return
string
setLabel public: Set option label
Param
string $stringValue
Return
Option
setValue public: Set option label
Param
string $stringValue
Return
Option

Class

Options

Collection of option entities

addOption public: Add Option to the collection
Param
Option $option
Return
\NFHubspot\EmailCRM\NfBridge\Entities\options
toArray public: Return option collection as array
Return
array
fromArray public

Class

ResponseData

Class ResponseData
Provides standardized data from a response with meta data

fromArray public
toArray public: Return array of ResponseData
Return
array
getResponse public: Return Response
Return
string
getMessage public: Return Message
Return
string
getContext public: Return Context
Return
string
getDiagnostics public: Return Diagnostics
Return
string
getType public: Return Type
Return
string
getNote public: Return Note
Return
string
setResponse public: Set Response
Return
SimpleEntity
setMessage public: Set Message
Return
SimpleEntity
setContext public: Set Context
Return
SimpleEntity
setDiagnostics public: Set Diagnostics
Return
SimpleEntity
setType public: Set Type
Return
SimpleEntity
setNote public: Set Note
Return
SimpleEntity

Class

SubmissionData

Class SubmissionData
Represents the details about current submission relevant to the form action/ form processor

__construct public
getValue public: Get value or default

Param
string $key
Param
null $default
Return
mixed|null

Class

ConsolidateHandledResponses

Consolidates collection of HandledResponses into single response Form processing may make multiple requests for a single submission, each of which has its own HandledResponse. This class consolidates the responses into a single response so that downstream operations have a single instance with which to work.

handle public: Consolidate collection of HandledResponses into single HandledResponse
Param
array $handledResponseCollection
Return
HandledResponse
consolidateResponses protected: Consolidate responses into a single response A failure in any boolean counts as a failure; all error messages combined in response order; record counts summed.
ensureValidCollection protected: Ensures incoming value is indexed array of HandledResponses
Return
bool
setInvalidRequestResponse protected: Sets handled response when incoming request is invalid

Class

SimpleEntity

toArray public: @inheritdoc
fromArray public
jsonSerialize public
__get public: @inheritdoc
__set public: @inheritdoc

Class

InMemoryArrayStore

Implimentation of ArrayStore that is for testing.

__construct public
getData public
saveData public: @inheritDoc
getKey public: @inheritDoc

Class

InMemoryArrayStore

fromArray public
unSnake protected

Class

InMemoryArrayStore

toArray public: @inheritdoc
getterName protected
snake protected: Convert camel-cased string to snake case

See
https://stackoverflow.com/a/1993772
Param
string $str
Return
string

Class

InMemoryArrayStore

__get public: Get a single config value

Param
string $name Value name
Return
mixed
__set public: Update a single config value

Param
string $name Value name
Param
mixed $value New value
Return
SimpleEntity
fromArray public
jsonSerialize public: @inheritDoc
hasValue public: Can this object supply a value?

Param
string $name Name of the value
Return
bool
toArray public: @inheritDoc
setItems protected
addData public: At item to collection

Param
string $key
Param
$value

Class

InMemoryArrayStore

addFilter public: Provide WP's add_filter() functionality
Param
string $filterName
Param
mixed $incoming
Param
int $priority
Param
int $acceptedArgs
Return
mixed
applyFilters public: Provide WP's apply_filters() functionality
Param
string $filterName
Param
mixed $incoming
Return
mixed
addAction public: Provide WP's add_action functionality
Param
string $tag
Param
array|string|callable $hook
wpNonceField public: Provide WP's wp_nonce_field functionality
Param
int|string $action
Param
string $name
Param
bool $referer
Param
bool $echo

Class

InMemoryArrayStore

updateOption public: Wraps WordPress' update_option()
Param
string $key
Param
array|string|integer $data
getOption public: Wraps WordPress' get_option()

Param
string $key
Return
mixed

Class

InMemoryArrayStore

setWpdb public: Set a new instance of WPDB.

Param
\WPDB $wpdb
Return
$this
getWpdb public: Get current instance of WPDB

Return
\WPDB
getResults public: Sql to query, using WordPress
wpdb::getResults($sql)

Param
string $sql The sql query to get results for
Return
\stdClass[]

Class

OptionsStore

A getter/setter for using options table as key/ value store where value is an array

__construct public: OptionsStore constructor.
Param
string $key The name of the key
getData public: @inheritDoc
getKey public: @inheritDoc
saveData public: @inheritDoc

Class

TransientStore

A getter/setter for using transients as key/ value store where value is an array

__construct public: TransientStore constructor.
Param
string $key The name of the key
getData public: @inheritDoc
getKey public: @inheritDoc
saveData public: @inheritDoc

Class

UseWpdb

__construct public
setWpdb public: @inheritDoc
getWpdb public: @inheritDoc
getResults public: @inheritDoc

Class

WPOptionsApi

updateOption public: @inheritDoc
getOption public: @inheritDoc

Class

MailchimpWpHttpClient

Class MailchimpWpHttpClient
For the Mailchimp API client -- uses WordPress HTTP API

handleRequest public: @inheritdoc

Class

RemoteRequest

Make an HTTP request using wp_remote_request

__construct public: Make an HTTP request to return a response array
setUrl public: Set HTTP request URL

Param
string $url
Return
RemoteRequestContract
setHttpArg public: Set an HTTP argument

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

Param
string $arg
Param
mixed $value
Return
RemoteRequestContract
setBody public: Set HTTP request body
Param
mixed $body
Return
RemoteRequestContract
setHeaderParameter public: Set an HTTP header parameter
Param
string $arg
Param
mixed $value
Return
RemoteRequestContract
finalizeRequest protected
handle public: Return
HandledResponse
setDefaultHttpArgs protected: Set default arguments

Class

AuthorizeRequestWithWordPressUser

Class AuthorizeRequestWithWordPressUser
WordPress capability-based authorization check for routes

__construct public: AuthorizeRestRequest constructor.
Param
string $capability
authorizeRequest public: Param
RequestContract $request
Return
bool

Class

CreateWordPressEndpoints

Create and endpoint on the WordPress REST API

__construct public: CreateEndpoint constructor.

Param
callable $registrationFunction
Param
string $namespace
registerRouteWithWordPress public: Register an endpoint with WordPress

Param
Endpoint $endpoint
wpArgs public: Create arguments for register_rest_route()

Param
Endpoint $endpoint

Return
array
createCallBack protected: Create the callable function for WordPress to use as the callback for this endpoint

Param
callable $handler
Return
callable
createAuthCallBack protected: Create a callable function WordPress will call to authorize the request

Param
callable $handler
Return
callable
requestFromWp protected: Create instance of request class from a WordPress request

Param
\WP_REST_Request $_request

Return
Request

Class

WpBridge

Exposes the top-level API of the package

getIdentifier public: @inheritDoc
registerServices public: Register the module's services

Return
Module

Class

WpHooksApi

Hook into Wordpress functions to decouple Wordpress from the Monorepo This class provides standardized methods for Wordpress-specific functions. In doing so, the Monorepo can function with or without an actual Wordpress installation. This enables robust, simplified testing along with a code base that can migrate across any platform.

applyFilters public: Provide WP's apply_filters() functionality Checks if Wordpress' native function is available and uses that. If it is not, then the original value is returned as it would if no filter had been added.
Param
string $filterName
Param
mixed $incoming
Return
mixed
addFilter public: Provide WP's add_filter() functionality Checks if Wordpress' native function is available and uses that. If it is not available, no filter is added.
Param
string $filterName
Param
mixed $callback
Param
int $priority
Param
int $accepted_args
Return
mixed
addAction public: Provide WP's add_action functionality Check if Wordpress' native function is available and uses that. If it is not available, no action is added.
Param
string $tag
Param
array|string|callable $hook
wpNonceField public: Provide WP's wp_nonce_field functionality If function exists, sets a variable by Wordpress' wp_nonce_field function. Wordpress' function will automatically echo if that parameter is true, If the function does not exist, this method creates a simulated nonce string and conditionally echoes it. Regardless of $echo conditional, the nonce value is returned
Param
int|string $action
Param
string $name
Param
bool $referer
Param
bool $echo
wpRestUrl public: Return the wp_rest_url parameter
Return
string

Class

WpHooksApi

nf_hubspot_init /** * Load plugin if possible * * @since 3.0.0 */
nf_hubspot_php_nag /** * Callback for admin notice shown when PHP version is not correct. * * @since 3.0.0 */

Class

AdminSettings

Description of AdminSettings

__construct public
adminAjax public: Handle AdminAJAX requests

Return
Void
updateCustomFields protected: Request custom field update, returning results for feedback

Return
String
saveApiKeyOnChange protected: Update Ninja Forms Api Key setting

Return
String

Class

ConstructCreateEntryActionEntity

Creates the ActionEntity object from which a NF action can be constructed

appendIntegrationSpecificGlobalSettings protected: Add Custom Field and Reauthorization buttons to the GlobalSettings
Provides UI interfaces inside NF plugin settings

Return
Void
determineActionSettingGroup protected: Determine the group location for a given FormField

Param
FormField $apiFormField

Return
String
createActionSettingsGroups public: Create groupings for the action field mapping
Enables large lists of field maps to be organized into manageable groups

Param
Array $groups

Return
Array

Class

MetaboxOutput

handle public
extractResponses protected
addContext protected
addResult protected
addRecord protected

Class

OAuthConnection

__construct public: Constructor

Return
Void
oauthUpgradeNotice public: Function to notify users who need to upgrade from API Key to oAuth.

Param
Array $notices

Return
Array $notices
oauthReconnectNotice public: Function to notify users who need to reconnect

Param
Array $notices

Return
Array $notices
isOauthRequest public: Checks if current request is oAuth request

Return
Bool
handleOauthRequest public: Handle an oAuth Request

Return
Void
hasAPIKey public: Checks if API Key (old method) exists

Return
Bool
getOption private: Get NF Setting Option

Param
String $key

Return
Mixed
setOption private: Set NF Settings Option

Param
String $key
Param
String $value

Return
Void
saveSettings private: Save settings

Return
Void
getAccessToken public: Return Access Token

Return
String
getRefreshToken protected: Return Refresh Token

Return
String
refreshTokens public: Refresh Tokens

Return
Void
handleApiRefresh protected: Refresh token via API request

Return
Void
saveTokens protected: Save New Tokens

Return
Void
deleteTokens protected: Delete Tokens

Return
Void
isConnected public: Check if we're connected

Return
Bool
isExpired public: Check if current access token is expired

Return
Bool
generate_key public: Generates secret key

Return
String
getKey protected: Get Key

Return
String

Class

OAuthConnection

initRestApi public: Initialize the REST API endpoints

Since
3.2.0
@uses "rest_api_init" hook.
setNfBridge public: Set the NfBridge
Param
NfBridgeContract $nfBridge
Return
NinjaFormsMailchimpContract
getNfBridge public: Get the NfBridge
Return
NfBridgeContract
setApiModule public: Get instance of top level API Module

Return
HubspotContract
Since
3.0.0
getApiModule public: Set instance of top level API Module

Return
HubspotContract
Since
3.0.0

Class

AutogenerateFormEndpoint

Endpoint to handle a form autogenerate request

setAutogenerateForm public: Set the autogenerate form

Param
AutogenerateForm $autogenerateForm
addAuthorizer public: Add an authorizer that ensures source of request is authorized
Param
AuthorizeRequestContract $authorizer
getHttpMethod public: @inheritDoc
getArgs public: @inheritDoc
getUri public: @inheritDoc
authorizeRequest public: Authorize the request

Param
RequestContract $request
Return
bool
handleRequest public: @inheritDoc
constructExceptionResponse protected: Construct exception response from given exception
Param
\Exception $exception
Param
string $context
Return
ResponseContract

Class

Configure

Provides configured Integrating Plugin-specific entities

__construct public: Instantiate with top-level file directory to provide access throughout

Param
string $dir
autogenerateModalMarkup public: Return autogenerate modal markup
Used to construct Add New modal box
Return
Modal
actionEntity public: Provide ActionEntity defining the primary action of the integrating plugin

Return
ActionEntity

Class

NfHubspotCreateRecordsFormActionHandler

Extends the default ApiModule FormActionHandler for NF-specific requirements Extracts data from the NF ->process(...,$data) property needed for processing Returns the handled responses for any downstream processing and post processing

getPostProcessData public
extractFormFieldProcessingData public: Extract processing data from form fields to return key-value pairs
Some data required by submission action is contained within form fields. Given the form fields data upon submission, extract the required data to return it as key-value pairs such that it can be added to the submission data and processed
Param
array $data Form field process data
Return
array

Class

NinjaFormsHubspot

Exposes the top-level API of the Integrating Plugin

registerAutogenerateModal public: Creates modal with Add New form autogeneration button
The modal configuration is provided through the configuration factory. A nonce field is generated at the time of modal construction. The endpoint points to a registered REST API endpoint that will handle the request.

Param
Array $templates

Return
Array
addMetabox public: Add a metabox constructor to the react.js submissions page

Param
Array $metaboxHandlers

Return
Array
registerCreateEntryAction public: Register the CreateEntry action
Custom fields are retrieved from storage, or request via the API Module This collection is injected into BOTH the action entity, which defines the action, AND the FormActionHandler. By coordinating their construction, both the defining action and the action handler have the same set of data and the handler has instructions on every piece of data submitted.

Return
Void
initRestApi public: Initialize the REST API endpoints

Since
3.0.0
@uses "rest_api_init" hook.

Return
Void
updateCustomFields public: Store custom fields as requested and provided by the API Module

Return
FormFields
getCustomApiFormFields public: Return stored Custom API Form fields
Custom API Fields are stored and provided by the Integrating Plugin
In NF, a request is made, usually from the settings page and the data is stored in WP Options.

Return
FormFields
setNfBridge public: Set the NF Bridge to provide NF functionality

Param
NfBridgeContract $nfBridge

Return
NinjaFormsHubspot
getNfBridge public: Return the NF Bridge object

Return
NfBridgeContract
setApiModule public: Set the API Module

Param
ApiModuleContract $apiModule

Return
MainInstanceContract
initializeApiModule protected: Initialize API Module with settings values

Return
Void
maybeRemoveApiKey protected: Modify the global settings within NF to encourage migration to OAuth
If refresh token is present, hide API Key option to prevent going back to that authoriztion. If no API Key is set, hide the option completely to force OAuth usage. If API Key is set, and no refresh token is present, then user has not yet migrated, so disable API key so that value is still present, but locked.

Param
GlobalSettings $incoming

Return
GlobalSettings
removeApiKeyFromGlobalSettings protected: Remove the API key from the global settings to ensure only OAuth is available

Param
GlobalSettings $incoming

Return
GlobalSettings
disableApiKeyInGlobalSettings protected: Disable the API key from the global settings but keep it for use

Param
GlobalSettings $incoming

Return
GlobalSettings
getApiModule public: Return the API Module

Return
ApiModuleContract
registerServices public: Binds instances of classes used by the API Module
The API module can then provide those instances in any injected dependency when requested by calling the make() method with the requested class name

Return
Module
setupAdmin public: Setup Admin
Setup admin classes for Ninja Forms and WordPress.

Return
Void
getIdentifier public: @inheritDoc

Class

TestCase

loadTestData public: Load some test data

Param
string $file
Return
array
loadArrayData public: Load array data returned as array from config file
Param
string $file PHP file name including extension
Return
array
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

Class

ConfigureTest

Test Configure class delivers configurations as expected

setUp protected: @inheritDoc
testConfigure public: @covers \NFHubspot\Factories\Configure::actionEntity @covers \NFHubspot\Factories\Configure::autogenerateModalMarkup

Class

ConstructCreateEntryActionEntityTest

setUp protected: @inheritDoc
testActionEntityCreation public: Ensure that the entity is created per specifications @covers NFHubspot\Actions\ConstructCreateEntryActionEntity::getActionEntity()
testCreateActionSettingsGroups public: Ensure class constructs the required groupings Expected groupings include standard API modules such that the constructed action entity will provide drop-down groups that simplify the field mapping. If more modules are added as a feature enhancement, this test should be adjusted to include any new modules as groups. @covers NFHubspot\Actions\ConstructCreateEntryActionEntity::createActionSettingsGroups()
constructCreateEntryActionEntity protected: Construct class to be tested
constructProperties protected: Construct properties required for class instantiation

Class

GlobalSettingsStorage

Provides agnostic implementation of GlobalSettingsStorageContract All data is contained within the instantiated class; one must manually set Global Settings values as there is no live data source from which to retrieve data. Perfect for testing.

getGlobalSettings public: Return the stored GlobalSettings
Return
GlobalSettings
setGlobalSettings public: Set the GlobalSettings
Param
GlobalSettings $globalSettings
Return
GlobalSettingsStorageContract
retrieveGlobalSetting public: Return the required contract without a live data source
Param
string $id
Return
GlobalSettingsStorageContract
retrieveGlobalSettings public: Return the required contract without a live data source
Param
string $id
Return
GlobalSettingsStorageContract
storeGlobalSetting public: Return the required contract without a live data source
Param
string $id
Return
GlobalSettingsStorageContract
storeGlobalSettings public: Return the required contract without a live data source
Return
GlobalSettingsStorageContract

Class

NfHubspotCreateRecordsFormActionHandlerTest

Test the NF-specific extension of the Hubspot CreateRecordsFormActionHandler

testGetPostProcessData public: Ensures method provides expected array response Hubspot's FormActionHandler will generate an indexed array of HandledResponse. This NF extension to the base class returns this collection and it must always be an array, even if there are no HandledResponse @covers NFHubspot\Handlers\NfHubspotCreateRecordsFormActionHandler::getPostProcessData
testExtractFormFieldProcessingData public: Ensures method provides expected array response The NF extension is given an array of submission data to extract any additional values required. This is useful for extracting data that is not specifically mapped into the action (a custom opt-in field, for example). In this case, there is no additional data required and the method should return the incoming array exactly as provided. @covers NFHubspot\Handlers\NfHubspotCreateRecordsFormActionHandler::getPostProcessData
setUp /** @inheritDoc */

Class

NinjaFormsHubspotTest

testConstants public: Ensure that required constants are set

Class

UnitTestCase

Class

UnitTestCase

add_shortcode <?php

Class

UnitTestCase

esc_html__ <?php

Class

UnitTestCase

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

Ninja_Forms

_manually_load_plugin

Class

Ninja_Forms

__

Class

TestCase

loadTestData public: Load some test data

Param
string $file
Return
array
loadArrayData public: Load array data returned as array from config file
Param
string $file PHP file name including extension
Return
array

Class

CompaniesTest

Test Companies class

setUp protected: @inheritDoc
testCreateCompany public: Ensure that data-less, communication-less class still returns expected data @covers \NFHubspot\EmailCRM\Hubspot\Sdk\Companies::createCompany

Class

ConfigureTest

Test Configure class delivers configurations as expected

setUp protected: @inheritDoc
testConfigure public: Ensures required configuration methods provided @covers \NFHubspot\EmailCRM\Hubspot\Factories\Configure::globalSettings @covers \NFHubspot\EmailCRM\Hubspot\Factories\Configure::formFields @covers \NFHubspot\EmailCRM\Hubspot\Factories\Configure::moduleConfig

Class

ContactsTest

Test Contacts class

setUp protected: @inheritDoc
testCreateContact public: Ensure that data-less, communication-less class still returns expected data @covers \NFHubspot\EmailCRM\Hubspot\Sdk\Contacts::createContact

Class

ConvertFieldPropertiesIntoFormFieldsTest

Test ConvertFieldPropertiesIntoFormFields class

testHandle public: Test that class successfully converts successful and unsuccessful request @covers NFHubspot\EmailCRM\Hubspot\Sdk\ConvertFieldPropertiesIntoFormFields::handle()

Class

CreateRecordsFormActionHandlerTest

Test FormActionHandler functionality

testValidations public: Ensure that validation method returns the correct validated values @test
Return
void

Class

extends

__construct public
exposeValidateValueByFieldType public: Provide external access to method

Param
mixed $rawValue
Param
string $fieldType
Return
void
validateDates public: Ensure date values are constructed correctly when timezone is set
Timestamp uses microseconds, so multiply values by 1000
To account for possible daylight savings time, compare absolute value within one hour (36001000) @test
Return
void
__construct public
testFormatDateField public
validateDatesNoTimezone public: Ensure date values are constructed correctly when no timezone set
Timestamp uses microseconds, so multiply values by 1000
To account for possible daylight savings time, compare absolute value within one hour (36001000) @test
Return
void
__construct public
testFormatDateField public
testHandle public: @covers \NFHubspot\EmailCRM\Hubspot\Factories\Configure::globalSettings @covers \NFHubspot\EmailCRM\Hubspot\Factories\Configure::formFields
mockClass protected: @inheritDoc
getId public
getName public

Class

$this

Class

DealsTest

Test Deals class

setUp protected: @inheritDoc
testCreateContact public: Ensure that data-less, communication-less class still returns expected data @covers \NFHubspot\EmailCRM\Hubspot\Sdk\Deals::createDeal

Class

ExtractAssociatinResponseTest

Test ExtractAssociatinResponse class

testBadRequest public: Test that class successfully converts bad response Test using empty handled response @covers NFHubspot\EmailCRM\Hubspot\Sdk\ExtractAssociatinResponse::extractResults()

Class

ExtractCreateEntryResultsTest

Test ExtractCreateEntryResultsTest class

testBadRequest public: Test that class successfully converts bad response Test using empty handled response @covers NFHubspot\EmailCRM\Hubspot\Sdk\ExtractCreateEntryResultsTest::extractResults()

Class

HubspotSdkTest

setUp public: Set up before each test
testGetApiFields public: Ensure all get
Fields are available and return FormFields entities @covers \NFHubspot\EmailCRM\Hubspot\HubspotSdk::getContactFields @covers \NFHubspot\EmailCRM\Hubspot\HubspotSdk::getCompanyFields @covers \NFHubspot\EmailCRM\Hubspot\HubspotSdk::getDealFields @covers \NFHubspot\EmailCRM\Hubspot\HubspotSdk::getTicketFields

Class

testCreateEntry public: Ensure all valid module requests return HandledResponse with correct context Dummy module added in request to ensure class skips undefined modules; this module must be skipped, not appearing in the response collection such that only valid requests are made through the SDK. @covers \NFHubspot\EmailCRM\Hubspot\HubspotSdk::createEntry

Class

HubspotTest

testConstants public: Ensure that required constants are set @covers \NFHubspot\EmailCRM\Hubspot\Hubspot::IDENTIFIER
testGetGlobalSettings public: Ensure as-configured global settings have required values @covers \NFHubspot\EmailCRM\Hubspot\Hubspot::getGlobalSettings
testSetGlobalSettings public: Ensure class sets global settings correctly with correct return types @covers \NFHubspot\EmailCRM\Hubspot\Hubspot::setGlobalSettings

Class

RemoteRequest

Agnostic implementation of WP Bridge's remote request Skips the wp_remote_request

handle public: Override handle() with empty response after skipping HTTP request
Return
HandledResponse
finalizeRequest protected: Overrides finalizeRequest to skip add_query_args WordPress function

Class

TicketsTest

Test Tickets class

setUp protected: @inheritDoc
testCreateContact public: Ensure that data-less, communication-less class still returns expected data @covers \NFHubspot\EmailCRM\Hubspot\Sdk\Tickets::createTicket

Class

UnitTestCase

Class

UnitTestCase

_manually_load_plugin

Class

UnitTestCase

__

Class

TestCase

loadTestData public: Load some test data

Param
string $file
Return
array
loadArrayData public: Load array data returned as array from config file
Param
string $file PHP file name including extension
Return
array

Class

ConsolidatedHandledResponseTest

Test ConsolidatedHandledResponse class Ensure that a collection of Handled Responses are summarized correctly, appending all error messages, summing record counts.

testBadRequest public: Ensure poorly formed request returns valid response

Class

getCollection protected: Load and return specified sample HandledResponse collection data
Param
type $collectionName
Return
array
constructHandledResponseCollection protected: Construct collection of HandledResponses CRMs make multiple API requests while processing a submission, which are collected as an indexed array of HandledResponses. This method simulates that collection when given a well-formed array.
Param
array $array

Class