Ninja Forms Developer Docs

Class

AddSubmenuPage

Add submenu page enabling edits on all scheduled submission exports

__construct public: Construct submenu page using FormSettingsStorage
Param
FormSettingsStorage $formSettingsStorage
registerSubmenu public: Register submenu page
outputMarkup public: Output markup for submenu page
Calls class that generates output for the UI for changing the date/time of daily and weekly exports.
Class class that generates output to list all existing scheduled exports, grouped by form, with links to those forms' builder.
setLogger public: Set the logger

Return
AddSubmenuPage
getLogger public: Provide the logger, fallback to empty logger

Class

FormSettings

Register settings with Ninja Forms Provides options via static methods for consistent settings data

__construct public: Add Export Scheduling settings as form settings
constructIntervalOptions public
constructFormatOptions public
constructDeliveryOptions public
formSettingsTypes public: Add Scheduled Exports form setting type
Param
type $types
Return
type
formExportSettings public: Append Export Schedule option repeater to Scheduled Exports section
Param
array $settings
Return
array
builderTemplates public: Add templates for HTML output
addExtendedFormats public
addExtendedDelivery public
getExportSettings protected: Get form export settings as currently stored in NF Settings (not permanent location)
Param
int $formId
Return
array
getFormIds protected: Get indexed array of form Ids

Class

SubmissionExportScheduler

Register and fire submission export actions on a WP Cron schedule

__construct public: Ensure Cron hooks are linked and internal methods attached to those hooks
Param
StorageInterface $scheduledExportParametersStorage
nfSubExportHourly public: Export on Hourly Interval
nfSubExportDaily public: Export on Daily Interval
nfSubExportWeekly public: Export on Weekly Interval
nfSubExport public: Perform requested scheduled submission exports Requests retrieved by ScheduledExportSettingsStorage class.
Param
string $interval
makeSubmissionAggregate protected: Return filtered SubmissionAggregate

Param
SubmissionFilter $submissionFilter
Return
SubmissionAggregate
generateFormattedOutput protected: Select method for generating output, return array of filenames
Param
string $format
Param
SubmissionAggregate $submissionAggregate
Return
array Keyed on `attachmentNames`, `fileInfos`
generateCsvOutput protected: Generate output as a CSV file, returning filename as indexed array Single file is generated for a collection of CSVs; returned as an indexed array of a single element to maintain common return structure with other output methods (PDF, for example) that must generate a separate file for each submission.
Param
SubmissionAggregate $submissionsCollection
Return
array
deliverOutput protected: Select delivery method to deliver attachments
Param
string $delivery
Param
ScheduledExportParameters $scheduledExportParameters
Param
array $attachmentNames
Param
array $fileInfos Array of filenames for attachment
deliverEmail protected: Deliver specified files via email
Param
ScheduledExportParameters $scheduledExportParameters
Param
array $fileInfos
getFromEmailAddress protected: Provide a 'from' email address for email Currently defaults to admin email

Return
string
handleWpMailFailure public: Logs a wp_mail failure do_action is called when wp_mail fails; this catches it and logs the failure

Param
[type] $wpError
Return
void
convertExportParametersToSubmissionFilter protected: Given export request and interval, generate submission filter parameters
Param
ScheduledExportParameters $scheduledExportParameters
Param
string $interval
Return
SubmissionFilter
setLogger public: Set the logger

Return
self
getLogger public: Provide the logger, fallback to empty logger

Class

LogEntry

fromArray public
fromString public
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.
__get public: Magic method getter for properties

Param
string $name
Return
void
__set public: Magic method setter for properties

Param
string $name
Param
mixed $value
Return
Void
__toString public: @inheritDoc
getLevel public: Get PSR log level

Return
string
setLevel public: Set PSR log level

Param
string $level PSR log level

Return
LogEntry
getSummary public: Get log summary

Return
string
setSummary public: Set log summary

Param
string $summary Log summary

Return
LogEntry
getTimestamp public: Get timestamp in epoch format

Return
int
setTimestamp public: Set timestamp in epoch format

Param
integer $timestamp Timestamp in epoch format

Return
LogEntry
getLogPoint public: Get situation under which entry happened

Return
string
setLogPoint public: Set situation under which entry happened

Param
string $logPoint Situation under which entry happened

Return
LogEntry
getSupportingData public: Get supporting data

Return
string
setSupportingData public: Set supporting data

