Ninja Forms Developer Docs

Class

SalesforceAccessTokenV2_9

receives an array 'credentials_array'=> 'refresh_token'=>, 'consumer_key, 'consumer_secret'=>,
returns access_token

Author

Stuart Sequeira

extract_needed_parameters protected
build_response_messages protected
build_final_http_args protected
build_url protected
extract_data_from_response_body protected
get_instance_url public
get_access_token public

Class

SalesforceRefreshToken

Grabs the client_id, client_secret, and authorization_code from the settings in the options database Returns the refresh token and instance Accessed on the Settings Pages, this class generates the token and instance to be stored in the options database for use during each form submission Receives parameter_array 'client_id' => 'client_secret' => 'authorization_code' => writes the refresh token directly into the options database

Author

Stuart Sequeira

extract_needed_parameters protected
build_response_messages protected
build_url protected
build_final_http_args protected
extract_data_from_response_body protected
get_refresh_token public

Class

SalesforceSecurityCredentials_V2_9

Structure of returned array 'result' 'comm_data' //-comm_data_array structure-// ) 'data'=>array( 'refresh_token'=>, 'consumer_key, 'consumer_secret'=>, )

__construct
extract_consumer_key private
extract_consumer_secret private
extract_refresh_token private
extract_password private
get_credentials_array public
get_comm_data public

Class

SalesforceVersion_V2_9

Grabs a list of available verions Sets the version_url to the lates version Receives parameter_array['instance']

Author

Stuart Sequeira

extract_needed_parameters protected
build_response_messages protected
build_url protected
build_final_http_args protected
extract_data_from_response_body protected
get_version_url public

Class

SalesforceBuildRequestV2_9

Author

Stuart Sequeira

__construct // specifies the child objects and the child object field that uses the parent object id for linking
link_child_objects public
build_object_order protected: Creates a default array of the order in which objects must be posted to ensure that the following objects can be linked to the newly created object's ID
build_child_object_array protected: Creates a default array of parent objects containing an array of child objects and the field name that links the child to the parent.
iterate_field_array protected: For NF 2.9 Cycle through the field array from ninja_forms_processing Extract the object and field map Calls method to validate form value Builds the unprioritized request array when finished cycling
iterate_nf3_array protected: Iterates array structure for NF3 and sends it to process method The Process Field method is shared with 2.9, so the special instructions are converted one by one into the 2.9 data structure to prevent 2.9 installs from breaking
structureSpecialInstructions protected: Converts NF3 special instructions into a NF2.9-friendly data structure Added February 2018 to refactor for simplifying structure
Param
array $field
Return
array
process_field protected: Adds field to request array, given field data and raw form value
Param
array $field field data structured as pre-3
Param
mixed $raw_form_value Submitted form value
validate_raw_form_value protected: Converts array values to comma separated string Converts date interval into date set to the interval from the form submission date
Param
type $raw_form_value
Param
type $field_args
Return
type
formatSalesforceCurrency protected: Converts incoming field into Salesforce currency format (integer) Added February 2018
Param
mixed $value_in
Return
integer
validate_unprioritized_request_array protected: Check if unprioritized request array has any values before proceeding If not, update comm data and return false to halt processing of form
reorder_request_array protected: Sorts the unprioritized array into order needed for processing Done by adding the two-digit object order to the front of each object, sorting on the object key, then removing the object order
build_object_request_list protected: Builds a list of the objects from the prioritized list for iteration This is done so that after each new record added, the request array can be modified to insert the newly created object id for linking
extract_field_settings protected: Extract the field arguments needed for validating each field Set a default value for any field argument that may not be automatically set, especially custom settings created by this extension Currency field_arg added Feb 2018 Removed unneeded $field variable mods
Param
array $field
Return
array
extract_object_and_field_map protected: Receives a string of the map argument set by the field registration Explodes the map argument into a salesforce object and a salesforce field
Param
string $map_args
Return
array
strip_html_tags protected: Strips the HTML tags NF3 escapes textarea tags; when these get sent to a custom field, these tags appear as text. The new default function is to decode and then strip these tags, then escape the result A filter allows one to keep the new functionality
Param
type $raw_form_value
get_request_array public
get_duplicate_check_array public
get_object_request_list public
get_object_field_list public