Param
string $supportingData

Return
LogEntry
getExpiration public: Get used for cleanup of records in DB

Return
integer
setExpiration public: Set used for cleanup of records in DB

Param
integer $expiration Used for cleanup of records in DB

Return
LogEntry

Class

LogLevel

Class that extends standard log levels with custom log levels

Class

LoggerFactory

__construct public
getLogger public: @inheritDoc
getDebugLogHandler public: @inheritDoc
getWarningHandler public: @inheritDoc
createDebugLogRoutes public: @inheritDoc
constructLogger protected: Construct common logger

Return
NfLogger

Class

DateTimeConverter

Converts timestamps between formats, cognizant of WordPress settings
This class is aware of the WordPress timezone settings and can convert stringed times into integer timestamps and vice-versa, relieving all other classes of this responsibility.

localizeDateTimeStringIntoEpoch public
localizeEpochIntoString public
getWpTimezoneSetting public

Class

DownloadDebugLog

__construct public
getDebugJson public: Get debug log as JSON string

Return
string
getDebugLog protected: Get collection of log entries for the plugin

Return
array
constructJsonString protected: Construct JSON string from debug log

Return
string
constructLineItem protected: Construct a stringed line item as JSON for easy reading Unpack double encoded supportingData

Param
LogEntry $logEntry
Return
string

Class

Logger

Logs data

log public: Record log using available handler at that level @inheritDoc
pushLogHandler public: Assigns a single handler to a given log level @inheritDoc

Param
NfLogHandler $handler
Param
string $logLevel
Return
void

Class

WordPressSettingsElementBuilder

Builds HTML elements to match WP settings

formElement public: Markup form opening and close elements
Param
string $endpoint
Param
bool $close
Return
string
generateSelectMarkup public: Generate Select markup
Param
string $elementId
Param
string $optionsMarkup
Return
string
generateOptions public: Generate options markup from FormSettings' defined options
Param
array $options
Param
mixed $selectedValue
Return
string
textboxElement public: Mark up a textbox element
Param
string $label
Param
string $dataId
Param
mixed $value
Param
string $divStyle
Param
string $inputStyle
Return
string
buttonElement public: Mark up a button element
Param
string $id
Param
type $label
Return
string
hiddenElement public: Mark up a hidden input element
Param
string $dataId
Param
mixed $value
Return
string
generateFormTable public: Generate open/close elements on form table

Param
boolean $close TRUE to close previously opened form element
Return
string

Class

TableLogHandler

Stores record as a DB entry Some of these may be expected to expire

log public: @inheritDoc
getPluginLogEntries public: @inheritDoc
getAllLogEntries public: Get every log entry in the table
Return
array
getLogEntriesByLevel public: Get log entries by log level
Param
string $requested The requested level to fetch
Return
array
getCallerLogEntries public: Get log entries by caller
Param
string $identifier The target log point
Return
array
getLogEntriesByParam protected: Base method for getting log entries from the table
Param
string $key the column to narrow our results by
Param
mixed $value the value(s) to apply in our search
Return
array
$logEntryArray
deletePluginLogEntries public: @inheritDoc
buildLogEntry protected: Construct log entry object from log request

Param
$message
Param
array $context
Return
LogEntry
maybeAddTable protected: Add our table if necessary
Return
void
tableExists protected: Verify our table exists
Return
boolean
storeLogEntry protected: Store entry in our table

Param
LogEntry $logEntry
Return
void
setPluginPrefix public: @inheritDoc

Class

TransientLogHandler

Stores temporary record as WP transients Temporary logs are expected to expire

log public: @inheritDoc
buildLogEntry protected: Construct log entry object from log request

Param
string|\Stringable $message
Param
array $context
Return
LogEntry
storeLogEntryAsTransient protected: Store entry as WP transient
Removes 'expiration' and 'logKey' values from entry because they are only needed for setting expiration, not actual diagnostics

Param
LogEntry $logEntry
Return
void
getPluginLogEntries public: @inheritDoc
deletePluginLogEntries public: @inheritDoc
setPluginPrefix public: @inheritDoc

Class

WpListTable

Base class for displaying a list of items in an ajaxified HTML table.
This is a copy of WordPress core's WP_List_Table at v 6.0. It is copied here because the base class is marked as private and not intended for external use.

Since

3.1.0

__construct public: Constructor.
The child class should call this constructor from its own constructor to override the default $args.

Since
3.1.0

Param
array|string $args { Array or string of arguments.
@type string $plural Plural value used for labels and the objects being listed. This affects things such as CSS class-names and nonces used in the list table, e.g. 'posts'. Default empty. @type string $singular Singular label for an object being listed, e.g. 'post'. Default empty @type bool $ajax Whether the list table supports Ajax. This includes loading and sorting data, for example. If true, the class will call the _js_vars() method in the footer to provide variables to any scripts handling Ajax events. Default false. @type string $screen String containing the hook name used to determine the current screen. If left null, the current screen will be automatically set. Default null. }
__get public: Make private properties readable for backward compatibility.

Since
4.0.0

Param
string $name Property to get.
Return
mixed Property.
__set public: Make private properties settable for backward compatibility.

Since
4.0.0

Param
string $name Property to check if set.
Param
mixed $value Property value.
Return
mixed Newly-set property.
__isset public: Make private properties checkable for backward compatibility.

Since
4.0.0

Param
string $name Property to check if set.
Return
bool Whether the property is a back-compat property and it is set.
__unset public: Make private properties un-settable for backward compatibility.

Since
4.0.0

Param
string $name Property to unset.
__call public: Make private/protected methods readable for backward compatibility.

Since
4.0.0

Param
string $name Method to call.
Param
array $arguments Arguments to pass when calling.
Return
mixed|bool Return value of the callback, false otherwise.
ajax_user_can public: Checks the current user's permissions

Since
3.1.0 @abstract
prepare_items public: Prepares the list of items for displaying.
@uses WP_List_Table::set_pagination_args()

Since
3.1.0 @abstract
set_pagination_args protected: An internal method that sets all the necessary pagination arguments

Since
3.1.0

Param
array|string $args Array or string of arguments with information about the pagination.
get_pagination_arg public: Access the pagination args.

Since
3.1.0

Param
string $key Pagination argument to retrieve. Common values include 'total_items', 'total_pages', 'per_page', or 'infinite_scroll'.
Return
int Number of items that correspond to the given pagination argument.
has_items public: Whether the table has items to display or not

Since
3.1.0

Return
bool
no_items public: Message to be displayed when there are no items

Since
3.1.0
search_box public: Displays the search box.

Since
3.1.0

Param
string $text The 'submit' button label.
Param
string $input_id ID attribute value for the search input field.
get_views protected: Gets the list of views available on this table.
The format is an associative array: - `'id' => 'link'`

Since
3.1.0

Return
array
views public: Displays the list of views available on this table.

Since
3.1.0
get_bulk_actions protected: Retrieves the list of bulk actions available for this table.
The format is an associative array where each element represents either a top level option value and label, or an array representing an optgroup and its options.
For a standard option, the array element key is the field value and the array element value is the field label.
For an optgroup, the array element key is the label and the array element value is an associative array of options as above.
Example:
[ 'edit' => 'Edit', 'delete' => 'Delete', 'Change State' => [ 'feature' => 'Featured', 'sale' => 'On Sale', ] ]

Since
3.1.0
Since
5.6.0 A bulk action can now contain an array of options in order to create an optgroup.

Return
array
bulk_actions protected: Displays the bulk actions dropdown.

Since
3.1.0

Param
string $which The location of the bulk actions: 'top' or 'bottom'. This is designated as optional for backward compatibility.
current_action public: Gets the current action selected from the bulk actions dropdown.

Since
3.1.0

Return
string|false The action name. False if no action was selected.
row_actions protected: Generates the required HTML for a list of row action links.

Since
3.1.0

Param
string[] $actions An array of action links.
Param
bool $always_visible Whether the actions should be always visible.
Return
string The HTML for the row actions.
months_dropdown protected: Displays a dropdown for filtering items in the list table by month.

Since
3.1.0
@global wpdb $wpdb WordPress database abstraction object. @global WP_Locale $wp_locale WordPress date and time locale object.

Param
string $post_type The post type.
view_switcher protected: Displays a view switcher.

Since
3.1.0

Param
string $current_mode
comments_bubble protected: Displays a comment count bubble.

Since
3.1.0

Param
int $post_id The post ID.
Param
int $pending_comments Number of pending comments.
get_pagenum public: Gets the current page number.

Since
3.1.0

Return
int
get_items_per_page protected: Gets the number of items to display on a single page.

Since
3.1.0