Class

SalesforceCommunicationV2_9

__construct
make_it_so protected
extract_needed_parameters protected
build_default_http_args private
build_final_http_args protected
build_url protected
build_response_messages protected
retrieve_request private
process_request private
process_successful_response_20x protected
extract_data_from_response_body protected
process_bad_request_400 private
extract_body_error_400_messages private: Analyzes the body of a 400 response to extract errors Some errors are a single key-value pair while others are an indexed array of key value pairs. There are also different keys used for the errors. These must all be handled without creating an error.
Return
array $this->error_array
process_forbidden_403 private
process_unhandled_response_codes private
process_wp_error private
process_failed_parameter_gatekeeper private
get_processed_result_array public
get_result public
get_comm_data public

Class

SalesforceDuplicateCheck

checks for a duplicate record by a given field in a given object Receives parameter_array 'instance' => 'version_url' => 'access_token' => 'object_name' => 'field_name' => 'field_value' =>

Author

Stuart Sequeira

extract_needed_parameters protected
build_response_messages protected
build_url protected
build_query_string protected
build_final_http_args protected
extract_data_from_response_body protected
get_duplicate_check_response public

Class

SalesforceDescribeObject

Returns the description of a given object Receives parameter_array 'instance' => 'version_url' => 'access_token' => 'object_name' =>

Author

Stuart Sequeira

extract_needed_parameters protected
build_response_messages protected
build_url protected
build_final_http_args protected
extract_data_from_response_body protected
get_object_description public

Class

SalesforceListOfObjects

Builds an indexed array of object names Receives parameter_array 'instance' => 'version_url' => 'access_token' =?

Author

Stuart

extract_needed_parameters protected
build_response_messages protected
build_url protected
build_final_http_args protected
extract_data_from_response_body protected
get_list_of_objects public

Class

SalesforcePostNewRecordObject_v2_9

Posts a new record into the specified object

Author

Stuart Sequeira

extract_needed_parameters protected
build_response_messages protected
build_url protected
build_final_http_args protected
extract_data_from_response_body protected
get_new_record_id public

Class

SalesforcePostNewRecordObject_v2_9

nfsalesforcecrm_add_field_map_option
nfsalesforcecrm_add_duplicate_check_checkbox
nfsalesforcecrm_add_date_interval_option
nfsalesforcecrm_add_format_as_date_option
nfsalesforcecrm_mappable_field_types /** * Build a list of standard Ninja Form fields that are mappable * Enable via filter a way to add fields created by extensions * * @return array * */

Class

SalesforcePostNewRecordObject_v2_9

nfsalesforcecrm_add_ua_extension_to_mappable_fields /* * Use array_merge to add an array of new field types from extensions to add * */

Class

SalesforcePostNewRecordObject_v2_9

nfsalesforcecrm_process_form_to_insert_form_data /* * Process the submitted form to send the data to Salesforce * */

Class

SalesforcePostNewRecordObject_v2_9

nfsalesforcecrm_extension_setup_license
nfsalesforcecrm_extension_load_lang
nfsalesforcecrm_frontend_hook
nfsalesforcecrm_settings_page_hook /** * When the Salesforce settings page is loaded, check if desired to update * account objects; If yes, then refresh object and fields for specified objects * @global array $nfsalesforcecrm_settings * */

Class

NF_SalesforceCRM_Actions_AddToSalesforce