Param
string $option User option name.
Param
int $default_value Optional. The number of items to display. Default 20.
Return
int
pagination protected: Displays the pagination.

Since
3.1.0

Param
string $which
get_columns public: Gets a list of columns.
The format is: - `'internal-name' => 'Title'`

Since
3.1.0 @abstract

Return
array
get_sortable_columns protected: Gets a list of sortable columns.
The format is: - `'internal-name' => 'orderby'` - `'internal-name' => array( 'orderby', 'asc' )` - The second element sets the initial sorting order. - `'internal-name' => array( 'orderby', true )` - The second element makes the initial order descending.

Since
3.1.0

Return
array
get_default_primary_column_name protected: Gets the name of the default primary column.

Since
4.3.0

Return
string Name of the default primary column, in this case, an empty string.
get_primary_column public: Public wrapper for WP_List_Table::get_default_primary_column_name().

Since
4.4.0

Return
string Name of the default primary column.
get_primary_column_name protected: Gets the name of the primary column.

Since
4.3.0

Return
string The name of the primary column.
get_column_info protected: Gets a list of all, hidden, and sortable columns, with filter applied.

Since
3.1.0

Return
array
get_column_count public: Returns the number of visible columns.

Since
3.1.0

Return
int
print_column_headers public: Prints column headers, accounting for hidden and sortable columns.

Since
3.1.0

Param
bool $with_id Whether to set the ID attribute or not
display public: Displays the table.

Since
3.1.0
get_table_classes protected: Gets a list of CSS classes for the WP_List_Table table tag.

Since
3.1.0

Return
string[] Array of CSS classes for the table tag.
display_tablenav protected: Generates the table navigation above or below the table

Since
3.1.0
Param
string $which
extra_tablenav protected: Extra controls to be displayed between bulk actions and pagination.

Since
3.1.0

Param
string $which
display_rows_or_placeholder public: Generates the tbody element for the list table.

Since
3.1.0
display_rows public: Generates the table rows.

Since
3.1.0
single_row public: Generates content for a single row of the table.

Since
3.1.0

Param
object|array $item The current item
column_default protected: Param
object|array $item
Param
string $column_name
column_cb protected: Param
object|array $item
single_row_columns protected: Generates the columns for a single row of the table.

Since
3.1.0

Param
object|array $item The current item.
handle_row_actions protected: Generates and display row actions links for the list table.

Since
4.3.0

Param
object|array $item The item being acted upon.
Param
string $column_name Current column name.
Param
string $primary Primary column name.
Return
string The row actions HTML, or an empty string if the current column is not the primary column.
ajax_response public: Handles an incoming ajax request (called from admin-ajax.php)

Since
3.1.0
_js_vars public: Sends required variables to JavaScript land.

Since
3.1.0

Class

WpListTable

getLogger public: Provide a logger with desired log handlers

Return
NfLogger
getDebugLogHandler public: Construct the desired log handler for debug level logs

Return
NfLogHandler
getWarningHandler public: Construct the desired log handler for warning level logs

Return
NfLogHandler

Class

WpListTable

log public: Handle the log data in some fashion Typical uses include storing data in log file or in DB

Param
string|\Stringable $key
Param
array $context
Return
void
getPluginLogEntries public: Return indexed array of all log entries for a given plugin

Return
array LogEntry[]
deletePluginLogEntries public: Delete all plugin entries for a given plugin

Return
void
setPluginPrefix public: Set plugin prefix
Handlers must have a method to retrieve stored entries by plugin; setting this key enables easy identification by each handler

Param
string $prefix
Return
void

Class

WpListTable

pushLogHandler public: Push a log handler onto the stack of handlers

Param
LogHandler $handler
Param
string $logLevel
Return
void

Class

DebugLog

__construct public
registerRoutes /** * Register REST API routes for the debug log */
getDebugLogEntries public
deleteAllDiagnostics public
getDebugLogEntriesPermissionCallback public: Verify user is permitted to download diagnostics
Authorization handled using WP nonce
Param
WP_REST_Request $request
Return
void

Class

AbstractLogger

Class

InvalidArgumentException

Class

LogLevel

Describes log levels.

Class

LogLevel

setLogger public: Sets a logger instance on the object.

Param
LoggerInterface $logger

Return
void

Class

LogLevel

setLogger public: Sets a logger.

Param
LoggerInterface $logger

Class

LogLevel

emergency public: System is unusable.