__construct public: Constructor
enqueueAdminScripts public
save public
process public
retrieveActionMessages protected
instantiateFormProcessObject protected: Instantiates the FormProcess object for processing
injectRequestObject protected: Injects RequestObject into FormProcess object
If extending Request Object exists, injects that instead of standard
injectCommDataObject protected: Includes, initializes, and injects CommData object into FormProcess object
injectAnalyzeResponse protected: Injects AnalyzeResponse object into FormProcess object
injectSupportObject protected: Injects NF_SalesforceCRM_Support object into FormProcess object
builder_templates public
init_settings public
build_field_map_dropdown protected: Build the array of each field to be sent
Uses the reader-friendly name for both label and value. Processing can look up the programmatic value for mapping the request
Param
type $field_map_array
Return
array
scrub_action_settings protected: Remove unused dropdown options stored in specific action settings key
Param
type $keyed_action_settings
replace_placeholders public: Replace placeholder tags with Action-generated text
$this->action_messages is a keyed collection of messages accrued during the action process; these messages will replace a given placeholder text in other actions, such as the success or email messages

Param
array $action_settings
Param
string $form_id
Param
string $action_id
Param
array $form_settings
Return
array

Class

NF_SalesforceCRM_Admin_AdvancedCommands

Adds filters specified by an Advanced Command
Enables dashboard setting to apply hard coded filters

Author

stuartlb3

__construct public: Adds the Advanced Commands setting
Param
string $settings_key NF Settings key where advanced commands field is stored
refreshSettings public: Retrieves advanced command setting, generates advanced command array Checks setting from DB and sanitizes, then explodes and trims spaces
advancedCommands public: Returns the stored advanced codes for the plugin

Return
array Advanced codes as array
isAdvancedCommandSet public: Given an advanced command, evaluates if it is set or not
Param
string $command
Return
bool TRUE is command is set, FALSE if not set
variableAdvancedCommand public: Searches advanced commands for variable values and returns variable
Given a prefixed command, returns suffix, false on fail

Param
string $prefix
Return
string|false Variable value from advanced command, false on unmatched
intAdvancedCommmand public: Searches advanced commands for prefixed values and returns integer suffix
Given a prefixed command, returns integer, false on fail

Param
string $prefix
Return
integer|bool Description
arrayAdvancedCommmand public: Searches advanced commands for prefixed values and returns array suffix
Given a prefixed command, returns array, exploded on '-', false on fail
ex: samplecommand_A-B-C returns array (A,B,C)
Param
string $prefix
Return
array|bool Description

Class

NF_SalesforceCRM_Admin_AdvancedCommands

nfsalesforce_load_globals /** * Retrieve db options as global variables to minimize db calls * * @var array $nfsalesforcecrm_settings Client ID, Secret, Authorization Code, and Objects to Refresh * @var array $nfsalesforcecrm_comm_data Communication data for support * @var array $nfsalesforcecrm_account_data Objects and Fields available for field mapping * */
nfsalesforcecrm_extract_advanced_codes /** * Returns the advanced codes setting field as an array * @return array */
nfsalesforcecrm_advanced_code_is_set /** * Checks if given advanced code is set and returns boolean answer * * @param string $needle * @return boolean */
nfsalesforcrcrm_output_account_data /** * Create HTML for account data * * @global array $nfsalesforcecrm_settings * @global array $nfsalesforcecrm_account_data * @return type * */
nfsalesforcecrm_update_comm_data /** * Update communication data as a nested array for support * * 'debug'=>array( * *class* => array( * array( * 'heading' => string, * 'value' => string * ) * . . . * ) * . . . * ) * 'status'=>array( * (string) * . . . * ) * @param array $comm_data_array * */
nfsalesforcecrm_update_account_data
nfsalesforcecrm_update_settings
nfsalesforcecrm_listener /** * Listens for POST or GET requests with specific commands * * Calls specific functions based on the request made; uses if statements with * a switch/case so that only vetted functions are called instead of allowing * for unvetted function calls */
nfsalesforcecrm_refresh_token /** * Attempts to generate refresh token from key, secret, and auth code * * @global array $nfsalesforcecrm_settings Salesforce settings array in db * */
nfsalesforcecrm_filter_authcode /** * Adds characters removed by NF settings * @param string $incoming_authcode * @return string Authorization code with trailing %3D added back in */
nfsalesforcecrm_build_duplicate_check_task_array /* * Build the Task fields for reviewing the duplicate object, field, and value * found during the duplicate field check * * Currently uses Task Subject and Description */
nfsalesforcecrm_extract_upload_contents /** * Gets the contents of an href link * * If unable to retrieve the contents of the link, returns FALSE * * @param string $link Link sent in anchor href format * @return string $contents The contents of the link */

Class

NF_SalesforceCRM_Admin_Settings

__construct public
plugin_settings public
initiliazeCommData protected: Retrieves the stored Comm Data and sets default for any missing values
setHTMLMarkup protected: Sets and marks up the HTML values on the CRM section of settings page
optionDisplaySupport protected: Optionally display the support settings
Param
array $advanced_codes Advanced codes array
optionHideSetup protected: Optionally hide the setup settings Used to remove the setup settings (to reduce clutter on the page)
Param
array $advanced_codes Advanced codes array
plugin_settings_groups public
buildAuthURL protected: Build the Authorization URL
buildAuthorizationCodeMarkup protected: Used to provide current status of API connection
buildRefreshTokenInstructionsMarkup protected: Return
string HTMl markup of listener link for refresh token generation
buildStatusMarkup protected: Return
string HTML markup of the status array
buildRefreshTokenListenerLink protected: Builds URL for refresh token listener
Return
string Listener URL for refresh token Needs to match the URL in nfsalesforcecrm_listener
buildRefreshObjectsInstructionsMarkup protected: Return
string Markup with link for refreshing object
buildRefreshObjectsListenerLink protected: Builds URL for refresh objects listener
Return
string Listener URL for objects token Needs to match the URL in nfsalesforcecrm_listener

Class

NF_SalesforceCRM_Admin_Settings

nfsalesforcecrm_build_salesforce_field_list /** * Builds the drop-down list of Salesforce fields that can be mapped to * * Uses the global account_data variable to construct list. Structure is * an index array of 'name'-'value' pairs. The 'name' is reader-friendly, * the 'value' is programmatic * * @global array $nfsalesforcecrm_account_data * @return array * * TODO: refactor this function to eliminate multiple return statements */

Class

NF_SalesforceCRM_Admin_Settings

nfsalesforcecrm_retrieve_api_parameters /** * Uses the user settings to build an array of parameters needed to access * the Salesforce API * * Creates an instance of SalesforceSecurityCredentials to build security credentials * Creates an instance of SalesforceAccessToken from the security credentials * Creates an instance of SalesforceVersion from the access token * * @global array $nfsalesforcecrm_settings * @return array * api_parameter_array * 'result' => * 'status' => * 'access_token' => * 'instance' => * 'version_url' => * */

Class

NF_SalesforceCRM_Admin_Settings

nfsalesforcecrm_refresh_salesforce_objects /* * Process the submitted form to send the data to Salesforce * */

Class

ProcessAddToSalesforce

Handles the Process of the Add to Salesforce Action

Author

stuartlb3

__construct public: Processes the Add to Salesforce Action upon submission

Param
array $action_settings Action Settings from form submission
Param
string $form_id Form ID of the submission
Param
array $data Data array of the form submission
Param
array $field_map_array Salesforce fields available for mapping as indexed array of 'name''value' pairs
Param
array $fields_to_extract Field mapping keys of submission data to extract
processForm public: Processes the Add To Salesforce action
Return
boolean
getAuthorization protected: Retrieves and sets the API parameter array; false on failure
Updates the CommData status with results
TODO: add detailed failure analysis on failure ex: missing parameters, no internet
getObjectRequestList protected: Retrieves the Object Request List, if empty, logs CommData status message
iterateObjectList protected: Iterates the array of objects and inserts them into Salesforce
Return
boolean
logResponses protected: Gets raw response and analysis and logs them
Param
string $object_name
Param
\SalesforceCommunication $comm_object
checkForDuplicates protected: Cycle through the duplicate check array and check if the given Salesforce object and field have more than one of the same user value If true, create a task with description identifying the object, field, and value that is duplicated
analyzeResponse protected: Given a raw response, gets analysis and logs into CommData
Param
array $response Raw response from CommunicationObject
Return
array Response analysis
buildMessageArray protected: Given an object and the analysis, builds messages with appended support
Param
string $object Name of Salesforce object
Param
array $analysis Response analysis from SalesforceAnalyzeResponse
Return
array Message array
updateStatus protected: Updates status, given an array of messages
appendContextualHelp protected
appendStatusMessageArray protected: Appends status_message_array with given message array
Param
array $array Messages to append
logOrderedRequest protected: Given the object name and field array, add it Comm Data ordered request