Param
string|\Stringable $message
Param
mixed[] $context

Return
void
alert public: Action must be taken immediately.
Example: Entire website down, database unavailable, etc. This should trigger the SMS alerts and wake you up.

Param
string|\Stringable $message
Param
mixed[] $context

Return
void
critical public: Critical conditions.
Example: Application component unavailable, unexpected exception.

Param
string|\Stringable $message
Param
mixed[] $context

Return
void
error public: Runtime errors that do not require immediate action but should typically be logged and monitored.

Param
string|\Stringable $message
Param
mixed[] $context

Return
void
warning public: Exceptional occurrences that are not errors.
Example: Use of deprecated APIs, poor use of an API, undesirable things that are not necessarily wrong.

Param
string|\Stringable $message
Param
mixed[] $context

Return
void
notice public: Normal but significant events.

Param
string|\Stringable $message
Param
mixed[] $context

Return
void
info public: Interesting events.
Example: User logs in, SQL logs.

Param
string|\Stringable $message
Param
mixed[] $context

Return
void
debug public: Detailed debug information.

Param
string|\Stringable $message
Param
mixed[] $context

Return
void
log public: Logs with an arbitrary level.

Param
mixed $level
Param
string|\Stringable $message
Param
mixed[] $context

Return
void

Throws
\Psr\Log\InvalidArgumentException

Class

LogLevel

emergency public: System is unusable.

Param
string|\Stringable $message
Param
array $context

Return
void
alert public: Action must be taken immediately.
Example: Entire website down, database unavailable, etc. This should trigger the SMS alerts and wake you up.

Param
string|\Stringable $message
Param
array $context

Return
void
critical public: Critical conditions.
Example: Application component unavailable, unexpected exception.

Param
string|\Stringable $message
Param
array $context

Return
void
error public: Runtime errors that do not require immediate action but should typically be logged and monitored.

Param
string|\Stringable $message
Param
array $context

Return
void
warning public: Exceptional occurrences that are not errors.
Example: Use of deprecated APIs, poor use of an API, undesirable things that are not necessarily wrong.

Param
string|\Stringable $message
Param
array $context

Return
void
notice public: Normal but significant events.

Param
string|\Stringable $message
Param
array $context

Return
void
info public: Interesting events.
Example: User logs in, SQL logs.

Param
string|\Stringable $message
Param
array $context

Return
void
debug public: Detailed debug information.

Param
string|\Stringable $message
Param
array $context

Return
void
log public

Class

NullLogger

This Logger can be used to avoid conditional log calls.
Logging should always be optional, and if no logger is provided to your library creating a NullLogger instance to have something to throw logs at is a good way to avoid littering your code with `if ($this->logger) { }` blocks.

log public: Logs with an arbitrary level.

Param
mixed $level
Param
string|\Stringable $message
Param
array $context

Return
void

Throws
\Psr\Log\InvalidArgumentException

Class

Foo

__construct public
doSomething public

Class

ScheduledExportParameters

Entity to pass form export settings parameters
Provides a guarantee that any requested or required parameters have a known default value and type
Note that the `ExportSettings` configuration matches closely this object's field structure; this is because this object is the primary method to pass those form settings.

getDelivery public: Get delivery method
Return
string
getFormat public: Get output format
Return
string
getInterval public: Get interval between exports
Return
string
getMaxCount public: Get max number of submissions per export
Return
int
getFormId public: Get form Id
Return
int
getEmailTo public: Get Email `To` addresses string - comma delimited
Return
string
getEmailFrom public: Get Email `From` address
Return
string
getEmailReplyTo public: Get Email `Reply To` address
Return
string
getEmailSubject public: Get Email `Subject`
Return
string
getStartingTimestamp public: Get starting timestamp

Return
string Datetime in local timezone per WP settings
setEmailTo public: Set Email `To` addresses - comma delimited
Param
string $incoming
Return
ScheduledExportParameters
setEmailFrom public: Set Email `From` address
Param
string $incoming
Return
ScheduledExportParameters
setEmailReplyTo public: Set Email `Reply To` address
Param
string $incoming
Return
ScheduledExportParameters
setEmailSubject public: Set Email `Subject`
Param
string $incoming
Return
ScheduledExportParameters
setFormId public: Set form Id
Param
int $incoming
Return
ScheduledExportParameters
setDelivery public: Set delivery method
Param
string $incoming
Return
ScheduledExportParameters
setFormat public: Set output format
Param
string $incoming
Return
ScheduledExportParameters
setInterval public: Set interval between exports
Param
string $incoming
Return
ScheduledExportParameters
setMaxCount public: Set max number of submissions per export
Param
int $incoming
Return
ScheduledExportParameters
setStartingTimestamp public: Set starting timestamp

Param
string $incoming

Return
ScheduledExportParameters
toArray public: Convert instance to associative array
Return
array
fromArray public
__get public: Magic method to return property
Param
string $name
Return
mixed
__set public: Param
string $name
Param
mixed $value
Return
ScheduledExportParameters

Class

AddNewSubmissionExportScheduleMarkup

Constructs markup for Add New Submission Export Schedule

handle public: Param
int $index
Param
ScheduledExportParameters $scheduledExportParameters
createForm protected: Generate markup for form output
Return
string
generateFormOpen protected: Open form with wrapper, header, and handle
Return
string
generateFormSelectionOutput protected
generateIntervalMarkup protected: Generate Export Interval markup
Return
string
generateFormatMarkup protected: Generate Export Format markup
Return
string
generateDeliveryMarkup protected: Generate Export Delivery markup
Return
string
generateFormClose protected: Generate form close with hidden values and closing tags
Return
string

Class

ElementBuilder

Builds HTML elements

divWrapper public: Generate markup for outer box element; bool for closing tag
Param
bool $close
Return
string
formElement public: Markup form opening and close elements
Param
string $endpoint
Param
bool $close
Return
string
togglePanelButton public: Param
string $text Toggle button text
Return
string
accordionHandle public: Generate accordion handle markup
Param
string $text Accordion handle text
Param
mixed $formId Form Id
Return
string
generateSelectMarkup public: Generate Select markup
Param
string $elementId
Param
string $label
Param
string $optionsMarkup
Return
string
generateOptions public: Generate options markup from FormSettings' defined options
Param
array $options
Param
mixed $selectedValue
Return
string
textboxElement public: Mark up a textbox element
Param
string $label
Param
string $dataId
Param
mixed $value
Param
string $divStyle
Param
string $inputStyle
Return
string
buttonElement public: Mark up a button element
Param
string $id
Param
type $label
Return
string
hiddenElement public: Mark up a hidden input element
Param
string $dataId
Param
mixed $value
Return
string

Class

ExistingExportTableMarkup

Generate markup of existing scheduled exports as list table

setExistingExports public: Generate markup for modifying export date and times
prepare_items /** @inheritDoc */
generateLineItems protected: Generates the line items for the table

Return
void
generateFormMarkup protected: Generate markup for a form's scheduled exports

Param
string $formId
Param
array $scheduledExportsByForm
Return
string
generateFormTitleMarkup protected: Generate form title with link to form

Param
string $formId
Return
string
generateEditLinkMarkup protected: Generate href link to edit form

Param
string $formid
Return
string
getBaseFormEditUrl protected: Construct base URL for form edit

Return
string
get_columns /** @inheritDoc */
column_default /** @inheritDoc */

Class

ModifyExportTimingMarkup

Generate markup for modifying export date and times

handle public: Generate markup for modifying export date and times
generateMenuPageHeader protected
createForm protected: Generate markup for form output
Return
string
generateFormOpen protected: Open form with wrapper, header, and handle
Return
string
generateExistingScheduleDescription protected: Generate form heading
Return
string
generateFormTable protected
generateDailyMarkup protected: Return markup for daily schedule
Return
string
generateWeeklyMarkup protected: Return markup for weekly schedule
Return
string
formatDate protected: Return formatted string of date
Param
int $timestamp Unix timestamp
Return
string
generateWeekdayOptions protected: Return markup for Day of Week selection
Return
string
generateDailyTimeOptions protected: Return markup of daily time select options
Return
string
generateWeeklyTimeOptions protected: Return markup of weekly time select options
Return
string
getTimeSlots protected: Return array of time slot options
Return
array
generateFormClose protected: Generate form close with hidden values and closing tags
Return
string
setLogger public: Set the logger

Return
ModifyExportTimingMarkup
getLogger public: Provide the logger, fallback to empty logger

Class

ScheduledExportUiMarkup

Constructs markup for dashboard page scheduled export markup