Param
string $object
Param
array $field_array
extractFieldData protected: Builds the request array from extracted field mapping data
buildFieldMapLookup protected: Builds associative array['name'] => 'value' for available field maps
The lookup is keyed on the reader-friendly 'name' to lookup the mapping value
setRequestObject public: Inject the Salesforce Request Object for processing
Param
object $object
setCommDataObject public: Inject the Communication Data Object for managing comm data
Param
array $object
setAnalyzeResponseObject public: Inject the AnalyzeResponse Object to analyze and return information
Param
array $object SalesforceAnalyzeResponse class
setSupportObject public: Inject the Support Object to provide contextual support
Param
array $object NF_SalesforceCRM_Support class
getData public: Returns the $data from the form submission
Return
array
getMessages public: Returns Action messages, optionally imploded per formate
plain = plain text line breaks html, screen =

Param
string $format
Return
mixed

Class

SalesforceAnalyzeResponse

Given a full response, analyze and return pertinent information

Author

stuartlb3

Since

3.1.0

analyzeResponse public: Analyze current response
getData protected: On create success, raw data has this structure: a:3:{ s:2:"id";s:18:" { string } "; s:7:"success";b:1; s:6:"errors";a:0:{} }
On Duplicate Check a:3{ s:9:"totalSize";i:_ s:4:"done";b:_ s:7:"records";a:_{} }
Return
array Extracted data
extractDataErrors protected: On failure, raw data has this structure: a:1:{ i:0;a:3:{ s:7:"message";s:39:" { human-readable string } "; s:9:"errorCode";s:22:" { programmatic string }"; s:6:"fields";a:1:{i:0;s:8:" { field-name string } ";} // OPTIONAL } }
On error, extract each error as an element in data[ 'errors' ] If fields is populated, each field will get its own fully formed element with message and errorCode

Param
array $raw_data Raw data array describing errors
Return
array Indexed array of errors
iterateErrorFields protected: Splits a single error with multiple fields into individual errors
Each individual error has a string as an error

Param
array $single_error Single error from raw response data
Return
array Indexed array of errors
initVars protected: Initialize variables for new analysis
setResponse public: Sets the incoming response
Param
array $raw_response
Param
string Context of response, 'create' or 'getrecords'
getResponseAnalysis public: Returns the Analysis of the full response
Return
array

Class

SalesforceCommData

Manages updates to the communication data log Retrieves existing db array for starting log; overwrites or appends new communication data; writes log to db

Author

stuartlb3

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
initializeCommData public: Retrieves existing CommData from db If incoming value is not an array, sets CommData as empty array
Param
string $db_key WP options table key storing data
storeCommData public: Stores CommData array in WP options table under given key
Param
string $db_key WP options table key storing data

Class

SalesforceContextualSupport

Given context, search help configuration and returns contextual help

__construct public
searchContext public: Searches for context in help configuration and returns array of help text
Context should be set before using this method

Return
array
isMatched protected: Given an code or message snippet, determines if Contextual Help exists

Param
string $search_string Portion of string to be matched
Return
boolean
setAndSearchContext public: Sets context and returns contextual help array

Param
array error Message from response error
Return
array
setContext public: Set context of what support is needed
A string is given and it is used to search for available help documentation.
Param
string $context

Class

SalesforceSettingsMarkup

Given a key and raw values, adds markup for display on Settings page

Author

stuartlb3

markup public
orderedRequest public
fieldMapArray public
commDataDebug public
markupRequestForDisplay public

Class

SalesforceAccessToken

Communication object requesting access token Expected parameter array on construct: 'credentials_array'=> 'refresh_token'=>, 'consumer_key, 'consumer_secret'=>,

extract_needed_parameters protected: @inheritDoc
build_response_messages protected: @inheritDoc
build_final_http_args protected: @inheritDoc
build_url protected: @inheritDoc
extract_data_from_response_body protected: @inheritDoc
get_instance_url public: Return the generated instance url

Return
string|bool
get_access_token public: Return the generated access token

Return
string|bool

Class

SalesforceRefreshToken

Grabs the client_id, client_secret, and authorization_code from the settings in the options database Returns the refresh token and instance Accessed on the Settings Pages, this class generates the token and instance to be stored in the options database for use during each form submission Receives parameter_array 'client_id' => 'client_secret' => 'authorization_code' => writes the refresh token directly into the options database

Author

Stuart Sequeira

extract_needed_parameters protected
build_response_messages protected
build_url protected
build_final_http_args protected
extract_data_from_response_body protected
get_refresh_token public

Class

SalesforceSecurityCredentials

Given stored settings, extract credentials into known structure
Provides communication data with credentials to provide technical assistance to the class making the call for credentials

__construct /** * Construct with array of raw credential data * * * @param [type] $nfsalesforcecrm_settings */
extract_consumer_key private: Extract consumer key and store in credentials property

Return
void
extract_consumer_secret private: Extract consumer secret and store in credentials property

Return
void
extract_refresh_token private: Extract refresh token and store in credentials property

Return
void
extract_password private: Unused method - should be removed

Return
void
ToDo
Remove this unused method
get_credentials_array public: Return credentials array

Return
array|bool
get_comm_data public: Unused method - should be removed

Return
void
ToDo
Remove this method after verifying disuse

Class

SalesforceVersion

Grabs a list of available verions Sets the version_url to the lates version Receives parameter_array['instance']

Author

Stuart Sequeira

extract_needed_parameters protected
build_response_messages protected
build_url protected
build_final_http_args protected
extract_data_from_response_body protected
get_version_url public

Class

SalesforceBuildRequest

Author

Stuart Sequeira

__construct
setFieldArray public
iterateFieldArray public
link_child_objects public
build_object_order protected: Creates a default array of the order in which objects must be posted to ensure that the following objects can be linked to the newly created object's ID
build_child_object_array protected: Creates a default array of parent objects containing an array of child objects and the field name that links the child to the parent.
iterate_nf3_array protected: Iterates array structure for NF3 and sends it to process method
processField protected
validateFormValue protected
validateDateFormat protected
forceBoolean protected
keepCharacters protected: Remove any html tags but keep the special characters like apostrophe and ampersand
TODO: determine how to handle this unused method
validateDateInterval protected
validateFileUpload protected
formatSalesforceCurrency protected: Converts incoming field into Salesforce currency format (integer)
Added February 2018
Param
mixed $value_in
Return
integer
validate_unprioritized_request_array protected: Check if unprioritized request array has any values before proceeding If not, update comm data and return false to halt processing of form
reorder_request_array protected: Sorts the unprioritized array into order needed for processing Done by adding the two-digit object order to the front of each object, sorting on the object key, then removing the object order
build_object_request_list protected: Builds a list of the objects from the prioritized list for iteration This is done so that after each new record added, the request array can be modified to insert the newly created object id for linking
extractObjectAndFieldMap protected: Receives a string of the map argument set by the field registration
Explodes the map argument into a salesforce object and a salesforce field

Param
string $map_args
Return
array
get_request_array public
get_duplicate_check_array public
get_object_request_list public
get_object_field_list public

Class

SalesforceCommunication

__construct /** * Constructed with parameter array that is validated by child class * @param array $parameter_array */
make_it_so protected: Process the communication request
Return
void
extract_needed_parameters protected
build_default_http_args private: Build the default HTTP args as defined by structure in wp_remote_post
Return
void
Since
3.1.0
setSSL private: Sets default ssl_verify, applies filters then advanced commands Default sslverify is true; modifies for nfsalesforcecrm_sslverify filter, then checks if advanced command 'sslverify_false' is set to change it to false
Return
boolean
Since
3.1.0
build_final_http_args protected
build_url protected
build_response_messages protected
retrieve_request private: Make the request, set response

Return
void
process_request private: Process the raw response data into a known structure

Return
void
process_successful_response_20x protected: Structure result when response code is 20x

Return
void
extract_data_from_response_body protected
process_bad_request_400 private: Structure result when response code is 400

Return
void
extract_body_error_400_messages private: Analyze the body of a 400 response to extract errors Some errors are a single key-value pair while others are an indexed array of key value pairs. There are also different keys used for the errors. These must all be handled without creating an error.
Return
void
process_forbidden_403 private: Structure result when response code is 403

Return
void
process_unhandled_response_codes private: Structure result when response code is not explicitly defined

Return
void
process_wp_error private: Structure result when response is a WP_Error

Return
void
process_failed_parameter_gatekeeper private: Structure response when parameter gatekeeper fails

Return
void
get_processed_result_array public: Return processed result array

Return
array|bool
get_result public: Return the processed result 'result' value 'failure' or child-defined value (should be 'success')

Return
void
get_comm_data public: Return comm data array
ToDo
Standardize comm data as entity object

Return
void
getRawResponse public: Returns the Raw Response; false if empty
Return
array|mixed
Since
3.1.0

Class

SalesforceDuplicateCheck

checks for a duplicate record by a given field in a given object Receives parameter_array 'instance' => 'version_url' => 'access_token' => 'object_name' => 'field_name' => 'field_value' =>

Author

Stuart Sequeira

extract_needed_parameters protected
build_response_messages protected
build_url protected
build_query_string protected
build_final_http_args protected
extract_data_from_response_body protected
get_duplicate_check_response public

Class

SalesforceDescribeObject

Returns the description of a given object Receives parameter_array 'instance' => 'version_url' => 'access_token' => 'object_name' =>

Author

Stuart Sequeira

extract_needed_parameters protected
build_response_messages protected
build_url protected
build_final_http_args protected
extract_data_from_response_body protected
get_object_description public

Class

SalesforceListOfObjects

Builds an indexed array of object names Receives parameter_array 'instance' => 'version_url' => 'access_token' =?

Author

Stuart

extract_needed_parameters protected
build_response_messages protected
build_url protected
build_final_http_args protected
extract_data_from_response_body protected
get_list_of_objects public

Class

SalesforcePostNewRecordObject

Posts a new record into the specified object

Author

Stuart Sequeira

extract_needed_parameters protected
build_response_messages protected
build_url protected
build_final_http_args protected
extract_data_from_response_body protected
get_new_record_id public

Class

SimpleEntity

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

toArray public: Constructs an array representation of an object
Returns all properties; if properties are not set, then values defined by setter method ensures required values are set. Undefined properties are returned as stored in object. This enables passing of undefined properties, enabling extension of object.
jsonSerialize public: Sets data for json_encode

Return
void
__get public: Magic method getter for properties

Param
string $name
Return
void
__set public: Magic method setter for properties
Usually does not support setting undefined properties, but this class is enabling that, although it is kept as a separate command in case it must be modified. This is because field definitions can have an undetermined collection of settings and this class will enable setting of all those values, while maintaining the ability to define sets and gets that filter values for proper types.

Param
string $name
Param
mixed $value
Return
Void

Class

NF_SalesforceCRM

instance public
__construct public
composerAutoloader /** * Load an autoloader from vendor subdirectory * * This function can be copied and reused in other plugins using composer's * PSR-4 specification because it is namespaced within this file to avoid * collision. * * @return boolean */
loadTools public: Instantiates advanced commands object as public property
register_actions public
initiateFilters public: Adds filters for immediate use Ensures filters that are called on page load can have values set
returnConnectiontype public: Checks advanced command "sandbox_", returns connection type Used for connecting to a sandbox version of the site
Param
string $original
Return
string
setup_license public
setup_admin public: Create the settings page
load_classes public
config public
file_include public
template public
autoloader public
get_nfsalesforcecrm_account_data public: Return
array Array of the Account data
get_nfsalesforcecrm_comm_data public: Return
array Array of the communication data
modify_nfsalesforcecrm_comm_data public: Modify the comm data global This doesn't write to the database to minimize db calls. Rather, use update_nfsalesforcecrm_comm_data to write to the db. If there is a point where error can halt or branch; run an update to store the last known data.
Param
string $key Key of the comm data to update
Param
string $value Value to update in comm data
Param
bool $append Add to nested array to preserve previous data
update_nfsalesforcecrm_comm_data public: Write the current global comm data to the database
NF_SalesforceCRM /** * The main function responsible for returning The Highlander Plugin * Instance to functions everywhere. * * Use this function like you would a global variable, except without needing * to declare the global. * * @since 3.0 * @return {class} Highlander Instance */
NF_SalesforceCRM_Upgrade
nfsalesforcecrm_build_field_lookup_array /** * * @return array A lookup array keyed on the stored value to replace with the proper label */

Class

SalesforceSettingsMarkupTest

ensureSingleRequestMarkupWithString public: Ensures single request markup with string value is constructed properly
Tests that a debug value with a string outputs correctly as a single row with inline style @test
Return
void
ensureSingleRequestMarkupWithArray public: Ensures single request markup with array value is constructed properly
Tests that an array value for debug is serialized @test
Return
void
setUp public: @inheritDoc

Class

PluginTestCase

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

Return
void
defineAbspath protected: Set ABSPATH to the Wordpress directory

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

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

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

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

Class

PluginTestCase

add_shortcode <?php

Class

PluginTestCase

esc_html__ <?php

Class

PluginTestCase

get_option
update_option

Class

Ninja_Forms

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

instance public
form public: Form Model Factory Wrapper

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

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

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

Return
array
update_setting public: Update a setting

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

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

Class

Ninja_Forms

plugins_url <?php
is_ssl

Class

Ninja_Forms

__

Class

Ninja_Forms

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

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

Class

VerifyTestStructureTest

ensureTestSuiteRuns public: @test
testAutoloader public: Ensures that autoloader correctly loads non-dev classes @test

Class

SalesforceAccessTokenV2_9

SalesforceRefreshToken

SalesforceSecurityCredentials_V2_9

SalesforceVersion_V2_9

SalesforceBuildRequestV2_9

SalesforceCommunicationV2_9

SalesforceDuplicateCheck

SalesforceDescribeObject

SalesforceListOfObjects

SalesforcePostNewRecordObject_v2_9

SalesforcePostNewRecordObject_v2_9

SalesforcePostNewRecordObject_v2_9

SalesforcePostNewRecordObject_v2_9

SalesforcePostNewRecordObject_v2_9

NF_SalesforceCRM_Actions_AddToSalesforce

NF_SalesforceCRM_Admin_AdvancedCommands

NF_SalesforceCRM_Admin_AdvancedCommands

NF_SalesforceCRM_Admin_Settings

NF_SalesforceCRM_Admin_Settings

NF_SalesforceCRM_Admin_Settings

NF_SalesforceCRM_Admin_Settings

ProcessAddToSalesforce

SalesforceAnalyzeResponse

SalesforceCommData

SalesforceContextualSupport

SalesforceSettingsMarkup

SalesforceAccessToken

SalesforceRefreshToken

SalesforceSecurityCredentials

SalesforceVersion

SalesforceBuildRequest

SalesforceCommunication

SalesforceDuplicateCheck

SalesforceDescribeObject

SalesforceListOfObjects

SalesforcePostNewRecordObject

SimpleEntity

NF_SalesforceCRM

SalesforceSettingsMarkupTest

PluginTestCase

PluginTestCase

PluginTestCase

PluginTestCase

Ninja_Forms

Ninja_Forms

Ninja_Forms

Ninja_Forms

VerifyTestStructureTest

$class