handle public: Param
int $index
Param
ScheduledExportParameters $scheduledExportParameters
createForm protected: Generate markup for form output
Return
string
generateFormOpen protected: Open form with wrapper, header, and handle
Return
string
generateIntervalMarkup protected: Generate Export Interval markup
Return
string
generateFormatMarkup protected: Generate Export Format markup
Return
string
generateDeliveryMarkup protected: Generate Export Delivery markup
Return
string
generateFormClose protected: Generate form close with hidden values and closing tags
Return
string

Class

ModifyCronTiming

Modify Cron timing from dashboard request

__construct public: Initialize Cron storage upon construct
handle public: Modify Cron timing from dashboard request associative array
Param
array $array Keyed array dailytime, weeklytime, hourlytime,dayofweek,timezonestring
setExternallyDependentProperties protected: Set properties used throughout object
Isolate the setting of properties dependent on external conditions, isolating these to enable unit testing

Return
void
calculateNextDayOfWeek protected: Calculate timestamp for next weekly export
Param
int $dayOfWeek Integer day of week (1-7)
Param
string $timeString Parseable time string
Return
int Unix timestamp
calculateNextTimeOfDay protected: Calculate timestamp of next daily export
Param
string $timeString
Param
int $next Time offset in seconds until next day
Return
int Unix timestamp
setLogger public: Set the logger

Return
ModifyCronTiming
getLogger public: Provide the logger, fallback to empty logger

Class

SubmissionCsvUploadsDelivery

Upload CSV file to a specified location Default location is WP Uploads directory

__construct public: Set default values for CSV upload to Uploads directory
handle public: Write the contents of a csv string to a file
Param
string $content
Param
string $filename
setUploadDirectory public: Set upload directory If not set, then default value is used
Param
string $dir
Return
$this
setDefaults protected: Set default properties
writeTempFile protected: Write contents to temporary file location
renameFile protected: Rename temp file to permanent file name
Param
string $filename

Class

SubmissionExportUpdater

Updates form settings for a given ScheduledExportParameter and index

__construct public: Initialize form settings storage upon construct
handle public: Update form settings for a given ScheduledExportParameter and index
Param
ScheduledExportParameters $scheduledExportParameters
Param
int $index
addOrUpdateParameters protected: Set export parameters in correct index position
Param
ScheduledExportParameters $scheduledExportParameters
Param
int $index
retrieveCurrentFormSettings protected: Retrieve scheduled export settings for given form Id
Param
int $formId

Class

TemplateBuilder

Build output template script

handle public
constructTemplate protected: Construct action settings template

Return
void
scriptOpen protected: Generate opening script tag
Param
string $id
Return
string
addMenuHandle protected: Add menu handle
Return
string
addSelectBox protected: Add markup for select box
Param
string $label
Param
string $optionKey
Param
string $style
Return
string
addTextbox protected: Add markup for textbox
Param
string $label
Param
string $optionKey
Param
string $style
Return
string
addDisabledTextbox protected: Add markup for disabled textbox
Param
string $label
Param
string $optionKey
Param
string $style
Return
string
addHiddenTextbox protected: Add markup for hidden textbox
Param
string $label
Param
string $optionKey
Param
string $style
Return
string
scriptClose protected: Add markup to close the script
Return
string

Class

TemplateBuilder

getExportRequests public: Return all export requests across all forms

Return
array NinjaForms\NfScheduledExports\Entities\ScheduledExportParameters keyed on forms, then indexed for multiple export schedules per form
getByInterval public: Return all ScheduledExportParameters for a given interval Array keyed on interval, sub-key is indexed array
Param
string $interval
Return
array
getExportSettingsByForm public: Get indexed array of scheduled export parameters by form Id
Param
int $formId
setExportSettings public: Set export settings for a given form id Given form Id and indexed array of scheduled export parameters
Param
int $formId
Param
array $scheduledExportParametersArray

Class

NinjaFormsScheduledExports

Main class that controls plugin functionality

__construct public: Initialize form settings for scheduled actions with admin page output
set_timezone_missing_notice public: Display an error message if timezone is not set in general options
initializeLogger public: Initializes debug logger for injection
injectLogger protected
setupAdmin public: Setup admin classes for Ninja Forms and WordPress Hooked into `init`
registerSettingsScript public: Register settings script for settings page
Contains script for calling REST routes of debug logger
Return
void
registerEndpoint public: Register endpoints for triggering updates to schedules or timing
addPluginSettingsGroup public: Add configured settings group to the NF groups
Param
array $groups
Return
array
addPluginSettings public: Add configured plugin settings to the plugin group
Param
array $settings
Return
array
Configure public: Return configured data
Param
string $filename Filename without extension
Param
string $type File type - 'php' or 'json'
Return
mixed
updateExportSchedule public: Callback method for scheduled-exports endpoint
Param
WP_REST_Request $request
updateCronDateTime public: Callback method for submission-export-datetime endpoint
Param
WP_REST_Request $request
adminNotices public: Function to register any admin notices we need to show.
Param
$notices (Array) The list of admin notices.
Return
array The updated list of admin notices.

Class

CronStorage

Manage the retrieval and storage of Cron job information

scheduleEvents public: Link a hook to a named interval at a given start time
setDefaultSchedule public: Set a default cron job if one does not already exist
topOfHourTimestamp protected: Return timestamp for top of the next hour

Param
integer $epochTime
Return
integer
setHourlyTimestamp public: Set the timestamp for the next scheduled hourly cron job
Param
int $timestamp
setDailyTimestamp public: Set the timestamp for the next scheduled daily cron job
Param
int $timestamp
setWeeklyTimestamp public: Set the timestamp for the next scheduled daily cron job
Param
int $timestamp
getNextScheduled public: Return the next scheduled job for a given interval, 0 if not scheduled
Param
string $interval
Return
int Unix timestamp

Class

FormSettingsStorage

Provide Scheduled Export Settings as stored in Form Settings

getExportRequests public: @inheritDoc
constructScheduledExportParameterCollection protected: Construct indexed array ScheduledExportParameter objects

Param
string $formId
Param
array $exportSettings
Return
array Keys 'formExportRequests', 'supportingData'
getByInterval public: @inheritDoc
getExportSettingsByForm public: Get indexed array of scheduled export parameters by form Id
Param
int $formId
setExportSettings public: Set export settings for a given form id Given form Id and indexed array of scheduled export parameters
Param
int $formId
Param
ScheduledExportParameters[] $scheduledExportParametersArray
cacheOnDelivery protected: Rebuild the cache so every other Ninja_Forms() call gets the updated data
Param
int $formId
getExportSettings protected: Get form export settings stored as a form Setting Each form can have multiple ExportSettings, each of which specifies an interval, format, and delivery method at the minimum. May include email addresses and additional data required for any given export.
Param
int $formId
Return
array
getFormIds protected: Get indexed array of form Ids
setLogger public: Set the logger

Return
FormSettingsStorage
getLogger public: Provide the logger, fallback to empty logger

Class

ModifyCronTimingTest

ensureScheduleSetsOnSameDay public: Ensure schedule sets time on current day when current time has not passed
@test
ensureScheduleBumpsToNextDay public: Ensure schedule moves to following day when scheduled time has passed today
@test
ensureFailsafeWhenNoTimezoneSet public: Ensure schedule defaults to GMT when no timezone is set
@test
mockTestedClass protected: Return tested class with exposed methods and test params

Param
array $params
Return
ModifyCronTiming

Class

$params

__construct public: Pass test parameters into mocked object

Param
array $params
Return
void
callCalculateNextTimeOfDay public: Call the protected method calculateNextTimeOfDay() and return value

Return
void

Class

ModifyExportTimingMarkupTest

ensureExpectedOperation public: Ensure expected operation
Passes a valid Unix timestamp and valid timezone string, expects the correct string time @test
ensureEmptyTimezoneSuccess public: Ensure empty timezone does not cause failure Before resolution of issue #2, this test fails @test
See
https://github.com/Saturday-Drive/ninja-forms-scheduled-exports/issues/2
mockTestedClass protected: Return tested class with exposed methods and test params

Param
array $params
Return
ModifyExportTimingMarkup

Class

$params

__construct public: Pass test parameters into mocked object

Param
array $params
Return
void
callFormatDate public: Call the protected method formatDate() and return value

Return
void

Class

ScheduledExportParametersTest

ensureConstructionFromEmptyArray public: Ensure values constructed from empty array @test

Return
void

Class

ensureNewConstruction public: Ensure values constructed from 'new' command @test

Return
void
ensureValidFromArrayConstruction public: Ensure values constructed from expected data @test

Return
void
ensureInvalidFromArrayConstruction public: Ensure values constructed from incorrect data @test

Return
void
ensureIntegerValuesAsString public: Ensure integer value of string converts to integer @test

Return
void

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