element above the able. * * @var string */ protected $table_header; /** * Enables bulk actions. It must be an array where the key is the action name * and the value is the label (which is translated automatically). It is important * to notice that it will check that the method exists (`bulk_$name`) and will throw * an exception if it does not exists. * * This class will automatically check if the current request has a bulk action, will do the * validations and afterwards will execute the bulk method, with two arguments. The first argument * is the array with primary keys, the second argument is a string with a list of the primary keys, * escaped and ready to use (with `IN`). * * @var array */ protected $bulk_actions = array(); /** * Makes translation easier, it basically just wraps * `_x` with some default (the package name). * * @param string $text The new text to translate. * @param string $context The context of the text. * @return string|void The translated text. * * @deprecated 3.0.0 Use `_x()` instead. */ protected function translate($text, $context = '') { } /** * Reads `$this->bulk_actions` and returns an array that WP_List_Table understands. It * also validates that the bulk method handler exists. It throws an exception because * this is a library meant for developers and missing a bulk method is a development-time error. * * @return array * * @throws RuntimeException Throws RuntimeException when the bulk action does not have a callback method. */ protected function get_bulk_actions() { } /** * Checks if the current request has a bulk action. If that is the case it will validate and will * execute the bulk method handler. Regardless if the action is valid or not it will redirect to * the previous page removing the current arguments that makes this request a bulk action. */ protected function process_bulk_action() { } /** * Default code for deleting entries. * validated already by process_bulk_action() * * @param array $ids ids of the items to delete. * @param string $ids_sql the sql for the ids. * @return void */ protected function bulk_delete(array $ids, $ids_sql) { } /** * Prepares the _column_headers property which is used by WP_Table_List at rendering. * It merges the columns and the sortable columns. */ protected function prepare_column_headers() { } /** * Reads $this->sort_by and returns the columns name in a format that WP_Table_List * expects */ public function get_sortable_columns() { } /** * Returns the columns names for rendering. It adds a checkbox for selecting everything * as the first column */ public function get_columns() { } /** * Get prepared LIMIT clause for items query * * @global wpdb $wpdb * * @return string Prepared LIMIT clause for items query. */ protected function get_items_query_limit() { } /** * Returns the number of items to offset/skip for this current view. * * @return int */ protected function get_items_offset() { } /** * Get prepared OFFSET clause for items query * * @global wpdb $wpdb * * @return string Prepared OFFSET clause for items query. */ protected function get_items_query_offset() { } /** * Prepares the ORDER BY sql statement. It uses `$this->sort_by` to know which * columns are sortable. This requests validates the orderby $_GET parameter is a valid * column and sortable. It will also use order (ASC|DESC) using DESC by default. */ protected function get_items_query_order() { } /** * Querystring arguments to persist between form submissions. * * @since 3.7.3 * * @return string[] */ protected function get_request_query_args_to_persist() { } /** * Return the sortable column specified for this request to order the results by, if any. * * @return string */ protected function get_request_orderby() { } /** * Return the sortable column order specified for this request. * * @return string */ protected function get_request_order() { } /** * Return the status filter for this request, if any. * * @return string */ protected function get_request_status() { } /** * Return the search filter for this request, if any. * * @return string */ protected function get_request_search_query() { } /** * Process and return the columns name. This is meant for using with SQL, this means it * always includes the primary key. * * @return array */ protected function get_table_columns() { } /** * Check if the current request is doing a "full text" search. If that is the case * prepares the SQL to search texts using LIKE. * * If the current request does not have any search or if this list table does not support * that feature it will return an empty string. * * @return string */ protected function get_items_query_search() { } /** * Prepares the SQL to filter rows by the options defined at `$this->filter_by`. Before trusting * any data sent by the user it validates that it is a valid option. */ protected function get_items_query_filters() { } /** * Prepares the data to feed WP_Table_List. * * This has the core for selecting, sorting and filtering data. To keep the code simple * its logic is split among many methods (get_items_query_*). * * Beside populating the items this function will also count all the records that matches * the filtering criteria and will do fill the pagination variables. */ public function prepare_items() { } /** * Display the table. * * @param string $which The name of the table. */ public function extra_tablenav($which) { } /** * Set the data for displaying. It will attempt to unserialize (There is a chance that some columns * are serialized). This can be override in child classes for further data transformation. * * @param array $items Items array. */ protected function set_items(array $items) { } /** * Renders the checkbox for each row, this is the first column and it is named ID regardless * of how the primary key is named (to keep the code simpler). The bulk actions will do the proper * name transformation though using `$this->ID`. * * @param array $row The row to render. */ public function column_cb($row) { } /** * Renders the row-actions. * * This method renders the action menu, it reads the definition from the $row_actions property, * and it checks that the row action method exists before rendering it. * * @param array $row Row to be rendered. * @param string $column_name Column name. * @return string */ protected function maybe_render_actions($row, $column_name) { } /** * Process the bulk actions. * * @return void */ protected function process_row_actions() { } /** * Default column formatting, it will escape everything for security. * * @param array $item The item array. * @param string $column_name Column name to display. * * @return string */ public function column_default($item, $column_name) { } /** * Display the table heading and search query, if any */ protected function display_header() { } /** * Display the table heading and search query, if any */ protected function display_admin_notices() { } /** * Prints the available statuses so the user can click to filter. */ protected function display_filter_by_status() { } /** * Renders the table list, we override the original class to render the table inside a form * and to render any needed HTML (like the search box). By doing so the callee of a function can simple * forget about any extra HTML. */ protected function display_table() { } /** * Process any pending actions. */ public function process_actions() { } /** * Render the list table page, including header, notices, status filters and table. */ public function display_page() { } /** * Get the text to display in the search box on the list table. */ protected function get_search_box_placeholder() { } /** * Gets the screen per_page option name. * * @return string */ protected function get_per_page_option_name() { } } /** * Implements the admin view of the actions. * * @codeCoverageIgnore */ class ActionScheduler_ListTable extends \ActionScheduler_Abstract_ListTable { /** * The package name. * * @var string */ protected $package = 'action-scheduler'; /** * Columns to show (name => label). * * @var array */ protected $columns = array(); /** * Actions (name => label). * * @var array */ protected $row_actions = array(); /** * The active data stores * * @var ActionScheduler_Store */ protected $store; /** * A logger to use for getting action logs to display * * @var ActionScheduler_Logger */ protected $logger; /** * A ActionScheduler_QueueRunner runner instance (or child class) * * @var ActionScheduler_QueueRunner */ protected $runner; /** * Bulk actions. The key of the array is the method name of the implementation. * Example: bulk_(array $ids, string $sql_in). * * See the comments in the parent class for further details * * @var array */ protected $bulk_actions = array(); /** * Flag variable to render our notifications, if any, once. * * @var bool */ protected static $did_notification = \false; /** * Array of seconds for common time periods, like week or month, alongside an internationalised string representation, i.e. "Day" or "Days" * * @var array */ private static $time_periods; /** * Sets the current data store object into `store->action` and initialises the object. * * @param ActionScheduler_Store $store Store object. * @param ActionScheduler_Logger $logger Logger object. * @param ActionScheduler_QueueRunner $runner Runner object. */ public function __construct(\ActionScheduler_Store $store, \ActionScheduler_Logger $logger, \ActionScheduler_QueueRunner $runner) { } /** * Handles setting the items_per_page option for this screen. * * @param mixed $status Default false (to skip saving the current option). * @param string $option Screen option name. * @param int $value Screen option value. * @return int */ public function set_items_per_page_option($status, $option, $value) { } /** * Convert an interval of seconds into a two part human friendly string. * * The WordPress human_time_diff() function only calculates the time difference to one degree, meaning * even if an action is 1 day and 11 hours away, it will display "1 day". This function goes one step * further to display two degrees of accuracy. * * Inspired by the Crontrol::interval() function by Edward Dale: https://wordpress.org/plugins/wp-crontrol/ * * @param int $interval A interval in seconds. * @param int $periods_to_include Depth of time periods to include, e.g. for an interval of 70, and $periods_to_include of 2, both minutes and seconds would be included. With a value of 1, only minutes would be included. * @return string A human friendly string representation of the interval. */ private static function human_interval($interval, $periods_to_include = 2) { } /** * Returns the recurrence of an action or 'Non-repeating'. The output is human readable. * * @param ActionScheduler_Action $action Action object. * * @return string */ protected function get_recurrence($action) { } /** * Serializes the argument of an action to render it in a human friendly format. * * @param array $row The array representation of the current row of the table. * * @return string */ public function column_args(array $row) { } /** * Prints the logs entries inline. We do so to avoid loading Javascript and other hacks to show it in a modal. * * @param array $row Action array. * @return string */ public function column_log_entries(array $row) { } /** * Prints the logs entries inline. We do so to avoid loading Javascript and other hacks to show it in a modal. * * @param ActionScheduler_LogEntry $log_entry Log entry object. * @param DateTimezone $timezone Timestamp. * @return string */ protected function get_log_entry_html(\ActionScheduler_LogEntry $log_entry, \DateTimezone $timezone) { } /** * Only display row actions for pending actions. * * @param array $row Row to render. * @param string $column_name Current row. * * @return string */ protected function maybe_render_actions($row, $column_name) { } /** * Renders admin notifications * * Notifications: * 1. When the maximum number of tasks are being executed simultaneously. * 2. Notifications when a task is manually executed. * 3. Tables are missing. */ public function display_admin_notices() { } /** * Prints the scheduled date in a human friendly format. * * @param array $row The array representation of the current row of the table. * * @return string */ public function column_schedule($row) { } /** * Get the scheduled date in a human friendly format. * * @param ActionScheduler_Schedule $schedule Action's schedule. * @return string */ protected function get_schedule_display_string(\ActionScheduler_Schedule $schedule) { } /** * Bulk delete. * * Deletes actions based on their ID. This is the handler for the bulk delete. It assumes the data * properly validated by the callee and it will delete the actions without any extra validation. * * @param int[] $ids Action IDs. * @param string $ids_sql Inherited and unused. */ protected function bulk_delete(array $ids, $ids_sql) { } /** * Implements the logic behind running an action. ActionScheduler_Abstract_ListTable validates the request and their * parameters are valid. * * @param int $action_id Action ID. */ protected function row_action_cancel($action_id) { } /** * Implements the logic behind running an action. ActionScheduler_Abstract_ListTable validates the request and their * parameters are valid. * * @param int $action_id Action ID. */ protected function row_action_run($action_id) { } /** * Force the data store schema updates. */ protected function recreate_tables() { } /** * Implements the logic behind processing an action once an action link is clicked on the list table. * * @param int $action_id Action ID. * @param string $row_action_type The type of action to perform on the action. */ protected function process_row_action($action_id, $row_action_type) { } /** * {@inheritDoc} */ public function prepare_items() { } /** * Prints the available statuses so the user can click to filter. */ protected function display_filter_by_status() { } /** * Get the text to display in the search box on the list table. */ protected function get_search_box_button_text() { } /** * {@inheritDoc} */ protected function get_per_page_option_name() { } } /** * Class ActionScheduler_LogEntry */ class ActionScheduler_LogEntry { /** * Action's ID for log entry. * * @var int $action_id */ protected $action_id = ''; /** * Log entry's message. * * @var string $message */ protected $message = ''; /** * Log entry's date. * * @var Datetime $date */ protected $date; /** * Constructor * * @param mixed $action_id Action ID. * @param string $message Message. * @param Datetime $date Datetime object with the time when this log entry was created. If this parameter is * not provided a new Datetime object (with current time) will be created. */ public function __construct($action_id, $message, $date = \null) { } /** * Returns the date when this log entry was created * * @return Datetime */ public function get_date() { } /** * Get action ID of log entry. */ public function get_action_id() { } /** * Get log entry message. */ public function get_message() { } } /** * Class ActionScheduler_NullLogEntry */ class ActionScheduler_NullLogEntry extends \ActionScheduler_LogEntry { /** * Construct. * * @param string $action_id Action ID. * @param string $message Log entry. */ public function __construct($action_id = '', $message = '') { } } /** * Abstract class for setting a basic lock to throttle some action. * * Class ActionScheduler_Lock */ abstract class ActionScheduler_Lock { /** * Instance. * * @var ActionScheduler_Lock */ private static $locker = \null; /** * Duration of lock. * * @var int */ protected static $lock_duration = \MINUTE_IN_SECONDS; /** * Check if a lock is set for a given lock type. * * @param string $lock_type A string to identify different lock types. * @return bool */ public function is_locked($lock_type) { } /** * Set a lock. * * To prevent race conditions, implementations should avoid setting the lock if the lock is already held. * * @param string $lock_type A string to identify different lock types. * @return bool */ abstract public function set($lock_type); /** * If a lock is set, return the timestamp it was set to expiry. * * @param string $lock_type A string to identify different lock types. * @return bool|int False if no lock is set, otherwise the timestamp for when the lock is set to expire. */ abstract public function get_expiration($lock_type); /** * Get the amount of time to set for a given lock. 60 seconds by default. * * @param string $lock_type A string to identify different lock types. * @return int */ protected function get_duration($lock_type) { } /** * Get instance. * * @return ActionScheduler_Lock */ public static function instance() { } } /** * Provide a way to set simple transient locks to block behaviour * for up-to a given duration. * * Class ActionScheduler_OptionLock * * @since 3.0.0 */ class ActionScheduler_OptionLock extends \ActionScheduler_Lock { /** * Set a lock using options for a given amount of time (60 seconds by default). * * Using an autoloaded option avoids running database queries or other resource intensive tasks * on frequently triggered hooks, like 'init' or 'shutdown'. * * For example, ActionScheduler_QueueRunner->maybe_dispatch_async_request() uses a lock to avoid * calling ActionScheduler_QueueRunner->has_maximum_concurrent_batches() every time the 'shutdown', * hook is triggered, because that method calls ActionScheduler_QueueRunner->store->get_claim_count() * to find the current number of claims in the database. * * @param string $lock_type A string to identify different lock types. * @bool True if lock value has changed, false if not or if set failed. */ public function set($lock_type) { } /** * If a lock is set, return the timestamp it was set to expiry. * * @param string $lock_type A string to identify different lock types. * @return bool|int False if no lock is set, otherwise the timestamp for when the lock is set to expire. */ public function get_expiration($lock_type) { } /** * Given the lock string, derives the lock expiration timestamp (or false if it cannot be determined). * * @param string $lock_value String containing a timestamp, or pipe-separated combination of unique value and timestamp. * * @return false|int */ private function get_expiration_from($lock_value) { } /** * Get the key to use for storing the lock in the transient * * @param string $lock_type A string to identify different lock types. * @return string */ protected function get_key($lock_type) { } /** * Supplies the existing lock value, or an empty string if not set. * * @param string $lock_type A string to identify different lock types. * * @return string */ private function get_existing_lock($lock_type) { } /** * Supplies a lock value consisting of a unique value and the current timestamp, which are separated by a pipe * character. * * Example: (string) "649de012e6b262.09774912|1688068114" * * @param string $lock_type A string to identify different lock types. * * @return string */ private function new_lock_value($lock_type) { } } /** * Class ActionScheduler_QueueCleaner */ class ActionScheduler_QueueCleaner { /** * The batch size. * * @var int */ protected $batch_size; /** * ActionScheduler_Store instance. * * @var ActionScheduler_Store */ private $store = \null; /** * 31 days in seconds. * * @var int */ private $month_in_seconds = 2678400; /** * Default list of statuses purged by the cleaner process. * * @var string[] */ private $default_statuses_to_purge = array(\ActionScheduler_Store::STATUS_COMPLETE, \ActionScheduler_Store::STATUS_CANCELED); /** * ActionScheduler_QueueCleaner constructor. * * @param ActionScheduler_Store|null $store The store instance. * @param int $batch_size The batch size. */ public function __construct(?\ActionScheduler_Store $store = \null, $batch_size = 20) { } /** * Default queue cleaner process used by queue runner. * * @return array */ public function delete_old_actions() { } /** * Delete selected actions limited by status and date. * * @param string[] $statuses_to_purge List of action statuses to purge. Defaults to canceled, complete. * @param DateTime $cutoff_date Date limit for selecting actions. Defaults to 31 days ago. * @param int|null $batch_size Maximum number of actions per status to delete. Defaults to 20. * @param string $context Calling process context. Defaults to `old`. * @return array Actions deleted. */ public function clean_actions(array $statuses_to_purge, \DateTime $cutoff_date, $batch_size = \null, $context = 'old') { } /** * Delete actions. * * @param int[] $actions_to_delete List of action IDs to delete. * @param int $lifespan Minimum scheduled age in seconds of the actions being deleted. * @param string $context Context of the delete request. * @return array Deleted action IDs. */ private function delete_actions(array $actions_to_delete, $lifespan = \null, $context = 'old') { } /** * Unclaim pending actions that have not been run within a given time limit. * * When called by ActionScheduler_Abstract_QueueRunner::run_cleanup(), the time limit passed * as a parameter is 10x the time limit used for queue processing. * * @param int $time_limit The number of seconds to allow a queue to run before unclaiming its pending actions. Default 300 (5 minutes). */ public function reset_timeouts($time_limit = 300) { } /** * Mark actions that have been running for more than a given time limit as failed, based on * the assumption some uncatchable and unloggable fatal error occurred during processing. * * When called by ActionScheduler_Abstract_QueueRunner::run_cleanup(), the time limit passed * as a parameter is 10x the time limit used for queue processing. * * @param int $time_limit The number of seconds to allow an action to run before it is considered to have failed. Default 300 (5 minutes). */ public function mark_failures($time_limit = 300) { } /** * Do all of the cleaning actions. * * @param int $time_limit The number of seconds to use as the timeout and failure period. Default 300 (5 minutes). */ public function clean($time_limit = 300) { } /** * Get the batch size for cleaning the queue. * * @return int */ protected function get_batch_size() { } } /** * Abstract class with common Queue Cleaner functionality. */ abstract class ActionScheduler_Abstract_QueueRunner_Deprecated { /** * Get the maximum number of seconds a batch can run for. * * @deprecated 2.1.1 * @return int The number of seconds. */ protected function get_maximum_execution_time() { } } /** * Abstract class with common Queue Cleaner functionality. */ abstract class ActionScheduler_Abstract_QueueRunner extends \ActionScheduler_Abstract_QueueRunner_Deprecated { /** * ActionScheduler_QueueCleaner instance. * * @var ActionScheduler_QueueCleaner */ protected $cleaner; /** * ActionScheduler_FatalErrorMonitor instance. * * @var ActionScheduler_FatalErrorMonitor */ protected $monitor; /** * ActionScheduler_Store instance. * * @var ActionScheduler_Store */ protected $store; /** * The created time. * * Represents when the queue runner was constructed and used when calculating how long a PHP request has been running. * For this reason it should be as close as possible to the PHP request start time. * * @var int */ private $created_time; /** * ActionScheduler_Abstract_QueueRunner constructor. * * @param ActionScheduler_Store|null $store Store object. * @param ActionScheduler_FatalErrorMonitor|null $monitor Monitor object. * @param ActionScheduler_QueueCleaner|null $cleaner Cleaner object. */ public function __construct(?\ActionScheduler_Store $store = \null, ?\ActionScheduler_FatalErrorMonitor $monitor = \null, ?\ActionScheduler_QueueCleaner $cleaner = \null) { } /** * Process an individual action. * * @param int $action_id The action ID to process. * @param string $context Optional identifier for the context in which this action is being processed, e.g. 'WP CLI' or 'WP Cron' * Generally, this should be capitalised and not localised as it's a proper noun. * @throws \Exception When error running action. */ public function process_action($action_id, $context = '') { } /** * Marks actions as either having failed execution or failed validation, as appropriate. * * @param int $action_id Action ID. * @param Exception $e Exception instance. * @param string $context Execution context. * @param bool $valid_action If the action is valid. * * @return void */ private function handle_action_error($action_id, $e, $context, $valid_action) { } /** * Schedule the next instance of the action if necessary. * * @param ActionScheduler_Action $action Action. * @param int $action_id Action ID. */ protected function schedule_next_instance(\ActionScheduler_Action $action, $action_id) { } /** * Determine if the specified recurring action has been consistently failing. * * @param ActionScheduler_Action $action The recurring action to be rescheduled. * @param int $action_id The ID of the recurring action. * * @return bool */ private function recurring_action_is_consistently_failing(\ActionScheduler_Action $action, $action_id) { } /** * Run the queue cleaner. */ protected function run_cleanup() { } /** * Get the number of concurrent batches a runner allows. * * @return int */ public function get_allowed_concurrent_batches() { } /** * Check if the number of allowed concurrent batches is met or exceeded. * * @return bool */ public function has_maximum_concurrent_batches() { } /** * Get the maximum number of seconds a batch can run for. * * @return int The number of seconds. */ protected function get_time_limit() { } /** * Get the number of seconds the process has been running. * * @return int The number of seconds. */ protected function get_execution_time() { } /** * Check if the host's max execution time is (likely) to be exceeded if processing more actions. * * @param int $processed_actions The number of actions processed so far - used to determine the likelihood of exceeding the time limit if processing another action. * @return bool */ protected function time_likely_to_be_exceeded($processed_actions) { } /** * Get memory limit * * Based on WP_Background_Process::get_memory_limit() * * @return int */ protected function get_memory_limit() { } /** * Memory exceeded * * Ensures the batch process never exceeds 90% of the maximum WordPress memory. * * Based on WP_Background_Process::memory_exceeded() * * @return bool */ protected function memory_exceeded() { } /** * See if the batch limits have been exceeded, which is when memory usage is almost at * the maximum limit, or the time to process more actions will exceed the max time limit. * * Based on WC_Background_Process::batch_limits_exceeded() * * @param int $processed_actions The number of actions processed so far - used to determine the likelihood of exceeding the time limit if processing another action. * @return bool */ protected function batch_limits_exceeded($processed_actions) { } /** * Process actions in the queue. * * @param string $context Optional identifier for the context in which this action is being processed, e.g. 'WP CLI' or 'WP Cron' * Generally, this should be capitalised and not localised as it's a proper noun. * @return int The number of actions processed. */ abstract public function run($context = ''); } /** * Class ActionScheduler_QueueRunner */ class ActionScheduler_QueueRunner extends \ActionScheduler_Abstract_QueueRunner { const WP_CRON_HOOK = 'action_scheduler_run_queue'; const WP_CRON_SCHEDULE = 'every_minute'; /** * ActionScheduler_AsyncRequest_QueueRunner instance. * * @var ActionScheduler_AsyncRequest_QueueRunner */ protected $async_request; /** * ActionScheduler_QueueRunner instance. * * @var ActionScheduler_QueueRunner */ private static $runner = \null; /** * Number of processed actions. * * @var int */ private $processed_actions_count = 0; /** * Get instance. * * @return ActionScheduler_QueueRunner * @codeCoverageIgnore */ public static function instance() { } /** * ActionScheduler_QueueRunner constructor. * * @param ActionScheduler_Store|null $store Store object. * @param ActionScheduler_FatalErrorMonitor|null $monitor Monitor object. * @param ActionScheduler_QueueCleaner|null $cleaner Cleaner object. * @param ActionScheduler_AsyncRequest_QueueRunner|null $async_request Async request runner object. */ public function __construct(?\ActionScheduler_Store $store = \null, ?\ActionScheduler_FatalErrorMonitor $monitor = \null, ?\ActionScheduler_QueueCleaner $cleaner = \null, ?\ActionScheduler_AsyncRequest_QueueRunner $async_request = \null) { } /** * Initialize. * * @codeCoverageIgnore */ public function init() { } /** * Hook check for dispatching an async request. */ public function hook_dispatch_async_request() { } /** * Unhook check for dispatching an async request. */ public function unhook_dispatch_async_request() { } /** * Check if we should dispatch an async request to process actions. * * This method is attached to 'shutdown', so is called frequently. To avoid slowing down * the site, it mitigates the work performed in each request by: * 1. checking if it's in the admin context and then * 2. haven't run on the 'shutdown' hook within the lock time (60 seconds by default) * 3. haven't exceeded the number of allowed batches. * * The order of these checks is important, because they run from a check on a value: * 1. in memory - is_admin() maps to $GLOBALS or the WP_ADMIN constant * 2. in memory - transients use autoloaded options by default * 3. from a database query - has_maximum_concurrent_batches() run the query * $this->store->get_claim_count() to find the current number of claims in the DB. * * If all of these conditions are met, then we request an async runner check whether it * should dispatch a request to process pending actions. */ public function maybe_dispatch_async_request() { } /** * Process actions in the queue. Attached to self::WP_CRON_HOOK i.e. 'action_scheduler_run_queue' * * The $context param of this method defaults to 'WP Cron', because prior to Action Scheduler 3.0.0 * that was the only context in which this method was run, and the self::WP_CRON_HOOK hook had no context * passed along with it. New code calling this method directly, or by triggering the self::WP_CRON_HOOK, * should set a context as the first parameter. For an example of this, refer to the code seen in * * @see ActionScheduler_AsyncRequest_QueueRunner::handle() * * @param string $context Optional identifier for the context in which this action is being processed, e.g. 'WP CLI' or 'WP Cron' * Generally, this should be capitalised and not localised as it's a proper noun. * @return int The number of actions processed. */ public function run($context = 'WP Cron') { } /** * Process a batch of actions pending in the queue. * * Actions are processed by claiming a set of pending actions then processing each one until either the batch * size is completed, or memory or time limits are reached, defined by @see $this->batch_limits_exceeded(). * * @param int $size The maximum number of actions to process in the batch. * @param string $context Optional identifier for the context in which this action is being processed, e.g. 'WP CLI' or 'WP Cron' * Generally, this should be capitalised and not localised as it's a proper noun. * @return int The number of actions processed. */ protected function do_batch($size = 100, $context = '') { } /** * Flush the cache if possible (intended for use after a batch of actions has been processed). * * This is useful because running large batches can eat up memory and because invalid data can accrue in the * runtime cache, which may lead to unexpected results. */ protected function clear_caches() { } /** * Add schedule to WP cron. * * @param array> $schedules Schedules. * @return array> */ public function add_wp_cron_schedule($schedules) { } } /** * Provides information about active and registered instances of Action Scheduler. */ class ActionScheduler_SystemInformation { /** * Returns information about the plugin or theme which contains the current active version * of Action Scheduler. * * If this cannot be determined, or if Action Scheduler is being loaded via some other * method, then it will return an empty array. Otherwise, if populated, the array will * look like the following: * * [ * 'type' => 'plugin', # or 'theme' * 'name' => 'Name', * ] * * @return array */ public static function active_source(): array { } /** * Returns the directory path for the currently active installation of Action Scheduler. * * @return string */ public static function active_source_path(): string { } /** * Get registered sources. * * It is not always possible to obtain this information. For instance, if earlier versions (<=3.9.0) of * Action Scheduler register themselves first, then the necessary data about registered sources will * not be available. * * @return array */ public static function get_sources() { } } /** * Class ActionScheduler_Versions */ class ActionScheduler_Versions { /** * ActionScheduler_Versions instance. * * @var ActionScheduler_Versions */ private static $instance = \null; /** * Versions. * * @var array */ private $versions = array(); /** * Registered sources. * * @var array */ private $sources = array(); /** * Register version's callback. * * @param string $version_string Action Scheduler version. * @param callable $initialization_callback Callback to initialize the version. */ public function register($version_string, $initialization_callback) { } /** * Get all versions. */ public function get_versions() { } /** * Get registered sources. * * Use with caution: this method is only available as of Action Scheduler's 3.9.1 * release and, owing to the way Action Scheduler is loaded, it's possible that the * class definition used at runtime will belong to an earlier version. * * @since 3.9.1 * * @return array */ public function get_sources() { } /** * Get latest version registered. */ public function latest_version() { } /** * Get callback for latest registered version. */ public function latest_version_callback() { } /** * Get instance. * * @return ActionScheduler_Versions * @codeCoverageIgnore */ public static function instance() { } /** * Initialize. * * @codeCoverageIgnore */ public static function initialize_latest_version() { } /** * Returns information about the plugin or theme which contains the current active version * of Action Scheduler. * * If this cannot be determined, or if Action Scheduler is being loaded via some other * method, then it will return an empty array. Otherwise, if populated, the array will * look like the following: * * [ * 'type' => 'plugin', # or 'theme' * 'name' => 'Name', * ] * * @deprecated 3.9.2 Use ActionScheduler_SystemInformation::active_source(). * * @return array */ public function active_source(): array { } /** * Returns the directory path for the currently active installation of Action Scheduler. * * @deprecated 3.9.2 Use ActionScheduler_SystemInformation::active_source_path(). * * @return string */ public function active_source_path(): string { } } /** * Class ActionScheduler_WPCommentCleaner * * @since 3.0.0 */ class ActionScheduler_WPCommentCleaner { /** * Post migration hook used to cleanup the WP comment table. * * @var string */ protected static $cleanup_hook = 'action_scheduler/cleanup_wp_comment_logs'; /** * An instance of the ActionScheduler_wpCommentLogger class to interact with the comments table. * * This instance should only be used as an interface. It should not be initialized. * * @var ActionScheduler_wpCommentLogger */ protected static $wp_comment_logger = \null; /** * The key used to store the cached value of whether there are logs in the WP comment table. * * @var string */ protected static $has_logs_option_key = 'as_has_wp_comment_logs'; /** * Initialize the class and attach callbacks. */ public static function init() { } /** * Determines if there are log entries in the wp comments table. * * Uses the flag set on migration completion set by @see self::maybe_schedule_cleanup(). * * @return boolean Whether there are scheduled action comments in the comments table. */ public static function has_logs() { } /** * Schedules the WP Post comment table cleanup to run in 6 months if it's not already scheduled. * Attached to the migration complete hook 'action_scheduler/migration_complete'. */ public static function maybe_schedule_cleanup() { } /** * Delete all action comments from the WP Comments table. */ public static function delete_all_action_comments() { } /** * Registers admin notices about the orphaned action logs. */ public static function register_admin_notice() { } /** * Prints details about the orphaned action logs and includes information on where to learn more. */ public static function print_admin_notice() { } } /** * Class ActionScheduler_wcSystemStatus */ class ActionScheduler_wcSystemStatus { /** * The active data stores * * @var ActionScheduler_Store */ protected $store; /** * Constructor method for ActionScheduler_wcSystemStatus. * * @param ActionScheduler_Store $store Active store object. * * @return void */ public function __construct($store) { } /** * Display action data, including number of actions grouped by status and the oldest & newest action in each status. * * Helpful to identify issues, like a clogged queue. */ public function render() { } /** * Get oldest and newest scheduled dates for a given set of statuses. * * @param array $status_keys Set of statuses to find oldest & newest action for. * @return array */ protected function get_oldest_and_newest($status_keys) { } /** * Get oldest or newest scheduled date for a given status. * * @param string $status Action status label/name string. * @param string $date_type Oldest or Newest. * @return DateTime */ protected function get_action_status_date($status, $date_type = 'oldest') { } /** * Get oldest or newest scheduled date for a given status. * * @param array $status_labels Set of statuses to find oldest & newest action for. * @param array $action_counts Number of actions grouped by status. * @param array $oldest_and_newest Date of the oldest and newest action with each status. */ protected function get_template($status_labels, $action_counts, $oldest_and_newest) { } /** * Is triggered when invoking inaccessible methods in an object context. * * @param string $name Name of method called. * @param array $arguments Parameters to invoke the method with. * * @return mixed * @link https://php.net/manual/en/language.oop5.overloading.php#language.oop5.overloading.methods */ public function __call($name, $arguments) { } } /** * Abstract for WP-CLI commands. */ abstract class ActionScheduler_WPCLI_Command extends \WP_CLI_Command { const DATE_FORMAT = 'Y-m-d H:i:s O'; /** * Keyed arguments. * * @var string[] */ protected $args; /** * Positional arguments. * * @var array */ protected $assoc_args; /** * Construct. * * @param string[] $args Positional arguments. * @param array $assoc_args Keyed arguments. * @throws \Exception When loading a CLI command file outside of WP CLI context. */ public function __construct(array $args, array $assoc_args) { } /** * Execute command. */ abstract public function execute(); /** * Get the scheduled date in a human friendly format. * * @see ActionScheduler_ListTable::get_schedule_display_string() * @param ActionScheduler_Schedule $schedule Schedule. * @return string */ protected function get_schedule_display_string(\ActionScheduler_Schedule $schedule) { } /** * Transforms arguments with '__' from CSV into expected arrays. * * @see \WP_CLI\CommandWithDBObject::process_csv_arguments_to_arrays() * @link https://github.com/wp-cli/entity-command/blob/c270cc9a2367cb8f5845f26a6b5e203397c91392/src/WP_CLI/CommandWithDBObject.php#L99 * @return void */ protected function process_csv_arguments_to_arrays() { } } } namespace Action_Scheduler\WP_CLI\Action { /** * WP-CLI command: action-scheduler action cancel */ class Cancel_Command extends \ActionScheduler_WPCLI_Command { /** * Execute command. * * @return void */ public function execute() { } /** * Cancel single action. * * @param string $hook The hook that the job will trigger. * @param array $callback_args Args that would have been passed to the job. * @param string $group The group the job is assigned to. * @return void */ protected function cancel_single($hook, $callback_args, $group) { } /** * Cancel all actions. * * @param string $hook The hook that the job will trigger. * @param array $callback_args Args that would have been passed to the job. * @param string $group The group the job is assigned to. * @return void */ protected function cancel_all($hook, $callback_args, $group) { } /** * Print a success message. * * @return void */ protected function print_success() { } /** * Convert an exception into a WP CLI error. * * @param \Exception $e The error object. * @param bool $multiple Boolean if multiple actions. * @throws \WP_CLI\ExitException When an error occurs. * @return void */ protected function print_error(\Exception $e, $multiple) { } } /** * WP-CLI command: action-scheduler action create */ class Create_Command extends \ActionScheduler_WPCLI_Command { const ASYNC_OPTS = array('async', 0); /** * Execute command. * * @return void */ public function execute() { } /** * Print a success message with the action ID. * * @param int $action_id Created action ID. * @param string $action_type Type of action. * * @return void */ protected function print_success($action_id, $action_type) { } /** * Convert an exception into a WP CLI error. * * @param \Exception $e The error object. * @throws \WP_CLI\ExitException When an error occurs. * @return void */ protected function print_error(\Exception $e) { } } /** * WP-CLI command: action-scheduler action delete */ class Delete_Command extends \ActionScheduler_WPCLI_Command { /** * Array of action IDs to delete. * * @var int[] */ protected $action_ids = array(); /** * Number of deleted, failed, and total actions deleted. * * @var array */ protected $action_counts = array('deleted' => 0, 'failed' => 0, 'total' => 0); /** * Construct. * * @param string[] $args Positional arguments. * @param array $assoc_args Keyed arguments. */ public function __construct(array $args, array $assoc_args) { } /** * Execute. * * @return void */ public function execute() { } /** * Action: action_scheduler_deleted_action * * @param int $action_id Action ID. * @return void */ public function on_action_deleted($action_id) { } } /** * WP-CLI command: action-scheduler action generate */ class Generate_Command extends \ActionScheduler_WPCLI_Command { /** * Execute command. * * @return void */ public function execute() { } /** * Schedule multiple single actions. * * @param int $schedule_start Starting timestamp of first action. * @param int $interval How long to wait between runs. * @param int $count Limit number of actions to schedule. * @param string $hook The hook to trigger. * @param array $args Arguments to pass when the hook triggers. * @param string $group The group to assign this job to. * @return int[] IDs of actions added. */ protected function generate($schedule_start, $interval, $count, $hook, array $args = array(), $group = '') { } /** * Print a success message with the action ID. * * @param int $actions_added Number of actions generated. * @param string $action_type Type of actions scheduled. * @return void */ protected function print_success($actions_added, $action_type) { } /** * Convert an exception into a WP CLI error. * * @param \Exception $e The error object. * @throws \WP_CLI\ExitException When an error occurs. * @return void */ protected function print_error(\Exception $e) { } } /** * WP-CLI command: action-scheduler action get */ class Get_Command extends \ActionScheduler_WPCLI_Command { /** * Execute command. * * @return void */ public function execute() { } } // phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped -- Escaping output is not necessary in WP CLI. /** * WP-CLI command: action-scheduler action list */ class List_Command extends \ActionScheduler_WPCLI_Command { const PARAMETERS = array('hook', 'args', 'date', 'date_compare', 'modified', 'modified_compare', 'group', 'status', 'claimed', 'per_page', 'offset', 'orderby', 'order'); /** * Execute command. * * @return void */ public function execute() { } } /** * WP-CLI command: action-scheduler action next */ class Next_Command extends \ActionScheduler_WPCLI_Command { /** * Execute command. * * @return void */ public function execute() { } } /** * WP-CLI command: action-scheduler action run */ class Run_Command extends \ActionScheduler_WPCLI_Command { /** * Array of action IDs to execute. * * @var int[] */ protected $action_ids = array(); /** * Number of executed, failed, ignored, invalid, and total actions. * * @var array */ protected $action_counts = array('executed' => 0, 'failed' => 0, 'ignored' => 0, 'invalid' => 0, 'total' => 0); /** * Construct. * * @param string[] $args Positional arguments. * @param array $assoc_args Keyed arguments. */ public function __construct(array $args, array $assoc_args) { } /** * Execute. * * @return void */ public function execute() { } /** * Action: action_scheduler_execution_ignored * * @param int $action_id Action ID. * @return void */ public function on_action_ignored($action_id) { } /** * Action: action_scheduler_after_execute * * @param int $action_id Action ID. * @return void */ public function on_action_executed($action_id) { } /** * Action: action_scheduler_failed_execution * * @param int $action_id Action ID. * @param \Exception $e Exception. * @return void */ public function on_action_failed($action_id, \Exception $e) { } /** * Action: action_scheduler_failed_validation * * @param int $action_id Action ID. * @param \Exception $e Exception. * @return void */ public function on_action_invalid($action_id, \Exception $e) { } } } namespace { /** * Commands for Action Scheduler. */ class ActionScheduler_WPCLI_Clean_Command extends \WP_CLI_Command { /** * Run the Action Scheduler Queue Cleaner * * ## OPTIONS * * [--batch-size=] * : The maximum number of actions to delete per batch. Defaults to 20. * * [--batches=] * : Limit execution to a number of batches. Defaults to 0, meaning batches will continue all eligible actions are deleted. * * [--status=] * : Only clean actions with the specified status. Defaults to Canceled, Completed. Define multiple statuses as a comma separated string (without spaces), e.g. `--status=complete,failed,canceled` * * [--before=] * : Only delete actions with scheduled date older than this. Defaults to 31 days. e.g `--before='7 days ago'`, `--before='02-Feb-2020 20:20:20'` * * [--pause=] * : The number of seconds to pause between batches. Default no pause. * * @param array $args Positional arguments. * @param array $assoc_args Keyed arguments. * @throws \WP_CLI\ExitException When an error occurs. * * @subcommand clean */ public function clean($args, $assoc_args) { } /** * Print WP CLI message about how many batches of actions were processed. * * @param int $batches_processed Number of batches processed. */ protected function print_total_batches(int $batches_processed) { } /** * Convert an exception into a WP CLI error. * * @param Exception $e The error object. */ protected function print_error(\Exception $e) { } /** * Print a success message with the number of completed actions. * * @param int $actions_deleted Number of deleted actions. */ protected function print_success(int $actions_deleted) { } } /** * WP CLI Queue runner. * * This class can only be called from within a WP CLI instance. */ class ActionScheduler_WPCLI_QueueRunner extends \ActionScheduler_Abstract_QueueRunner { /** * Claimed actions. * * @var array */ protected $actions; /** * ActionScheduler_ActionClaim instance. * * @var ActionScheduler_ActionClaim */ protected $claim; /** * Progress bar instance. * * @var \cli\progress\Bar */ protected $progress_bar; /** * ActionScheduler_WPCLI_QueueRunner constructor. * * @param ActionScheduler_Store|null $store Store object. * @param ActionScheduler_FatalErrorMonitor|null $monitor Monitor object. * @param ActionScheduler_QueueCleaner|null $cleaner Cleaner object. * * @throws Exception When this is not run within WP CLI. */ public function __construct(?\ActionScheduler_Store $store = \null, ?\ActionScheduler_FatalErrorMonitor $monitor = \null, ?\ActionScheduler_QueueCleaner $cleaner = \null) { } /** * Set up the Queue before processing. * * @param int $batch_size The batch size to process. * @param array $hooks The hooks being used to filter the actions claimed in this batch. * @param string $group The group of actions to claim with this batch. * @param bool $force Whether to force running even with too many concurrent processes. * * @return int The number of actions that will be run. * @throws \WP_CLI\ExitException When there are too many concurrent batches. */ public function setup($batch_size, $hooks = array(), $group = '', $force = \false) { } /** * Add our hooks to the appropriate actions. */ protected function add_hooks() { } /** * Set up the WP CLI progress bar. */ protected function setup_progress_bar() { } /** * Process actions in the queue. * * @param string $context Optional runner context. Default 'WP CLI'. * * @return int The number of actions processed. */ public function run($context = 'WP CLI') { } /** * Handle WP CLI message when the action is starting. * * @param int $action_id Action ID. */ public function before_execute($action_id) { } /** * Handle WP CLI message when the action has completed. * * @param int $action_id ActionID. * @param null|ActionScheduler_Action $action The instance of the action. Default to null for backward compatibility. */ public function after_execute($action_id, $action = \null) { } /** * Handle WP CLI message when the action has failed. * * @param int $action_id Action ID. * @param Exception $exception Exception. * @throws \WP_CLI\ExitException With failure message. */ public function action_failed($action_id, $exception) { } /** * Sleep and help avoid hitting memory limit * * @param int $sleep_time Amount of seconds to sleep. * @deprecated 3.0.0 */ protected function stop_the_insanity($sleep_time = 0) { } /** * Maybe trigger the stop_the_insanity() method to free up memory. */ protected function maybe_stop_the_insanity() { } } /** * Commands for Action Scheduler. */ class ActionScheduler_WPCLI_Scheduler_command extends \WP_CLI_Command { /** * Force tables schema creation for Action Scheduler * * ## OPTIONS * * @param array $args Positional arguments. * @param array $assoc_args Keyed arguments. * * @subcommand fix-schema */ public function fix_schema($args, $assoc_args) { } /** * Run the Action Scheduler * * ## OPTIONS * * [--batch-size=] * : The maximum number of actions to run. Defaults to 100. * * [--batches=] * : Limit execution to a number of batches. Defaults to 0, meaning batches will continue being executed until all actions are complete. * * [--cleanup-batch-size=] * : The maximum number of actions to clean up. Defaults to the value of --batch-size. * * [--hooks=] * : Only run actions with the specified hook. Omitting this option runs actions with any hook. Define multiple hooks as a comma separated string (without spaces), e.g. `--hooks=hook_one,hook_two,hook_three` * * [--group=] * : Only run actions from the specified group. Omitting this option runs actions from all groups. * * [--exclude-groups=] * : Run actions from all groups except the specified group(s). Define multiple groups as a comma separated string (without spaces), e.g. '--group_a,group_b'. This option is ignored when `--group` is used. * * [--free-memory-on=] * : The number of actions to process between freeing memory. 0 disables freeing memory. Default 50. * * [--pause=] * : The number of seconds to pause when freeing memory. Default no pause. * * [--force] * : Whether to force execution despite the maximum number of concurrent processes being exceeded. * * @param array $args Positional arguments. * @param array $assoc_args Keyed arguments. * @throws \WP_CLI\ExitException When an error occurs. * * @subcommand run */ public function run($args, $assoc_args) { } /** * Converts a string of comma-separated values into an array of those same values. * * @param string $string The string of one or more comma separated values. * * @return array */ private function parse_comma_separated_string($string): array { } /** * Print WP CLI message about how many actions are about to be processed. * * @param int $total Number of actions found. */ protected function print_total_actions($total) { } /** * Print WP CLI message about how many batches of actions were processed. * * @param int $batches_completed Number of completed batches. */ protected function print_total_batches($batches_completed) { } /** * Convert an exception into a WP CLI error. * * @param Exception $e The error object. * * @throws \WP_CLI\ExitException Under some conditions WP CLI may throw an exception. */ protected function print_error(\Exception $e) { } /** * Print a success message with the number of completed actions. * * @param int $actions_completed Number of completed actions. */ protected function print_success($actions_completed) { } } } namespace Action_Scheduler\WP_CLI { /** * Action command for Action Scheduler. */ class Action_Command extends \WP_CLI_Command { /** * Cancel the next occurrence or all occurrences of a scheduled action. * * ## OPTIONS * * [] * : Name of the action hook. * * [--group=] * : The group the job is assigned to. * * [--args=] * : JSON object of arguments assigned to the job. * --- * default: [] * --- * * [--all] * : Cancel all occurrences of a scheduled action. * * @param array $args Positional arguments. * @param array $assoc_args Keyed arguments. * @return void */ public function cancel(array $args, array $assoc_args) { } /** * Creates a new scheduled action. * * ## OPTIONS * * * : Name of the action hook. * * * : A unix timestamp representing the date you want the action to start. Also 'async' or 'now' to enqueue an async action. * * [--args=] * : JSON object of arguments to pass to callbacks when the hook triggers. * --- * default: [] * --- * * [--cron=] * : A cron-like schedule string (https://crontab.guru/). * --- * default: '' * --- * * [--group=] * : The group to assign this job to. * --- * default: '' * --- * * [--interval=] * : Number of seconds to wait between runs. * --- * default: 0 * --- * * ## EXAMPLES * * wp action-scheduler action create hook_async async * wp action-scheduler action create hook_single 1627147598 * wp action-scheduler action create hook_recurring 1627148188 --interval=5 * wp action-scheduler action create hook_cron 1627147655 --cron='5 4 * * *' * * @param array $args Positional arguments. * @param array $assoc_args Keyed arguments. * @return void */ public function create(array $args, array $assoc_args) { } /** * Delete existing scheduled action(s). * * ## OPTIONS * * ... * : One or more IDs of actions to delete. * --- * default: 0 * --- * * ## EXAMPLES * * # Delete the action with id 100 * $ wp action-scheduler action delete 100 * * # Delete the actions with ids 100 and 200 * $ wp action-scheduler action delete 100 200 * * # Delete the first five pending actions in 'action-scheduler' group * $ wp action-scheduler action delete $( wp action-scheduler action list --status=pending --group=action-scheduler --format=ids ) * * @param array $args Positional arguments. * @param array $assoc_args Keyed arguments. * @return void */ public function delete(array $args, array $assoc_args) { } /** * Generates some scheduled actions. * * ## OPTIONS * * * : Name of the action hook. * * * : The Unix timestamp representing the date you want the action to start. * * [--count=] * : Number of actions to create. * --- * default: 1 * --- * * [--interval=] * : Number of seconds to wait between runs. * --- * default: 0 * --- * * [--args=] * : JSON object of arguments to pass to callbacks when the hook triggers. * --- * default: [] * --- * * [--group=] * : The group to assign this job to. * --- * default: '' * --- * * ## EXAMPLES * * wp action-scheduler action generate test_multiple 1627147598 --count=5 --interval=5 * * @param array $args Positional arguments. * @param array $assoc_args Keyed arguments. * @return void */ public function generate(array $args, array $assoc_args) { } /** * Get details about a scheduled action. * * ## OPTIONS * * * : The ID of the action to get. * --- * default: 0 * --- * * [--field=] * : Instead of returning the whole action, returns the value of a single field. * * [--fields=] * : Limit the output to specific fields (comma-separated). Defaults to all fields. * * [--format=] * : Render output in a particular format. * --- * default: table * options: * - table * - csv * - json * - yaml * --- * * @param array $args Positional arguments. * @param array $assoc_args Keyed arguments. * @return void */ public function get(array $args, array $assoc_args) { } /** * Get a list of scheduled actions. * * Display actions based on all arguments supported by * [as_get_scheduled_actions()](https://actionscheduler.org/api/#function-reference--as_get_scheduled_actions). * * ## OPTIONS * * [--=] * : One or more arguments to pass to as_get_scheduled_actions(). * * [--field=] * : Prints the value of a single property for each action. * * [--fields=] * : Limit the output to specific object properties. * * [--format=] * : Render output in a particular format. * --- * default: table * options: * - table * - csv * - ids * - json * - count * - yaml * --- * * ## AVAILABLE FIELDS * * These fields will be displayed by default for each action: * * * id * * hook * * status * * group * * recurring * * scheduled_date * * These fields are optionally available: * * * args * * log_entries * * @param array $args Positional arguments. * @param array $assoc_args Keyed arguments. * @return void * * @subcommand list */ public function subcommand_list(array $args, array $assoc_args) { } /** * Get logs for a scheduled action. * * ## OPTIONS * * * : The ID of the action to get. * --- * default: 0 * --- * * @param array $args Positional arguments. * @return void */ public function logs(array $args) { } /** * Get the ID or timestamp of the next scheduled action. * * ## OPTIONS * * * : The hook of the next scheduled action. * * [--args=] * : JSON object of arguments to search for next scheduled action. * --- * default: [] * --- * * [--group=] * : The group to which the next scheduled action is assigned. * --- * default: '' * --- * * [--raw] * : Display the raw output of as_next_scheduled_action() (timestamp or boolean). * * @param array $args Positional arguments. * @param array $assoc_args Keyed arguments. * @return void */ public function next(array $args, array $assoc_args) { } /** * Run existing scheduled action(s). * * ## OPTIONS * * ... * : One or more IDs of actions to run. * --- * default: 0 * --- * * ## EXAMPLES * * # Run the action with id 100 * $ wp action-scheduler action run 100 * * # Run the actions with ids 100 and 200 * $ wp action-scheduler action run 100 200 * * # Run the first five pending actions in 'action-scheduler' group * $ wp action-scheduler action run $( wp action-scheduler action list --status=pending --group=action-scheduler --format=ids ) * * @param array $args Positional arguments. * @param array $assoc_args Keyed arguments. * @return void */ public function run(array $args, array $assoc_args) { } } /** * Class Migration_Command * * @package Action_Scheduler\WP_CLI * * @since 3.0.0 * * @codeCoverageIgnore */ class Migration_Command extends \WP_CLI_Command { /** * Number of actions migrated. * * @var int */ private $total_processed = 0; /** * Register the command with WP-CLI */ public function register() { } /** * Process the data migration. * * @param array $positional_args Required for WP CLI. Not used in migration. * @param array $assoc_args Optional arguments. * * @return void */ public function migrate($positional_args, $assoc_args) { } /** * Build the config object used to create the Runner * * @param array $args Optional arguments. * * @return ActionScheduler\Migration\Config */ private function get_migration_config($args) { } /** * Hook command line logging into migration actions. */ private function init_logging() { } } /** * WP_CLI progress bar for Action Scheduler. */ /** * Class ProgressBar * * @package Action_Scheduler\WP_CLI * * @since 3.0.0 * * @codeCoverageIgnore */ class ProgressBar { /** * Current number of ticks. * * @var integer */ protected $total_ticks; /** * Total number of ticks. * * @var integer */ protected $count; /** * Progress bar update interval. * * @var integer */ protected $interval; /** * Progress bar message. * * @var string */ protected $message; /** * Instance. * * @var \cli\progress\Bar */ protected $progress_bar; /** * ProgressBar constructor. * * @param string $message Text to display before the progress bar. * @param integer $count Total number of ticks to be performed. * @param integer $interval Optional. The interval in milliseconds between updates. Default 100. * * @throws \Exception When this is not run within WP CLI. */ public function __construct($message, $count, $interval = 100) { } /** * Increment the progress bar ticks. */ public function tick() { } /** * Get the progress bar tick count. * * @return int */ public function current() { } /** * Finish the current progress bar. */ public function finish() { } /** * Set the message used when creating the progress bar. * * @param string $message The message to be used when the next progress bar is created. */ public function set_message($message) { } /** * Set the count for a new progress bar. * * @param integer $count The total number of ticks expected to complete. */ public function set_count($count) { } /** * Set up the progress bar. */ protected function setup_progress_bar() { } } /** * System info WP-CLI commands for Action Scheduler. */ class System_Command { /** * Data store for querying actions * * @var ActionScheduler_Store */ protected $store; /** * Construct. */ public function __construct() { } /** * Print in-use data store class. * * @param array $args Positional args. * @param array $assoc_args Keyed args. * @return void * * @subcommand data-store */ public function datastore(array $args, array $assoc_args) { } /** * Print in-use runner class. * * @param array $args Positional args. * @param array $assoc_args Keyed args. * @return void */ public function runner(array $args, array $assoc_args) { } /** * Get system status. * * @param array $args Positional args. * @param array $assoc_args Keyed args. * @return void */ public function status(array $args, array $assoc_args) { } /** * Display the active version, or all registered versions. * * ## OPTIONS * * [--all] * : List all registered versions. * * @param array $args Positional args. * @param array $assoc_args Keyed args. * @return void */ public function version(array $args, array $assoc_args) { } /** * Display the current source, or all registered sources. * * ## OPTIONS * * [--all] * : List all registered sources. * * [--fullpath] * : List full path of source(s). * * @param array $args Positional args. * @param array $assoc_args Keyed args. * @uses ActionScheduler_SystemInformation::active_source_path() * @uses \WP_CLI\Formatter::display_items() * @uses $this->get_latest_version() * @return void */ public function source(array $args, array $assoc_args) { } /** * Get current data store. * * @return string */ protected function get_current_datastore() { } /** * Get latest version. * * @param null|\ActionScheduler_Versions $instance Versions. * @return string */ protected function get_latest_version($instance = null) { } /** * Get current runner. * * @return string */ protected function get_current_runner() { } /** * Get oldest and newest scheduled dates for a given set of statuses. * * @param array $status_keys Set of statuses to find oldest & newest action for. * @return array */ protected function get_oldest_and_newest($status_keys) { } /** * Get oldest or newest scheduled date for a given status. * * @param string $status Action status label/name string. * @param string $date_type Oldest or Newest. * @return string */ protected function get_action_status_date($status, $date_type = 'oldest') { } } } namespace { /** * Class ActionScheduler * * @codeCoverageIgnore */ abstract class ActionScheduler { /** * Plugin file path. * * @var string */ private static $plugin_file = ''; /** * ActionScheduler_ActionFactory instance. * * @var ActionScheduler_ActionFactory */ private static $factory = \null; /** * Data store is initialized. * * @var bool */ private static $data_store_initialized = \false; /** * Factory. */ public static function factory() { } /** * Get Store instance. */ public static function store() { } /** * Get Lock instance. */ public static function lock() { } /** * Get Logger instance. */ public static function logger() { } /** * Get QueueRunner instance. */ public static function runner() { } /** * Get AdminView instance. */ public static function admin_view() { } /** * Get the absolute system path to the plugin directory, or a file therein * * @static * @param string $path Path relative to plugin directory. * @return string */ public static function plugin_path($path) { } /** * Get the absolute URL to the plugin directory, or a file therein * * @static * @param string $path Path relative to plugin directory. * @return string */ public static function plugin_url($path) { } /** * Autoload. * * @param string $class Class name. */ public static function autoload($class) { } /** * Initialize the plugin * * @static * @param string $plugin_file Plugin file path. */ public static function init($plugin_file) { } /** * Check whether the AS data store has been initialized. * * @param string $function_name The name of the function being called. Optional. Default `null`. * @return bool */ public static function is_initialized($function_name = \null) { } /** * Determine if the class is one of our abstract classes. * * @since 3.0.0 * * @param string $class The class name. * * @return bool */ protected static function is_class_abstract($class) { } /** * Determine if the class is one of our migration classes. * * @since 3.0.0 * * @param string $class The class name. * * @return bool */ protected static function is_class_migration($class) { } /** * Determine if the class is one of our WP CLI classes. * * @since 3.0.0 * * @param string $class The class name. * * @return bool */ protected static function is_class_cli($class) { } /** * Clone. */ final public function __clone() { } /** * Wakeup. */ final public function __wakeup() { } /** * Construct. */ final private function __construct() { } /** Deprecated **/ /** * Get DateTime object. * * @param null|string $when Date/time string. * @param string $timezone Timezone string. */ public static function get_datetime_object($when = \null, $timezone = 'UTC') { } /** * Issue deprecated warning if an Action Scheduler function is called in the shutdown hook. * * @param string $function_name The name of the function being called. * @deprecated 3.1.6. */ public static function check_shutdown_hook($function_name) { } } /** * Class ActionScheduler_Schedule */ interface ActionScheduler_Schedule { /** * Get the date & time this schedule was created to run, or calculate when it should be run * after a given date & time. * * @param null|DateTime $after Timestamp. * @return DateTime|null */ public function next(?\DateTime $after = \null); /** * Identify the schedule as (not) recurring. * * @return bool */ public function is_recurring(); } /** * Class ActionScheduler_Abstract_Schedule */ abstract class ActionScheduler_Schedule_Deprecated implements \ActionScheduler_Schedule { /** * Get the date & time this schedule was created to run, or calculate when it should be run * after a given date & time. * * @param DateTime $after DateTime to calculate against. * * @return DateTime|null */ public function next(?\DateTime $after = \null) { } } /** * Class ActionScheduler_Abstract_Schedule */ abstract class ActionScheduler_Abstract_Schedule extends \ActionScheduler_Schedule_Deprecated { /** * The date & time the schedule is set to run. * * @var DateTime */ private $scheduled_date = \null; /** * Timestamp equivalent of @see $this->scheduled_date * * @var int */ protected $scheduled_timestamp = \null; /** * Construct. * * @param DateTime $date The date & time to run the action. */ public function __construct(\DateTime $date) { } /** * Check if a schedule should recur. * * @return bool */ abstract public function is_recurring(); /** * Calculate when the next instance of this schedule would run based on a given date & time. * * @param DateTime $after Start timestamp. * @return DateTime */ abstract protected function calculate_next(\DateTime $after); /** * Get the next date & time when this schedule should run after a given date & time. * * @param DateTime $after Start timestamp. * @return DateTime|null */ public function get_next(\DateTime $after) { } /** * Get the date & time the schedule is set to run. * * @return DateTime|null */ public function get_date() { } /** * For PHP 5.2 compat, because DateTime objects can't be serialized * * @return array */ public function __sleep() { } /** * Wakeup. */ public function __wakeup() { } } /** * Class ActionScheduler_Abstract_RecurringSchedule */ abstract class ActionScheduler_Abstract_RecurringSchedule extends \ActionScheduler_Abstract_Schedule { /** * The date & time the first instance of this schedule was setup to run (which may not be this instance). * * Schedule objects are attached to an action object. Each schedule stores the run date for that * object as the start date - @see $this->start - and logic to calculate the next run date after * that - @see $this->calculate_next(). The $first_date property also keeps a record of when the very * first instance of this chain of schedules ran. * * @var DateTime */ private $first_date = \null; /** * Timestamp equivalent of @see $this->first_date * * @var int */ protected $first_timestamp = \null; /** * The recurrence between each time an action is run using this schedule. * Used to calculate the start date & time. Can be a number of seconds, in the * case of ActionScheduler_IntervalSchedule, or a cron expression, as in the * case of ActionScheduler_CronSchedule. Or something else. * * @var mixed */ protected $recurrence; /** * Construct. * * @param DateTime $date The date & time to run the action. * @param mixed $recurrence The data used to determine the schedule's recurrence. * @param DateTime|null $first (Optional) The date & time the first instance of this interval schedule ran. Default null, meaning this is the first instance. */ public function __construct(\DateTime $date, $recurrence, ?\DateTime $first = \null) { } /** * Schedule is recurring. * * @return bool */ public function is_recurring() { } /** * Get the date & time of the first schedule in this recurring series. * * @return DateTime|null */ public function get_first_date() { } /** * Get the schedule's recurrence. * * @return string */ public function get_recurrence() { } /** * For PHP 5.2 compat, since DateTime objects can't be serialized * * @return array */ public function __sleep() { } /** * Unserialize recurring schedules serialized/stored prior to AS 3.0.0 * * Prior to Action Scheduler 3.0.0, schedules used different property names to refer * to equivalent data. For example, ActionScheduler_IntervalSchedule::start_timestamp * was the same as ActionScheduler_SimpleSchedule::timestamp. This was addressed in * Action Scheduler 3.0.0, where properties and property names were aligned for better * inheritance. To maintain backward compatibility with scheduled serialized and stored * prior to 3.0, we need to correctly map the old property names. */ public function __wakeup() { } } /** * Class ActionScheduler_Abstract_Schema * * @package Action_Scheduler * * @codeCoverageIgnore * * Utility class for creating/updating custom tables */ abstract class ActionScheduler_Abstract_Schema { /** * Increment this value in derived class to trigger a schema update. * * @var int */ protected $schema_version = 1; /** * Schema version stored in database. * * @var string */ protected $db_version; /** * Names of tables that will be registered by this class. * * @var array */ protected $tables = array(); /** * Can optionally be used by concrete classes to carry out additional initialization work * as needed. */ public function init() { } /** * Register tables with WordPress, and create them if needed. * * @param bool $force_update Optional. Default false. Use true to always run the schema update. * * @return void */ public function register_tables($force_update = \false) { } /** * Get table definition. * * @param string $table The name of the table. * * @return string The CREATE TABLE statement, suitable for passing to dbDelta */ abstract protected function get_table_definition($table); /** * Determine if the database schema is out of date * by comparing the integer found in $this->schema_version * with the option set in the WordPress options table * * @return bool */ private function schema_update_required() { } /** * Update the option in WordPress to indicate that * our schema is now up to date * * @return void */ private function mark_schema_update_complete() { } /** * Update the schema for the given table * * @param string $table The name of the table to update. * * @return void */ private function update_table($table) { } /** * Get full table name. * * @param string $table Table name. * * @return string The full name of the table, including the * table prefix for the current blog */ protected function get_full_table_name($table) { } /** * Confirms that all of the tables registered by this schema class have been created. * * @return bool */ public function tables_exist() { } } /** * Class ActionScheduler_Logger * * @codeCoverageIgnore */ abstract class ActionScheduler_Logger { /** * Instance. * * @var null|self */ private static $logger = \null; /** * Get instance. * * @return ActionScheduler_Logger */ public static function instance() { } /** * Create log entry. * * @param string $action_id Action ID. * @param string $message Log message. * @param DateTime|null $date Log date. * * @return string The log entry ID */ abstract public function log($action_id, $message, ?\DateTime $date = \null); /** * Get action's log entry. * * @param string $entry_id Entry ID. * * @return ActionScheduler_LogEntry */ abstract public function get_entry($entry_id); /** * Get action's logs. * * @param string $action_id Action ID. * * @return ActionScheduler_LogEntry[] */ abstract public function get_logs($action_id); /** * Initialize. * * @codeCoverageIgnore */ public function init() { } /** * Register callback for storing action. */ public function hook_stored_action() { } /** * Unhook callback for storing action. */ public function unhook_stored_action() { } /** * Log action stored. * * @param int $action_id Action ID. */ public function log_stored_action($action_id) { } /** * Log action cancellation. * * @param int $action_id Action ID. */ public function log_canceled_action($action_id) { } /** * Log action start. * * @param int $action_id Action ID. * @param string $context Action execution context. */ public function log_started_action($action_id, $context = '') { } /** * Log action completion. * * @param int $action_id Action ID. * @param null|ActionScheduler_Action $action Action. * @param string $context Action execution context. */ public function log_completed_action($action_id, $action = \null, $context = '') { } /** * Log action failure. * * @param int $action_id Action ID. * @param Exception $exception Exception. * @param string $context Action execution context. */ public function log_failed_action($action_id, \Exception $exception, $context = '') { } /** * Log action timeout. * * @param int $action_id Action ID. * @param string $timeout Timeout. */ public function log_timed_out_action($action_id, $timeout) { } /** * Log unexpected shutdown. * * @param int $action_id Action ID. * @param mixed[] $error Error. */ public function log_unexpected_shutdown($action_id, $error) { } /** * Log action reset. * * @param int $action_id Action ID. */ public function log_reset_action($action_id) { } /** * Log ignored action. * * @param int $action_id Action ID. * @param string $context Action execution context. */ public function log_ignored_action($action_id, $context = '') { } /** * Log the failure of fetching the action. * * @param string $action_id Action ID. * @param null|Exception $exception The exception which occurred when fetching the action. NULL by default for backward compatibility. */ public function log_failed_fetch_action($action_id, ?\Exception $exception = \null) { } /** * Log the failure of scheduling the action's next instance. * * @param int $action_id Action ID. * @param Exception $exception Exception object. */ public function log_failed_schedule_next_instance($action_id, \Exception $exception) { } /** * Bulk add cancel action log entries. * * Implemented here for backward compatibility. Should be implemented in parent loggers * for more performant bulk logging. * * @param array $action_ids List of action ID. */ public function bulk_log_cancel_actions($action_ids) { } } /** * Class ActionScheduler_Store_Deprecated * * @codeCoverageIgnore */ abstract class ActionScheduler_Store_Deprecated { /** * Mark an action that failed to fetch correctly as failed. * * @since 2.2.6 * * @param int $action_id The ID of the action. */ public function mark_failed_fetch_action($action_id) { } /** * Add base hooks * * @since 2.2.6 */ protected static function hook() { } /** * Remove base hooks * * @since 2.2.6 */ protected static function unhook() { } /** * Get the site's local time. * * @deprecated 2.1.0 * @return DateTimeZone */ protected function get_local_timezone() { } } /** * Class ActionScheduler_Store * * @codeCoverageIgnore */ abstract class ActionScheduler_Store extends \ActionScheduler_Store_Deprecated { const STATUS_COMPLETE = 'complete'; const STATUS_PENDING = 'pending'; const STATUS_RUNNING = 'in-progress'; const STATUS_FAILED = 'failed'; const STATUS_CANCELED = 'canceled'; const DEFAULT_CLASS = 'ActionScheduler_wpPostStore'; /** * ActionScheduler_Store instance. * * @var ActionScheduler_Store */ private static $store = \null; /** * Maximum length of args. * * @var int */ protected static $max_args_length = 191; /** * Save action. * * @param ActionScheduler_Action $action Action to save. * @param null|DateTime $scheduled_date Optional Date of the first instance * to store. Otherwise uses the first date of the action's * schedule. * * @return int The action ID */ abstract public function save_action(\ActionScheduler_Action $action, ?\DateTime $scheduled_date = \null); /** * Get action. * * @param string $action_id Action ID. * * @return ActionScheduler_Action */ abstract public function fetch_action($action_id); /** * Find an action. * * Note: the query ordering changes based on the passed 'status' value. * * @param string $hook Action hook. * @param array $params Parameters of the action to find. * * @return string|null ID of the next action matching the criteria or NULL if not found. */ public function find_action($hook, $params = array()) { } /** * Query for action count or list of action IDs. * * @since 3.3.0 $query['status'] accepts array of statuses instead of a single status. * * @param array $query { * Query filtering options. * * @type string $hook The name of the actions. Optional. * @type string|array $status The status or statuses of the actions. Optional. * @type array $args The args array of the actions. Optional. * @type DateTime $date The scheduled date of the action. Used in UTC timezone. Optional. * @type string $date_compare Operator for selecting by $date param. Accepted values are '!=', '>', '>=', '<', '<=', '='. Defaults to '<='. * @type DateTime $modified The last modified date of the action. Used in UTC timezone. Optional. * @type string $modified_compare Operator for comparing $modified param. Accepted values are '!=', '>', '>=', '<', '<=', '='. Defaults to '<='. * @type string $group The group the action belongs to. Optional. * @type bool|int $claimed TRUE to find claimed actions, FALSE to find unclaimed actions, an int to find a specific claim ID. Optional. * @type int $per_page Number of results to return. Defaults to 5. * @type int $offset The query pagination offset. Defaults to 0. * @type int $orderby Accepted values are 'hook', 'group', 'modified', 'date' or 'none'. Defaults to 'date'. * @type string $order Accepted values are 'ASC' or 'DESC'. Defaults to 'ASC'. * } * @param string $query_type Whether to select or count the results. Default, select. * * @return string|array|null The IDs of actions matching the query. Null on failure. */ abstract public function query_actions($query = array(), $query_type = 'select'); /** * Run query to get a single action ID. * * @since 3.3.0 * * @see ActionScheduler_Store::query_actions for $query arg usage but 'per_page' and 'offset' can't be used. * * @param array $query Query parameters. * * @return int|null */ public function query_action($query) { } /** * Get a count of all actions in the store, grouped by status * * @return array */ abstract public function action_counts(); /** * Get additional action counts. * * - add past-due actions * * @return array */ public function extra_action_counts() { } /** * Cancel action. * * @param string $action_id Action ID. */ abstract public function cancel_action($action_id); /** * Delete action. * * @param string $action_id Action ID. */ abstract public function delete_action($action_id); /** * Get action's schedule or run timestamp. * * @param string $action_id Action ID. * * @return DateTime The date the action is schedule to run, or the date that it ran. */ abstract public function get_date($action_id); /** * Make a claim. * * @param int $max_actions Maximum number of actions to claim. * @param DateTime|null $before_date Claim only actions schedule before the given date. Defaults to now. * @param array $hooks Claim only actions with a hook or hooks. * @param string $group Claim only actions in the given group. * * @return ActionScheduler_ActionClaim */ abstract public function stake_claim($max_actions = 10, ?\DateTime $before_date = \null, $hooks = array(), $group = ''); /** * Get claim count. * * @return int */ abstract public function get_claim_count(); /** * Release the claim. * * @param ActionScheduler_ActionClaim $claim Claim object. */ abstract public function release_claim(\ActionScheduler_ActionClaim $claim); /** * Un-claim the action. * * @param string $action_id Action ID. */ abstract public function unclaim_action($action_id); /** * Mark action as failed. * * @param string $action_id Action ID. */ abstract public function mark_failure($action_id); /** * Log action's execution. * * @param string $action_id Actoin ID. */ abstract public function log_execution($action_id); /** * Mark action as complete. * * @param string $action_id Action ID. */ abstract public function mark_complete($action_id); /** * Get action's status. * * @param string $action_id Action ID. * @return string */ abstract public function get_status($action_id); /** * Get action's claim ID. * * @param string $action_id Action ID. * @return mixed */ abstract public function get_claim_id($action_id); /** * Find actions by claim ID. * * @param string $claim_id Claim ID. * @return array */ abstract public function find_actions_by_claim_id($claim_id); /** * Validate SQL operator. * * @param string $comparison_operator Operator. * @return string */ protected function validate_sql_comparator($comparison_operator) { } /** * Get the time MySQL formatted date/time string for an action's (next) scheduled date. * * @param ActionScheduler_Action $action Action. * @param null|DateTime $scheduled_date Action's schedule date (optional). * @return string */ protected function get_scheduled_date_string(\ActionScheduler_Action $action, ?\DateTime $scheduled_date = \null) { } /** * Get the time MySQL formatted date/time string for an action's (next) scheduled date. * * @param ActionScheduler_Action|null $action Action. * @param null|DateTime $scheduled_date Action's scheduled date (optional). * @return string */ protected function get_scheduled_date_string_local(\ActionScheduler_Action $action, ?\DateTime $scheduled_date = \null) { } /** * Validate that we could decode action arguments. * * @param mixed $args The decoded arguments. * @param int $action_id The action ID. * * @throws ActionScheduler_InvalidActionException When the decoded arguments are invalid. */ protected function validate_args($args, $action_id) { } /** * Validate a ActionScheduler_Schedule object. * * @param mixed $schedule The unserialized ActionScheduler_Schedule object. * @param int $action_id The action ID. * * @throws ActionScheduler_InvalidActionException When the schedule is invalid. */ protected function validate_schedule($schedule, $action_id) { } /** * InnoDB indexes have a maximum size of 767 bytes by default, which is only 191 characters with utf8mb4. * * Previously, AS wasn't concerned about args length, as we used the (unindex) post_content column. However, * with custom tables, we use an indexed VARCHAR column instead. * * @param ActionScheduler_Action $action Action to be validated. * @throws InvalidArgumentException When json encoded args is too long. */ protected function validate_action(\ActionScheduler_Action $action) { } /** * Cancel pending actions by hook. * * @since 3.0.0 * * @param string $hook Hook name. * * @return void */ public function cancel_actions_by_hook($hook) { } /** * Cancel pending actions by group. * * @since 3.0.0 * * @param string $group Group slug. * * @return void */ public function cancel_actions_by_group($group) { } /** * Cancel a set of action IDs. * * @since 3.0.0 * * @param int[] $action_ids List of action IDs. * * @return void */ private function bulk_cancel_actions($action_ids) { } /** * Get status labels. * * @return array */ public function get_status_labels() { } /** * Check if there are any pending scheduled actions due to run. * * @return string */ public function has_pending_actions_due() { } /** * Callable initialization function optionally overridden in derived classes. */ public function init() { } /** * Callable function to mark an action as migrated optionally overridden in derived classes. * * @param int $action_id Action ID. */ public function mark_migrated($action_id) { } /** * Get instance. * * @return ActionScheduler_Store */ public static function instance() { } } /** * Class ActionScheduler_TimezoneHelper */ abstract class ActionScheduler_TimezoneHelper { /** * DateTimeZone object. * * @var null|DateTimeZone */ private static $local_timezone = \null; /** * Set a DateTime's timezone to the WordPress site's timezone, or a UTC offset * if no timezone string is available. * * @since 2.1.0 * * @param DateTime $date Timestamp. * @return ActionScheduler_DateTime */ public static function set_local_timezone(\DateTime $date) { } /** * Helper to retrieve the timezone string for a site until a WP core method exists * (see https://core.trac.wordpress.org/ticket/24730). * * Adapted from wc_timezone_string() and https://secure.php.net/manual/en/function.timezone-name-from-abbr.php#89155. * * If no timezone string is set, and its not possible to match the UTC offset set for the site to a timezone * string, then an empty string will be returned, and the UTC offset should be used to set a DateTime's * timezone. * * @since 2.1.0 * @param bool $reset Unused. * @return string PHP timezone string for the site or empty if no timezone string is available. */ protected static function get_local_timezone_string($reset = \false) { } /** * Get timezone offset in seconds. * * @since 2.1.0 * @return float */ protected static function get_local_timezone_offset() { } /** * Get local timezone. * * @param bool $reset Toggle to discard stored value. * @deprecated 2.1.0 */ public static function get_local_timezone($reset = \false) { } } /** * Class ActionScheduler_Action */ class ActionScheduler_Action { /** * Action's hook. * * @var string */ protected $hook = ''; /** * Action's args. * * @var array */ protected $args = array(); /** * Action's schedule. * * @var ActionScheduler_Schedule */ protected $schedule = \null; /** * Action's group. * * @var string */ protected $group = ''; /** * Priorities are conceptually similar to those used for regular WordPress actions. * Like those, a lower priority takes precedence over a higher priority and the default * is 10. * * Unlike regular WordPress actions, the priority of a scheduled action is strictly an * integer and should be kept within the bounds 0-255 (anything outside the bounds will * be brought back into the acceptable range). * * @var int */ protected $priority = 10; /** * Construct. * * @param string $hook Action's hook. * @param mixed[] $args Action's arguments. * @param null|ActionScheduler_Schedule $schedule Action's schedule. * @param string $group Action's group. */ public function __construct($hook, array $args = array(), ?\ActionScheduler_Schedule $schedule = \null, $group = '') { } /** * Executes the action. * * If no callbacks are registered, an exception will be thrown and the action will not be * fired. This is useful to help detect cases where the code responsible for setting up * a scheduled action no longer exists. * * @throws Exception If no callbacks are registered for this action. */ public function execute() { } /** * Set action's hook. * * @param string $hook Action's hook. */ protected function set_hook($hook) { } /** * Get action's hook. */ public function get_hook() { } /** * Set action's schedule. * * @param ActionScheduler_Schedule $schedule Action's schedule. */ protected function set_schedule(\ActionScheduler_Schedule $schedule) { } /** * Action's schedule. * * @return ActionScheduler_Schedule */ public function get_schedule() { } /** * Set action's args. * * @param mixed[] $args Action's arguments. */ protected function set_args(array $args) { } /** * Get action's args. */ public function get_args() { } /** * Section action's group. * * @param string $group Action's group. */ protected function set_group($group) { } /** * Action's group. * * @return string */ public function get_group() { } /** * Action has not finished. * * @return bool */ public function is_finished() { } /** * Sets the priority of the action. * * @param int $priority Priority level (lower is higher priority). Should be in the range 0-255. * * @return void */ public function set_priority($priority) { } /** * Gets the action priority. * * @return int */ public function get_priority() { } } /** * Class ActionScheduler_FinishedAction */ class ActionScheduler_FinishedAction extends \ActionScheduler_Action { /** * Execute action. */ public function execute() { } /** * Get finished state. */ public function is_finished() { } } /** * Class ActionScheduler_CanceledAction * * Stored action which was canceled and therefore acts like a finished action but should always return a null schedule, * regardless of schedule passed to its constructor. */ class ActionScheduler_CanceledAction extends \ActionScheduler_FinishedAction { /** * Construct. * * @param string $hook Action's hook. * @param array $args Action's arguments. * @param null|ActionScheduler_Schedule $schedule Action's schedule. * @param string $group Action's group. */ public function __construct($hook, array $args = array(), ?\ActionScheduler_Schedule $schedule = \null, $group = '') { } } /** * Class ActionScheduler_NullAction */ class ActionScheduler_NullAction extends \ActionScheduler_Action { /** * Construct. * * @param string $hook Action hook. * @param mixed[] $args Action arguments. * @param null|ActionScheduler_Schedule $schedule Action schedule. */ public function __construct($hook = '', array $args = array(), ?\ActionScheduler_Schedule $schedule = \null) { } /** * Execute action. */ public function execute() { } } /** * Class ActionScheduler_DBLogger * * Action logs data table data store. * * @since 3.0.0 */ class ActionScheduler_DBLogger extends \ActionScheduler_Logger { /** * Add a record to an action log. * * @param int $action_id Action ID. * @param string $message Message to be saved in the log entry. * @param DateTime|null $date Timestamp of the log entry. * * @return int The log entry ID. */ public function log($action_id, $message, ?\DateTime $date = \null) { } /** * Retrieve an action log entry. * * @param int $entry_id Log entry ID. * * @return ActionScheduler_LogEntry */ public function get_entry($entry_id) { } /** * Create an action log entry from a database record. * * @param object $record Log entry database record object. * * @return ActionScheduler_LogEntry */ private function create_entry_from_db_record($record) { } /** * Retrieve an action's log entries from the database. * * @param int $action_id Action ID. * * @return ActionScheduler_LogEntry[] */ public function get_logs($action_id) { } /** * Initialize the data store. * * @codeCoverageIgnore */ public function init() { } /** * Delete the action logs for an action. * * @param int $action_id Action ID. */ public function clear_deleted_action_logs($action_id) { } /** * Bulk add cancel action log entries. * * @param array $action_ids List of action ID. */ public function bulk_log_cancel_actions($action_ids) { } } /** * Class ActionScheduler_DBStore * * Action data table data store. * * @since 3.0.0 */ class ActionScheduler_DBStore extends \ActionScheduler_Store { /** * Used to share information about the before_date property of claims internally. * * This is used in preference to passing the same information as a method param * for backwards-compatibility reasons. * * @var DateTime|null */ private $claim_before_date = \null; /** * Maximum length of args. * * @var int */ protected static $max_args_length = 8000; /** * Maximum length of index. * * @var int */ protected static $max_index_length = 191; /** * List of claim filters. * * @var array */ protected $claim_filters = array('group' => '', 'hooks' => '', 'exclude-groups' => ''); /** * Initialize the data store * * @codeCoverageIgnore */ public function init() { } /** * Save an action, checks if this is a unique action before actually saving. * * @param ActionScheduler_Action $action Action object. * @param DateTime|null $scheduled_date Optional schedule date. Default null. * * @return int Action ID. * @throws RuntimeException Throws exception when saving the action fails. */ public function save_unique_action(\ActionScheduler_Action $action, ?\DateTime $scheduled_date = \null) { } /** * Save an action. Can save duplicate action as well, prefer using `save_unique_action` instead. * * @param ActionScheduler_Action $action Action object. * @param DateTime|null $scheduled_date Optional schedule date. Default null. * * @return int Action ID. * @throws RuntimeException Throws exception when saving the action fails. */ public function save_action(\ActionScheduler_Action $action, ?\DateTime $scheduled_date = \null) { } /** * Save an action. * * @param ActionScheduler_Action $action Action object. * @param ?DateTime $date Optional schedule date. Default null. * @param bool $unique Whether the action should be unique. * * @return int Action ID. * @throws \RuntimeException Throws exception when saving the action fails. */ private function save_action_to_db(\ActionScheduler_Action $action, ?\DateTime $date = \null, $unique = \false) { } /** * Helper function to build insert query. * * @param array $data Row data for action. * @param bool $unique Whether the action should be unique. * * @return string Insert query. */ private function build_insert_sql(array $data, $unique) { } /** * Helper method to build where clause for action insert statement. * * @param array $data Row data for action. * @param string $table_name Action table name. * @param bool $unique Where action should be unique. * * @return string Where clause to be used with insert. */ private function build_where_clause_for_insert($data, $table_name, $unique) { } /** * Helper method to get $wpdb->prepare placeholder for a given column name. * * @param string $column_name Name of column in actions table. * * @return string Placeholder to use for given column. */ private function get_placeholder_for_column($column_name) { } /** * Generate a hash from json_encoded $args using MD5 as this isn't for security. * * @param string $args JSON encoded action args. * @return string */ protected function hash_args($args) { } /** * Get action args query param value from action args. * * @param array $args Action args. * @return string */ protected function get_args_for_query($args) { } /** * Get a group's ID based on its name/slug. * * @param string|array $slugs The string name of a group, or names for several groups. * @param bool $create_if_not_exists Whether to create the group if it does not already exist. Default, true - create the group. * * @return array The group IDs, if they exist or were successfully created. May be empty. */ protected function get_group_ids($slugs, $create_if_not_exists = \true) { } /** * Create an action group. * * @param string $slug Group slug. * * @return int Group ID. */ protected function create_group($slug) { } /** * Retrieve an action. * * @param int $action_id Action ID. * * @return ActionScheduler_Action */ public function fetch_action($action_id) { } /** * Create a null action. * * @return ActionScheduler_NullAction */ protected function get_null_action() { } /** * Create an action from a database record. * * @param object $data Action database record. * * @return ActionScheduler_Action|ActionScheduler_CanceledAction|ActionScheduler_FinishedAction */ protected function make_action_from_db_record($data) { } /** * Returns the SQL statement to query (or count) actions. * * @since 3.3.0 $query['status'] accepts array of statuses instead of a single status. * * @param array $query Filtering options. * @param string $select_or_count Whether the SQL should select and return the IDs or just the row count. * * @return string SQL statement already properly escaped. * @throws \InvalidArgumentException If the query is invalid. * @throws \RuntimeException When "unknown partial args matching value". */ protected function get_query_actions_sql(array $query, $select_or_count = 'select') { } /** * Query for action count or list of action IDs. * * @since 3.3.0 $query['status'] accepts array of statuses instead of a single status. * * @see ActionScheduler_Store::query_actions for $query arg usage. * * @param array $query Query filtering options. * @param string $query_type Whether to select or count the results. Defaults to select. * * @return string|array|null The IDs of actions matching the query. Null on failure. */ public function query_actions($query = array(), $query_type = 'select') { } /** * Get a count of all actions in the store, grouped by status. * * @return array Set of 'status' => int $count pairs for statuses with 1 or more actions of that status. */ public function action_counts() { } /** * Cancel an action. * * @param int $action_id Action ID. * * @return void * @throws \InvalidArgumentException If the action update failed. */ public function cancel_action($action_id) { } /** * Cancel pending actions by hook. * * @since 3.0.0 * * @param string $hook Hook name. * * @return void */ public function cancel_actions_by_hook($hook) { } /** * Cancel pending actions by group. * * @param string $group Group slug. * * @return void */ public function cancel_actions_by_group($group) { } /** * Bulk cancel actions. * * @since 3.0.0 * * @param array $query_args Query parameters. */ protected function bulk_cancel_actions($query_args) { } /** * Delete an action. * * @param int $action_id Action ID. * @throws \InvalidArgumentException If the action deletion failed. */ public function delete_action($action_id) { } /** * Get the schedule date for an action. * * @param string $action_id Action ID. * * @return \DateTime The local date the action is scheduled to run, or the date that it ran. */ public function get_date($action_id) { } /** * Get the GMT schedule date for an action. * * @param int $action_id Action ID. * * @throws \InvalidArgumentException If action cannot be identified. * @return \DateTime The GMT date the action is scheduled to run, or the date that it ran. */ protected function get_date_gmt($action_id) { } /** * Stake a claim on actions. * * @param int $max_actions Maximum number of action to include in claim. * @param DateTime|null $before_date Jobs must be schedule before this date. Defaults to now. * @param array $hooks Hooks to filter for. * @param string $group Group to filter for. * * @return ActionScheduler_ActionClaim */ public function stake_claim($max_actions = 10, ?\DateTime $before_date = \null, $hooks = array(), $group = '') { } /** * Generate a new action claim. * * @return int Claim ID. */ protected function generate_claim_id() { } /** * Set a claim filter. * * @param string $filter_name Claim filter name. * @param mixed $filter_values Values to filter. * @return void */ public function set_claim_filter($filter_name, $filter_values) { } /** * Get the claim filter value. * * @param string $filter_name Claim filter name. * @return mixed */ public function get_claim_filter($filter_name) { } /** * Mark actions claimed. * * @param string $claim_id Claim Id. * @param int $limit Number of action to include in claim. * @param DateTime|null $before_date Should use UTC timezone. * @param array $hooks Hooks to filter for. * @param string $group Group to filter for. * * @return int The number of actions that were claimed. * @throws \InvalidArgumentException Throws InvalidArgumentException if group doesn't exist. * @throws \RuntimeException Throws RuntimeException if unable to claim action. */ protected function claim_actions($claim_id, $limit, ?\DateTime $before_date = \null, $hooks = array(), $group = '') { } /** * Get the number of active claims. * * @return int */ public function get_claim_count() { } /** * Return an action's claim ID, as stored in the claim_id column. * * @param string $action_id Action ID. * @return mixed */ public function get_claim_id($action_id) { } /** * Retrieve the action IDs of action in a claim. * * @param int $claim_id Claim ID. * @return int[] */ public function find_actions_by_claim_id($claim_id) { } /** * Release actions from a claim and delete the claim. * * @param ActionScheduler_ActionClaim $claim Claim object. * @throws \RuntimeException When unable to release actions from claim. */ public function release_claim(\ActionScheduler_ActionClaim $claim) { } /** * Remove the claim from an action. * * @param int $action_id Action ID. * * @return void */ public function unclaim_action($action_id) { } /** * Mark an action as failed. * * @param int $action_id Action ID. * @throws \InvalidArgumentException Throw an exception if action was not updated. */ public function mark_failure($action_id) { } /** * Add execution message to action log. * * @throws Exception If the action status cannot be updated to self::STATUS_RUNNING ('in-progress'). * * @param int $action_id Action ID. * * @return void */ public function log_execution($action_id) { } /** * Mark an action as complete. * * @param int $action_id Action ID. * * @return void * @throws \InvalidArgumentException Throw an exception if action was not updated. */ public function mark_complete($action_id) { } /** * Get an action's status. * * @param int $action_id Action ID. * * @return string * @throws \InvalidArgumentException Throw an exception if not status was found for action_id. * @throws \RuntimeException Throw an exception if action status could not be retrieved. */ public function get_status($action_id) { } } /** * Class ActionScheduler_HybridStore * * A wrapper around multiple stores that fetches data from both. * * @since 3.0.0 */ class ActionScheduler_HybridStore extends \ActionScheduler_Store { const DEMARKATION_OPTION = 'action_scheduler_hybrid_store_demarkation'; /** * Primary store instance. * * @var ActionScheduler_Store */ private $primary_store; /** * Secondary store instance. * * @var ActionScheduler_Store */ private $secondary_store; /** * Runner instance. * * @var Action_Scheduler\Migration\Runner */ private $migration_runner; /** * The dividing line between IDs of actions created * by the primary and secondary stores. * * @var int * * Methods that accept an action ID will compare the ID against * this to determine which store will contain that ID. In almost * all cases, the ID should come from the primary store, but if * client code is bypassing the API functions and fetching IDs * from elsewhere, then there is a chance that an unmigrated ID * might be requested. */ private $demarkation_id = 0; /** * ActionScheduler_HybridStore constructor. * * @param Config|null $config Migration config object. */ public function __construct(?\Action_Scheduler\Migration\Config $config = \null) { } /** * Initialize the table data store tables. * * @codeCoverageIgnore */ public function init() { } /** * When the actions table is created, set its autoincrement * value to be one higher than the posts table to ensure that * there are no ID collisions. * * @param string $table_name Table name. * @param string $table_suffix Suffix of table name. * * @return void * @codeCoverageIgnore */ public function set_autoincrement($table_name, $table_suffix) { } /** * Store the demarkation id in WP options. * * @param int $id The ID to set as the demarkation point between the two stores * Leave null to use the next ID from the WP posts table. * * @return int The new ID. * * @codeCoverageIgnore */ private function set_demarkation_id($id = \null) { } /** * Find the first matching action from the secondary store. * If it exists, migrate it to the primary store immediately. * After it migrates, the secondary store will logically contain * the next matching action, so return the result thence. * * @param string $hook Action's hook. * @param array $params Action's arguments. * * @return string */ public function find_action($hook, $params = array()) { } /** * Find actions matching the query in the secondary source first. * If any are found, migrate them immediately. Then the secondary * store will contain the canonical results. * * @param array $query Query arguments. * @param string $query_type Whether to select or count the results. Default, select. * * @return int[] */ public function query_actions($query = array(), $query_type = 'select') { } /** * Get a count of all actions in the store, grouped by status * * @return array Set of 'status' => int $count pairs for statuses with 1 or more actions of that status. */ public function action_counts() { } /** * If any actions would have been claimed by the secondary store, * migrate them immediately, then ask the primary store for the * canonical claim. * * @param int $max_actions Maximum number of actions to claim. * @param null|DateTime $before_date Latest timestamp of actions to claim. * @param string[] $hooks Hook of actions to claim. * @param string $group Group of actions to claim. * * @return ActionScheduler_ActionClaim */ public function stake_claim($max_actions = 10, ?\DateTime $before_date = \null, $hooks = array(), $group = '') { } /** * Migrate a list of actions to the table data store. * * @param array $action_ids List of action IDs. */ private function migrate($action_ids) { } /** * Save an action to the primary store. * * @param ActionScheduler_Action $action Action object to be saved. * @param DateTime|null $date Optional. Schedule date. Default null. * * @return int The action ID */ public function save_action(\ActionScheduler_Action $action, ?\DateTime $date = \null) { } /** * Retrieve an existing action whether migrated or not. * * @param int $action_id Action ID. */ public function fetch_action($action_id) { } /** * Cancel an existing action whether migrated or not. * * @param int $action_id Action ID. */ public function cancel_action($action_id) { } /** * Delete an existing action whether migrated or not. * * @param int $action_id Action ID. */ public function delete_action($action_id) { } /** * Get the schedule date an existing action whether migrated or not. * * @param int $action_id Action ID. */ public function get_date($action_id) { } /** * Mark an existing action as failed whether migrated or not. * * @param int $action_id Action ID. */ public function mark_failure($action_id) { } /** * Log the execution of an existing action whether migrated or not. * * @param int $action_id Action ID. */ public function log_execution($action_id) { } /** * Mark an existing action complete whether migrated or not. * * @param int $action_id Action ID. */ public function mark_complete($action_id) { } /** * Get an existing action status whether migrated or not. * * @param int $action_id Action ID. */ public function get_status($action_id) { } /** * Return which store an action is stored in. * * @param int $action_id ID of the action. * @param bool $primary_first Optional flag indicating search the primary store first. * @return ActionScheduler_Store */ protected function get_store_from_action_id($action_id, $primary_first = \false) { } /** * * * * * * * * * * * * * * * * * * * * * * * * * * * * All claim-related functions should operate solely * on the primary store. * * * * * * * * * * * * * * * * * * * * * * * * * * * */ /** * Get the claim count from the table data store. */ public function get_claim_count() { } /** * Retrieve the claim ID for an action from the table data store. * * @param int $action_id Action ID. */ public function get_claim_id($action_id) { } /** * Release a claim in the table data store. * * @param ActionScheduler_ActionClaim $claim Claim object. */ public function release_claim(\ActionScheduler_ActionClaim $claim) { } /** * Release claims on an action in the table data store. * * @param int $action_id Action ID. */ public function unclaim_action($action_id) { } /** * Retrieve a list of action IDs by claim. * * @param int $claim_id Claim ID. */ public function find_actions_by_claim_id($claim_id) { } } /** * Class ActionScheduler_wpCommentLogger */ class ActionScheduler_wpCommentLogger extends \ActionScheduler_Logger { const AGENT = 'ActionScheduler'; const TYPE = 'action_log'; /** * Create log entry. * * @param string $action_id Action ID. * @param string $message Action log's message. * @param DateTime|null $date Action log's timestamp. * * @return string The log entry ID */ public function log($action_id, $message, ?\DateTime $date = \null) { } /** * Create comment. * * @param int $action_id Action ID. * @param string $message Action log's message. * @param DateTime $date Action log entry's timestamp. */ protected function create_wp_comment($action_id, $message, \DateTime $date) { } /** * Get single log entry for action. * * @param string $entry_id Entry ID. * * @return ActionScheduler_LogEntry */ public function get_entry($entry_id) { } /** * Get action's logs. * * @param string $action_id Action ID. * * @return ActionScheduler_LogEntry[] */ public function get_logs($action_id) { } /** * Get comment. * * @param int $comment_id Comment ID. */ protected function get_comment($comment_id) { } /** * Filter comment queries. * * @param WP_Comment_Query $query Comment query object. */ public function filter_comment_queries($query) { } /** * Filter comment queries. * * @param array $clauses Query's clauses. * @param WP_Comment_Query $query Query object. * * @return array */ public function filter_comment_query_clauses($clauses, $query) { } /** * Make sure Action Scheduler logs are excluded from comment feeds, which use WP_Query, not * the WP_Comment_Query class handled by @see self::filter_comment_queries(). * * @param string $where Query's `where` clause. * @param WP_Query $query Query object. * * @return string */ public function filter_comment_feed($where, $query) { } /** * Return a SQL clause to exclude Action Scheduler comments. * * @return string */ protected function get_where_clause() { } /** * Remove action log entries from wp_count_comments() * * @param array $stats Comment count. * @param int $post_id Post ID. * * @return object */ public function filter_comment_count($stats, $post_id) { } /** * Retrieve the comment counts from our cache, or the database if the cached version isn't set. * * @return object */ protected function get_comment_count() { } /** * Delete comment count cache whenever there is new comment or the status of a comment changes. Cache * will be regenerated next time ActionScheduler_wpCommentLogger::filter_comment_count() is called. */ public function delete_comment_count_cache() { } /** * Initialize. * * @codeCoverageIgnore */ public function init() { } /** * Defer comment counting. */ public function disable_comment_counting() { } /** * Enable comment counting. */ public function enable_comment_counting() { } } /** * Class ActionScheduler_wpPostStore */ class ActionScheduler_wpPostStore extends \ActionScheduler_Store { const POST_TYPE = 'scheduled-action'; const GROUP_TAXONOMY = 'action-group'; const SCHEDULE_META_KEY = '_action_manager_schedule'; const DEPENDENCIES_MET = 'as-post-store-dependencies-met'; /** * Used to share information about the before_date property of claims internally. * * This is used in preference to passing the same information as a method param * for backwards-compatibility reasons. * * @var DateTime|null */ private $claim_before_date = \null; /** * Local Timezone. * * @var DateTimeZone */ protected $local_timezone = \null; /** * Save action. * * @param ActionScheduler_Action $action Scheduled Action. * @param DateTime|null $scheduled_date Scheduled Date. * * @throws RuntimeException Throws an exception if the action could not be saved. * @return int */ public function save_action(\ActionScheduler_Action $action, ?\DateTime $scheduled_date = \null) { } /** * Create post array. * * @param ActionScheduler_Action $action Scheduled Action. * @param DateTime|null $scheduled_date Scheduled Date. * * @return array Returns an array of post data. */ protected function create_post_array(\ActionScheduler_Action $action, ?\DateTime $scheduled_date = \null) { } /** * Save post array. * * @param array $post_array Post array. * @return int Returns the post ID. * @throws RuntimeException Throws an exception if the action could not be saved. */ protected function save_post_array($post_array) { } /** * Filter insert post data. * * @param array $postdata Post data to filter. * * @return array */ public function filter_insert_post_data($postdata) { } /** * Create a (probably unique) post name for scheduled actions in a more performant manner than wp_unique_post_slug(). * * When an action's post status is transitioned to something other than 'draft', 'pending' or 'auto-draft, like 'publish' * or 'failed' or 'trash', WordPress will find a unique slug (stored in post_name column) using the wp_unique_post_slug() * function. This is done to ensure URL uniqueness. The approach taken by wp_unique_post_slug() is to iterate over existing * post_name values that match, and append a number 1 greater than the largest. This makes sense when manually creating a * post from the Edit Post screen. It becomes a bottleneck when automatically processing thousands of actions, with a * database containing thousands of related post_name values. * * WordPress 5.1 introduces the 'pre_wp_unique_post_slug' filter for plugins to address this issue. * * We can short-circuit WordPress's wp_unique_post_slug() approach using the 'pre_wp_unique_post_slug' filter. This * method is available to be used as a callback on that filter. It provides a more scalable approach to generating a * post_name/slug that is probably unique. Because Action Scheduler never actually uses the post_name field, or an * action's slug, being probably unique is good enough. * * For more backstory on this issue, see: * - https://github.com/woocommerce/action-scheduler/issues/44 and * - https://core.trac.wordpress.org/ticket/21112 * * @param string $override_slug Short-circuit return value. * @param string $slug The desired slug (post_name). * @param int $post_ID Post ID. * @param string $post_status The post status. * @param string $post_type Post type. * @return string */ public function set_unique_post_slug($override_slug, $slug, $post_ID, $post_status, $post_type) { } /** * Save post schedule. * * @param int $post_id Post ID of the scheduled action. * @param string $schedule Schedule to save. * * @return void */ protected function save_post_schedule($post_id, $schedule) { } /** * Save action group. * * @param int $post_id Post ID. * @param string $group Group to save. * @return void */ protected function save_action_group($post_id, $group) { } /** * Fetch actions. * * @param int $action_id Action ID. * @return object */ public function fetch_action($action_id) { } /** * Get post. * * @param string $action_id - Action ID. * @return WP_Post|null */ protected function get_post($action_id) { } /** * Get NULL action. * * @return ActionScheduler_NullAction */ protected function get_null_action() { } /** * Make action from post. * * @param WP_Post $post Post object. * @return WP_Post */ protected function make_action_from_post($post) { } /** * Get action status by post status. * * @param string $post_status Post status. * * @throws InvalidArgumentException Throw InvalidArgumentException if $post_status not in known status fields returned by $this->get_status_labels(). * @return string */ protected function get_action_status_by_post_status($post_status) { } /** * Get post status by action status. * * @param string $action_status Action status. * * @throws InvalidArgumentException Throws InvalidArgumentException if $post_status not in known status fields returned by $this->get_status_labels(). * @return string */ protected function get_post_status_by_action_status($action_status) { } /** * Returns the SQL statement to query (or count) actions. * * @param array $query - Filtering options. * @param string $select_or_count - Whether the SQL should select and return the IDs or just the row count. * * @throws InvalidArgumentException - Throw InvalidArgumentException if $select_or_count not count or select. * @return string SQL statement. The returned SQL is already properly escaped. */ protected function get_query_actions_sql(array $query, $select_or_count = 'select') { } /** * Query for action count or list of action IDs. * * @since 3.3.0 $query['status'] accepts array of statuses instead of a single status. * * @see ActionScheduler_Store::query_actions for $query arg usage. * * @param array $query Query filtering options. * @param string $query_type Whether to select or count the results. Defaults to select. * * @return string|array|null The IDs of actions matching the query. Null on failure. */ public function query_actions($query = array(), $query_type = 'select') { } /** * Get a count of all actions in the store, grouped by status * * @return array */ public function action_counts() { } /** * Cancel action. * * @param int $action_id Action ID. * * @throws InvalidArgumentException If $action_id is not identified. */ public function cancel_action($action_id) { } /** * Delete action. * * @param int $action_id Action ID. * @return void * @throws InvalidArgumentException If action is not identified. */ public function delete_action($action_id) { } /** * Get date for claim id. * * @param int $action_id Action ID. * @return ActionScheduler_DateTime The date the action is schedule to run, or the date that it ran. */ public function get_date($action_id) { } /** * Get Date GMT. * * @param int $action_id Action ID. * * @throws InvalidArgumentException If $action_id is not identified. * @return ActionScheduler_DateTime The date the action is schedule to run, or the date that it ran. */ public function get_date_gmt($action_id) { } /** * Stake claim. * * @param int $max_actions Maximum number of actions. * @param DateTime|null $before_date Jobs must be schedule before this date. Defaults to now. * @param array $hooks Claim only actions with a hook or hooks. * @param string $group Claim only actions in the given group. * * @return ActionScheduler_ActionClaim * @throws RuntimeException When there is an error staking a claim. * @throws InvalidArgumentException When the given group is not valid. */ public function stake_claim($max_actions = 10, ?\DateTime $before_date = \null, $hooks = array(), $group = '') { } /** * Get claim count. * * @return int */ public function get_claim_count() { } /** * Generate claim id. * * @return string */ protected function generate_claim_id() { } /** * Claim actions. * * @param string $claim_id Claim ID. * @param int $limit Limit. * @param DateTime|null $before_date Should use UTC timezone. * @param array $hooks Claim only actions with a hook or hooks. * @param string $group Claim only actions in the given group. * * @return int The number of actions that were claimed. * @throws RuntimeException When there is a database error. */ protected function claim_actions($claim_id, $limit, ?\DateTime $before_date = \null, $hooks = array(), $group = '') { } /** * Get IDs of actions within a certain group and up to a certain date/time. * * @param string $group The group to use in finding actions. * @param int $limit The number of actions to retrieve. * @param DateTime $date DateTime object representing cutoff time for actions. Actions retrieved will be * up to and including this DateTime. * * @return array IDs of actions in the appropriate group and before the appropriate time. * @throws InvalidArgumentException When the group does not exist. */ protected function get_actions_by_group($group, $limit, \DateTime $date) { } /** * Find actions by claim ID. * * @param string $claim_id Claim ID. * @return array */ public function find_actions_by_claim_id($claim_id) { } /** * Release claim. * * @param ActionScheduler_ActionClaim $claim Claim object to release. * @return void * @throws RuntimeException When the claim is not unlocked. */ public function release_claim(\ActionScheduler_ActionClaim $claim) { } /** * Unclaim action. * * @param string $action_id Action ID. * @throws RuntimeException When unable to unlock claim on action ID. */ public function unclaim_action($action_id) { } /** * Mark failure on action. * * @param int $action_id Action ID. * * @return void * @throws RuntimeException When unable to mark failure on action ID. */ public function mark_failure($action_id) { } /** * Return an action's claim ID, as stored in the post password column * * @param int $action_id Action ID. * @return mixed */ public function get_claim_id($action_id) { } /** * Return an action's status, as stored in the post status column * * @param int $action_id Action ID. * * @return mixed * @throws InvalidArgumentException When the action ID is invalid. */ public function get_status($action_id) { } /** * Get post column * * @param string $action_id Action ID. * @param string $column_name Column Name. * * @return string|null */ private function get_post_column($action_id, $column_name) { } /** * Log Execution. * * @throws Exception If the action status cannot be updated to self::STATUS_RUNNING ('in-progress'). * * @param string $action_id Action ID. */ public function log_execution($action_id) { } /** * Record that an action was completed. * * @param string $action_id ID of the completed action. * * @throws InvalidArgumentException When the action ID is invalid. * @throws RuntimeException When there was an error executing the action. */ public function mark_complete($action_id) { } /** * Mark action as migrated when there is an error deleting the action. * * @param int $action_id Action ID. */ public function mark_migrated($action_id) { } /** * Determine whether the post store can be migrated. * * @param [type] $setting - Setting value. * @return bool */ public function migration_dependencies_met($setting) { } /** * InnoDB indexes have a maximum size of 767 bytes by default, which is only 191 characters with utf8mb4. * * Previously, AS wasn't concerned about args length, as we used the (unindex) post_content column. However, * as we prepare to move to custom tables, and can use an indexed VARCHAR column instead, we want to warn * developers of this impending requirement. * * @param ActionScheduler_Action $action Action object. */ protected function validate_action(\ActionScheduler_Action $action) { } /** * (@codeCoverageIgnore) */ public function init() { } } /** * Class ActionScheduler_wpPostStore_PostStatusRegistrar * * @codeCoverageIgnore */ class ActionScheduler_wpPostStore_PostStatusRegistrar { /** * Registrar. */ public function register() { } /** * Build the args array for the post type definition * * @return array */ protected function post_status_args() { } /** * Build the args array for the post type definition * * @return array */ protected function post_status_failed_labels() { } /** * Build the args array for the post type definition * * @return array */ protected function post_status_running_labels() { } } /** * Class ActionScheduler_wpPostStore_PostTypeRegistrar * * @codeCoverageIgnore */ class ActionScheduler_wpPostStore_PostTypeRegistrar { /** * Registrar. */ public function register() { } /** * Build the args array for the post type definition * * @return array */ protected function post_type_args() { } } /** * Class ActionScheduler_wpPostStore_TaxonomyRegistrar * * @codeCoverageIgnore */ class ActionScheduler_wpPostStore_TaxonomyRegistrar { /** * Registrar. */ public function register() { } /** * Get taxonomy arguments. */ protected function taxonomy_args() { } } } namespace Action_Scheduler\Migration { /** * Class ActionMigrator * * @package Action_Scheduler\Migration * * @since 3.0.0 * * @codeCoverageIgnore */ class ActionMigrator { /** * Source store instance. * * @var ActionScheduler_Store */ private $source; /** * Destination store instance. * * @var ActionScheduler_Store */ private $destination; /** * LogMigrator instance. * * @var LogMigrator */ private $log_migrator; /** * ActionMigrator constructor. * * @param \ActionScheduler_Store $source_store Source store object. * @param \ActionScheduler_Store $destination_store Destination store object. * @param LogMigrator $log_migrator Log migrator object. */ public function __construct(\ActionScheduler_Store $source_store, \ActionScheduler_Store $destination_store, \Action_Scheduler\Migration\LogMigrator $log_migrator) { } /** * Migrate an action. * * @param int $source_action_id Action ID. * * @return int 0|new action ID * @throws \RuntimeException When unable to delete action from the source store. */ public function migrate($source_action_id) { } } } namespace { /** * Class ActionScheduler_DBStoreMigrator * * A class for direct saving of actions to the table data store during migration. * * @since 3.0.0 */ class ActionScheduler_DBStoreMigrator extends \ActionScheduler_DBStore { /** * Save an action with optional last attempt date. * * Normally, saving an action sets its attempted date to 0000-00-00 00:00:00 because when an action is first saved, * it can't have been attempted yet, but migrated completed actions will have an attempted date, so we need to save * that when first saving the action. * * @param ActionScheduler_Action $action Action to migrate. * @param null|DateTime $scheduled_date Optional date of the first instance to store. * @param null|DateTime $last_attempt_date Optional date the action was last attempted. * * @return string The action ID * @throws \RuntimeException When the action is not saved. */ public function save_action(\ActionScheduler_Action $action, ?\DateTime $scheduled_date = \null, ?\DateTime $last_attempt_date = \null) { } } } namespace Action_Scheduler\Migration { /** * Class BatchFetcher * * @package Action_Scheduler\Migration * * @since 3.0.0 * * @codeCoverageIgnore */ class BatchFetcher { /** * Store instance. * * @var ActionScheduler_Store */ private $store; /** * BatchFetcher constructor. * * @param ActionScheduler_Store $source_store Source store object. */ public function __construct(\ActionScheduler_Store $source_store) { } /** * Retrieve a list of actions. * * @param int $count The number of actions to retrieve. * * @return int[] A list of action IDs */ public function fetch($count = 10) { } /** * Generate a list of prioritized of action search parameters. * * @param int $count Number of actions to find. * * @return array */ private function get_query_strategies($count) { } } /** * Class Config * * @package Action_Scheduler\Migration * * @since 3.0.0 * * A config builder for the ActionScheduler\Migration\Runner class */ class Config { /** * Source store instance. * * @var ActionScheduler_Store */ private $source_store; /** * Source logger instance. * * @var ActionScheduler_Logger */ private $source_logger; /** * Destination store instance. * * @var ActionScheduler_Store */ private $destination_store; /** * Destination logger instance. * * @var ActionScheduler_Logger */ private $destination_logger; /** * Progress bar object. * * @var Action_Scheduler\WP_CLI\ProgressBar */ private $progress_bar; /** * Flag indicating a dryrun. * * @var bool */ private $dry_run = false; /** * Config constructor. */ public function __construct() { } /** * Get the configured source store. * * @return ActionScheduler_Store * @throws \RuntimeException When source store is not configured. */ public function get_source_store() { } /** * Set the configured source store. * * @param ActionScheduler_Store $store Source store object. */ public function set_source_store(\ActionScheduler_Store $store) { } /** * Get the configured source logger. * * @return ActionScheduler_Logger * @throws \RuntimeException When source logger is not configured. */ public function get_source_logger() { } /** * Set the configured source logger. * * @param ActionScheduler_Logger $logger Logger object. */ public function set_source_logger(\ActionScheduler_Logger $logger) { } /** * Get the configured destination store. * * @return ActionScheduler_Store * @throws \RuntimeException When destination store is not configured. */ public function get_destination_store() { } /** * Set the configured destination store. * * @param ActionScheduler_Store $store Action store object. */ public function set_destination_store(\ActionScheduler_Store $store) { } /** * Get the configured destination logger. * * @return ActionScheduler_Logger * @throws \RuntimeException When destination logger is not configured. */ public function get_destination_logger() { } /** * Set the configured destination logger. * * @param ActionScheduler_Logger $logger Logger object. */ public function set_destination_logger(\ActionScheduler_Logger $logger) { } /** * Get flag indicating whether it's a dry run. * * @return bool */ public function get_dry_run() { } /** * Set flag indicating whether it's a dry run. * * @param bool $dry_run Dry run toggle. */ public function set_dry_run($dry_run) { } /** * Get progress bar object. * * @return ActionScheduler\WPCLI\ProgressBar */ public function get_progress_bar() { } /** * Set progress bar object. * * @param ActionScheduler\WPCLI\ProgressBar $progress_bar Progress bar object. */ public function set_progress_bar(\Action_Scheduler\WP_CLI\ProgressBar $progress_bar) { } } /** * Class Controller * * The main plugin/initialization class for migration to custom tables. * * @package Action_Scheduler\Migration * * @since 3.0.0 * * @codeCoverageIgnore */ class Controller { /** * Instance. * * @var self */ private static $instance; /** * Scheduler instance. * * @var Action_Scheduler\Migration\Scheduler */ private $migration_scheduler; /** * Class name of the store object. * * @var string */ private $store_classname; /** * Class name of the logger object. * * @var string */ private $logger_classname; /** * Flag to indicate migrating custom store. * * @var bool */ private $migrate_custom_store; /** * Controller constructor. * * @param Scheduler $migration_scheduler Migration scheduler object. */ protected function __construct(\Action_Scheduler\Migration\Scheduler $migration_scheduler) { } /** * Set the action store class name. * * @param string $class Classname of the store class. * * @return string */ public function get_store_class($class) { } /** * Set the action logger class name. * * @param string $class Classname of the logger class. * * @return string */ public function get_logger_class($class) { } /** * Get flag indicating whether a custom datastore is in use. * * @return bool */ public function has_custom_datastore() { } /** * Set up the background migration process. * * @return void */ public function schedule_migration() { } /** * Get the default migration config object * * @return ActionScheduler\Migration\Config */ public function get_migration_config_object() { } /** * Hook dashboard migration notice. */ public function hook_admin_notices() { } /** * Show a dashboard notice that migration is in progress. */ public function display_migration_notice() { } /** * Add store classes. Hook migration. */ private function hook() { } /** * Possibly hook the migration scheduler action. */ public function maybe_hook_migration() { } /** * Allow datastores to enable migration to AS tables. */ public function allow_migration() { } /** * Proceed with the migration if the dependencies have been met. */ public static function init() { } /** * Singleton factory. */ public static function instance() { } } /** * Class DryRun_ActionMigrator * * @package Action_Scheduler\Migration * * @since 3.0.0 * * @codeCoverageIgnore */ class DryRun_ActionMigrator extends \Action_Scheduler\Migration\ActionMigrator { /** * Simulate migrating an action. * * @param int $source_action_id Action ID. * * @return int */ public function migrate($source_action_id) { } } /** * Class LogMigrator * * @package Action_Scheduler\Migration * * @since 3.0.0 * * @codeCoverageIgnore */ class LogMigrator { /** * Source logger instance. * * @var ActionScheduler_Logger */ private $source; /** * Destination logger instance. * * @var ActionScheduler_Logger */ private $destination; /** * ActionMigrator constructor. * * @param ActionScheduler_Logger $source_logger Source logger object. * @param ActionScheduler_Logger $destination_logger Destination logger object. */ public function __construct(\ActionScheduler_Logger $source_logger, \ActionScheduler_Logger $destination_logger) { } /** * Migrate an action log. * * @param int $source_action_id Source logger object. * @param int $destination_action_id Destination logger object. */ public function migrate($source_action_id, $destination_action_id) { } } /** * Class DryRun_LogMigrator * * @package Action_Scheduler\Migration * * @codeCoverageIgnore */ class DryRun_LogMigrator extends \Action_Scheduler\Migration\LogMigrator { /** * Simulate migrating an action log. * * @param int $source_action_id Source logger object. * @param int $destination_action_id Destination logger object. */ public function migrate($source_action_id, $destination_action_id) { } } /** * Class Runner * * @package Action_Scheduler\Migration * * @since 3.0.0 * * @codeCoverageIgnore */ class Runner { /** * Source store instance. * * @var ActionScheduler_Store */ private $source_store; /** * Destination store instance. * * @var ActionScheduler_Store */ private $destination_store; /** * Source logger instance. * * @var ActionScheduler_Logger */ private $source_logger; /** * Destination logger instance. * * @var ActionScheduler_Logger */ private $destination_logger; /** * Batch fetcher instance. * * @var BatchFetcher */ private $batch_fetcher; /** * Action migrator instance. * * @var ActionMigrator */ private $action_migrator; /** * Log migrator instance. * * @var LogMigrator */ private $log_migrator; /** * Progress bar instance. * * @var ProgressBar */ private $progress_bar; /** * Runner constructor. * * @param Config $config Migration configuration object. */ public function __construct(\Action_Scheduler\Migration\Config $config) { } /** * Run migration batch. * * @param int $batch_size Optional batch size. Default 10. * * @return int Size of batch processed. */ public function run($batch_size = 10) { } /** * Migration a batch of actions. * * @param array $action_ids List of action IDs to migrate. */ public function migrate_actions(array $action_ids) { } /** * Initialize destination store and logger. */ public function init_destination() { } } /** * Class Scheduler * * @package Action_Scheduler\WP_CLI * * @since 3.0.0 * * @codeCoverageIgnore */ class Scheduler { /** Migration action hook. */ const HOOK = 'action_scheduler/migration_hook'; /** Migration action group. */ const GROUP = 'action-scheduler-migration'; /** * Set up the callback for the scheduled job. */ public function hook() { } /** * Remove the callback for the scheduled job. */ public function unhook() { } /** * The migration callback. */ public function run_migration() { } /** * Mark the migration complete. */ public function mark_complete() { } /** * Get a flag indicating whether the migration is scheduled. * * @return bool Whether there is a pending action in the store to handle the migration */ public function is_migration_scheduled() { } /** * Schedule the migration. * * @param int $when Optional timestamp to run the next migration batch. Defaults to now. * * @return string The action ID */ public function schedule_migration($when = 0) { } /** * Remove the scheduled migration action. */ public function unschedule_migration() { } /** * Get migration batch schedule interval. * * @return int Seconds between migration runs. Defaults to 0 seconds to allow chaining migration via Async Runners. */ private function get_schedule_interval() { } /** * Get migration batch size. * * @return int Number of actions to migrate in each batch. Defaults to 250. */ private function get_batch_size() { } /** * Get migration runner object. * * @return Runner */ private function get_migration_runner() { } } } namespace { /** * Class ActionScheduler_SimpleSchedule */ class ActionScheduler_SimpleSchedule extends \ActionScheduler_Abstract_Schedule { /** * Deprecated property @see $this->__wakeup() for details. * * @var null|DateTime */ private $timestamp = \null; /** * Calculate when this schedule should start after a given date & time using * the number of seconds between recurrences. * * @param DateTime $after Timestamp. * * @return DateTime|null */ public function calculate_next(\DateTime $after) { } /** * Schedule is not recurring. * * @return bool */ public function is_recurring() { } /** * Serialize schedule with data required prior to AS 3.0.0 * * Prior to Action Scheduler 3.0.0, schedules used different property names to refer * to equivalent data. For example, ActionScheduler_IntervalSchedule::start_timestamp * was the same as ActionScheduler_SimpleSchedule::timestamp. Action Scheduler 3.0.0 * aligned properties and property names for better inheritance. To guard against the * scheduled date for single actions always being seen as "now" if downgrading to * Action Scheduler < 3.0.0, we need to also store the data with the old property names * so if it's unserialized in AS < 3.0, the schedule doesn't end up with a null recurrence. * * @return array */ public function __sleep() { } /** * Unserialize recurring schedules serialized/stored prior to AS 3.0.0 * * Prior to Action Scheduler 3.0.0, schedules used different property names to refer * to equivalent data. For example, ActionScheduler_IntervalSchedule::start_timestamp * was the same as ActionScheduler_SimpleSchedule::timestamp. Action Scheduler 3.0.0 * aligned properties and property names for better inheritance. To maintain backward * compatibility with schedules serialized and stored prior to 3.0, we need to correctly * map the old property names with matching visibility. */ public function __wakeup() { } } /** * Class ActionScheduler_SimpleSchedule */ class ActionScheduler_CanceledSchedule extends \ActionScheduler_SimpleSchedule { /** * Deprecated property @see $this->__wakeup() for details. * * @var null */ private $timestamp = \null; /** * Calculate when the next instance of this schedule would run based on a given date & time. * * @param DateTime $after Timestamp. * * @return DateTime|null */ public function calculate_next(\DateTime $after) { } /** * Cancelled actions should never have a next schedule, even if get_next() * is called with $after < $this->scheduled_date. * * @param DateTime $after Timestamp. * @return DateTime|null */ public function get_next(\DateTime $after) { } /** * Action is not recurring. * * @return bool */ public function is_recurring() { } /** * Unserialize recurring schedules serialized/stored prior to AS 3.0.0 * * Prior to Action Scheduler 3.0.0, schedules used different property names to refer * to equivalent data. For example, ActionScheduler_IntervalSchedule::start_timestamp * was the same as ActionScheduler_SimpleSchedule::timestamp. Action Scheduler 3.0.0 * aligned properties and property names for better inheritance. To maintain backward * compatibility with schedules serialized and stored prior to 3.0, we need to correctly * map the old property names with matching visibility. */ public function __wakeup() { } } /** * Class ActionScheduler_CronSchedule */ class ActionScheduler_CronSchedule extends \ActionScheduler_Abstract_RecurringSchedule implements \ActionScheduler_Schedule { /** * Deprecated property @see $this->__wakeup() for details. * * @var null */ private $start_timestamp = \null; /** * Deprecated property @see $this->__wakeup() for details. * * @var null */ private $cron = \null; /** * Wrapper for parent constructor to accept a cron expression string and map it to a CronExpression for this * objects $recurrence property. * * @param DateTime $start The date & time to run the action at or after. If $start aligns with the CronSchedule passed via $recurrence, it will be used. If it does not align, the first matching date after it will be used. * @param CronExpression|string $recurrence The CronExpression used to calculate the schedule's next instance. * @param DateTime|null $first (Optional) The date & time the first instance of this interval schedule ran. Default null, meaning this is the first instance. */ public function __construct(\DateTime $start, $recurrence, ?\DateTime $first = \null) { } /** * Calculate when an instance of this schedule would start based on a given * date & time using its the CronExpression. * * @param DateTime $after Timestamp. * @return DateTime */ protected function calculate_next(\DateTime $after) { } /** * Get the schedule's recurrence. * * @return string */ public function get_recurrence() { } /** * Serialize cron schedules with data required prior to AS 3.0.0 * * Prior to Action Scheduler 3.0.0, recurring schedules used different property names to * refer to equivalent data. For example, ActionScheduler_IntervalSchedule::start_timestamp * was the same as ActionScheduler_SimpleSchedule::timestamp. Action Scheduler 3.0.0 * aligned properties and property names for better inheritance. To guard against the * possibility of infinite loops if downgrading to Action Scheduler < 3.0.0, we need to * also store the data with the old property names so if it's unserialized in AS < 3.0, * the schedule doesn't end up with a null recurrence. * * @return array */ public function __sleep() { } /** * Unserialize cron schedules serialized/stored prior to AS 3.0.0 * * For more background, @see ActionScheduler_Abstract_RecurringSchedule::__wakeup(). */ public function __wakeup() { } } /** * Class ActionScheduler_IntervalSchedule */ class ActionScheduler_IntervalSchedule extends \ActionScheduler_Abstract_RecurringSchedule implements \ActionScheduler_Schedule { /** * Deprecated property @see $this->__wakeup() for details. * * @var null */ private $start_timestamp = \null; /** * Deprecated property @see $this->__wakeup() for details. * * @var null */ private $interval_in_seconds = \null; /** * Calculate when this schedule should start after a given date & time using * the number of seconds between recurrences. * * @param DateTime $after Timestamp. * @return DateTime */ protected function calculate_next(\DateTime $after) { } /** * Schedule interval in seconds. * * @return int */ public function interval_in_seconds() { } /** * Serialize interval schedules with data required prior to AS 3.0.0 * * Prior to Action Scheduler 3.0.0, recurring schedules used different property names to * refer to equivalent data. For example, ActionScheduler_IntervalSchedule::start_timestamp * was the same as ActionScheduler_SimpleSchedule::timestamp. Action Scheduler 3.0.0 * aligned properties and property names for better inheritance. To guard against the * possibility of infinite loops if downgrading to Action Scheduler < 3.0.0, we need to * also store the data with the old property names so if it's unserialized in AS < 3.0, * the schedule doesn't end up with a null/false/0 recurrence. * * @return array */ public function __sleep() { } /** * Unserialize interval schedules serialized/stored prior to AS 3.0.0 * * For more background, @see ActionScheduler_Abstract_RecurringSchedule::__wakeup(). */ public function __wakeup() { } } /** * Class ActionScheduler_NullSchedule */ class ActionScheduler_NullSchedule extends \ActionScheduler_SimpleSchedule { /** * DateTime instance. * * @var DateTime|null */ protected $scheduled_date; /** * Make the $date param optional and default to null. * * @param null|DateTime $date The date & time to run the action. */ public function __construct(?\DateTime $date = \null) { } /** * This schedule has no scheduled DateTime, so we need to override the parent __sleep(). * * @return array */ public function __sleep() { } /** * Wakeup. */ public function __wakeup() { } } /** * Class ActionScheduler_LoggerSchema * * @codeCoverageIgnore * * Creates a custom table for storing action logs */ class ActionScheduler_LoggerSchema extends \ActionScheduler_Abstract_Schema { const LOG_TABLE = 'actionscheduler_logs'; /** * Schema version. * * Increment this value to trigger a schema update. * * @var int */ protected $schema_version = 3; /** * Construct. */ public function __construct() { } /** * Performs additional setup work required to support this schema. */ public function init() { } /** * Get table definition. * * @param string $table Table name. */ protected function get_table_definition($table) { } /** * Update the logs table schema, allowing datetime fields to be NULL. * * This is needed because the NOT NULL constraint causes a conflict with some versions of MySQL * configured with sql_mode=NO_ZERO_DATE, which can for instance lead to tables not being created. * * Most other schema updates happen via ActionScheduler_Abstract_Schema::update_table(), however * that method relies on dbDelta() and this change is not possible when using that function. * * @param string $table Name of table being updated. * @param string $db_version The existing schema version of the table. */ public function update_schema_3_0($table, $db_version) { } } /** * Class ActionScheduler_StoreSchema * * @codeCoverageIgnore * * Creates custom tables for storing scheduled actions */ class ActionScheduler_StoreSchema extends \ActionScheduler_Abstract_Schema { const ACTIONS_TABLE = 'actionscheduler_actions'; const CLAIMS_TABLE = 'actionscheduler_claims'; const GROUPS_TABLE = 'actionscheduler_groups'; const DEFAULT_DATE = '0000-00-00 00:00:00'; /** * Schema version. * * Increment this value to trigger a schema update. * * @var int */ protected $schema_version = 7; /** * Construct. */ public function __construct() { } /** * Performs additional setup work required to support this schema. */ public function init() { } /** * Get table definition. * * @param string $table Table name. */ protected function get_table_definition($table) { } /** * Update the actions table schema, allowing datetime fields to be NULL. * * This is needed because the NOT NULL constraint causes a conflict with some versions of MySQL * configured with sql_mode=NO_ZERO_DATE, which can for instance lead to tables not being created. * * Most other schema updates happen via ActionScheduler_Abstract_Schema::update_table(), however * that method relies on dbDelta() and this change is not possible when using that function. * * @param string $table Name of table being updated. * @param string $db_version The existing schema version of the table. */ public function update_schema_5_0($table, $db_version) { } } /** * CRON expression parser that can determine whether or not a CRON expression is * due to run, the next run date and previous run date of a CRON expression. * The determinations made by this class are accurate if checked run once per * minute (seconds are dropped from date time comparisons). * * Schedule parts must map to: * minute [0-59], hour [0-23], day of month, month [1-12|JAN-DEC], day of week * [1-7|MON-SUN], and an optional year. * * @author Michael Dowling * @link http://en.wikipedia.org/wiki/Cron */ class CronExpression { const MINUTE = 0; const HOUR = 1; const DAY = 2; const MONTH = 3; const WEEKDAY = 4; const YEAR = 5; /** * @var array CRON expression parts */ private $cronParts; /** * @var CronExpression_FieldFactory CRON field factory */ private $fieldFactory; /** * @var array Order in which to test of cron parts */ private static $order = array(self::YEAR, self::MONTH, self::DAY, self::WEEKDAY, self::HOUR, self::MINUTE); /** * Factory method to create a new CronExpression. * * @param string $expression The CRON expression to create. There are * several special predefined values which can be used to substitute the * CRON expression: * * @yearly, @annually) - Run once a year, midnight, Jan. 1 - 0 0 1 1 * * @monthly - Run once a month, midnight, first of month - 0 0 1 * * * @weekly - Run once a week, midnight on Sun - 0 0 * * 0 * @daily - Run once a day, midnight - 0 0 * * * * @hourly - Run once an hour, first minute - 0 * * * * * *@param CronExpression_FieldFactory $fieldFactory (optional) Field factory to use * * @return CronExpression */ public static function factory($expression, ?\CronExpression_FieldFactory $fieldFactory = \null) { } /** * Parse a CRON expression * * @param string $expression CRON expression (e.g. '8 * * * *') * @param CronExpression_FieldFactory $fieldFactory Factory to create cron fields */ public function __construct($expression, \CronExpression_FieldFactory $fieldFactory) { } /** * Set or change the CRON expression * * @param string $value CRON expression (e.g. 8 * * * *) * * @return CronExpression * @throws InvalidArgumentException if not a valid CRON expression */ public function setExpression($value) { } /** * Set part of the CRON expression * * @param int $position The position of the CRON expression to set * @param string $value The value to set * * @return CronExpression * @throws InvalidArgumentException if the value is not valid for the part */ public function setPart($position, $value) { } /** * Get a next run date relative to the current date or a specific date * * @param string|DateTime $currentTime (optional) Relative calculation date * @param int $nth (optional) Number of matches to skip before returning a * matching next run date. 0, the default, will return the current * date and time if the next run date falls on the current date and * time. Setting this value to 1 will skip the first match and go to * the second match. Setting this value to 2 will skip the first 2 * matches and so on. * @param bool $allowCurrentDate (optional) Set to TRUE to return the * current date if it matches the cron expression * * @return DateTime * @throws RuntimeException on too many iterations */ public function getNextRunDate($currentTime = 'now', $nth = 0, $allowCurrentDate = \false) { } /** * Get a previous run date relative to the current date or a specific date * * @param string|DateTime $currentTime (optional) Relative calculation date * @param int $nth (optional) Number of matches to skip before returning * @param bool $allowCurrentDate (optional) Set to TRUE to return the * current date if it matches the cron expression * * @return DateTime * @throws RuntimeException on too many iterations * @see CronExpression::getNextRunDate */ public function getPreviousRunDate($currentTime = 'now', $nth = 0, $allowCurrentDate = \false) { } /** * Get multiple run dates starting at the current date or a specific date * * @param int $total Set the total number of dates to calculate * @param string|DateTime $currentTime (optional) Relative calculation date * @param bool $invert (optional) Set to TRUE to retrieve previous dates * @param bool $allowCurrentDate (optional) Set to TRUE to return the * current date if it matches the cron expression * * @return array Returns an array of run dates */ public function getMultipleRunDates($total, $currentTime = 'now', $invert = \false, $allowCurrentDate = \false) { } /** * Get all or part of the CRON expression * * @param string $part (optional) Specify the part to retrieve or NULL to * get the full cron schedule string. * * @return string|null Returns the CRON expression, a part of the * CRON expression, or NULL if the part was specified but not found */ public function getExpression($part = \null) { } /** * Helper method to output the full expression. * * @return string Full CRON expression */ public function __toString() { } /** * Determine if the cron is due to run based on the current date or a * specific date. This method assumes that the current number of * seconds are irrelevant, and should be called once per minute. * * @param string|DateTime $currentTime (optional) Relative calculation date * * @return bool Returns TRUE if the cron is due to run or FALSE if not */ public function isDue($currentTime = 'now') { } /** * Get the next or previous run date of the expression relative to a date * * @param string|DateTime $currentTime (optional) Relative calculation date * @param int $nth (optional) Number of matches to skip before returning * @param bool $invert (optional) Set to TRUE to go backwards in time * @param bool $allowCurrentDate (optional) Set to TRUE to return the * current date if it matches the cron expression * * @return DateTime * @throws RuntimeException on too many iterations */ protected function getRunDate($currentTime = \null, $nth = 0, $invert = \false, $allowCurrentDate = \false) { } } /** * CRON field interface * * @author Michael Dowling */ interface CronExpression_FieldInterface { /** * Check if the respective value of a DateTime field satisfies a CRON exp * * @param DateTime $date DateTime object to check * @param string $value CRON expression to test against * * @return bool Returns TRUE if satisfied, FALSE otherwise */ public function isSatisfiedBy(\DateTime $date, $value); /** * When a CRON expression is not satisfied, this method is used to increment * or decrement a DateTime object by the unit of the cron field * * @param DateTime $date DateTime object to change * @param bool $invert (optional) Set to TRUE to decrement * * @return CronExpression_FieldInterface */ public function increment(\DateTime $date, $invert = \false); /** * Validates a CRON expression for a given field * * @param string $value CRON expression value to validate * * @return bool Returns TRUE if valid, FALSE otherwise */ public function validate($value); } /** * Abstract CRON expression field * * @author Michael Dowling */ abstract class CronExpression_AbstractField implements \CronExpression_FieldInterface { /** * Check to see if a field is satisfied by a value * * @param string $dateValue Date value to check * @param string $value Value to test * * @return bool */ public function isSatisfied($dateValue, $value) { } /** * Check if a value is a range * * @param string $value Value to test * * @return bool */ public function isRange($value) { } /** * Check if a value is an increments of ranges * * @param string $value Value to test * * @return bool */ public function isIncrementsOfRanges($value) { } /** * Test if a value is within a range * * @param string $dateValue Set date value * @param string $value Value to test * * @return bool */ public function isInRange($dateValue, $value) { } /** * Test if a value is within an increments of ranges (offset[-to]/step size) * * @param string $dateValue Set date value * @param string $value Value to test * * @return bool */ public function isInIncrementsOfRanges($dateValue, $value) { } } /** * Day of month field. Allows: * , / - ? L W * * 'L' stands for "last" and specifies the last day of the month. * * The 'W' character is used to specify the weekday (Monday-Friday) nearest the * given day. As an example, if you were to specify "15W" as the value for the * day-of-month field, the meaning is: "the nearest weekday to the 15th of the * month". So if the 15th is a Saturday, the trigger will fire on Friday the * 14th. If the 15th is a Sunday, the trigger will fire on Monday the 16th. If * the 15th is a Tuesday, then it will fire on Tuesday the 15th. However if you * specify "1W" as the value for day-of-month, and the 1st is a Saturday, the * trigger will fire on Monday the 3rd, as it will not 'jump' over the boundary * of a month's days. The 'W' character can only be specified when the * day-of-month is a single day, not a range or list of days. * * @author Michael Dowling */ class CronExpression_DayOfMonthField extends \CronExpression_AbstractField { /** * Get the nearest day of the week for a given day in a month * * @param int $currentYear Current year * @param int $currentMonth Current month * @param int $targetDay Target day of the month * * @return DateTime Returns the nearest date */ private static function getNearestWeekday($currentYear, $currentMonth, $targetDay) { } /** * {@inheritdoc} */ public function isSatisfiedBy(\DateTime $date, $value) { } /** * {@inheritdoc} */ public function increment(\DateTime $date, $invert = \false) { } /** * {@inheritdoc} */ public function validate($value) { } } /** * Day of week field. Allows: * / , - ? L # * * Days of the week can be represented as a number 0-7 (0|7 = Sunday) * or as a three letter string: SUN, MON, TUE, WED, THU, FRI, SAT. * * 'L' stands for "last". It allows you to specify constructs such as * "the last Friday" of a given month. * * '#' is allowed for the day-of-week field, and must be followed by a * number between one and five. It allows you to specify constructs such as * "the second Friday" of a given month. * * @author Michael Dowling */ class CronExpression_DayOfWeekField extends \CronExpression_AbstractField { /** * {@inheritdoc} */ public function isSatisfiedBy(\DateTime $date, $value) { } /** * {@inheritdoc} */ public function increment(\DateTime $date, $invert = \false) { } /** * {@inheritdoc} */ public function validate($value) { } } /** * CRON field factory implementing a flyweight factory * * @author Michael Dowling * @link http://en.wikipedia.org/wiki/Cron */ class CronExpression_FieldFactory { /** * @var array Cache of instantiated fields */ private $fields = array(); /** * Get an instance of a field object for a cron expression position * * @param int $position CRON expression position value to retrieve * * @return CronExpression_FieldInterface * @throws InvalidArgumentException if a position is not valid */ public function getField($position) { } } /** * Hours field. Allows: * , / - * * @author Michael Dowling */ class CronExpression_HoursField extends \CronExpression_AbstractField { /** * {@inheritdoc} */ public function isSatisfiedBy(\DateTime $date, $value) { } /** * {@inheritdoc} */ public function increment(\DateTime $date, $invert = \false) { } /** * {@inheritdoc} */ public function validate($value) { } } /** * Minutes field. Allows: * , / - * * @author Michael Dowling */ class CronExpression_MinutesField extends \CronExpression_AbstractField { /** * {@inheritdoc} */ public function isSatisfiedBy(\DateTime $date, $value) { } /** * {@inheritdoc} */ public function increment(\DateTime $date, $invert = \false) { } /** * {@inheritdoc} */ public function validate($value) { } } /** * Month field. Allows: * , / - * * @author Michael Dowling */ class CronExpression_MonthField extends \CronExpression_AbstractField { /** * {@inheritdoc} */ public function isSatisfiedBy(\DateTime $date, $value) { } /** * {@inheritdoc} */ public function increment(\DateTime $date, $invert = \false) { } /** * {@inheritdoc} */ public function validate($value) { } } /** * Year field. Allows: * , / - * * @author Michael Dowling */ class CronExpression_YearField extends \CronExpression_AbstractField { /** * {@inheritdoc} */ public function isSatisfiedBy(\DateTime $date, $value) { } /** * {@inheritdoc} */ public function increment(\DateTime $date, $invert = \false) { } /** * {@inheritdoc} */ public function validate($value) { } } class WPMUDEV_Analytics_V2_Mutex { public function __construct($key) { } public function __call($name, $arguments) { } } /** * @method identify( int $user_id ) * @method register( string $property, mixed $value ) * @method registerAll( array $properties ) */ class WPMUDEV_Analytics_V4 { private $data_option_id = 'wpmudev_analytics_%s_json_data'; private $exceeded_event_name = 'exceeded_daily_limit'; private $plugin_slug; private $plugin_name; private $event_limit; private $project_token; /** * @var Mixpanel */ private $mixpanel; /** * @var int */ private $time_window; /** * @var array */ private $options; /** * @var mixed|string|null */ private $mysql_version; public function __construct($plugin_slug, $plugin_name, $event_limit, $project_token, $options = array()) { } private function get_consumer() { } private function get_constant_value($name, $default) { } /** * @return Mixpanel|null */ private function get_mixpanel() { } public function set_mixpanel($mixpanel) { } private function prepare_mixpanel_instance() { } public function handle_error($code, $data) { } public function __call($name, $arguments) { } private function server_meets_requirements() { } public function track($event, $properties = array()) { } /** * @return string */ private function get_option_key() { } private function update_data() { } private function update_json_data() { } private function get_time_now() { } private function wp_update_data() { } private function wp_get_event_count() { } private function wp_get_timestamp() { } private function wp_get_data() { } private function wp_set_data($data) { } private function get_mysql_version() { } public function set_mysql_version($mysql_version) { } private function is_function_supported($function_name) { } public function get_array_value($haystack, $key, $default_value = \null) { } } class WPMUDEV_Analytics_V2 extends \WPMUDEV_Analytics_V4 { } class WPMUDEV_Analytics_V3 extends \WPMUDEV_Analytics_V4 { } class WPMUDEV_Analytics extends \WPMUDEV_Analytics_V4 { } class Test_WPMUDEV_Analytics extends \WP_UnitTestCase { private $time; public function set_up() { } /** * @dataProvider mysql_version */ public function test_event_limit_enforced($mysql_version) { } private function then_event_tracked_times($event_name, $expected_count) { } private function set_time($time) { } public function time_function() { } private function given_analytics($event_limit) { } public function mysql_version() { } } class Testable_Mixpanel { static $track_count = array(); public function track($event_name) { } } } namespace WPMUDEV_Analytics_Vendor { /** * This a Base class which all Mixpanel classes extend from to provide some very basic * debugging and logging functionality. It also serves to persist $_options across the library. * */ class Base_MixpanelBase { /** * Default options that can be overridden via the $options constructor arg * @var array */ private $_defaults = array( "max_batch_size" => 50, // the max batch size Mixpanel will accept is 50, "max_queue_size" => 1000, // the max num of items to hold in memory before flushing "debug" => \false, // enable/disable debug mode "consumer" => "curl", // which consumer to use "host" => "api.mixpanel.com", // the host name for api calls "events_endpoint" => "/track", // host relative endpoint for events "people_endpoint" => "/engage", // host relative endpoint for people updates "groups_endpoint" => "/groups", // host relative endpoint for groups updates "use_ssl" => \true, // use ssl when available "error_callback" => null, ); /** * An array of options to be used by the Mixpanel library. * @var array */ protected $_options = array(); /** * Construct a new MixpanelBase object and merge custom options with defaults * @param array $options */ public function __construct($options = array()) { } /** * Log a message to PHP's error log * @param $msg */ protected function _log($msg) { } /** * Returns true if in debug mode, false if in production mode * @return bool */ protected function _debug() { } } /** * Provides some base methods for use by a Consumer implementation */ abstract class ConsumerStrategies_AbstractConsumer extends \WPMUDEV_Analytics_Vendor\Base_MixpanelBase { /** * Creates a new AbstractConsumer * @param array $options */ function __construct($options = array()) { } /** * Encode an array to be persisted * @param array $params * @return string */ protected function _encode($params) { } /** * Handles errors that occur in a consumer * @param $code * @param $msg */ protected function _handleError($code, $msg) { } /** * Number of requests/batches that will be processed in parallel. * @return int */ public function getNumThreads() { } /** * Persist a batch of messages in whatever way the implementer sees fit * @param array $batch an array of messages to consume * @return boolean success or fail */ abstract function persist($batch); } /** * Consumes messages and sends them to a host/endpoint using cURL */ class ConsumerStrategies_CurlConsumer extends \WPMUDEV_Analytics_Vendor\ConsumerStrategies_AbstractConsumer { /** * @var string the host to connect to (e.g. api.mixpanel.com) */ protected $_host; /** * @var string the host-relative endpoint to write to (e.g. /engage) */ protected $_endpoint; /** * @var int connect_timeout The number of seconds to wait while trying to connect. Default is 5 seconds. */ protected $_connect_timeout; /** * @var int timeout The maximum number of seconds to allow cURL call to execute. Default is 30 seconds. */ protected $_timeout; /** * @var string the protocol to use for the cURL connection */ protected $_protocol; /** * @var bool|null true to fork the cURL process (using exec) or false to use PHP's cURL extension. false by default */ protected $_fork = null; /** * @var int number of cURL requests to run in parallel. 1 by default */ protected $_num_threads; /** * Creates a new CurlConsumer and assigns properties from the $options array * @param array $options * @throws Exception */ function __construct($options) { } /** * Write to the given host/endpoint using either a forked cURL process or using PHP's cURL extension * @param array $batch * @return bool */ public function persist($batch) { } /** * Write using the cURL php extension * @param $url * @param $batch * @return bool */ protected function _execute($url, $batch) { } /** * Write using a forked cURL process * @param $url * @param $data * @return bool */ protected function _execute_forked($url, $data) { } /** * @return int */ public function getConnectTimeout() { } /** * @return string */ public function getEndpoint() { } /** * @return bool|null */ public function getFork() { } /** * @return string */ public function getHost() { } /** * @return array */ public function getOptions() { } /** * @return string */ public function getProtocol() { } /** * @return int */ public function getTimeout() { } /** * Number of requests/batches that will be processed in parallel using curl_multi_exec. * @return int */ public function getNumThreads() { } } /** * Consumes messages and writes them to a file */ class ConsumerStrategies_FileConsumer extends \WPMUDEV_Analytics_Vendor\ConsumerStrategies_AbstractConsumer { /** * @var string path to a file that we want to write the messages to */ private $_file; /** * Creates a new FileConsumer and assigns properties from the $options array * @param array $options */ function __construct($options) { } /** * Append $batch to a file * @param array $batch * @return bool */ public function persist($batch) { } } /** * Consumes messages and writes them to host/endpoint using a persistent socket */ class ConsumerStrategies_SocketConsumer extends \WPMUDEV_Analytics_Vendor\ConsumerStrategies_AbstractConsumer { /** * @var string the host to connect to (e.g. api.mixpanel.com) */ private $_host; /** * @var string the host-relative endpoint to write to (e.g. /engage) */ private $_endpoint; /** * @var int connect_timeout the socket connection timeout in seconds */ private $_connect_timeout; /** * @var string the protocol to use for the socket connection */ private $_protocol; /** * @var resource holds the socket resource */ private $_socket; /** * @var bool whether or not to wait for a response */ private $_async; /** * @var int the port to use for the socket connection */ private $_port; /** * Creates a new SocketConsumer and assigns properties from the $options array * @param array $options */ public function __construct($options = array()) { } /** * Write using a persistent socket connection. * @param array $batch * @return bool */ public function persist($batch) { } /** * Return cached socket if open or create a new persistent socket * @return bool|resource */ private function _getSocket() { } /** * Attempt to open a new socket connection, cache it, and return the resource * @param bool $retry * @return bool|resource */ private function _createSocket($retry = \true) { } /** * Attempt to close and dereference a socket resource */ private function _destroySocket() { } /** * Write $data through the given $socket * @param $socket * @param $data * @param bool $retry * @return bool */ private function _write($socket, $data, $retry = \true) { } /** * Parse the response from a socket write (only used for debugging) * @param $response * @return array */ private function handleResponse($response) { } } /** * This is the main class for the Mixpanel PHP Library which provides all of the methods you need to track events, * create/update profiles and group profiles. * * Architecture * ------------- * * This library is built such that all messages are buffered in an in-memory "queue" * The queue will be automatically flushed at the end of every request. Alternatively, you can call "flush()" manually * at any time. Flushed messages will be passed to a Consumer's "persist" method. The library comes with a handful of * Consumers. The "CurlConsumer" is used by default which will send the messages to Mixpanel using forked cURL processes. * You can implement your own custom Consumer to customize how a message is sent to Mixpanel. This can be useful when * you want to put messages onto a distributed queue (such as ActiveMQ or Kestrel) instead of writing to Mixpanel in * the user thread. * * Options * ------------- * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *

Option	Description	Default
max_queue_size	The maximum number of items to buffer in memory before flushing	1000
debug	Enable/disable debug mode	false
consumer	The consumer to use for writing messages	curl
consumers	An array of custom consumers in the format array(consumer_key => class_name)	null
host	The host name for api calls (used by some consumers)	api.mixpanel.com
events_endpoint	The endpoint for tracking events (relative to the host)	/events
people_endpoint	The endpoint for making people updates (relative to the host)	/engage
use_ssl	Tell the consumer whether or not to use ssl (when available)	true
error_callback	The name of a function to be called on consumption failures	null
connect_timeout	In both the SocketConsumer and CurlConsumer, this is used for the connection timeout (i.e. How long it has take to actually make a connection). *	5
timeout	In the CurlConsumer (non-forked), it is used to determine how long the cURL call has to execute. *	30

* * Example: Tracking an Event * ------------- * * $mp = Mixpanel::getInstance("MY_TOKEN"); * * $mp->track("My Event"); * * Example: Setting Profile Properties * ------------- * * $mp = Mixpanel::getInstance("MY_TOKEN", array("use_ssl" => false)); * * $mp->people->set(12345, array( * '$first_name' => "John", * '$last_name' => "Doe", * '$email' => "john.doe@example.com", * '$phone' => "5555555555", * 'Favorite Color' => "red" * )); * */ class Mixpanel extends \WPMUDEV_Analytics_Vendor\Base_MixpanelBase { /** * An instance of the MixpanelPeople class (used to create/update profiles) * @var Producers_MixpanelPeople */ public $people; /** * An instance of the MixpanelEvents class * @var Producers_MixpanelEvents */ private $_events; /** * An instance of the MixpanelGroups class (used to create/update group profiles) * @var Producers_MixpanelPeople */ public $group; /** * Instances' list of the Mixpanel class (for singleton use, splitted by token) * @var Mixpanel[] */ private static $_instances = array(); /** * Instantiates a new Mixpanel instance. * @param $token * @param array $options */ public function __construct($token, $options = array()) { } /** * Returns a singleton instance of Mixpanel * @param $token * @param array $options * @return Mixpanel */ public static function getInstance($token, $options = array()) { } /** * Add an array representing a message to be sent to Mixpanel to the in-memory queue. * @param array $message */ public function enqueue($message = array()) { } /** * Add an array representing a list of messages to be sent to Mixpanel to a queue. * @param array $messages */ public function enqueueAll($messages = array()) { } /** * Flush the events queue * @param int $desired_batch_size */ public function flush($desired_batch_size = 50) { } /** * Empty the events queue */ public function reset() { } /** * Identify the user you want to associate to tracked events. The $anon_id must be UUID v4 format and not already merged to an $identified_id. * All identify calls with a new and valid $anon_id will trigger a track $identify event, and merge to the $identified_id. * @param string|int $user_id * @param string|int $anon_id [optional] */ public function identify($user_id, $anon_id = null) { } /** * Track an event defined by $event associated with metadata defined by $properties * @param string $event * @param array $properties */ public function track($event, $properties = array()) { } /** * Register a property to be sent with every event. * * If the property has already been registered, it will be * overwritten. NOTE: Registered properties are only persisted for the life of the Mixpanel class instance. * @param string $property * @param mixed $value */ public function register($property, $value) { } /** * Register multiple properties to be sent with every event. * * If any of the properties have already been registered, * they will be overwritten. NOTE: Registered properties are only persisted for the life of the Mixpanel class * instance. * @param array $props_and_vals */ public function registerAll($props_and_vals = array()) { } /** * Register a property to be sent with every event. * * If the property has already been registered, it will NOT be * overwritten. NOTE: Registered properties are only persisted for the life of the Mixpanel class instance. * @param $property * @param $value */ public function registerOnce($property, $value) { } /** * Register multiple properties to be sent with every event. * * If any of the properties have already been registered, * they will NOT be overwritten. NOTE: Registered properties are only persisted for the life of the Mixpanel class * instance. * @param array $props_and_vals */ public function registerAllOnce($props_and_vals = array()) { } /** * Un-register an property to be sent with every event. * @param string $property */ public function unregister($property) { } /** * Un-register a list of properties to be sent with every event. * @param array $properties */ public function unregisterAll($properties) { } /** * Get a property that is set to be sent with every event * @param string $property * @return mixed */ public function getProperty($property) { } /** * An alias to be merged with the distinct_id. Each alias can only map to one distinct_id. * This is helpful when you want to associate a generated id (such as a session id) to a user id or username. * @param string|int $distinct_id * @param string|int $alias */ public function createAlias($distinct_id, $alias) { } } /** * Provides some base methods for use by a message Producer */ abstract class Producers_MixpanelBaseProducer extends \WPMUDEV_Analytics_Vendor\Base_MixpanelBase { /** * @var string a token associated to a Mixpanel project */ protected $_token; /** * @var array a queue to hold messages in memory before flushing in batches */ private $_queue = array(); /** * @var ConsumerStrategies_AbstractConsumer the consumer to use when flushing messages */ private $_consumer = null; /** * @var array The list of available consumers */ private $_consumers = array("file" => "WPMUDEV_Analytics_Vendor\\ConsumerStrategies_FileConsumer", "curl" => "WPMUDEV_Analytics_Vendor\\ConsumerStrategies_CurlConsumer", "socket" => "WPMUDEV_Analytics_Vendor\\ConsumerStrategies_SocketConsumer"); /** * If the queue reaches this size we'll auto-flush to prevent out of memory errors * @var int */ protected $_max_queue_size = 1000; /** * Creates a new MixpanelBaseProducer, assings Mixpanel project token, registers custom Consumers, and instantiates * the desired consumer * @param $token * @param array $options */ public function __construct($token, $options = array()) { } /** * Flush the queue when we destruct the client with retries */ public function __destruct() { } /** * Iterate the queue and write in batches using the instantiated Consumer Strategy * @param int $desired_batch_size * @return bool whether or not the flush was successful */ public function flush($desired_batch_size = 50) { } /** * Empties the queue without persisting any of the messages */ public function reset() { } /** * Returns the in-memory queue * @return array */ public function getQueue() { } /** * Returns the current Mixpanel project token * @return string */ public function getToken() { } /** * Given a strategy type, return a new PersistenceStrategy object * @return ConsumerStrategies_AbstractConsumer */ protected function _getConsumer() { } /** * Add an array representing a message to be sent to Mixpanel to a queue. * @param array $message */ public function enqueue($message = array()) { } /** * Add an array representing a list of messages to be sent to Mixpanel to a queue. * @param array $messages */ public function enqueueAll($messages = array()) { } /** * Given an array of messages, persist it with the instantiated Persistence Strategy * @param $message * @return mixed */ protected function _persist($message) { } /** * Return the endpoint that should be used by a consumer that consumes messages produced by this producer. * @return string */ abstract function _getEndpoint(); } /** * Provides an API to track events on Mixpanel */ class Producers_MixpanelEvents extends \WPMUDEV_Analytics_Vendor\Producers_MixpanelBaseProducer { /** * An array of properties to attach to every tracked event * @var array */ private $_super_properties = array("mp_lib" => "php"); /** * Track an event defined by $event associated with metadata defined by $properties * @param string $event * @param array $properties */ public function track($event, $properties = array()) { } /** * Register a property to be sent with every event. If the property has already been registered, it will be * overwritten. * @param string $property * @param mixed $value */ public function register($property, $value) { } /** * Register multiple properties to be sent with every event. If any of the properties have already been registered, * they will be overwritten. * @param array $props_and_vals */ public function registerAll($props_and_vals = array()) { } /** * Register a property to be sent with every event. If the property has already been registered, it will NOT be * overwritten. * @param $property * @param $value */ public function registerOnce($property, $value) { } /** * Register multiple properties to be sent with every event. If any of the properties have already been registered, * they will NOT be overwritten. * @param array $props_and_vals */ public function registerAllOnce($props_and_vals = array()) { } /** * Un-register an property to be sent with every event. * @param string $property */ public function unregister($property) { } /** * Un-register a list of properties to be sent with every event. * @param array $properties */ public function unregisterAll($properties) { } /** * Get a property that is set to be sent with every event * @param string $property * @return mixed */ public function getProperty($property) { } /** * Identify the user you want to associate to tracked events. The $anon_id must be UUID v4 format (optionally with the * prefix '$device:') and not already merged to an $identified_id. All identify calls with a new and valid $anon_id will * trigger a track $identify event, and merge to the $identified_id. * @param string|int $user_id * @param string|int $anon_id [optional] */ public function identify($user_id, $anon_id = null) { } /** * An alias to be merged with the distinct_id. Each alias can only map to one distinct_id. * This is helpful when you want to associate a generated id (such as a session id) to a user id or username. * * Because aliasing can be extremely vulnerable to race conditions and ordering issues, we'll make a synchronous * call directly to Mixpanel when this method is called. If it fails we'll throw an Exception as subsequent * events are likely to be incorrectly tracked. * @param string|int $distinct_id * @param string|int $alias * @return array $msg * @throws Exception */ public function createAlias($distinct_id, $alias) { } /** * Returns the "events" endpoint * @return string */ function _getEndpoint() { } } /** * Provides an API to create/update group profiles on Mixpanel */ class Producers_MixpanelGroups extends \WPMUDEV_Analytics_Vendor\Producers_MixpanelBaseProducer { /** * Internal method to prepare a message given the message data * @param $group_key * @param $group_id * @param $operation * @param $value * @param boolean $ignore_time If the $ignore_time property is true, Mixpanel will not automatically update the "Last Seen" property of the group Profile. Otherwise, Mixpanel will add a "Last Seen" property associated with the current time * @return array */ private function _constructPayload($group_key, $group_id, $operation, $value, $ignore_time = \false) { } /** * Set properties on a group profile. If the group profile does not exist, it creates it with these properties. * If it does exist, it sets the properties to these values, overwriting existing values. * @param string|int $group_key the group_key used for groups in Project Settings * @param string|int $group_id the group id used for the group profile * @param array $props associative array of properties to set on the group profile * @param boolean $ignore_time If the $ignore_time property is true, Mixpanel will not automatically update the "Last Seen" property of the group profile. Otherwise, Mixpanel will add a "Last Seen" property associated with the current time */ public function set($group_key, $group_id, $props, $ignore_time = \false) { } /** * Set properties on a group profile. If the Group profile does not exist, it creates it with these properties. * If it does exist, it sets the properties to these values but WILL NOT overwrite existing values. * @param string|int $group_key the group_key used for groups in Project Settings * @param string|int $group_id the group id used for the group profile * @param array $props associative array of properties to set on the group profile * @param boolean $ignore_time If the $ignore_time property is true, Mixpanel will not automatically update the "Last Seen" property of the group profile. Otherwise, Mixpanel will add a "Last Seen" property associated with the current time */ public function setOnce($group_key, $group_id, $props, $ignore_time = \false) { } /** * Unset properties on a group profile. If the group does not exist, it creates it with no properties. * If it does exist, it unsets these properties. NOTE: In other libraries we use 'unset' which is * a reserved word in PHP. * @param string|int $group_key the group_key used for groups in Project Settings * @param string|int $group_id the group id used for the group profile * @param array $props associative array of properties to unset on the group profile * @param boolean $ignore_time If the $ignore_time property is true, Mixpanel will not automatically update the "Last Seen" property of the group profile. Otherwise, Mixpanel will add a "Last Seen" property associated with the current time */ public function remove($group_key, $group_id, $props, $ignore_time = \false) { } /** * Adds $val to a list located at $prop. If the property does not exist, it will be created. If $val is a string * and the list is empty or does not exist, a new list with one value will be created. * @param string|int $group_key the group_key used for groups in Project Settings * @param string|int $group_id the group id used for the group profile * @param string $prop the property that holds the list * @param string|array $val items to add to the list * @param boolean $ignore_time If the $ignore_time property is true, Mixpanel will not automatically update the "Last Seen" property of the group profile. Otherwise, Mixpanel will add a "Last Seen" property associated with the current time */ public function union($group_key, $group_id, $prop, $val, $ignore_time = \false) { } /** * Delete this group profile from Mixpanel * @param string|int $group_key the group_key used for groups in Project Settings * @param string|int $group_id the group id used for the group profile * @param boolean $ignore_time If the $ignore_time property is true, Mixpanel will not automatically update the "Last Seen" property of the profile. Otherwise, Mixpanel will add a "Last Seen" property associated with the current time */ public function deleteGroup($group_key, $group_id, $ignore_time = \false) { } /** * Returns the "groups" endpoint * @return string */ function _getEndpoint() { } } /** * Provides an API to create/update profiles on Mixpanel */ class Producers_MixpanelPeople extends \WPMUDEV_Analytics_Vendor\Producers_MixpanelBaseProducer { /** * Internal method to prepare a message given the message data * @param $distinct_id * @param $operation * @param $value * @param null $ip * @param boolean $ignore_time If the $ignore_time property is true, Mixpanel will not automatically update the "Last Seen" property of the profile. Otherwise, Mixpanel will add a "Last Seen" property associated with the current time * @param boolean $ignore_alias If the $ignore_alias property is true, an alias look up will not be performed after ingestion. Otherwise, a lookup for the distinct ID will be performed, and replaced if a match is found * @return array */ private function _constructPayload($distinct_id, $operation, $value, $ip = null, $ignore_time = \false, $ignore_alias = \false) { } /** * Set properties on a user record. If the profile does not exist, it creates it with these properties. * If it does exist, it sets the properties to these values, overwriting existing values. * @param string|int $distinct_id the distinct_id or alias of a user * @param array $props associative array of properties to set on the profile * @param string|null $ip the ip address of the client (used for geo-location) * @param boolean $ignore_time If the $ignore_time property is true, Mixpanel will not automatically update the "Last Seen" property of the profile. Otherwise, Mixpanel will add a "Last Seen" property associated with the current time * @param boolean $ignore_alias If the $ignore_alias property is true, an alias look up will not be performed after ingestion. Otherwise, a lookup for the distinct ID will be performed, and replaced if a match is found */ public function set($distinct_id, $props, $ip = null, $ignore_time = \false, $ignore_alias = \false) { } /** * Set properties on a user record. If the profile does not exist, it creates it with these properties. * If it does exist, it sets the properties to these values but WILL NOT overwrite existing values. * @param string|int $distinct_id the distinct_id or alias of a user * @param array $props associative array of properties to set on the profile * @param string|null $ip the ip address of the client (used for geo-location) * @param boolean $ignore_time If the $ignore_time property is true, Mixpanel will not automatically update the "Last Seen" property of the profile. Otherwise, Mixpanel will add a "Last Seen" property associated with the current time * @param boolean $ignore_alias If the $ignore_alias property is true, an alias look up will not be performed after ingestion. Otherwise, a lookup for the distinct ID will be performed, and replaced if a match is found */ public function setOnce($distinct_id, $props, $ip = null, $ignore_time = \false, $ignore_alias = \false) { } /** * Unset properties on a user record. If the profile does not exist, it creates it with no properties. * If it does exist, it unsets these properties. NOTE: In other libraries we use 'unset' which is * a reserved word in PHP. * @param string|int $distinct_id the distinct_id or alias of a user * @param array $props associative array of properties to unset on the profile * @param string|null $ip the ip address of the client (used for geo-location) * @param boolean $ignore_time If the $ignore_time property is true, Mixpanel will not automatically update the "Last Seen" property of the profile. Otherwise, Mixpanel will add a "Last Seen" property associated with the current time * @param boolean $ignore_alias If the $ignore_alias property is true, an alias look up will not be performed after ingestion. Otherwise, a lookup for the distinct ID will be performed, and replaced if a match is found */ public function remove($distinct_id, $props, $ip = null, $ignore_time = \false, $ignore_alias = \false) { } /** * Increments the value of a property on a user record. If the profile does not exist, it creates it and sets the * property to the increment value. * @param string|int $distinct_id the distinct_id or alias of a user * @param $prop string the property to increment * @param int $val the amount to increment the property by * @param string|null $ip the ip address of the client (used for geo-location) * @param boolean $ignore_time If the $ignore_time property is true, Mixpanel will not automatically update the "Last Seen" property of the profile. Otherwise, Mixpanel will add a "Last Seen" property associated with the current time * @param boolean $ignore_alias If the $ignore_alias property is true, an alias look up will not be performed after ingestion. Otherwise, a lookup for the distinct ID will be performed, and replaced if a match is found */ public function increment($distinct_id, $prop, $val, $ip = null, $ignore_time = \false, $ignore_alias = \false) { } /** * Adds $val to a list located at $prop. If the property does not exist, it will be created. If $val is a string * and the list is empty or does not exist, a new list with one value will be created. * @param string|int $distinct_id the distinct_id or alias of a user * @param string $prop the property that holds the list * @param string|array $val items to add to the list * @param string|null $ip the ip address of the client (used for geo-location) * @param boolean $ignore_time If the $ignore_time property is true, Mixpanel will not automatically update the "Last Seen" property of the profile. Otherwise, Mixpanel will add a "Last Seen" property associated with the current time * @param boolean $ignore_alias If the $ignore_alias property is true, an alias look up will not be performed after ingestion. Otherwise, a lookup for the distinct ID will be performed, and replaced if a match is found */ public function append($distinct_id, $prop, $val, $ip = null, $ignore_time = \false, $ignore_alias = \false) { } /** * Adds a transaction to the user's profile for revenue tracking * @param string|int $distinct_id the distinct_id or alias of a user * @param string $amount the transaction amount e.g. "20.50" * @param null $timestamp the timestamp of when the transaction occurred (default to current timestamp) * @param string|null $ip the ip address of the client (used for geo-location) * @param boolean $ignore_time If the $ignore_time property is true, Mixpanel will not automatically update the "Last Seen" property of the profile. Otherwise, Mixpanel will add a "Last Seen" property associated with the current time * @param boolean $ignore_alias If the $ignore_alias property is true, an alias look up will not be performed after ingestion. Otherwise, a lookup for the distinct ID will be performed, and replaced if a match is found */ public function trackCharge($distinct_id, $amount, $timestamp = null, $ip = null, $ignore_time = \false, $ignore_alias = \false) { } /** * Clear all transactions stored on a user's profile * @param string|int $distinct_id the distinct_id or alias of a user * @param string|null $ip the ip address of the client (used for geo-location) * @param boolean $ignore_time If the $ignore_time property is true, Mixpanel will not automatically update the "Last Seen" property of the profile. Otherwise, Mixpanel will add a "Last Seen" property associated with the current time * @param boolean $ignore_alias If the $ignore_alias property is true, an alias look up will not be performed after ingestion. Otherwise, a lookup for the distinct ID will be performed, and replaced if a match is found */ public function clearCharges($distinct_id, $ip = null, $ignore_time = \false, $ignore_alias = \false) { } /** * Delete this profile from Mixpanel * @param string|int $distinct_id the distinct_id or alias of a user * @param string|null $ip the ip address of the client (used for geo-location) * @param boolean $ignore_time If the $ignore_time property is true, Mixpanel will not automatically update the "Last Seen" property of the profile. Otherwise, Mixpanel will add a "Last Seen" property associated with the current time * @param boolean $ignore_alias If the $ignore_alias property is true, an alias look up will not be performed after ingestion. Otherwise, a lookup for the distinct ID will be performed, and replaced if a match is found */ public function deleteUser($distinct_id, $ip = null, $ignore_time = \false, $ignore_alias = \false) { } /** * Returns the "engage" endpoint * @return string */ function _getEndpoint() { } } } namespace WPMUDEV\Hub { /** * Class Connector. */ final class Connector { /** * Instance holder. * * @var Connector $instance */ private static $instance; /** * Instance obtaining method. * * @since 1.0.0 * * @return static Called class instance. */ public static function get(): \WPMUDEV\Hub\Connector { } /** * Initialize the module. * * @since 1.0.0 * * @return void */ protected function __construct() { } /** * Set options for plugin. * * @since 1.0.0 * * @param string $plugin Plugin identifier. * @param array $options Options. * * @return void */ public function set_options(string $plugin, array $options = array()) { } /** * Autoload class files for the module. * * @since 1.0.0 * * @param string $class Class name to autoload. */ public function autoload(string $class) { } } } namespace WPMUDEV\Hub\Connector { trait Singleton { /** * Instance holder. * * @var static $instance */ private static $instance; /** * Instance obtaining method. * * @since 1.0.0 * * @return static Called class instance. */ public static function get() { } } /** * Class Actions */ class Actions { use \WPMUDEV\Hub\Connector\Singleton; /** * Cron job hook name. * * @since 1.0.0 */ const CRON = 'wpmudev_scheduled_jobs'; /** * Flag to trigger Hub Sync. * * @since 1.0.0 * * @var bool */ protected $sync_hub = false; /** * Initialize UI class. * * @since 1.0.0 */ protected function __construct() { } /** * Perform shut down actions. * * We will set a flag for shut down hook to check and perform * a sync with hub. * * @since 1.0.0 */ public function set_shutdown_sync() { } /** * Perform shut down actions. * * @since 1.0.0 */ public function shutdown_action() { } /** * Do a periodic sync with the Hub. * * @since 1.0.0 * * @return void */ public function hub_sync() { } } /** * Class Admin */ class Admin { use \WPMUDEV\Hub\Connector\Singleton; /** * Plugin identifier. * * @var string $plugin */ protected $plugin = 'default'; /** * Admin page screen IDs. * * @var array Screen IDs. */ protected $screens = array(); /** * Extra query arguments for auth URLs. * * @var array Arguments. */ protected $extra_args = array(); /** * Initialize admin class. * * @since 1.0.0 */ protected function __construct() { } /** * Get extra query arguments for plugin. * * @since 1.0.0 * * @param string $plugin Plugin identifier. * * @return array */ public function get_plugin_extra_args(string $plugin): array { } /** * Get screen IDs of plugin. * * @since 1.0.0 * * @param string $plugin Plugin identifier. * * @return array */ public function get_plugin_screens(string $plugin): array { } /** * Set extra query arguments URL redirects. * * @since 1.0.0 * * @param string $plugin Plugin identifier. * @param array $options Options. * * @return void */ public function set_plugin_options(string $plugin, array $options = array()) { } /** * Set admin screens to process. * * UI will be rendered only on these screens. * * @since 1.0.0 * * @param string $plugin Plugin identifier. * @param array $screens Screen IDs. * * @return void */ public function set_plugin_screens(string $plugin, array $screens = array()) { } /** * Set extra query arguments for login and register redirects. * * @since 1.0.0 * * @param string $plugin Plugin identifier. * @param array $args Extra arguments. * * @return void */ public function set_plugin_extra_args(string $plugin, array $args = array()) { } /** * Make sure we get WDP ID in plugins data. * * NOTE: We NEED TO keep using WDP ID as the * key, because that's how the WP filter works. * * @since 1.0.0 * * @param array $headers Existing headers. * * @return array */ public function include_wdp_id_header($headers) { } /** * Get plugin identifier. * * Get an identifier for plugins to identify if the * module was initialised by their plugin. * If no identifier was being passed from plugin, it will have * a default value "default". * * @since 1.0.0 * * @return string */ public function get_plugin_id() { } /** * Render hub connector UI. * * @since 1.0.0 * * @param string $plugin Plugin identifier. */ public function render($plugin = 'default') { } /** * Add required classes to HTML body. * * @since 1.0.0 * * @param string $classes Class names. */ public function add_body_class($classes) { } /** * Check if current admin page is one of the allowed pages. * * @since 1.0.0 * * @return bool */ public function is_allowed_screen() { } /** * Enqueue styles and scripts for UI. * * This should be called only when required. * * @since 1.0.0 */ protected function enqueue_assets() { } /** * Process auth callback from the API. * * This method handles the dynamic script vars required * for the UI. * * @since 1.0.0 * * @return bool */ public function process_auth_callback() { } /** * Get authentication error messages. * * Based on the error code, prepare different error messages. * * @since 1.0.0 * * @return string */ private function get_auth_error() { } /** * Check if current request is team selection after auth. * * @since 1.0.0 * * @return bool */ private function is_team_selection() { } /** * Verify auth nonce. * * After or during the hub auth process, we need to make sure * the nonce is valid. * * @since 1.0.0 * * @return bool */ private function verify_nonce() { } /** * Script vars to assign. * * @since 1.0.0 * * @param array $data Script vars. * * @return bool */ private function update_vars($data) { } /** * Localized text strings for UI. * * @since 1.0.0 * * @return array */ private function text_vars() { } /** * Get extra arguments for plugin. * * @return array */ private function get_plugin_extra_args_from_screen(): array { } } /** * Class API */ class API { use \WPMUDEV\Hub\Connector\Singleton; /** * Check if member is logged in. * * @since 1.0.0 * * @return bool */ public function is_logged_in() { } /** * Check if an API key is set. * * @since 1.0.0 * @sice 1.0.6 Added force param. * * @param bool $force Force clear cache. * * @return bool */ public function has_api_key($force = false) { } /** * Get API key for current member. * * @since 1.0.0 * @sice 1.0.6 Added force param. * * @param bool $force Force clear cache. * * @return string */ public function get_api_key($force = false) { } /** * Set API key for current member. * * @since 1.0.0 * * @param string $key API key. * * @return bool */ public function set_api_key($key) { } /** * Returns the full URL to the specified REST API endpoint. * * @since 1.0.0 * * @param string $endpoint The endpoint to call on the server. * * @return string The full URL to the requested endpoint. */ public function rest_url($endpoint) { } /** * Returns the full URL to the specified REST API endpoint and includes * the API key as last element in URL. * * Uses the function `rest_url()` to build the URL. * * @since 1.0.0 * * @param string $endpoint The endpoint to call on the server. * * @return string The full URL to the requested endpoint. */ public function rest_url_auth($endpoint) { } /** * Contacts the API to sync the latest data from this site. * * Returns the membership status if things are working out. * In case the API call fails the function returns boolean false and does * not update the update * * @since 1.0.0 * * @param bool $force Optional forces a sync. * @param bool $auth_check Should check for API key. * * @return array|WP_Error */ public function sync_site($force = false, $auth_check = true) { } /** * Logout and disconnect the site from Hub. * * @since 1.0.0 * * @return array|WP_Error */ public function logout() { } /** * Get available teams for the authenticated user. * * This list is used to select the team after login. * * @since 1.0.0 * * @param string $key API key. * * @return array|bool */ public function get_hub_teams($key) { } /** * Get the currently logged in member user profile data. * * If not found in db, get it from the API. * * @since 1.0.0 * * @param bool $force Force update from API. * * @return array|WP_Error */ public function get_profile($force = false) { } /** * Parse API error and get a readable error message. * * @since 1.0.0 * * @param mixed $response API response. * * @return array */ private function get_api_error($response) { } /** * Update membership data from API data. * * @since 1.0.0 * * @param array $data Data to update. * * @return void */ private function update_membership_data($data) { } /** * Write data to error log if log is enabled. * * @since 1.0.0 * * @param string $data Data to log. * * @return void */ private function maybe_log($data) { } /** * Format error messages before showing to public. * * @since 1.0.0 * * @param array $error Error data. * * @return array */ private function format_error_messages($error) { } } /** * Class Data */ class Data { use \WPMUDEV\Hub\Connector\Singleton; /** * Returns the URL with wpmudev.com base URL prefixed. * * If a custom server is configured, it will be used as base url. * * @since 1.0.0 * * @param string $path Path to suffix. * * @return string The full URL. */ public function server_url($path = '') { } /** * Returns current full URL. * * @since 1.0.0 * * @return string The full URL. */ public function current_url() { } /** * Returns the canonical site_url that should be used for the site in the hub. * * Define WPMUDEV_HUB_SITE_URL to override or make static the url it should show as * in the hub. Defaults to network_site_url() which may be dynamically filtered * by some plugins and hosting providers. * * @since 1.0.0 * * @return string */ public function network_site_url() { } /** * Returns the canonical home_url that should be used for the site in the hub. * * Define WPMUDEV_HUB_HOME_URL to override or make static the url it should show as * in the hub. Defaults to WPMUDEV_HUB_SITE_URL if set, or network_home_url() which * may be dynamically filtered by some plugins and hosting providers. * * @since 1.0.0 * * @return string */ public function network_home_url() { } /** * Returns the canonical home_url that should be used for the site in the hub. * * Define WPMUDEV_HUB_ADMIN_URL to override or make static the url it should show as * in the hub. Defaults to deriving from WPMUDEV_HUB_SITE_URL if set, or network_admin_url() * which may be dynamically filtered by some plugins and hosting providers. * * @since 1.0.0 * * @return string */ public function network_admin_url() { } /** * The proper way to get details about the current membership. * * @since 1.0.0 * * @return array */ public function membership_data() { } /** * Get the current Hub site ID. * * @since 1.0.0 * * @return int */ public function hub_site_id() { } /** * Get current membership type. * * Possible return values: * 'free' - Free hub membership. * 'single' - Single membership (i.e. only 1 project is licensed) * 'unit' - One or more projects licensed * 'full' - Full membership, no restrictions. * 'paused' - Membership access is paused. * 'expired' - Expired membership. * '' - (empty string) If user is not logged in or with an unknown type. * * @since 1.0.0 * * @return string The membership type. */ public function membership_type() { } /** * Get the list of installed plugins. * * We will exclude WPMUDEV plugins from the list. * * @since 1.0.0 * * @return array */ public function plugins() { } /** * Get the list of installed themes. * * @since 1.0.0 * * @return array */ public function themes() { } /** * Get the list of WPMUDEV projects. * * Only plugins are in this list as of now. * * @since 1.0.0 * * @return array */ public function wpmudev_projects() { } /** * Get currently logged in member user data. * * To avoid unwanted API calls, profile data will not be available * unless we call it for the first time. Once called, it will be stored * within the plugin options and will be cleared only when member logout. * * @since 1.0.0 * * @return array */ public function profile_data() { } } /** * Class Options */ class Options { /** * Settings options key. * * @since 1.0.0 */ const NAME = 'wpmudev_hc_options'; /** * Returns the value of a module option. * * @since 1.0.0 * * @param string $name The option name. * @param mixed $default Optional. Set value to return if option not found. * * @return mixed The option value. */ public static function get($name, $default = false) { } /** * Updates the value of a single module option. * * @since 1.0.0 * * @param string $name The option name. * @param mixed $value The new option value. * * @return bool */ public static function set($name, $value = false) { } /** * Returns the entire module options. * * @since 1.0.0 * * @return array */ public static function get_options() { } /** * Updates the entire module options. * * @since 1.0.0 * * @param array $values The values to update. * * @return bool */ public static function set_options($values) { } /** * Returns the value of a module transient. * * The prefix is automatically added to the transient name. * Use this function instead of direct access via get_site_transient(). * * @since 1.0.0 * * @param string $name The transient name. * @param bool $prefix Optional. Set to false to not prefix the name. * * @return mixed The transient value. */ public static function get_transient($name, $prefix = true) { } /** * Updates the value of a module transient. * * The prefix is automatically added to the transient name. * Use this function instead of direct access via set_site_transient(). * * @since 1.0.0 * * @param string $name The transient name. * @param mixed $value The new transient value. * @param int $expiration Time until expiration. Default: No expiration. * @param bool $prefix Optional. Set to false to not prefix the name. * * @return bool */ public static function set_transient($name, $value, $expiration = 0, $prefix = true) { } /** * Reset the options to defaults. * * @since 1.0.0 * * @return bool */ public static function reset() { } /** * Get the default options values. * * Only the options in this list will be accepted for update. * * @since 1.0.0 * * @return array */ public static function defaults() { } } /** * Class Remote */ class Remote { use \WPMUDEV\Hub\Connector\Singleton; /** * Stores current action being processed * * @var string */ protected $current_action = ''; /** * Stores current action params being processed * * @since 1.0.0 * @var array */ protected $current_params = array(); /** * Stores registered remote access actions and their callbacks. * * @var array */ protected $actions = array(); /** * Set up the remote module. * * Here we load and initialize the API request from Hub. * * @since 1.0.0 * @access public */ public function __construct() { } /** * Setup current request data. * * Set current action name and params to be processed. * If action and params are invalid, we will die with json * error message. * * @since 1.0.0 * @access protected * * @return void */ public function run_request() { } /** * Run current request. * * First we will register all actions and then check if current action * is a valid one. If not we will send a json error and die. * * @since 1.0.0 * * @return void */ private function process_action() { } /** * Validate the hash for the request. * * @since 1.0.0 * * @param string $hash Hash from header. * @param string $id Request ID. * @param string $json Json string. * * @return bool */ public function validate_hash($hash, $id, $json) { } /** * Validate the nonce for the request. * * Check nonce to prevent replay attacks. * * @since 1.0.0 * * @param string $id Request ID. * * @return bool */ public function validate_nonce($id) { } /** * Check signature hash of the request. * * @since 4.0.0 * @access protected * * @param string $req_id The request id as passed by Hub. * @param string $json The full json body that hash was created on. * @param bool $die_on_failure If set to false the function returns a bool. * * @return bool True on success. */ protected function validate_request_hash($req_id, $json, $die_on_failure = true) { } /** * Registers a Hub api action and callback for it. * * @since 1.0.0 * * @param string $action Action name. * @param callable $callback The name of the function you wish to be called. * * @return void */ public function register_action($action, $callback) { } /** * Logout of this site, removing it from the Hub. * * @since 1.0.0 * * @param object $params Parameters passed in json body. * @param string $action The action name that was called. * * @return void */ public function action_logout($params, $action) { } /** * Installs a list of plugins and themes by pid or slug. * * Handles multiple, but should normally be called with * only one package at a time. * * @since 1.0.0 * * @param object $params Parameters passed in json body. * @param string $action The action name that was called. * * @return void */ public function action_install($params, $action) { } /** * Activates a list of plugins and themes by slug. * * Handles multiple, but should normally be called with only one package at a time. * * @since 1.0.0 * * @param object $params Parameters passed in json body. * @param string $action The action name that was called. * * @return void */ public function action_activate($params, $action) { } /** * Deactivates a list of plugins and themes by pid or slug. * * Handles multiple, but should normally be called with only one package at a time. * * @since 1.0.0 * * @param object $params Parameters passed in json body. * @param string $action The action name that was called. * * @return void */ public function action_deactivate($params, $action) { } /** * Get a list of registered Hub actions that can be called. * * @since 1.0.0 * * @param object $params Parameters passed in json body. * @param string $action The action name that was called. * * @return void */ public function action_registered($params, $action) { } /** * Register actions that are used by the Dashboard plugin. * * These are the internal actions which act as API endpoints * between Dash plugin and Hub for communication. * * @since 1.0.0 * * @return void */ protected function register_internal_actions() { } /** * Registers custom Hub actions from other DEV plugins * * Other plugins should use the wdp_register_hub_action * filter to add an item to the associative array as * 'action_name' => 'callback' * * @since 1.0.0 * * @return void */ protected function register_plugin_actions() { } /** * Check if current request is from Hub. * * Currently, we need this class only for API requests from * Hub. So checking for a 'wpmudev-hub' param is useful to * identify the request. * * @since 1.0.0 * @access protected * * @return bool */ protected function is_hub_request() { } } /** * Class Request. */ class Request { /** * Request max timeout. * * @since 1.0.0 * * @var int */ private $timeout = 15; /** * Header arguments. * * @since 1.0.0 * * @var array */ private $headers = array(); /** * POST arguments. * * @since 1.0.0 * * @var array */ private $post_args = array(); /** * GET arguments. * * @since 1.0.0 * * @var array */ private $get_args = array(); /** * Request constructor. * * @since 1.0.0 */ public function __construct() { } /** * Set request timeout. * * @since 1.0.0 * * @param int $timeout Request timeout (seconds). */ public function set_timeout($timeout) { } /** * Add a new request argument for POST requests. * * @since 1.0.0 * * @param string $name Argument name. * @param string $value Argument value. */ public function add_post_argument($name, $value) { } /** * Add a new request argument for GET requests. * * @since 1.0.0 * * @param string $name Argument name. * @param string $value Argument value. */ public function add_get_argument($name, $value) { } /** * Add a new request argument for GET requests. * * @since 1.0.0 * * @param string $name Argument name. * @param string $value Argument value. */ public function add_header_argument($name, $value) { } /** * Make a POST request. * * @since 1.0.0 * * @param string $path Endpoint route. * @param bool $auth Should attach API key?. * @param array $data Data array. * * @return mixed|WP_Error */ public function post($path, $auth = false, $data = array()) { } /** * Make a GET request. * * @since 1.0.0 * * @param string $path Endpoint route. * @param bool $auth Should attach API key?. * @param array $data Data array. * * @return mixed|WP_Error */ public function get($path, $auth = false, $data = array()) { } /** * Add API key for authorization to request. * * Optionally if hub site id is found, include that too. * * @since 1.0.0 * * @param string $url URL of request. * @param string $method Request method (post or get). * * @return string */ private function set_api_key($url, $method = 'post') { } /** * Make an HTTP request using WP. * * @since 1.0.0 * * @param string $path API endpoint route. * @param bool $auth Should attach API key?. * @param array $data Data array. * @param string $method Request method. * * @return array|WP_Error */ private function request($path, $auth = false, $data = array(), $method = 'post') { } } /** * Class Rest */ class Rest { use \WPMUDEV\Hub\Connector\Singleton; /** * API namespace. * * @var string $namespace */ protected $namespace = 'hub-connector/v1'; /** * Initialize Rest class. * * @since 1.0.0 */ protected function __construct() { } /** * Register the routes for rest API. * * @since 1.0.0 * * @return void */ public function register_routes() { } /** * Callback for sync API request. * * @since 1.0.0 * * @param WP_REST_Request $request Request object. * * @return WP_REST_Response */ public function sync($request) { } /** * Callback for logout API request. * * @since 1.0.0 * * @return WP_REST_Response */ public function logout() { } /** * Get API response data. * * @since 1.0.0 * * @param array $data Data to return. * @param bool $success Success?. * @param int $code Status code. * * @return WP_REST_Response */ private function get_response($data = array(), $success = true, $code = 200) { } } /** * Class Upgrader */ class Upgrader { use \WPMUDEV\Hub\Connector\Singleton; /** * Stores the errors during current action. * * @since 1.0.0 * @var WP_Error * @accces protected */ protected $error; /** * Options for current action. * * @since 1.0.0 * * @var array * @access protected */ protected $options = array(); /** * Initialize the upgrader. * * @since 1.0.0 */ protected function __construct() { } /** * Install a new plugin or theme. * * Optionally plugin can be activated after installation. * * @since 1.0.0 * * @return bool */ public function install($item, $type = 'plugin', $options = array()) { } /** * Get download link from plugin id, slug. * * @since 1.0.0 * * @param string|int $plugin Slug or ID. * * @return bool|string */ protected function get_plugin_link($plugin) { } /** * Get download link from theme slug. * * @since 1.0.0 * * @param string|int $theme Slug. * * @return bool */ public function get_theme_link($theme) { } /** * Setup temporary filters to alter the process. * * These filters will be removed after the action. * * @since 1.0.0 * * @return void */ protected function setup_filters() { } /** * Set flag to overwrite plugin/theme if folder already exists. * * @since 1.0.0 * * @param array $options Installation options. * * @return array */ public function filter_overwrite($options) { } /** * Remove filters we added for the action. * * @since 1.0.0 * * @return void */ protected function remove_filters() { } /** * Get a specific option value for current action. * * @since 1.0.0 * * @param string $key Option key. * @param mixed $default Default value. * * @return mixed */ public function get_option($key, $default = false) { } /** * Get the error holder instance. * * @since 1.0.0 * * @return WP_Error */ public function get_error() { } /** * Get a specific option value for current action. * * @since 1.0.0 * * @param int|string $code Error code. * @param string $message Error message. * * @return void */ public function add_error($code, $message) { } /** * Reset error class instance. * * @since 1.0.0 * * @return void */ public function reset_errors() { } /** * Load all required files for the upgrader. * * @since 1.0.0 * * @return void */ protected function load_dependencies() { } } } namespace WPMUDEV\Modules\Plugin_Cross_Sell { /** * Class Rest_Api * * @package WPMUDEV\Plugin_Cross_Sell */ abstract class Rest_Api extends \WP_REST_Controller { /** * Holds the request param. * * @var array|object */ protected $request_action; /** * The version. * * @var string */ protected $version = 'v1'; /** * The namespace. * * @var string */ protected $namespace = 'wpmudev_pcs/v1'; /** * API endpoint for the current endpoint. * * @since 1.0.0 * * @var string $endpoint */ protected $endpoint = ''; /** * Dependency container. * * @since 1.0.0 * * @var Container */ protected $di_container = null; /** * Utilities object. * * @since 1.0.0 * * @var Utilities */ protected $utilities = null; /** * Prepares the class properties. * * @param Container $container Dependency container. * @return void */ public function init(?\WPMUDEV\Modules\Plugin_Cross_Sell\Container $container = null): void { } /** * Set up WordPress hooks and filters * * @since 1.0.0 * * @return void */ protected function register_hooks(): void { } /** * Formatting the response * * @since 1.0.0 * * @param mixed $item The item to format. * @param WP_REST_Request $request request object. * * @return array|WP_Error|WP_REST_Response */ public function prepare_item_for_response($item, $request): array { } /** * Sets up the proper HTTP status code for authorization. * * @since 2.0.0 * * @return int */ public function authorization_status_code(): int { } /** * Check if a given request has access to manage settings. * * @param \WP_REST_Request $request Request object. * @param string $capability Capability to check. * * @return bool * @since 1.0.0 */ public function has_permission(?\WP_REST_Request $request = null, string $capability = 'manage_options'): bool { } /** * Get formatted response for the current request. * * @param array $data Response data. * @param bool $success Is request success. * * @return \WP_REST_Response * @since 1.0.0 */ public function get_response($data = array(), $success = true): \WP_REST_Response { } /** * Get the Endpoint's namespace. * * @return string */ public function get_namespace(): string { } /** * Set the Endpoint's namespace. * * @param string $api_namespace The namespace. * @return void */ protected function set_namespace(string $api_namespace = ''): void { } /** * Get the Endpoint's endpoint part * * @return string */ public function get_endpoint(): string { } /** * Gives the full url of the Rest endpoint (with site url). * * @return string */ public function get_endpoint_url(): string { } /** * Gives the path of the Rest endpoint without site url * * @return string */ public function get_endpoint_path(): string { } /** * Register the routes for the objects of the controller. This should be defined in extending class. * * @since 1.0.0 * * @return void */ public function register_routes(): void { } /** * A helper function called early to allow prepare some variables * * @since 1.0.0 * * @return void */ public function prepare_endpoint_params(): void { } } } namespace WPMUDEV\Modules\Plugin_Cross_Sell\App\Rest_Endpoints { /** * Summary of Activate_Plugin */ class Activate_Plugin extends \WPMUDEV\Modules\Plugin_Cross_Sell\Rest_Api { /** * Endpoint for activating plugin. * * @var string */ protected $endpoint = '/plugincrosssell/activate_plugin'; /** * Register the routes for handling confirmation functionality. * * @since 1.0.0 * * @return void */ public function register_routes(): void { } /** * Get the input arguments schema for the endpoint. * * @since 1.0.0 * * @return array */ protected function input_args(): array { } /** * Check if the current user has permission to activate plugins. * * @param \WP_REST_Request $request Request object. * @return bool */ public function check_permission(\WP_REST_Request $request): bool { } /** * Callback to activate the plugin. * * @param \WP_REST_Request $request Request object. * * @since 1.0.0 * * @return \WP_REST_Response */ public function activate(\WP_REST_Request $request): \WP_REST_Response { } /** * Activate the plugin. * * @param string $plugin_slug Plugin slug. * * @since 1.0.0 * * @return bool|\WP_Error */ public function activate_plugin(string $plugin_slug) { } } /** * Class Install_Plugin * * @since 1.0.0 */ class Install_Plugin extends \WPMUDEV\Modules\Plugin_Cross_Sell\Rest_Api { /** * The endpoint for the route. * * @var string */ protected $endpoint = '/plugincrosssell/install_plugin'; /** * Register the routes for handling confirmation functionality. * * @since 1.0.0 * * @return void */ public function register_routes(): void { } /** * The input arguments schema for the route. * * @since 1.0.0 * @return array{current_slug: array{required: bool, type: string, plugin_slug: array{required: bool, type: string}}} */ protected function input_args(): array { } /** * Check if the current user has permission to install plugins. * * @since 1.0.0 * @param \WP_REST_Request $request The Request object. * @return bool */ public function check_permission(\WP_REST_Request $request): bool { } /** * Save the client id and secret. * * @param \WP_REST_Request $request Request object. * * @since 1.0.0 * * @return \WP_REST_Response */ public function install(\WP_REST_Request $request): \WP_REST_Response { } /** * Performs the actual plugin installation. * * @param string $plugin_slug Will be used to get the path to the plugin. * @return bool|\WP_Error */ protected function install_plugin(string $plugin_slug) { } /** * Implements the install using Plugin_Upgrader, WP built in class. * * @param \stdClass $api Plugin installer data in object, see plugins_api(). * @return bool|\WP_Error */ protected function install_from_api(\stdClass $api) { } } } namespace WPMUDEV\Modules\Plugin_Cross_Sell\App\Submenus { /** * Class CrossSell */ class CrossSell { /** * The page title. * * @var string */ private $page_title; /** * The page slug. * * @var string */ private $page_slug = 'wpmudev_plugins_cross_sell'; /** * Submenu params. * * @var array */ private $submenu_params = array('parent_slug' => '', 'page_title' => '', 'menu_title' => '', 'capability' => '', 'menu_slug' => '', 'position' => ''); /** * Page Assets. * * @var array */ private $page_scripts = array(); /** * Assets version. * * @var string */ private $assets_version = ''; /** * A unique string id to be used in markup and jsx. * * @var string */ private $unique_id = ''; /** * Utilities object. * * @since 1.0.0 * * @var Utilities */ protected $utilities = null; /** * The translation directory of the plugin. * * @since 1.0.0 * * @var string */ protected $translation_dir = ''; /** * Initializes the page. * * @param Container $container The dependency container. * @return void * @since 1.0.0 */ public function init(\WPMUDEV\Modules\Plugin_Cross_Sell\Container $container): void { } /** * Actions (not necessary hooks) that should be executed on specific admin menu's page load. * * @param string $text The text to be displayed in the footer. * * @return void */ public function internal_admin_actions($text = ''): void { } /** * Prepares assets. * * @return void */ public function prepare_assets(): void { } /** * Removes the footer text. * * @param string $text The text to be displayed in the footer. * * @return string */ public function rm_footer_text($text = '') { } /** * Removes the footer version. * * @param string $text The text/version to be displayed in the footer. * * @return string */ public function rm_footer_verion($text = '') { } /** * Hides the WP footer. * * @param string $text The text to be displayed in the footer. * * @return string */ public function hide_wp_footer($text = '') { } /** * Suppresses admin notices. * * @return void */ public function suppress_admin_notices() { } /** * Registers the submenu. * * @return string|bool The resulting page’s hook_suffix, or false if the user does not have the capability required. * @since 1.0.0 */ public function register_submenu() { } /** * Check if a submenu already exists under a given top‐level menu. * * @param string $parent_slug The plugin parent menu’s slug. * @param string $submenu_slug The submenu slug per plugin. * @return bool True if it’s already registered, false otherwise. */ public function submenu_exists(string $parent_slug = '', string $submenu_slug = ''): bool { } /** * Retrieves the submenu schema, which includes all parameters for adding a submenu. * * @return array An associative array representing the submenu schema. * @since 1.0.0 */ private function get_submenu_schema(): array { } /** * The admin page callback method. * * @return void */ public function callback(): void { } protected function get_utm_source(): string { } public function plugins_list(): array { } /** * Returns the structure of plugins to be used in Detailed and Concise views. * * @return array */ public function plugins_order(): array { } /** * Checks if a plugin is a major one. * @param string $plugin_slug * @return bool */ public function is_major_plugin(string $plugin_slug = ''): bool { } /** * Checks if a plugin is a minor one. * @param string $plugin_slug * @return bool */ public function is_minor_plugin(string $plugin_slug = ''): bool { } /** * Checks if a plugin is the placeholder one. * @param string $plugin_slug * @return bool */ public function is_placeholder_plugin(string $plugin_slug = ''): bool { } /** * Filters the plugins list. * * @param array $plugins Plugins list. * @return array */ private function filter_plugins_list(array $plugins = array()): array { } /** * Gets assets data for given key. * * @param string $key The requested portion of data, an array key, usually version or dependencies. * * @return string|array */ protected function script_data(string $key = '') { } /** * Gets the script data from assets php file. * * @return array */ protected function raw_script_data(): array { } /** * Prepares assets. * * @return void */ public function enqueue_assets() { } /** * Sets the script translation. * * @param string $handle The handle of the script. * * @return void */ public function set_script_translation(string $handle = ''): void { } /** * Prints the wrapper element which React will use as root. * * @return void */ protected function view() { } /** * Adds the SUI class on markup body. * * @param string $classes The current body classes. * * @return string */ public function admin_body_classes($classes = '') { } protected function is_current_page(): bool { } } } namespace WPMUDEV\Modules\Plugin_Cross_Sell { /** * Dependency Injection Container class. * * @since 1.0.0 */ class Container { /** * Services list. * * @var array */ private $services = array(); /** * Pushes a service into the container. * * @param string $key Service key. * @param mixed $value Service. * @return void */ public function set(string $key, $value): void { } /** * Fetches a service from the container. * * @param string $key Service key. * @throws \InvalidArgumentException If service not found. */ public function get(string $key) { } /** * Checks if a service is registered. * * @param string $key Service key. * @return bool */ public function has(string $key): bool { } } /** * The Loader class is responsible for initializing the module. */ final class Loader { /** * Settings helper class instance. * * @since 1.0.0 * @var object */ public $settings; /** * Minimum supported php version. * * @since 1.0.0 * @var float */ public $php_version = '7.4'; /** * Minimum WordPress version. * * @since 1.0.0 * @var float */ public $wp_version = '6.3'; /** * The dependency container. * * @since 1.0.0 * @var Container */ private $container; /** * Initialize the loader. * * @since 1.0.0 * @param Container $container The dependency container. * @return void */ public function __construct(\WPMUDEV\Modules\Plugin_Cross_Sell\Container $container) { } /** * Initialize functionality if requirements are met. * * @return void */ public function init(): void { } /** * Main condition that checks if plugin parts should continue loading. * * @return bool */ private function can_boot() { } /** * Register all the actions and filters. * * @since 1.0.0 * @access private * @return void */ private function setup_components(): void { } } /** * A list of general purpose utility methods. */ class Utilities { /** * Returns the list of all plugins. * * @return array */ public function get_plugins_list() { } /** * Retrieves the path of a plugin by its slug. * * @param string $plugin_slug The plugin slug. * @return string */ public function get_plugin_path_by_slug(string $plugin_slug = ''): string { } /** * Extracts the value of a key from the first associative array in an array that matches the given criteria. * * @param string $key The key whose value you want to extract. * @param array $input_list The array of associative arrays to filter. * @param array $args The criteria for filtering (key-value pairs). * @param string $operator How to combine the criteria ('AND' or 'OR'). * @return mixed The value for the specified key if found, or null. */ public function get_value_from_associative_array(string $key = '', array $input_list = array(), array $args = array(), string $operator = 'AND') { } /** * Checks if a plugin is installed. * * @param string $file The plugin file path. * @return bool */ public function is_plugin_installed(string $file = ''): bool { } /** * Get plugin statistics from WordPress.org API * * @param string $plugin_slug The plugin slug from wordpress.org. * @param bool $force_refresh Optional. Whether to force a refresh of the data from the API. * @return array|false Plugin data or false on failure. */ public function get_plugin_stats(string $plugin_slug = '', bool $force_refresh = false): mixed { } /** * Clear plugin stats cache for a specific plugin or all plugin stats * * @param string $plugin_slug Optional. Clear cache for specific plugin. If empty, clears all plugin stats. * @return bool True on success */ public function clear_plugin_stats_cache(string $plugin_slug = ''): bool { } /** * Validate a value against a given schema. * * @param mixed $value The value to check. * @param mixed $schema The schema that defines the expected type or structure. * @param bool $strict If true, value must not have extra keys/properties. * @return bool */ public function validate_schema($value, $schema, bool $strict = false): bool { } /** * Check if a value is of the expected type. * * @param mixed $value The value to check. * @param string $type The expected type (e.g., 'int', 'string', 'bool', 'array', 'object'). * @return bool */ public function validate_type($value, string $type): bool { } } } namespace WPMUDEV\Modules { /** * Module main class. */ final class Plugin_Cross_Sell { /** * The DI container. * * @var Plugin_Cross_Sell\Container */ private $container = null; /** * Initialize the module. * * @param array $props Module properties. * @since 1.0.0 * * @return void */ public function __construct(array $props = array()) { } /** * Class initializer. */ public function load(): void { } } } namespace { // autoload_real.php @generated by Composer class ComposerAutoloaderInit65a0a6b53636acc8bd93737adac79345 { private static $loader; public static function loadClassLoader($class) { } /** * @return \Composer\Autoload\ClassLoader */ public static function getLoader() { } } } namespace Composer\Autoload { class ComposerStaticInit65a0a6b53636acc8bd93737adac79345 { public static $classMap = array('Composer\InstalledVersions' => __DIR__ . '/..' . '/composer/InstalledVersions.php', 'WPMUDEV\Modules\Plugin_Cross_Sell\App\Rest_Endpoints\Activate_Plugin' => __DIR__ . '/../..' . '/app/rest-endpoints/class-activate-plugin.php', 'WPMUDEV\Modules\Plugin_Cross_Sell\App\Rest_Endpoints\Install_Plugin' => __DIR__ . '/../..' . '/app/rest-endpoints/class-install-plugin.php', 'WPMUDEV\Modules\Plugin_Cross_Sell\App\Submenus\CrossSell' => __DIR__ . '/../..' . '/app/submenus/class-cross-sell.php', 'WPMUDEV\Modules\Plugin_Cross_Sell\Container' => __DIR__ . '/../..' . '/core/class-container.php', 'WPMUDEV\Modules\Plugin_Cross_Sell\Loader' => __DIR__ . '/../..' . '/core/class-loader.php', 'WPMUDEV\Modules\Plugin_Cross_Sell\Rest_Api' => __DIR__ . '/../..' . '/core/class-rest-api.php', 'WPMUDEV\Modules\Plugin_Cross_Sell\Utilities' => __DIR__ . '/../..' . '/core/class-utilities.php'); public static function getInitializer(\Composer\Autoload\ClassLoader $loader) { } } } namespace { /** * Class WPMUDEV_Recommended_Plugins_Notice_Registered_Plugin * * Hold registered plugin as object */ class WPMUDEV_Recommended_Plugins_Notice_Registered_Plugin { //phpcs:ignore /** * Plugin basename * plugin-dir/plugin-name.php * * @var string */ protected $basename = ''; /** * Plugin nice name * * `My Plugin` * * @var string */ public $name = ''; /** * Screens which notice should be displayed * * @var array */ public $screens = array(); /** * Time the plugin registered to notice * * @var int */ public $registered_at = 0; /** * Element selector which notice should be append-ed * * @var array */ public $selector = array(); /** * Current active screen being displayed * * @var string */ protected $active_screen = ''; /** * WPMUDEV_Recommended_Plugins_Notice_Registered_Plugin constructor. * * @param string $basename Plugin basename. */ public function __construct($basename) { } /** * Get plugin basename * * @return string */ public function get_basename() { } /** * Build object properties from array * * @param array $data Notice data. */ public function from_array($data) { } /** * Export to array * * @return array */ public function to_array() { } /** * Check if screen is listen on plugin screen * * @param string $screen_id Screen ID. * * @return bool */ public function is_my_screen($screen_id) { } /** * Get where notice should be moved * * @return array */ public function get_selector() { } /** * Check whether now is the time to display * * @return bool */ public function is_time_to_display_notice() { } /** * Get pre text on displayed notice * * @return string */ public function get_pre_text_notice() { } } /** * Class WPMUDEV_Recommended_Plugins_Notice * * @internal */ class WPMUDEV_Recommended_Plugins_Notice { //phpcs:ignore /** * Class instance. * * @var WPMUDEV_Recommended_Plugins_Notice */ private static $instance = \null; /** * Collection of recommended plugins * * @var array */ protected $recommended_plugins = array(); /** * Version */ const VERSION = '1.0.0'; /** * Pointer name */ const POINTER_NAME = 'wpmudev_recommended_plugins'; /** * Registered plugins */ const OPTION_NAME = 'wpmudev_recommended_plugins_registered'; /** * Collection of registered plugins to use this notice * * @var WPMUDEV_Recommended_Plugins_Notice_Registered_Plugin[] */ protected $registered_plugins = array(); /** * Active registered plugin on this screen * * @var null */ protected $active_registered_plugin = \null; /** * WPMUDEV_Recommended_Plugins_Notice constructor. */ public function __construct() { } /** * Init recommended plugins * * @return void */ private function init_recommended_plugins() { } /** * Get recommended plugins to be displayed on notice * * This function will only return recommended plugins that `not installed` yet * * @param int $min Minimum plugins to be displayed. * @param int $max Maximum plugins to be displayed. * * @return array */ protected function get_recommended_plugins_for_notice($min = 2, $max = 2) { } /** * Check whether plugin is installed * * @uses get_plugins() * * @param array $plugin_data Plugin data. * * @return bool */ protected function is_plugin_installed($plugin_data) { } /** * Display the notice * * @return void */ public function display() { } /** * Check if notice can be displayed * * @uses current_user_can() * * @return bool */ public function is_displayable() { } /** * Register plugin for notice to be added * * @param string $plugin_basename Plugin basename. * @param string $plugin_name Plugin name. * @param array $screens Screens. * @param array $selector [jqueryFn, jQuerySelector]. */ public function register($plugin_basename, $plugin_name, $screens = array(), $selector = array()) { } /** * Parse registered plugins from storage */ public function parse_saved_registered_plugins() { } /** * Save registered plugins to storage */ public function save_registered_plugins() { } /** * Un-dismiss the notice * * @internal */ public function un_dismiss() { } /** * Reset saved registered plugins * * @internal */ public function reset_registered_plugins() { } /** * Get class instance. * * @return WPMUDEV_Recommended_Plugins_Notice */ public static function get_instance() { } } /** * The Events class. * * @package Forminator */ /** * Abstract class for Mixpanel Events. */ abstract class Events { /** * Initialize class. * * @since 1.27.0 */ public static function init() { } /** * Get mixpanel instance. * * @return Mixpanel * * @since 1.27.0 */ protected static function tracker() { } /** * Tracking event * * @param string $event Event. * @param array $properties Properties. * * @return void * * @since 1.27.0 */ public static function track_event($event, $properties) { } /** * Fetch Settings value * * @param array $settings Settings. * @param string $key Key name. * @param string $value Value. * * @return string|void * @since 1.27.0 */ protected static function settings_value($settings, $key, $value = '') { } /** * Limit text to Mixpanel character limit * * @param mixed $text Text. * @return string */ protected static function limit_text($text) { } } /** * The Forminator_Mixpanel_Deactivation_Survey class. * * @package Forminator */ /** * Mixpanel Deactivation Survey Events class */ class Forminator_Mixpanel_Deactivation_Survey extends \Events { /** * Initialize class. * * @since 1.50.0 */ public static function init() { } /** * Share deactivation survey * * @param string $reason Reason. * @param string $action Model action. * @param string $requested_assistance Requested assistance. * @param string $message Message. * * @return void * @since 1.50.0 */ public static function share_deactivation_survey($reason, $action, $requested_assistance, $message) { } /** * Get active plugins * * @return string[] */ private static function get_active_plugins() { } /** * Get active and valid plugin files * * @return array */ private static function get_active_and_valid_plugin_files() { } /** * Get plugin name from plugin file * * @param string $plugin_file Plugin file. * @return string */ private static function get_plugin_name($plugin_file) { } } /** * The Forminator_Mixpanel_Feedback class. * * @package Forminator */ /** * Mixpanel Feedback Events class */ class Forminator_Mixpanel_Feedback extends \Events { /** * Initialize class. * * @since 1.49.0 */ public static function init() { } /** * Share Feedback * * @param integer $rating Rating. * @param string $message Message. * * @return void * @since 1.49.0 */ public static function share_feedback($rating, $message = '') { } } /** * The Forminator_Mixpanel_General class. * * @package Forminator */ /** * Mixpanel General Events class */ class Forminator_Mixpanel_General extends \Events { /** * Initialize class. * * @since 1.27.0 */ public static function init() { } /** * Tracking Import * * @param string $slug Slug. * * @return void * @since 1.27.0 */ public static function tracking_import($slug) { } /** * Tracking Export * * @param string $slug Slug. * * @return void * @since 1.27.0 */ public static function tracking_export($slug) { } /** * Tracking Schedule Export * * @param int $form_id Form id. * @param string $form_type Form type. * * @return void * @since 1.27.0 */ public static function tracking_manual_export($form_id, $form_type) { } /** * Tracking Schedule Export * * @param int $form_id Form Id. * @param string $form_type Form type. * @param array $data Data. * * @return void * @since 1.27.0 */ public static function tracking_schedule_export($form_id, $form_type, $data) { } /** * Event Import/Export * * @param string $slug Slug. * @param string $type Type. * * @return void */ private static function event_form_import_export($slug, $type) { } /** * Event Submission export * * @param string $form_type Form type. * @param string $action Action. * * @return void */ private static function event_submission_export($form_type, $action) { } /** * Event Rating Notice Dismissal * * @param string $action_type Action type. * @param string $notice_type Notice type. * @param string $location Location. * * @return void */ public static function event_rating_notice_dismissal($action_type, $notice_type, $location) { } } /** * The Forminator_Mixpanel_Hub_Deactivation_Survey class. * * @package Forminator */ /** * Mixpanel Hub Deactivation Survey Events class */ class Forminator_Mixpanel_Hub_Deactivation_Survey extends \Events { /** * Initialize class. * * @since 1.50.0 */ public static function init() { } /** * Share hub deactivation survey * * @param string $action Model action. * @param string $message Message. * * @return void * @since 1.50.0 */ public static function share_hub_deactivation_survey($action, $message = '') { } } /** * The Forminator_Mixpanel class. * * @package Forminator */ /** * Mixpanel main class. */ class Forminator_Mixpanel { /** * Mixpanel token for Forminator */ const TOKEN = '5d545622e3a040aca63f2089b0e6cae7'; /** * Mixpanel instance. * * @var Mixpanel */ private $mixpanel = \null; /** * Plugin instance * * @since 1.27.0 * @access private * @var null */ private static $instance = \null; /** * General * * @var mixed */ public $general = \null; /** * Return the plugin instance * * @return Forminator_mixpanel */ public static function get_instance() { } /** * Construct */ public function __construct() { } /** * Include initialize * * @return void */ public function include_init() { } /** * Include class * * @return void */ public function include_class() { } /** * Get configured mixpanel instance. * * Use this method to make tracking events. * * @return Mixpanel * @since 1.27.0 */ public function tracker() { } /** * Get unique identity for current site. * * @return string * @since 1.27.0 */ private function identity() { } /** * Get super properties for all events. * * These properties are attached to all events. * * @return array * @since 1.27.0 */ private function super_properties() { } /** * Get current server type name. * * Only apache and ngnix can be detected. * * @return string * @since 1.27.0 */ private function get_server_type() { } /** * Is Tablet * * @return bool|string */ private function is_tablet() { } /** * Is mobile * * @return bool|string */ private function is_mobile() { } /** * Get current device type. * * @return string */ protected function get_device() { } /** * Get competitor plugins. * * @return string * @since 1.27.0 */ private function get_competitors() { } /** * Module updates * * @param string $update_type Update type. * * @return array */ public static function module_updates($update_type) { } /** * Check if array of strings has a string. * * @param array $haystack Array of strings. * @param string $needle Value to search. * * @return bool * @since 1.27.0 */ private function array_has_needle($haystack, $needle) { } /** * Mixpanel directory * * @return string */ public function mixpanel_dir() { } } /** * The Forminator_Mixpanel_Modules class. * * @package Forminator */ /** * Mixpanel Modules class */ class Forminator_Mixpanel_Modules extends \Events { /** * Stripe OCS data * * @var array */ public static array $stripe_ocs = array(); /** * Initialize class. * * @since 1.27.0 */ public static function init() { } /** * Form publish * * @param int $id Form id. * @param string $title Title. * @param string $status Form status. * @param array $fields Fields wrapper. * @param array $settings Settings. * * @return void * @since 1.27.0 */ public static function tracking_form_publish($id, $title, $status, $fields, $settings) { } /** * Poll publish * * @param int $id Poll id. * @param string $status Poll status. * @param array $answers Answer. * @param array $settings Settings. * * @return void * @since 1.27.0 */ public static function tracking_poll_publish($id, $status, $answers, $settings) { } /** * Track quiz publish * * @param int $id Quiz id. * @param string $type Quiz type. * @param string $status Quiz status. * @param array $questions Questions. * @param array $results Result. * @param array $settings Settings. * * @return void * @since 1.27.0 */ public static function tracking_quiz_publish($id, $type, $status, $questions, $results, $settings) { } /** * Track delete form * * @param int $module_id Module Id. * * @return void * @since 1.27.0 */ public static function tracking_form_delete($module_id) { } /** * Track delete poll * * @param int $module_id Module Id. * * @return void * @since 1.27.0 */ public static function tracking_poll_delete($module_id) { } /** * Track delete quiz * * @param int $module_id Module Id. * * @return void * @since 1.27.0 */ public static function tracking_quiz_delete($module_id) { } /** * Track module update * * @param string $update_type Update type. * * @return void */ public static function track_module_updates($update_type) { } /** * Tracking save cloud template * * @param int $form_id Form ID. * @param int|null $template_id Template ID. * * @since 1.35.0 */ public static function tracking_save_template(int $form_id, ?int $template_id = \null) { } /** * Module properties * * @param int $module_id Module Id. * @param string $module_slug Module slug. * @param string $status Status. * @param array $module_data Module data. * @param array $settings Settings. * * @return array */ private static function module_properties($module_id, $module_slug, $status, $module_data, $settings) { } /** * Get module addon * * @param int $module_id Module Id. * @param string $module_slug Module slug. * * @return string */ private static function module_integration($module_id, $module_slug) { } /** * Form Properties * * @param int $module_id Module Id. * @param array $fields Fields. * @param array $settings Settings. * * @return array */ private static function form_properties($module_id, $fields, $settings) { } /** * Poll Properties * * @param array $answer Answer. * @param array $settings Settings. * * @return array */ private static function poll_properties($answer, $settings) { } /** * Quiz Properties * * @param array $module_data Module Data. * @param array $settings Settings. * * @return array */ private static function quiz_properties($module_data, $settings) { } /** * Field List * * @param array $fields Fields. * * @return string */ private static function fields_list($fields) { } /** * Addon data * * @param int $moduel_id Module Id. * @param array $fields Fields. * @param array $settings Settings. * * @return array */ private static function addon_data($moduel_id, $fields, $settings) { } /** * Field array * * @param array $fields Fields. * @param string $field_type Field type. * * @return array */ private static function fields_array($fields, $field_type = '') { } /** * Get captcha provider label. * * @param array $fields Fields. * * @return string */ private static function captcha_type($fields) { } /** * Get email field properties. * * @param array $fields Fields. * * @return array */ private static function email_field_properties($fields) { } /** * Module status * * @param string $status Status. * @param array $settings Settings. * * @return string|void */ private static function module_status($status, $settings) { } /** * Delete module * * @param int $module_id Module Id. * @param string $module_type Module type. * * @return void */ private static function delete_module($module_id, $module_type) { } /** * Get filtered wrappers by group. If group ID is empty - it returns ungrouped wrappers * * @param array $fields Fields wrapper. * @param string $group_id Group ID. * * @return array */ public static function get_grouped_fiels($fields, $group_id = '') { } } /** * The Forminator_Mixpanel_Notifications class. * * @package Forminator */ /** * Mixpanel Notifications Events class */ class Forminator_Mixpanel_Notifications extends \Events { /** * Initialize class. * * @since 1.27.0 */ public static function init() { } /** * Tracking update notification * * @param array $data Data. * * @return void * @since 1.27.0 */ public static function tracking_update_notification($data) { } /** * Tracking update status notification * * @param int $report_id Report Id. * * @return void * @since 1.27.0 */ public static function tracking_update_status_notification($report_id) { } /** * Tracking Delete notification * * @param int $report_id Report Id. * * @return void * @since 1.27.0 */ public static function tracking_delete_notification($report_id) { } /** * Fetch notification data * * @param int $report_id Report Id. * * @return array */ private static function notifications_data($report_id) { } /** * Event Notification update * * @param array $data Data. * * @return void */ private static function event_update_notification($data) { } /** * Event Delete notification * * @param int $report_id Report Id. * * @return void */ private static function event_delete_notification($report_id) { } } /** * The Forminator_Mixpanel_Settings class. * * @package Forminator */ /** * Mixpanel Settings Events class */ class Forminator_Mixpanel_Settings extends \Events { /** * Initialize class. * * @since 1.27.0 */ public static function init() { } /** * Track stripe migrated. * * @return void */ public static function tracking_stripe_migrated() { } /** * Handle settings reset. * * We need to opt out after settings reset. * * @return void * @since 1.27.0 */ public static function tracking_settings_reset() { } /** * Handle Plugin Deactivate. * * We need to opt out after plugin deactivate. * * @param mixed $plugin Plugin name. * * @return void * @since 1.27.0 */ public static function tracking_deactivate($plugin) { } /** * Handle settings uninstall. * * We need to opt out after plugin uninstall if not keep settings. * * @param bool $keep_settings Determine whether to save current settings for next time, or reset them. * * @return void * * @since 1.27.0 */ public static function tracking_plugin_uninstall($keep_settings) { } /** * Handle settings enabling. * * @param string $triggered_from Source of the action. * @return void */ public static function tracking_settings_enabled($triggered_from) { } /** * Handle settings disabling. * * @param string $triggered_from Source of the action. * @return void */ public static function tracking_settings_disabled($triggered_from = 'Disable Tracking') { } /** * Track data tracking opt in and opt out. * * @param bool $active Toggle value. * @param string $method method. * * @return void * @since 1.27.0 */ private static function track_opt_toggle($active, $method) { } /** * Track stripe RAK use. * * @param string $test_key Test API key. * @param string $test_secret Test Secret/Restricted Key. * @param string $live_key Live API key. * @param string $live_secret Live Secret/Restricted Key. * @param string $page_slug Page slug. * * @return void */ public static function tracking_stripe_rak_use(string $test_key, string $test_secret, string $live_key, string $live_secret, $page_slug) { } /** * Track Auto Save setting. * * @param bool $auto_save Auto Save status. * * @return void */ public static function tracking_auto_save(bool $auto_save) { } } /** * Author: Hoang Ngo * * @property string $status */ abstract class Forminator_Base_Form_Model { const META_KEY = 'forminator_form_meta'; const TEMP_META_KEY = 'forminator_temp_form_meta'; /** * Form ID * * @var int */ public $id; /** * Form name * * @var string */ public $name; /** * Client Id * * @var string */ public $client_id; /** * Status * * @var string */ public $status; /** * Contain fields of this form * * @var Forminator_Form_Field_Model[] */ public $fields = array(); /** * Contain real fields of this form excluding 'html', 'page-break', 'section' and so on. * * @var Forminator_Form_Field_Model[] */ private $real_fields; /** * Form settings * * @var array */ public $settings = array(); /** * Form notification * * @var array */ public $notifications = array(); /** * Form behaviors * * @var array */ public $behaviors = array(); /** * Integration Conditions * * @var array */ public $integration_conditions = array(); /** * WP_Post * * @var WP_Post */ public $raw; /** * This post type * * @var string */ protected $post_type; const STATUS_PUBLISH = 'publish'; const STATUS_DRAFT = 'draft'; /** * Save form * * @param bool $clone_form Clone. * * @return mixed * @since 1.0 */ public function save($clone_form = \false) { } /** * Save temporary settings * * @param int $id Module ID. * @param array $module_data Module data. * * @return bool */ public static function save_temp_settings(int $id, array $module_data): bool { } /** * Get temporary settings * * @param int $id Module ID. * * @return array|bool */ public static function get_temp_settings(int $id) { } /** * Remove temporary settings * * @param int $id Module ID. * @return bool */ public static function remove_temp_settings(int $id): bool { } /** * Add temp saved changes to the data * * @param array $data Data. * @param Forminator_Base_Form_Model|null $model Model. * * @return array */ public static function add_saved_changes($data, $model) { } /** * Get fields * * @return Forminator_Form_Field_Model[] * @since 1.0 */ public function get_fields() { } /** * Get real fields - all fields except ignored ones * * @return Forminator_Form_Field_Model[] */ public function get_real_fields() { } /** * Get filtered fields by group. If group ID is empty - it returns ungrouped fields * * @param string $group_id Group ID. * @return array */ public function get_grouped_real_fields($group_id = '') { } /** * Get filtered fields by group. If group ID is empty - it returns ungrouped fields * * @param string $group_id Group ID. * @return array */ public function get_grouped_fields($group_id = '') { } /** * Get filtered fields by page break. * * @param string $page_break_id Page break ID. * @return array */ public function get_page_fields($page_break_id) { } /** * Get fields IDs of filtered fields by group * * @param string $group_id Group ID. * @return array */ public function get_grouped_fields_slugs($group_id) { } /** * Set var in array * * @param string $property Property. * @param string $name Name. * @param string $array_values Array values. * @param string $sanitize_function custom sanitize function to use, default is sanitize_title. * * @since 1.0 * @since 1.2 Add $sanitize_function as optional param */ public function set_var_in_array($property, $name, $array_values, $sanitize_function = 'sanitize_title') { } /** * Add field * * @param mixed $field Field. * * @since 1.0 */ public function add_field($field) { } /** * Get field * * @param string $slug Slug. * * @return Forminator_Form_Field|null * @since 1.0 */ public function get_field($slug) { } /** * Remove field * * @param string $slug Slug. * * @since 1.0 */ public function remove_field($slug) { } /** * Clear fields * * @since 1.0 */ public function clear_fields() { } /** * Load model * * @param int $id Id. * @param mixed $callback Callback function. * * @return bool|$this * @since 1.0 */ public function load($id, $callback = \false) { } /** * Load preview * * @param int $id Id. * @param array $data Data for preview. * * @return bool|Forminator_Base_Form_Model * @since 1.0 */ public function load_preview($id, $data) { } /** * Get relevant module object based on its ID. * * @param int $id Module ID. * * @return boolean|object */ public static function get_model($id) { } /** * Get module class by module ID * * @param int $id Module ID. * * @return boolean|string */ public static function get_model_class($id) { } /** * Return latest id for the post_type * * @return int * @since 1.0 */ public function get_latest_id() { } /** * Count all form types * * @param string $status Status. * * @return int * @since 1.0 * @since 1.6 add optional param `status` */ public function count_all($status = '') { } /** * Get entry type * * @return string */ public function get_entry_type() { } /** * Get all paginated * * @param int $current_page Current page. * @param null|int $per_page Limit per page. * @param string $status Status. * @param null|int $pdf_parent_id PDF parent Id. * @param null|string $search Optional search. Added in 1.52. * * @return array * @since 1.5.4 add optional param per_page * @since 1.5.4 add optional param $status * * @since 1.2 */ public function get_all_paged($current_page = 1, $per_page = \null, $status = '', $pdf_parent_id = \null, $search = '') { } /** * Get all * * @param string $status post_status arg. * @param int $limit Limit. * * @return array() * @since 1.0 * @since 1.6 add `status` in param * @since 1.6 add `limit` in param */ public function get_all_models($status = '', $limit = -1) { } /** * Get 3 models with old stripe field * * @return array */ public function get_models_with_old_stripe() { } /** * Get modules from field * * @param int $id Id. * * @return array * @since 1.9 */ public function get_models_by_field($id) { } /** * Get modules from field id & version * * @param int $id Id. * @param string $version Version. * * @return array * @since 1.9 */ public function get_models_by_field_and_version($id, $version) { } /** * Get Models * * @param int $total - the total. Defaults to 4. * @param string $status Status. * * @return array $models * @since 1.6 add `status` as optional param * * @since 1.0 */ public function get_models($total = 4, $status = '') { } /** * Load form * * @param WP_Post $post Post. * * @return mixed * @since 1.0 */ private function _load($post) { } /** * Disable fields * * @param array $fields Fields. * @return array */ protected static function disable_fields($fields) { } /** * Validate registration fields mapping for Registration forms * If the field is removed - replace it to the first field in the list * * @param array $form_settings Form settings. * @param array $fields Form fields. * * @return array */ private static function validate_registration_fields_mapping($form_settings, $fields) { } /** * Return fields as array * * @return array * @since 1.0 */ public function get_fields_as_array() { } /** * Return fields grouped * * @return array * @since 1.0 */ public function get_fields_grouped() { } /** * Migrate payment fields to new behavior with multi payments * * @param array $field Field. * * @return array * @since 1.15 */ private function migrate_payments($field) { } /** * Model to array * * @return array * @since 1.0 */ public function to_array() { } /** * Model to json * * @return mixed|string * @since 1.0 */ public function to_json() { } /** * In here we will define how we store the properties * * @return array * @since 1.0 */ public function get_default_maps() { } /** * This should be get override by children * * @return array * @since 1.0 */ public function get_maps() { } /** * Return model * * @param string $class_name Class name. * * @return self * @since 1.0 */ public static function model($class_name = \null) { } /** * Get Post Type of cpt * * @return mixed * @since 1.0.5 */ public function get_post_type() { } /** * Get export Model * * @return array * @since 1.4 * Override-able, but use of hook `forminator_{$module_type}_model_to_exportable_data` encouraged */ public function to_exportable_data() { } /** * Export integrations setting * * @param array $exportable_data Exportable data. * * @return array * @since 1.4 */ public function export_integrations_data($exportable_data) { } /** * Create model from import data * * @param array $import_data Import data. * @param string $name Form name. * * @return self|Forminator_Form_Model|Forminator_Poll_Model|Forminator_Quiz_Model|WP_Error * @since 1.4 * @throws Exception When there is an error. */ public static function create_from_import_data($import_data, $name = '') { } /** * Clear Stripe plan IDs * * @param array $data Data. * * @return mixed */ public static function clear_stripe_plan_ids($data) { } /** * Import Integrations data model * * @param mixed $model Model. * @param array $import_data Import data. * @param string $module Module. * * @return Forminator_Base_Form_Model * @since 1.4 */ public static function import_integrations_data($model, $import_data, $module) { } /** * Get status of prevent_store * * @param int $id Id. * @param array $settings Settings. * * @return boolean * @since 1.5 */ public function is_prevent_store($id = \null, $settings = array()) { } /** * Flag if module should be loaded via ajax * * @param bool $force Force. * * @return bool * @since 1.6.1 */ public function is_ajax_load($force = \false) { } /** * Flag if module should be loaded via ajax (Global settings) * * @param bool $force Force. * * @return bool * @since 1.6.1 */ private static function is_global_ajax_load($force = \false) { } /** * Flag to use `DONOTCACHEPAGE` * * @return bool * @since 1.6.1 */ public function is_use_donotcachepage_constant() { } /** * Flag to use `DONOTCACHEPAGE` * * @return bool * @since 1.6.1 */ private static function is_global_use_donotcachepage_constant() { } /** * Check if the result enable for share * * @return bool * @since 1.7 */ public function is_entry_share_enabled() { } /** * Check if we can submit the form * * @since 1.19.0 * @return array */ public function form_can_submit() { } /** * Check if form has active PayPal field * * @return bool * @since 1.51.0 */ public function has_active_paypal() { } /** * Check if form is expired * * @param array $form_settings Form settings. * @param string $module_slug Module slug. * * @since 1.53.0 * @return array */ public function check_form_expired($form_settings, $module_slug = '') { } /** * Check if we can show the form * * @param bool $is_preview Is preview. * * @since 1.19.0 * @return bool */ public function form_is_visible($is_preview) { } /** * Get expiry date * * Before 1.15.4 expiry date is being saved like: 1 Mar 2022 * Since we changed it to save as Unix timestamp, we need to process * * @param string $expire_date Expire date. * * @since 1.19.0 * @return string */ public function get_expiry_date($expire_date) { } /** * Filter multi search. * This filter is used to search for multiple words in post titles (OR logic). * * @param string $search The existing SQL WHERE clause for search. * @param WP_Query $query The WP_Query instance. * * @since 1.52 * @return string Modified SQL WHERE clause for search. */ public function filter_multi_search($search, $query) { } /** * Call do action when module update * * @param string $type module type. * @param string $post_id post ID. * @param object $model model array. * * @return void */ public static function module_update_do_action($type, $post_id, $model) { } /** * Check if model is publishable * * @return true|WP_Error */ public function is_publishable() { } } /** * Author: Hoang Ngo */ class Forminator_Form_Model extends \Forminator_Base_Form_Model { /** * Module slug * * @var string */ public static $module_slug = 'form'; /** * Post type * * @var string */ protected $post_type = 'forminator_forms'; /** * Get field * * @since 1.0 * * @param int $id Id. * @param bool $to_array Return in array. * * @return array|null|Forminator_Form_Field_Model */ public function get_field($id, $to_array = \true) { } /** * Return fields as array * * @since 1.5 * * @param string $type Field type. * * @return array */ public function get_fields_by_type($type) { } /** * Get wrapper * * @since 1.5 * * @param string $id Wrapper Id. * * @return array|null */ public function get_wrapper($id) { } /** * Delete form field by ID * * @since 1.5 * * @param int $id Field Id. * * @return string|false */ public function delete_field($id) { } /** * Update fields cols in specific wrapper * * @since 1.5 * * @param string $wrapper_id Wrapper Id. * * @return bool */ public function update_fields_by_wrapper($wrapper_id) { } /** * Prepare data for preview * * @param object $form_model Model. * @param array $data Passed data. * * @return object */ public static function prepare_data_for_preview($form_model, $data) { } /** * Return Form Settings * * @since 1.1 * * @return mixed */ public function get_form_settings() { } /** * Return behaviors options. * * @return array */ public function get_behavior_array() { } /** * Check if submit is handled with AJAX * * @since 1.9 * * @return bool */ public function is_ajax_submit() { } /** * Get field * * Call this method when you need get field and migrate it as well * * @since 1.7 * * @param string $id Field Id. * * @return array|null */ public function get_formatted_array_field($id) { } /** * Disable payments fields if payments are disabled * * @param array $fields Fields. * @return array */ protected static function disable_fields($fields) { } /** * Flag whether ssl required when payment exists * * @since 1.7 * * @return bool */ public function is_payment_require_ssl() { } /** * Check if Custom form has stripe field * * @since 1.7 * @return object|false */ public function has_stripe_field() { } /** * Check if Custom form has paypal field * * @since 1.41 * @return object|false */ public function has_paypal_field() { } /** * Check if form has stripe or paypal field * * @since 1.9.3 * @return bool */ public function has_stripe_or_paypal() { } } /** * The Forminator_Form_Entry_Model class. * * @package Forminator */ /** * Form Entry model * Base model for all form entries * * @since 1.0 */ class Forminator_Form_Entry_Model { /** * Cache group for entry model */ const FORM_ENTRY_CACHE_GROUP = 'Forminator_Form_Entry_Model'; /** * Cache group for total entries */ const FORM_COUNT_CACHE_GROUP = 'forminator_total_entries'; /** * Entry id * * @var int */ public $entry_id = 0; /** * Updating entry * * @var bool */ public $updating_entry = \false; /** * Entry type * * @var string */ public $entry_type; /** * Form id * * @var int */ public $form_id; /** * Draft id * * @var string */ public $draft_id; /** * Spam flag * * @var bool */ public $is_spam = \false; /** * Entry status * * @var string 'active'|'spam'|'draft'|'abandoned' */ public $status = 'active'; /** * Compute status using explicit source status if present, otherwise from this model's flags. * * @param object $source Source object that may contain `status`. * * @return string */ private function get_entry_status($source) { } /** * Date created in sql format 0000-00-00 00:00:00 * * @var string */ public $date_created_sql; /** * Date created in sql format D M Y * * @var string */ public $date_created; /** * Time created in sql format M D Y @ g:i A * * @var string */ public $time_created; /** * Meta data * * @var array */ public $meta_data = array(); /** * The table name * * @var string */ protected $table_name; /** * The table meta name * * @var string */ protected $table_meta_name; /** * Hold information about connected addons * * @since 1.1 * @var array */ private static $connected_addons = array(); /** * Initialize the Model * * @param int $entry_id Entry Id. * * @since 1.0 * @since 1.1 Add instantiate connected addons * @since 1.2 Limit initiate addon only on custom-forms by default */ public function __construct($entry_id = 0) { } /** * Load entry by id * After load set entry to cache * * @param int $entry_id - the entry id. * * @return bool|mixed * @since 1.0 */ public function get($entry_id) { } /** * Set fields * * @param array $meta_array Array of data to be saved. * @param string $entry_date Entry date. * * @type key - string the meta key * @type value - string the meta value * } * * @return bool - true or false * @since 1.5 set meta_data values even entry_id is null for object reference in the future usage * entry_id has null value is the outcome of failed to save or prevent_store is enabled * * @since 1.0 */ public function set_fields($meta_array, $entry_date = '') { } /** * Load all meta data for entry * * @param object|bool $db - the WP_Db object. * * @since 1.0 */ public function load_meta($db = \false) { } /** * Get Meta * * @param string $meta_key - the meta key. * @param mixed $default_value - the default value. * * @return mixed * @since 1.0 */ public function get_meta($meta_key, $default_value = \false) { } /** * Get Grouped Meta * Sometimes the meta prefix is same * * @param string $meta_key - the meta key. * @param mixed $default_value - the default value. * * @return mixed * @since 1.0 */ public function get_grouped_meta($meta_key, $default_value = \false) { } /** * Save entry * * @param string|null $data_created Optional custom date created. * @param int|null $entry_id Entry Id. * @param int|null $previous_draft Draft Id. * * @return bool * @since 1.6.1 add $data_created arg * * @since 1.0 */ public function save($data_created = \null, $entry_id = \null, $previous_draft = \null) { } /** * Get saved entry id * * @return int */ private function get_saved_entry_id() { } /** * Delete entry with meta * * @since 1.0 */ public function delete() { } /** * Field suffix * Some fields are grouped and have the same suffix * * @return array * @since 1.0 */ public static function field_suffix() { } /** * Field suffix label * Displayable label for suffix * * @param string $suffix Suffix. * * @return string * @since 1.0.5 */ public static function translate_suffix($suffix) { } /** * Ignored fields * Fields not saved or shown * * @return array * @since 1.0 */ public static function ignored_fields() { } /** * Return if form has live payment entry * * @param int $form_id - the form id. * * @return mixed * @since 1.10 */ public static function has_live_payment($form_id) { } /** * Get all entries * * @param int $form_id - the form id. * @param array $filters Filters. * * @return Forminator_Form_Entry_Model[] * @since 1.40 */ public static function get_all_entries($form_id, $filters = array()) { } /** * Group count of Entries with extra selected * * @param int $form_id Form id. * @param array $fields_element_id_with_extra Fields element Id. * * @return array|null|object * @example = [ * 'FIELDS_WITH_EXTRA_ELEMENT_ID' => [ * 'META_VALUE-1' => COUNT * 'META_VALUE-2' => COUNT * ], * 'answer-3' => [ * 'javascript is the best' => 8 * 'php is the best' => 7 * ], * ] * * @since 1.0.5 */ public static function count_polls_with_extra($form_id, $fields_element_id_with_extra) { } /** * Count entries by form * * @param int $form_id - the form id. * @param mixed $db DB. * @param bool $all_types Include draft, abandoned, etc. * * @return int - total entries * @since 1.0 */ public static function count_entries($form_id, $db = \false, $all_types = \false) { } /** * Count lead entries by form * * @param int $form_id Form Id. * @param string $start_date Start date. * @param string $end_date End date. * * @return int|string */ public static function count_leads($form_id, $start_date = '', $end_date = '') { } /** * Count entries by form * * @param int $form_id - the form id. * * @return int - total entries * @since 1.0 * @deprecated */ public static function count_entries_by_form_and_field($form_id) { } /** * Map Polls Entries with its votes * * @param int $form_id Form id. * @param array $fields Fields. * * @return array * @example { * 'ELEMENT_ID' => 'NUMBER' * 'answer-1' = 9 * } * * @since 1.0.5 */ public static function map_polls_entries($form_id, $fields) { } /** * Map Polls Entries to be used for export * Pretty much @see Form_Entry_Model::map_polls_entries(), but returning what's required for the export. * * @since 1.6 * * @example { * 'meta_id' => 'values' * '2' = [ * 'date_created' = '1999-12-31 23:59:59', * 'meta_key' = 'answer-1', * 'is_spam' = '0', * ] * } * * @param int $form_id Form Id. * @param array $fields Fields. * * @return array */ public static function map_polls_entries_for_export($form_id, $fields) { } /** * Update poll entries meta_key to its element_id * * @param int $form_id Form id. * @param string $old_meta_key Old meta key. * @param string $element_id Element Id. * * @since 1.0.5 */ public static function maybe_update_poll_entries_meta_key_to_element_id($form_id, $old_meta_key, $element_id) { } /** * Get entry date by ip and form * * @param int $form_id - the form id. * @param string $ip - the user ip. * * @return string|bool * @since 1.0 */ public static function get_entry_date_by_ip_and_form($form_id, $ip) { } /** * Get amount submissions by current user * * @param int $form_id Form ID. * @return int */ public static function count_user_entries($form_id) { } /** * Get last entry by IP and form * * @param int $form_id - the form id. * @param string $ip - the user ip. * * @return string|bool * @since 1.0 */ public static function get_last_entry_by_ip_and_form($form_id, $ip) { } /** * Get entry date by ip and form * * @param int $form_id - the form id. * @param string $ip - the user ip. * @param int $entry_id - the entry id. * @param string $interval - the mysql interval. Eg (INTERVAL 1 HOUR). * * @return string|bool * @since 1.0 */ public static function check_entry_date_by_ip_and_form($form_id, $ip, $entry_id, $interval = '') { } /** * Bulk delete form entries * * @param int $form_id - the form id. * @param mixed $db - DB. * * @since 1.0 */ public static function delete_by_form($form_id, $db = \false) { } /** * Delete by string of comma separated entry ids * * @param int $form_id Form id. * @param string $entries Entries. * @param bool|wpdb $db DB. * * @return bool * @since 1.0 * @since 1.1 Add init addons and Add hooks `forminator_before_delete_entry` */ public static function delete_by_entrys($form_id, $entries, $db = \false) { } /** * Delete by entry * * @param int $entry_id - the entry id. * * @since 1.0 * @since 1.1 Add init addons and Add hooks `forminator_before_delete_entry` */ public static function delete_by_entry($entry_id) { } /** * Delete files from upload folder * * @param int $form_id Form Id. * @param Forminator_Form_Entry_Model $entry_model Form Entry model. * * @since 1.7 */ public static function entry_delete_upload_files($form_id, $entry_model) { } /** * Convert meta value to string * Useful on displaying metadata without PHP warning on conversion * * @param string $field_type Field type. * @param mixed $meta_value Meta value. * @param bool $allow_html Allow HTML. * @param int $truncate truncate returned string (usefull if display container is limited). * @param mixed $field Field data (optional). * * @return string * @since 1.0.5 */ public static function meta_value_to_string($field_type, $meta_value, $allow_html = \false, $truncate = \PHP_INT_MAX, $field = \null) { } /** * Process postdata meta value * * @param array $meta_value Meta value. * @param bool $allow_html Allow HTML. * @param int $truncate Truncate. * * @return string * @since 1.17.0 */ public static function postdata_to_string($meta_value, $allow_html = \false, $truncate = \PHP_INT_MAX) { } /** * Get the postdata title depending on context * * @param string $value Value. * @param string $type allow_html, no_html, draft. * @param int $truncate Truncate, Default: PHP_INT_MAX. * @param string $url URL. * * @since 1.17.0 */ public static function get_postdata_title($value, $type = 'allow_html', $truncate = \PHP_INT_MAX, $url = '') { } /** * Get the postdata content depending on context * * @param string $value Value. * @param bool $allow_html Allow HTML. * @param int $truncate Truncate. * * @since 1.17.0 */ public static function get_postdata_content($value = '', $allow_html = \true, $truncate = \PHP_INT_MAX) { } /** * Get the postdata excerpt depending on context * * @param string $value Value. * @param bool $allow_html Allow HTML. * @param int $truncate Truncate. * * @since 1.17.0 */ public static function get_postdata_excerpt($value = '', $allow_html = \true, $truncate = \PHP_INT_MAX) { } /** * Get the postdata categories depending on context * * @param string|array $value Value. * @param bool $allow_html Allow HTML. * * @since 1.17.0 */ public static function get_postdata_categories($value = '', $allow_html = \true) { } /** * Get the postdata taxonmies depending on context * * @param string $tax_name Tax name. * @param string|array $value Value. * @param bool $allow_html Allow HTML. * * @since 1.20.0 */ public static function get_postdata_taxonomies($tax_name, $value = '', $allow_html = \true) { } /** * Get the postdata tags depending on context * * @param string|array $value Value. * @param bool $allow_html Allow HTML. * * @since 1.17.0 */ public static function get_postdata_tags($value = '', $allow_html = \true) { } /** * Get the postdata featured image depending on context * * @param string|array $value Value. * @param bool $allow_html Allow HTML. * * @since 1.17.0 */ public static function get_postdata_image($value = '', $allow_html = \true) { } /** * Get the postdata Custom fields depending on context * * @param string|array $value Value. * @param bool $allow_html Allow HTML. * @param int $truncate Truncate. * * @since 1.17.0 */ public static function get_postdata_customfields($value = array(), $allow_html = \true, $truncate = \PHP_INT_MAX) { } /** * Count all entries for all form_type */ public static function count_all_entries() { } /** * Count all entries for the selected entry type * * @param string $entry_type Entry type. * * @return int * @since 1.5.4 */ public static function count_all_entries_by_type($entry_type = 'custom-forms') { } /** * Get Latest Entry * * @param string $entry_type Entry type. * * @return Forminator_Form_Entry_Model|null */ public static function get_latest_entry($entry_type = 'custom-forms') { } /** * Get Latest Entry by form_id * * @param int $form_id Form Id. * @param string $order Order by. * * @return Forminator_Form_Entry_Model|null */ public static function get_latest_entry_by_form_id($form_id, $order = 'DESC') { } /** * Get Connected Addons for form_id, avoid overhead for checking connected addons many times * * @param int $module_id Module id. * @param string $module_slug Module slug. * * @return array|Forminator_Integration[] * @since 1.1 */ public static function get_connected_addons($module_id, $module_slug = 'form') { } /** * Attach hooks for delete entry on connected addons * * @param int $form_id Form Id. * @param Forminator_Form_Entry_Model $entry_model Form entry model. * * @since 1.1 * @throws Exception When there is an error. */ public static function attach_addons_on_before_delete_entry($form_id, \Forminator_Form_Entry_Model $entry_model) { } /** * Get entries by email * * @since 1.0.6 * * @param string $email Email. * * @return array */ public static function get_custom_form_entry_ids_by_email($email) { } /** * Get entries older than $date_created * * @param string $date_created Created date. * @param string $entry_type Entry type. * @param int $id Id. * @param bool $is_draft Is draft. * * @return array * @since 1.0.6 */ public static function get_older_entry_ids($date_created, $entry_type = '', $id = 0, $is_draft = \false) { } /** * Get entries newer than $date_created * * @param string $entry_type Entry type. * @param string $date_created Created date. * * @return array * @since 1.5.3 */ public static function get_newer_entry_ids($entry_type, $date_created) { } /** * Get entries newer than $date_created * * @param string $entry_type Entry type. * * @return array|object * @since 1.5.3 */ public static function get_most_entry($entry_type) { } /** * Get entries newer than $date_created of form_id * * @param int $form_id Form Id. * @param string $date_created Created date. * * @return array * @since 1.5.3 */ public static function get_newer_entry_ids_of_form_id($form_id, $date_created) { } /** * Get entries newer than $date_created of form_id grouped by date_created Day * * @param int $form_id Form Id. * @param string $date_created Created date. * @param string $date_end End date. * * @return array * @since 1.5.3 */ public static function get_form_latest_entries_count_grouped_by_day($form_id, $date_created, $date_end = '') { } /** * Get entries newer than $date_created of form_id grouped by date_created Day * * @param int $form_id Form id. * @param string $date_created Created date. * * @return array * @since 1.14 */ public static function get_form_latest_lead_entries_count_grouped_by_day($form_id, $date_created) { } /** * Update Meta * * @param int $meta_id Meta Id. * @param string $meta_key - the meta key. * @param bool|object $default_value - the default value. * @param string $date_updated Update date. * @param string $date_created Create date. * * @since 1.0.6 * @since 1.5 : add optional `$date_updated` and `$date_created` arguments */ public function update_meta($meta_id, $meta_key, $default_value = \false, $date_updated = '', $date_created = '') { } /** * Custom Query entries * * @param array $args Arguments. `form_id` is required to retrieve entries. * * @return Forminator_Form_Entry_Model[] | array * @since 1.5.4 * * @since 1.40 * @param bool $get_count If true, returns an array with the keys `count` and `data`. Default: false. */ public static function query_entries($args, $get_count = \false) { } /** * Is option limit reached * * @param int $module_id - Module ID. * @param string $field_name - Field name. * @param string $field_type - Field type. * @param array $option Option settings. * @param bool $freeze Optional. Should it save transient option for the current request or not. False by default. * @return bool */ public static function is_option_limit_reached($module_id, $field_name, $field_type, $option, $freeze = \false) { } /** * Count entries of form select key and value * * @param int $form_id - the form id. * @param string $field_name - the field name. * @param string $field_value - the field value. * @param string $field_label - the field label. * @param string $option_type - Option type (multiselect|single). * * @return int - total entries * @since 1.7 */ public static function select_count_entries_by_meta_field($form_id, $field_name, $field_value, $field_label, $option_type = 'single') { } /** * Load entry by draft_id * * @param int $draft_id - the draft id. * * @return bool|mixed * @since 1.17.0 */ public function get_entry_id_by_draft_id($draft_id) { } /** * Delete previous draft * * @param string $previous_draft - draft ID of previously saved draft. * * @since 1.17.0 */ public function delete_previous_draft($previous_draft) { } /** * Get entries with filters * * @param int $form_id Form Id. * @param string $start_date Start date. * @param string $end_date End date. * @param string $status Entries status. * * @return int */ public static function count_report_entries($form_id, $start_date = '', $end_date = '', $status = 'active') { } /** * Payment array * * @param int $form_id Form Id. * @param string $start_date Start date. * @param string $end_date End date. * * @return array */ public static function payment_amount($form_id, $start_date = '', $end_date = '') { } /** * Addon array * * @param int $form_id Form Id. * @param string $data_key Meta key name. * @param string $start_date Start date. * @param string $end_date End date. * * @return int */ public static function addons_data($form_id, $data_key, $start_date = '', $end_date = '') { } /** * Delete form cache * * @param int $form_id Form ID. * * @return void */ public static function delete_form_entry_cache(int $form_id): void { } /** * Delete form entries query cache * * @param int $form_id Form Id. * @return void */ public static function delete_form_entries_query_cache($form_id): void { } } /** * The Forminator_Form_Field_Model class. * * Author: Hoang Ngo * * @package Forminator */ /** * Forminator_Form_Field_Model * * Hold Field as model * Heads up! this class use __get and __set magic method, use with care * * @property string $wrapper_id */ class Forminator_Form_Field_Model { /** * This should be unique * * @var string */ public $slug; /** * This is parent form ID, optional * * @var int */ public $form_id; /** * This is parent group, optional * * @var string */ public $parent_group = ''; /** * This contains all the parsed json data from frontend form * * @var array */ protected $raw = array(); /** * This contains all form settings for field migration * * @var array */ protected $form_settings = array(); /** * Forminator_Form_Field_Model constructor. * * @param null|array $settings Settings. */ public function __construct($settings = \null) { } /** * Get * * @since 1.0 * * @param string $name Field name. * * @return mixed|null */ public function __get($name) { } /** * Set * * @since 1.0 * * @param string $name Field name. * @param mixed $value Field value. */ public function __set($name, $value) { } /** * To JSON * * @since 1.0 * @return string */ public function to_json() { } /** * To array * * @since 1.0 * @return array */ public function to_array() { } /** * Format to array * * @since 1.0 * @return array */ public function to_formatted_array() { } /** * Import * * @since 1.0 * @since 1.5 add `wrapper_id` on the attribute * * @param array $data Data. */ public function import($data) { } /** * Check if subfield is enabled or disabled * * @param string $subfield_name Subfield name. * @return boolean */ public function is_subfield_enabled($subfield_name) { } /** * Get Field Label For Entry * * @since 1.0.3 * * @return string */ public function get_label_for_entry() { } } /** * The Forminator_Form_Reports_Model class. * * Author: Hoang Ngo * * @package Forminator */ /** * Form Reports */ class Forminator_Form_Reports_Model { /** * The table name * * @var string */ protected $table_name; /** * Plugin instance * * @var null */ private static $instance = \null; /** * Return the plugin instance * * @return Forminator_Form_Views_Model * @since 1.0 */ public static function get_instance() { } /** * Forminator_Form_Reports_Model constructor. * * @since 1.0 */ public function __construct() { } /** * Save reports to database * * @param mixed $report Report. * @param string $status Status. * * @return int */ public function report_save($report, $status) { } /** * Update report * * @param int $report_id Report Id. * @param mixed $report Report. * @param string $status Status. * * @return bool|int|mysqli_result|resource|null */ public function report_update($report_id, $report, $status) { } /** * Update report data * * @param int $report_id Report Id. * * @return bool|int|mysqli_result|resource|null */ public function report_update_date($report_id) { } /** * Delete Report * * @param int $report_id Report Id. * * @return bool|int|mysqli_result|resource|null */ public function report_delete($report_id) { } /** * Load all report data * * @since 1.20.0 */ public function fetch_all_report() { } /** * Load reports data by id * * @param int $id Id. * * @return array|object|stdClass[]|null */ public function fetch_report_by_id($id) { } /** * Update report status * * @param int $report_id Report Id. * @param string $status Status. * * @return bool|int|mysqli_result|resource|null */ public function report_update_status($report_id, $status) { } /** * Return report table name * * @return string * @since 1.20.0 */ public function get_table_name() { } /** * Insert default report entry * * @since 1.20.0 */ public function default_report_entry() { } } /** * The Forminator_Form_Views_Model class. * * @package Forminator */ /** * Form Views * Handles conversions and views of the different forms */ class Forminator_Form_Views_Model { /** * The table name * * @var string */ protected $table_name; /** * Plugin instance * * @var null */ private static $instance = \null; /** * Return the plugin instance * * @since 1.0 * @return Forminator_Form_Views_Model */ public static function get_instance() { } /** * Forminator_Form_Views_Model constructor. * * @since 1.0 */ public function __construct() { } /** * Save conversion * * @since 1.0 * @param int $form_id - the form id. * @param int $page_id - the page id. */ public function save_view($form_id, $page_id) { } /** * Save Data to database * * @param int $form_id - the form id. * @param int $page_id - the page id. * @param bool|object $db - the wp db object. */ private function _save($form_id, $page_id, $db = \false) { } /** * Update view * * @since 1.0 * @param int $id - entry id. * @param bool|object $db - the wp db object. */ private function _update($id, $db = \false) { } /** * Count views * * @since 1.0 * @param int $form_id - the form id. * @param string $starting_date - the start date (dd-mm-yyy). * @param string $ending_date - the end date (dd-mm-yyy). * * @return int - totol views based on parameters */ public function count_views($form_id, $starting_date = \null, $ending_date = \null) { } /** * Delete views by form * * @since 1.0 * @param int $form_id - the form id. */ public function delete_by_form($form_id) { } /** * Count data * * @since 1.0 * @param int $form_id - the form id. * @param string $starting_date - the start date (dd-mm-yyy). * @param string $ending_date - the end date (dd-mm-yyy). * * @return int - totol counts based on parameters */ private function _count($form_id, $starting_date = \null, $ending_date = \null) { } /** * Generate the date query * * @since 1.0 * @param object $wpdb - the WordPress database object. * @param string $starting_date - the start date (dd-mm-yyy). * @param string $ending_date - the end date (dd-mm-yyy). * @param string $prefix Prefix. * @param string $clause Clause. * * @return string $date_query */ private function generate_date_query($wpdb, $starting_date = \null, $ending_date = \null, $prefix = '', $clause = 'AND') { } /** * Return views table name * * @since 1.6.3 * * @return string */ public function get_table_name() { } } /** * Author: Hoang Ngo */ class Forminator_Poll_Model extends \Forminator_Base_Form_Model { /** * Module slug * * @var string */ public static $module_slug = 'poll'; /** * Post type * * @var string */ protected $post_type = 'forminator_polls'; /** * Whether to check form access * * @since 1.0.5 * * @var bool */ protected $check_access = \true; /** * Prepare data for preview * * @param object $form_model Model. * @param array $data Passed data. * * @return object */ public static function prepare_data_for_preview($form_model, $data) { } /** * Check if the vote clause is set up and if a user can vote again * * @since 1.0 * @param bool $freeze Optional. Should it prevent parallel requests. False by default. * @return bool */ public function current_user_can_vote($freeze = \false) { } /** * Check user can vote by browser cookie * * @return bool */ public function poll_votes_method_browser_cookie() { } /** * Check user can vote by user IP * * @return bool */ public function poll_votes_method_user_ip() { } /** * Overridden load function to check element_id of answers for older poll * Backward compat for <= 1.0.4 * which is forminator poll doesnt have element_id on poll answers * * @since 1.0.5 * * @param int $id Id. * @param bool $callback Callback. * * @return bool|Forminator_Poll_Model */ public function load($id, $callback = \false) { } /** * Add Element id on answers that doesnt have it * * @since 1.0.5 * * @param Forminator_Poll_Model $model Poll model. * * @return Forminator_Poll_Model */ private function maybe_add_element_id_on_answers(\Forminator_Poll_Model $model) { } /** * Resave model and then load to return new model * * @since 1.0.5 * * @param Forminator_Poll_Model $model Poll model. * * @return Forminator_Poll_Model */ private function resave_and_reload(\Forminator_Poll_Model $model) { } /** * Get Fields as array with `$key` as key of array and `$pluck_key` as $value with `$default` as fallback * * @since 1.0.5 * * @param string $pluck_key Pluck key. * @param string|null $key Key. * @param null $default_value Default value. * * @return array */ public function pluck_fields_array($pluck_key, $key = \null, $default_value = \null) { } /** * Get enable limit votes status flag * * @since 1.6.1 * @return bool */ public function is_allow_multiple_votes() { } /** * Get Browser votes method enable status flag * * @since 1.7 * * @return bool */ public function is_method_browser_cookie() { } /** * Check vote opening status * * @return array */ public function opening_status() { } } /** * Author: Hoang Ngo */ class Forminator_Quiz_Model extends \Forminator_Base_Form_Model { /** * Module slug * * @var string */ public static $module_slug = 'quiz'; /** * Post type * * @var string */ protected $post_type = 'forminator_quizzes'; /** * Results * * @var array */ public $results = array(); /** * Questions * * @var array */ public $questions = array(); /** * Quiz type * * @var string */ public $quiz_type = ''; /** * Get maps * * @since 1.0 * @return array */ public function get_maps() { } /** * Get right answer for question * * @since 1.0 * * @param string $slug Slug. * * @return array|bool */ public function getRightAnswerForQuestion($slug) { } /** * Return questions * * @since 1.0 * * @param string $slug Slug. * * @return mixed */ public function getQuestion($slug) { } /** * Return answer * * @since 1.0 * * @param string $slug Slug. * @param string $index Index. * * @return bool */ public function getAnswer($slug, $index) { } /** * Get result from answer * * @since 1.0 * * @param string $slug Slug. * @param string $index Index. * * @return mixed */ public function getResultFromAnswer($slug, $index) { } /** * Get priority * * @since 1.0 * @since 1.3 use results instead of non existent value of priority_order * @return mixed */ public function getPriority() { } /** * Return results * * @since 1.0 * @return array */ public function getResults() { } /** * Get result * * @since 1.0 * * @param string $slug Slug. * * @return mixed|null */ public function getResult($slug) { } /** * Prepare data for preview * * @param object $form_model Model. * @param array $data Passed data. * * @return object */ public static function prepare_data_for_preview($form_model, $data) { } /** * Export integrations setting * * @param array $exportable_data Exportable data. * @return array */ public function export_integrations_data($exportable_data) { } /** * Import Integrations data model * * @since 1.4 * * @param mixed $model Model. * @param array $import_data Import data. * @param string $module Module. * * @return Forminator_Base_Form_Model */ public static function import_integrations_data($model, $import_data, $module) { } /** * Get result of nowrong quiz * * @since 1.6.1 * * @param array $answer_results Answer results. * * @return array contains `title`, `order`, `slug` if found, return empty array otherwise */ public function get_nowrong_result($answer_results) { } /** * Check whether answer is correct for a question on Knowledge Quiz * * @since 1.6.2 * * @param string $slug question slug. * @param int $answer_index answer index. * * @return bool */ public function is_correct_answer_for_question($slug, $answer_index) { } /** * Find Correct Answers for a question on knowledge quiz * * @since 1.6.2 * * @param string $slug question slug. * * @return array */ public function get_correct_answers_for_question($slug) { } /** * Check whether entry share-able * * @since 1.7 * @return bool */ public function is_entry_share_enabled() { } /** * Get the count of answered questions for multi-answer questions * * @param array $questions Questions. * @param array $user_answers User answers. * * @return int */ public function count_answered_questions($questions, $user_answers) { } } /** * Class Forminator_Custom_Form_Admin * * @property Forminator_Custom_Forms module * @since 1.0 */ class Forminator_Custom_Form_Admin extends \Forminator_Admin_Module { /** * Module objects * * @var array */ public $module; /** * Init module admin * * @since 1.0 */ public function init() { } /** * Add module pages to Admin * * @since 1.0 */ public function add_menu_pages() { } /** * Pass module defaults to JS * * @since 1.0 * * @param array $data Data. * * @return mixed */ public function add_js_defaults($data) { } /** * Localize module * * @since 1.0 * * @param array $data Data. * * @return mixed */ public function add_l10n_strings($data) { } /** * Return template * * @param string $slug Template slug. * @since 1.0 * @return Forminator_Template|false */ private function get_template(string $slug) { } /** * Return Form notifications * * @since 1.1 * * @param Forminator_Form_Model|null $form Form model. * * @return mixed */ public static function get_form_notifications($form) { } /** * Get Registration Form notifications * * @since 1.11 * * @param Forminator_Form_Model|null $form Form model. * @param Forminator_Template|null $template Template. * * @return mixed */ public static function get_registration_form_notifications($form, $template = \null) { } /** * Get customer email as field slug * * @since 1.11 * * @param Forminator_Form_Model|Forminator_Template $form Form Model. * @param string $default_value Default value. * * @return string */ public static function get_registration_form_customer_email_slug($form, $default_value = '{email-1}') { } /** * Form default data * * @param string $name Form name. * @param array $settings Settings. * * @return array */ public static function get_default_settings($name, $settings = array()) { } /** * Get default color settings * * @return array */ public static function get_default_color_settings() { } /** * Customizing import data * * @param array $import_data Import data. * * @return array */ public static function customize_import_data(array $import_data): array { } /** * Create quiz module * * @since 1.14 */ public function create_module() { } /** * Create form from template * * @param string $template_id Template ID or slug. * @param string $name Template name. * @param string $trigger_from Trigger from Template page or Form builder. * * @return int|WP_Error */ public function create_module_from_template(string $template_id, string $name = '', string $trigger_from = '') { } /** * Create form from free template * * @param string $slug Template slug. * @param string $name Template name. * @param string $trigger_from Trigger from Template page or Form builder. * * @return int | WP_Error */ public function create_module_from_free_template(string $slug, string $name = '', string $trigger_from = '') { } /** * Create form * * @param string $name Name. * @param string $status Status. * @param object $template Template. * @return int post ID */ public static function create($name, $status, $template = \null) { } /** * Update form * * @param string $id Module ID. * @param string $title Name. * @param string $status Status. * @param object $template Template. * @return WP_Error post ID */ public static function update($id, $title, $status, $template) { } /** * Add draft retention settings to global retention options * * @param string $form_id Module ID. * @param array $settings Form settings. */ public static function add_draft_retention_settings($form_id, $settings) { } /** * Get PDF data * * @param int $form_id Form Id. * * @return array */ public function get_pdf_data($form_id) { } /** * Get cloud templates */ public function get_cloud_templates() { } /** * Save template */ public function save_template() { } /** * Delete template */ public function delete_template() { } /** * Rename template */ public function rename_template() { } /** * Disconnect Hub */ public function disconnect_hub() { } /** * Share hub deactivation survey to Mixpanel * * @param string $model_action Model action. * @param string $message Message. * @return void */ private function share_hub_deactivation_survey_to_mixpanel($model_action, $message = '') { } /** * Duplicate template */ public function duplicate_template() { } } /** * Class Forminator_CForm_View_Page * * @since 1.0 */ class Forminator_CForm_View_Page extends \Forminator_Admin_View_Page { /** * Current model id * * @var int */ protected $model_id = 0; /** * Moduel type * * @var string */ protected static $module_slug = 'form'; /** * Nested Mappers * * @var array */ protected $fields_mappers = array(); /** * Flatten version of mappers * * @var array */ protected $flatten_field_mappers = array(); /** * Custom form model * * @var Forminator_Form_Model|null */ protected static $custom_form_model = \null; /** * Initialise variables * * @param int|null $form_id Form id. * * @since 1.0 */ public function before_render($form_id = \null) { } /** * Action delete_all */ public function delete_all_action() { } /** * Action approve_users */ public function approve_users() { } /** * Return visible fields as string * * @since 1.0 * @return string */ public function get_visible_fields_as_string() { } /** * Show a field if selected * * @since 1.0 * * @param string $slug - the field slug. * * @return bool */ public function is_selected_field($slug) { } /** * Render entry * * @since 1.0 * * @param object $item - the entry. * @param string $column_name - the column name. * * @param null $field @since 1.0.5, optional Forminator_Form_Field_Model. * * @return string * TO-DO: replace Forminator_CForm_View_Page::render_entry() by render_entry() on other files */ public static function render_entry($item, $column_name, $field = \null) { } /** * Render entry values raw * * @since 1.0 * * @param object $item - the entry. * @param string $column_name - the column name. * * @return mixed */ public static function render_raw_entry($item, $column_name) { } /** * Mimic from export * * @see Forminator_Export::get_custom_form_export_mappers() * TODO: decouple this function so it can be called on multiple occasions (export, entries render) with single place to update * * @return array */ private function build_fields_mappers() { } /** * Build field * * @param object $field Field object. * @return array */ private function build_field_mapper($field) { } /** * Get Fields Mappers based on current state of form * * @return array */ public function get_fields_mappers() { } /** * Get flatten fields mappers * * @return array */ public function get_flatten_fields_mappers() { } /** * Build Html Entries Header */ public function entries_header() { } /** * Entries iterator * * @param null|array $entries Entries. * @param string $form_type Form type. * * @return array */ public function entries_iterator($entries = \null, $form_type = '') { } /** * Get sub entries * * @param array $mapper Field Mapper. * @param object $entry Entry object. * @param string $slug Cloned field suffix. * @return array */ private static function get_sub_entries($mapper, $entry, $slug = '') { } /** * Ensuring additional items for addons met the entries data requirement * Format used is, * - label * - value * - subentries[] * - label * - value * * @since 1.1 * * @param array $addon_additional_items Additional items. * @param array $meta_data Meta data. * * @return mixed */ protected static function format_addon_additional_items($addon_additional_items, $meta_data = array()) { } /** * Get Connected Addons on current form, avoid overhead for checking connected addons many times * * @since 1.1 * * @return array|Forminator_Integration[] */ public function get_connected_addons() { } /** * Get form type param * * @since 1.5.4 * @return string */ protected function get_form_type() { } /** * Get form id param * * @since 1.5.4 * @return int */ protected function get_form_id() { } /** * Redirect to referer if available * * @param string $fallback_redirect Fallback redirect. * @param bool $to_referer Referrer. */ protected function maybe_redirect_to_referer($fallback_redirect = '', $to_referer = \true) { } /** * Check payment * * @return bool */ public function has_payments() { } /** * Check payment * * @param int $form_id Form Id. * * @return bool */ public function has_live_payments($form_id) { } /** * Executor of adding additional items on entry page * * @see Forminator_Integration_Form_Hooks::on_render_entry() * @since 1.1 * * @param Forminator_Form_Entry_Model $entry_model Form entry model. * * @return array */ private function attach_addon_on_quiz_render_entry(\Forminator_Form_Entry_Model $entry_model) { } /** * Delete signup user entry * * @param array $entry Entry. */ public function delete_signup_user_entry($entry) { } } /** * Class Forminator_CForm_New_Page * * @since 1.0 */ class Forminator_CForm_New_Page extends \Forminator_Admin_Page { /** * Get wizard title * * @since 1.0 * @return mixed */ public function getWizardTitle() { } /** * Add page screen hooks * * @since 1.0 * @param string $hook Hook. */ public function enqueue_scripts($hook) { } /** * Render page content with access guard for registration forms. * * @since 1.52.0 */ protected function render_page_content() { } /** * Render the registration access restriction notice. * * @since 1.52.0 */ private function render_registration_restriction_notice() { } } /** * Class Forminator_CForm_Page * * @since 1.0 */ class Forminator_CForm_Page extends \Forminator_Admin_Module_Edit_Page { /** * Module slug * * @var string */ protected static $module_slug = 'form'; /** * Initialize */ public function init() { } /** * Migration for stripe field * * @return bool */ private static function maybe_migrate_stripe_field() { } /** * Bulk actions * * @since 1.0 * @return array */ public function bulk_actions() { } /** * Return module array * * @since 1.14.10 * * @param int $id Id. * @param string $title Title. * @param mixed $views Views. * @param string $date Date. * @param string $status Status. * @param mixed $model Model. * * @return array */ protected static function module_array($id, $title, $views, $date, $status, $model) { } /** * Override scripts to be loaded * * @since 1.6.1 * * @param string $hook Hook. */ public function enqueue_scripts($hook) { } } /** * Class Forminator_CForm_Renderer_Entries * * @since 1.0.5 */ class Forminator_CForm_Renderer_Entries extends \Forminator_CForm_View_Page { /** * Forminator_CForm_Renderer_Entries constructor * * @noinspection PhpMissingParentConstructorInspection * * Construct Entries Renderer * * @since 1.0.5 * * @param string $folder Folder. */ public function __construct($folder) { } } /** * Class Forminator_Template_Contact_Form * * @since 1.0 */ class Forminator_Template_Blank extends \Forminator_Template { /** * Template defaults * * @since 1.0 * @return array */ public function defaults() { } /** * Template fields * * @since 1.0 * @return array */ public function fields() { } /** * Template settings * * @since 1.0 * @return array */ public function settings() { } } /** * Class Forminator_Template_Contact_Form * * @since 1.0 */ class Forminator_Template_Contact_Form extends \Forminator_Template { /** * Template defaults * * @since 1.0 * @return array */ public function defaults() { } /** * Template fields * * @since 1.0 * @return array */ public function fields() { } /** * Template settings * * @since 1.0 * @return array */ public function settings() { } } /** * Class Forminator_Template_Leads * * @since 1.0 */ class Forminator_Template_Leads extends \Forminator_Template { /** * Template defaults * * @since 1.0 * @return array */ public function defaults() { } /** * Template fields * * @since 1.0 * @return array */ public function fields() { } /** * Template settings * * @since 1.0 * @return array */ public function settings() { } } /** * Class Forminator_Template_Contact_Form * * @since 1.0 */ class Forminator_Template_Login extends \Forminator_Template { /** * Template defaults * * @since 1.0 * @return array */ public function defaults() { } /** * Template fields * * @since 1.0 * @return array */ public function fields() { } /** * Template settings * * @since 1.0 * @return array */ public function settings() { } } /** * Class Forminator_Template_Contact_Form * * @since 1.0 */ class Forminator_Template_Newsletter extends \Forminator_Template { /** * Template defaults * * @since 1.0 * @return array */ public function defaults() { } /** * Template fields * * @since 1.0 * @return array */ public function fields() { } /** * Template settings * * @since 1.0 * @return array */ public function settings() { } } /** * Class Forminator_Template_Contact_Form * * @since 1.0 */ class Forminator_Template_Post extends \Forminator_Template { /** * Template defaults * * @since 1.0 * @return array */ public function defaults() { } /** * Template fields * * @since 1.0 * @return array */ public function fields() { } /** * Template settings * * @since 1.0 * @return array */ public function settings() { } } /** * Class Forminator_Template_Contact_Form * * @since 1.0 */ class Forminator_Template_Quote extends \Forminator_Template { /** * Template defaults * * @since 1.0 * @return array */ public function defaults() { } /** * Template fields * * @since 1.0 * @return array */ public function fields() { } /** * Template settings * * @since 1.0 * @return array */ public function settings() { } } /** * Class Forminator_Template_Contact_Form * * @since 1.0 */ class Forminator_Template_Registration extends \Forminator_Template { /** * Template defaults * * @since 1.0 * @return array */ public function defaults() { } /** * Template fields * * @since 1.0 * @return array */ public function fields() { } /** * Template settings * * @since 1.0 * @return array */ public function settings() { } } /** * Front ajax for custom forms * * @since 1.0 */ class Forminator_CForm_Front_Action extends \Forminator_Front_Action { /** * Module slug * * @var string */ protected static $module_slug = 'form'; /** * Submit errors * * @var array */ public static $submit_errors = array(); /** * Hidden fields * * @var array */ public static $hidden_fields = array(); /** * Not calculable fields * * @var array */ public static $not_calculable = array(); /** * Fields that shoud be replaced to zero if it's hidden * * @var array */ public static $replace_to_zero = array(); /** * Entry type * * @var string */ public static $entry_type = 'custom-forms'; /** * Registration object * * @var string */ public static $registration = \null; /** * Plugin instance * * @var null */ private static $instance = \null; /** * Flag if form has upload field * * @var false */ private static $has_upload = \false; /** * Flag if form has payment fields * * @var false */ private static $has_payment = \false; /** * Is stripe payment * * @var false */ private static $is_stripe_payment = \false; /** * Is paypal payment * * @var false */ private static $is_paypal_payment = \false; /** * Forminator_CForm_Front_Action constructor */ public function __construct() { } /** * Return the plugin instance * * @since 1.0 * @return Forminator_Front_Action */ public static function get_instance() { } /** * Prepare price to pass to PayPal * * @param array $amount Amount array. * @return array */ private static function prepare_pp_price($amount) { } /** * Create PayPal order * * @since 1.14.3 */ public function create_paypal_order() { } /** * Update payment amount * * @since 1.7.3 */ public function update_payment_amount() { } /** * Add a temporary country code based on currency to prevent errors. * Set country code to Austria if currency is Euro, * else remove the last letter from currency code to get temporary country code. * * This only prevents error from Paypal in case the country is not enabled/required in the Address field. * Users will be able to choose the country again in Paypal window or credit card form. * * @param array $data Data for paypal order. * * @return array */ private function get_temporary_country_code($data) { } /** * Get state code * * @param array $data Data for paypal order. * * @return array */ private function get_state_code($data) { } /** * Get default currency * * @return string */ private function get_default_currency() { } /** * Check reCaptcha * * @return string|null * @throws Exception When there is an error. */ private static function check_captcha() { } /** * Check if field is in $hidden_fields array * * @param string $field Field slug excluding the iterator. * * @return bool */ private static function is_in_hidden_fields($field) { } /** * Handle login if it's login form * * @param object $entry Entry. * @return boolean * @throws Exception When there is an error. */ private static function maybe_login($entry) { } /** * Handle registration form validation separately * * @since 1.17.2 * * @return \WP_Error|boolean * @throws Exception When there is an error. */ private static function validate_registration() { } /** * Handle registration if it's registration form. * * @param object $entry Entry. * * @return \WP_Error|boolean * @throws Exception When there is an error. */ private static function maybe_registration($entry) { } /** * Prepare fields info */ private static function prepare_fields_info() { } /** * Set field data array * * @param int $field_index Int key. * @param object $field Forminator_Form_Field_Model. * @return null */ private static function set_field_data_array($field_index, $field) { } /** * Set custom value for radio/select/checkbox fields * * @param mixed $field_array Field settings. * @return void */ private static function maybe_handle_custom_option($field_array) { } /** * Set field data * * @param string $field_id Field slug. * @param array $field_array Field settings. * @param int $field_index Field index. * @param string|null $original_id Original field ID. * * @return null */ private static function set_field_data($field_id, $field_array, $field_index, $original_id = \null) { } /** * Check field has empty value. * * @param array $field Field. * @param mixed $field_data Field value. * * @return bool */ private static function is_empty_field($field, $field_data) { } /** * Stop submission process if it has errors * * @throws Exception When there is an error. */ private static function check_errors() { } /** * Filter field_data_array property * * @throws Exception When there is an error. */ private static function filter_field_data_array() { } /** * Subscriptions payment intent * * @since 1.38 * * @return null|object */ public static function subscription_payment_intent() { } /** * Handle stripe single payment * * @since 1.15 * * @param object $field_object Field object. * @param array $field Field data. * @param object $entry Entry. * @param array $payment_plan Entry. * * @return array|WP_ERROR * @throws Exception When there is an error. */ private static function handle_stripe_subscription($field_object, $field, $entry, $payment_plan) { } /** * Handle stripe single payment * * @since 1.15 * * @param array $field_object Field. * @param array $field Field data. * @param object $entry Entry. * @param string $mode Stripe payment mode. * * @return array|WP_ERROR * @throws Exception When there is an error. */ private static function handle_stripe_single($field_object, $field, $entry, $mode) { } /** * Handle stripe failed response * * @param object $result Stripe result. * @param object $entry Entry object. * * @return array */ public static function handle_failed_stripe_response($result, $entry) { } /** * Handle stripe payments * * @param object $entry Entry. * @return array */ private static function handle_stripe($entry) { } /** * Handle paypal * * @param object $entry Entry. * @return array * @throws Exception When there is an error. */ private static function handle_paypal($entry) { } /** * Handle form * * @since 1.0 * @since 1.1 change superglobal POST to `get_post_data` * @since 1.5.1 utilize `_post_data` which already defined on submit * * @param bool $preview Is preview. * * @return array|bool */ public function handle_form($preview = \false) { } /** * Check abandonment required fields * * @throws Exception When there is an error. */ private static function check_abandonment_required_fields() { } /** * Send email * * @param object $entry Entry. */ private static function send_email($entry) { } /** * Save entry fields * * @param object $entry Entry object. */ private static function save_entry_fields($entry) { } /** * Prepare submitted data to sending to addons * * @param array $current_entry_fields Entry fields. * @return array */ protected static function get_prepared_submitted_data_for_addons($current_entry_fields) { } /** * Get post data fields and replace placeholders in Custom Fields * * @param object|null $entry Form entry object. * @return array */ private static function get_post_data_fields($entry = \null) { } /** * Maybe create post * * @param object|null $entry Form entry object. * @throws Exception When there is an error. */ private static function maybe_create_post($entry = \null) { } /** * Get submission response * * @param object $entry Form entry object. * @return mixed */ private static function get_response($entry) { } /** * Get draft response * * @param object $entry Form entry object. * @return type */ private static function get_draft_response($entry) { } /** * Handle product fields * * @param array $response Response. * @param object $entry Form entry object. */ private static function handle_product_fields($response, $entry) { } /** * Get product field data * * @param string $type Field type. * @return array * @throws Exception When there is an error. */ private static function get_specific_field_data($type) { } /** * Get fields * * @throws Exception When there is an error. */ private static function get_fields() { } /** * Check if submission is possible. * * @throws Exception When there is an error. */ private static function can_submit() { } /** * Check submit button visibility condition after fields data is prepared. * * @since 1.52.0 * * @throws Exception When submit button is hidden by conditions. */ private static function check_submit_visibility() { } /** * Honeypot check * * @return boolean */ private static function is_honeypot() { } /** * Set behavior settings * * @param object $entry Entry. */ private static function set_behaviour_settings($entry) { } /** * Get "Thank you" message * * @param object $custom_form Custom form. * @param array $behavior_options Releavant behavior options. * @param object $entry Entry object. * @return type */ private static function get_thankyou_message($custom_form, $behavior_options, $entry) { } /** * Get submission behavior * * @param array $behavior_options Behavior settings. * @return string */ private static function get_submission_behaviour($behavior_options) { } /** * Get the relevant behavior which will be applied according conditions * * @return array|false Return the relevant behavior or false if no behavior found. */ private static function get_relevant_behavior_options() { } /** * Get select values according limit. * * @return array */ private static function get_limited_select_values() { } /** * Remove a password field. */ private static function remove_password() { } /** * Replace values to labels for radios, selectboxes and checkboxes * * @param array $data Data. * @param array $entry Entry. * @return array */ private static function replace_values_to_labels($data, $entry) { } /** * Multiple File upload for ajax multi-upload */ public function multiple_file_upload() { } /** * Response message * * @since 1.0 * @since 1.1 change superglobal POST to `get_post_data` * @since 1.5.1 utilize `_post_data` which already defined on submit * * @param int $form_id Form Id. * @param int $render_id Render Id. */ public function form_response_message($form_id, $render_id) { } /** * Get invalid form message * * @since 1.0 * * @return mixed */ private static function get_invalid_form_message() { } /** * Executor On form submit for attached addons * * @see Forminator_Integration_Form_Hooks::on_module_submit() * @since 1.1 * * @return bool true on success|string error message from addon otherwise * @throws Exception When there is an error. */ private static function attach_addons_on_form_submit() { } /** * Process stripe charge * * @since 1.7 * @param object $entry Entry. * * @return array * @throws Exception When there is an error. */ private static function stripe_field_to_entry_data_array($entry) { } /** * Process PayPal charge * * @since 1.7 * @param object $entry Entry. * * @return array * @throws Exception When there is an error. */ private static function paypal_field_to_entry_data_array($entry) { } /** * Prepare hidden and visible fields */ public static function check_fields_visibility() { } /** * Add $field_id and its subfields to $hidden_fields array * * @param string $field_id Field slug. * @param string $group_prefix Group prefix. * @param array $field_settings Field settings. */ private static function update_hidden_fields_array($field_id, $group_prefix, $field_settings) { } /** * Check if all dependent fields are already defined * * @param array $dependent_fields Dependent fields. * @param array $visible_fields Visible fields. * @return boolean */ private static function dependencies_not_ready($dependent_fields, $visible_fields) { } /** * Prepare subfields * * @param array $visible_fields Visible fields. * @param array $field_settings Field settings. * @param object $field_object Field object. * @param string $group_prefix Group prefix. */ private static function prepare_subfields($visible_fields, $field_settings, $field_object, $group_prefix = '') { } /** * Maybe replace groupped fields field like {calculation-1-*}, {number-2-*}... to real fields {calculation-1}, {number-1-2} * * @param string $formula Formula. * @return string */ private static function maybe_replace_groupped_fields($formula) { } /** * Pull fields from formula * * @param string $formula Formula. * @return array */ public static function calculator_pull_fields($formula) { } /** * Calculate formula. * * @param string $formula Formula. * @param array $visible_fields Not hidden field values. * @param array $field_settings Field settings. * @return mixed */ public static function calculate_formula($formula, $visible_fields, $field_settings) { } /** * Check if value is in scientific notation * * @param float $value Value. * @return boolean */ private static function is_in_scientific_notation($value) { } /** * Handle captcha field * * @param array $field_settings Field settings. */ private static function handle_captcha_field($field_settings) { } /** * Handle postdata field * * @param array $field_settings Field settings. */ private static function handle_postdata_field($field_settings) { } /** * Handle date field * * @param array $field_settings Field settings. */ private static function handle_date_field($field_settings) { } /** * Handle Time field * * @param array $field_settings Field settings. */ private static function handle_time_field($field_settings) { } /** * Handle url field * * @param array $field_settings Field settings. */ private static function handle_url_field($field_settings) { } /** * Handle upload field * * @param array $field_settings Field settings. */ private static function handle_upload_field($field_settings) { } /** * Check if the native upload payload contains no selected files. * * @since 1.54.0 * * @param mixed $upload_data Upload data. * @return bool */ private static function is_empty_native_upload($upload_data) { } /** * Handle rating field * * @param array $field_settings Field settings. */ private static function handle_rating_field($field_settings) { } /** * Upload or transfer uploads * For single and multiple-on-submit uploads, * we upload directly when form doesnt have any payment fields. * If form has payment fields, uploads go to forminator_temp folder first * so that when there is an error, the uploads in the forminator_temp folder * can be cleared after 24hrs. * * @param string $mode - upload/transfer. */ private static function process_uploads($mode) { } /** * Handle select field * * @param array $field_settings Field settings. */ private static function handle_select_field($field_settings) { } /** * Resolve trusted embed hidden value by default key. * * @param string $default_value Hidden default value key. * @return mixed|null */ private static function get_embed_hidden_value($default_value) { } /** * Apply updated values to hidden-type fields after submission * * @param array $field_settings Field settings. */ private static function handle_hidden_field($field_settings) { } /** * Apply updated values to hidden-type fields after entry is saved * * @param array $entry Entry. * @param int $module_id Module Id. */ private static function handle_hidden_fields_after_entry_save($entry, $module_id = \null) { } /** * Get replaved fields by forminator_replace_form_data method * * @param string $old_value Old value. * @param string $new_value New value. * @return array */ private static function get_replaced_fields($old_value, $new_value) { } /** * Returns what the current field should be replaced to (0 or 1) * * @param string $field_id Field id. * @param string $formula Formula. * @return int 0|1 */ public static function replace_to($field_id, $formula) { } /** * Create new post from postdata field * Add upload file urls to postdata custom fields if necessary * * @param array $postdata_fields Fields with postdata type. * @return array */ public static function create_post_from_postdata($postdata_fields) { } /** * Retrieve the backup code if lost phone. * * @return void */ public function fallback_email() { } /** * Get the first email in submitted data * * @param array $submitted_data Submitted data. * * @since 1.17.0 */ private static function get_first_email($submitted_data) { } /** * Build a draft link URL. * * @param string $draft_id Draft ID. * @param int $page_id WordPress page/post ID where the form is embedded. * * @since 1.54.0 * * @return string The draft link URL. */ public static function get_draft_link($draft_id, $page_id) { } /** * Create draft ID * * @param int $form_id Form Id. * * @since 1.17.0 */ public function create_draft_id($form_id) { } /** * Set the Draft ID */ public function set_entry_draft_id() { } /** * Get draft notification from form notifications * * @param array $notifications Notification. * @param array $data Data. * * @since 1.17.0 */ public function get_draft_notification($notifications, $data) { } /** * Draft link email submission * * @since 1.17.0 */ public function submit_email_draft_link() { } } /** * The Forminator_Assets_Enqueue class. * * @package Forminator */ /** * Class Forminator_Assets_Enqueue * * @since 1.11 */ abstract class Forminator_Assets_Enqueue { /** * Model data * * @var Forminator_Base_Form_Model */ public $model = \null; /** * Is form loaded with AJAX * * @var bool */ public $is_ajax_load = \false; /** * Forminator_Render_Form constructor. * * @param mixed $model Model. * @param bool $is_ajax_load Is ajax load. * * @since 1.11 */ public function __construct($model, $is_ajax_load) { } /** * Return Form Design * * @since 1.0 * @return mixed|string */ public function get_module_design() { } /** * Get CSS upload. * * @param int $id Id. * @param string $type Type. * @param bool $maybe_create Create CSS file if it does not exist. * @return string */ public static function get_css_upload($id, $type = 'url', $maybe_create = \false) { } /** * Return Form Settins * * @since 1.11 * @return mixed */ public function get_settings() { } /** * Enqueue module styles * * @since 1.11 */ public function load_base_styles() { } /** * Load relevant module CSS * * @param bool $force Force loading module CSS in special rendering contexts. */ public function load_module_css($force = \false) { } /** * Load base scripts * * @since 1.11 */ public function load_base_scripts() { } /** * Detect Divi Builder Activation or Preview Mode * * This utility function checks if the Divi Builder is actively used on the current page * or if it is in preview mode. It determines this through the following conditions: * * 1. **Divi Preview Mode Check:** If Divi is in preview mode (detected via query parameters), * the function confirms this by validating the `et_pb_preview_nonce` nonce. If verified, * the function immediately returns `true`, signaling that Divi preview mode is active. * * 2. **Divi Theme Check:** If Divi preview mode is not active, the function checks if the * Divi theme is the currently active theme. If Divi is active as the main theme, the * function returns `false`, as there is no need to load builder-specific assets outside * of preview mode. * * 3. **Divi Builder Plugin Check:** If the Divi theme is not active, the function then checks * if the Divi Builder plugin is active by looking for the `ET_CORE_VERSION` constant and * the `_et_pb_use_builder` meta key set to "on" in the current post's metadata. If both * conditions are met, the function returns `true`, indicating that the Divi Builder plugin * is active on this page. * * @since 1.37 * * @return true|false */ public static function is_divi_active_or_preview() { } /** * Load styles based on builder. * * This function conditionally loads a specific stylesheet depending on whether * the Divi builder is installed and activated. If Divi is detected, the function * modifies the file path to load the Divi-specific stylesheet. * * @since 1.36 * * @param string $name The name of the stylesheet. * @param string $file_path The path to the stylesheet. * @param array $deps An array of dependencies for the stylesheet. Defaults to an empty array. * @param string $version The version number for the stylesheet. Defaults to FORMINATOR_VERSION. * * @return true|WP_Error True on success, WP_Error on failure. */ public static function fui_enqueue_style($name, $file_path, $deps = array(), $version = \FORMINATOR_VERSION) { } } /** * The Forminator_Assets_Enqueue_Form class. * * @package Forminator */ /** * Conditionally load assets class * * @since 1.11 */ class Forminator_Assets_Enqueue_Form extends \Forminator_Assets_Enqueue { /** * Module slug * * @var string */ protected static $module_slug = 'form'; /** * Enqueue form styles * * @param object $render_obj Forminator_CForm_Front object. * @since 1.11 */ public function enqueue_styles($render_obj) { } /** * Enqueue form scripts * * @param mixed $render_obj Render Object. * * @since 1.11 */ public function enqueue_scripts($render_obj) { } /** * Load base styles and scripts * * @since 1.11 */ public function load_base_styles() { } /** * Load full styles * * @param object $render_obj Forminator_CForm_Front object. */ public function load_full_styles($render_obj) { } /** * Load slider field scripts */ public static function load_slider_scripts() { } /** * Load date field scripts * * @since 1.11 */ public function load_date_scripts() { } /** * Get date-picker data for using in JS * * @return array */ private static function get_datepicker_data() { } /** * Load phone field scripts conditionally * * @since 1.11 */ private function load_phone_scripts() { } /** * Load DOMPurify script for HTML field * * @return void */ public static function load_dompurify_scripts() { } /** * Load calculation,currency and number field scripts mask * * @since 1.11 */ private function load_number_scripts() { } /** * Load styles and scripts for fields with select element. * * @param mixed $render_obj Render object. * * @since 1.14.10 */ public function load_select_styles($render_obj) { } /** * Load select scripts. * * @param mixed $render_obj Render object. */ public function load_select_scripts($render_obj) { } } /** * The Forminator_CForm_Front_Mail class. * * @package Forminator */ /** * Front ajax for custom forms * * @since 1.0 */ class Forminator_CForm_Front_Mail extends \Forminator_Mail { /** * Module slug * * @var string */ protected static $module_slug = 'form'; /** * Skipped custom form_data parsing * * @since 1.0.3 * @var array */ private $skip_custom_form_data = array('admin' => array(), 'user' => array()); /** * Replace all placeholders for mail properties * * @param array $settings Settings. * @param string $option_name Current option name. * @param object $module Module. * @param object $entry Saved entry. * @param bool $full_mode Use full mode or not. * @param bool $is_email_recipient Is email recipient or not. * @return string */ private function replace_placeholders($settings, $option_name, $module, $entry, $full_mode = \false, $is_email_recipient = \false) { } /** * Format repeated field values with commas for email recipients. * * @param string $formatted_string The formatted string with repeated field values. * @param array $field_values The original field values. * @return string The formatted string with repeated field values separated by commas. */ public static function format_repeated_field_values_with_commas($formatted_string, $field_values) { } /** * Get files for email sending. * * @param object $custom_form Module. * @param object $entry Saved entry. * @return array */ private function get_files($custom_form, $entry) { } /** * Maybe add files * * @param array $files All files. * @param object $form_field Form fields. * @param object $entry Entry. * @return array */ private static function add_field_files($files, $form_field, $entry) { } /** * Check if attachments exceed size limit. * * @since 1.52.0 * * @param array $files Files to check. * @return bool */ private function is_attachment_size_limit_exceeded($files) { } /** * Process mail * * @since 1.0 * * @param Forminator_Form_Model $custom_form Form model. * @param Forminator_Form_Entry_Model $entry - saved entry @since 1.0.3. * @param array $submitted_data - submitted data from email draft form @since 1.17.0. */ public function process_mail($custom_form, \Forminator_Form_Entry_Model $entry, $submitted_data = array()) { } /** * Prepare headers. * * @param array $notification Settings. * @param object $custom_form Module. * @param array $data Submitted data. * @param object $entry Saved entry. * @return array */ private function prepare_headers($notification, $custom_form, $data, $entry) { } /** * Get user email from data * * @since 1.0.3 * * @param int $data Data. * @param Forminator_Form_Model $custom_form Form model. * * @return bool|string */ public function get_user_email_data($data, $custom_form) { } /** * Get user email * * @since 1.0.3 * * @param int $data Data. * @param Forminator_Form_Model $custom_form Form model. * * @return bool */ public function get_user_email($data, $custom_form) { } /** * Set Sender Email * * @since 1.1 * * @param string $email - email address. */ public function set_sender_email($email) { } /** * Set Sender Name * * @since 1.1 * * @param string $name - sender name. */ public function set_sender_name($name) { } /** * Get Recipient * * @param string $recipient Recipient. * @param mixed $custom_form Custom form. * @param mixed $entry Entry. * @param mixed $lead_model Lead model. * * @return string */ public function get_recipient($recipient, $custom_form, $entry, $lead_model) { } /** * Check if all conditions are met to send user email * * @since 1.0 * * @param array $setting - the form settings. * * @return bool */ public function send_user_mail($setting) { } /** * Get Recipients of user emails * * @since 1.6 * * @param array $data submitted data. * @param Forminator_Form_Model $custom_form Form model. * @param Forminator_Form_Entry_Model $entry Entry model. * * @return array */ public function get_user_email_recipients($data, $custom_form, $entry) { } /** * Check if Field is hidden based on conditions property and POST-ed data * * @since 1.0 * * @param array $notification Notification. * * @return bool */ public function is_condition($notification) { } /** * Check if notification is routing * * @since 1.0 * * @param array $condition Condition. * @param mixed $module Module. * @param string $result_slug Result slug. * * @return bool */ public function is_routing($condition, $module, $result_slug = '') { } /** * Remove Stripe quantity if payment_type is single/One time * * @since 1.19.0 * * @param object $entry Forminator_Form_Entry_Model. * * @return Forminator_Form_Entry_Model */ public function maybe_remove_stripe_quantity($entry) { } } /** * The Forminator_Render_Form class. * * @package Forminator */ /** * Class Forminator_Render_Form * * @since 1.0 */ abstract class Forminator_Render_Form { /** * Class instance * * @var Forminator_Render_Form|null */ protected static $instance = \null; /** * Forms properties * * @var array */ protected $forms_properties = array(); /** * Styles to be enqueued * * @var array */ protected $styles = array(); /** * Scripts to be enqueued * * @var array */ protected $scripts = array(); /** * Script to be printed * * @var array */ protected $script = ''; /** * Model data * * @var Forminator_Base_Form_Model */ public $model = \null; /** * Checks if is admin * * @var bool */ protected $is_admin = \false; /** * Track Views * * @var bool */ protected $track_views = \true; /** * Mapper form with its instance, handling multiple same form rendered * * @var array */ protected static $render_ids = array(); /** * Checks if is preview * * @var bool */ protected $is_preview = \false; /** * Whether the current render is running in Breakdance SSR preview. * * @var bool */ protected $is_breakdance_ssr_preview = \false; /** * Breakdance preview-only style handles collected during enqueue. * * @var array */ protected $breakdance_preview_style_handles = array(); /** * Last submitted data * useful when rendering via ajax and need older data for markup * * @since 1.6.1 * @var array */ protected $last_submitted_data = array(); /** * Original wp http referer * When ajax load enabled wp_http_referer is replaced with admin-ajax * This var will make it persistent for next render * * @since 1.6.2 * @var string */ protected $_wp_http_referer = ''; /** * Original page_id * When ajax load enabled page_id cant be found * This var will make it persistent for next render * * @since 1.6.2 * @var int */ protected $_page_id = 0; /** * Draft Id * * @var string */ protected $draft_id = ''; /** * Draft data * * @var array */ public $draft_data = array(); /** * Unique Id * * @var string */ public static $uid = ''; /** * Return class instance * * @since 1.0 * @return Forminator_Render_Form */ public static function get_instance() { } /** * Forminator_Render_Form constructor. * * @since 1.0 */ public function __construct() { } /** * Init method * * @since 1.0 */ public function init() { } /** * Render shortcode * * @since 1.0 * * @param array $atts Attributes. * * @return string */ public function render_shortcode($atts = array()) { } /** * Display form method * Must be implemented by class that extend it * * @since 1.0 * * @param int $id Id. * @param bool $is_preview Is preview. * * @return mixed */ abstract public function display($id, $is_preview = \false); /** * Generate render_id for current form * represented as integer, start from 0 * * @param int $id Module id. * @param ?int $forced_render_id Optional. The render id to force for module id. */ public function generate_render_id($id, $forced_render_id = \null) { } /** * Render form markup * * @since 1.0 * * @param int $id Id. * @param bool $hide If true, display: none will be added on the form markup and later removed with JS. * @param bool $is_preview Is preview. * @param int $render_id Render Id. */ public function render($id, $hide = \true, $is_preview = \false, $render_id = 0) { } /** * Maybe wrap description * * @param string $html HTML. * @param string $description Description. * @param string $id ID. * @param string $descr_position Description position. * * @return string */ public function maybe_wrap_description($html, $description, $id, $descr_position) { } /** * Return form markup * * @since 1.0 * * @param int $id Id. * @param bool $render Render. * @param bool $hide Hide. * @param int $render_id_ajax Render id. * * @return mixed|void */ public function get_form($id, $render = \true, $hide = \true, $render_id_ajax = 0) { } /** * Refresh nonce to avoid static cache */ private function add_script_for_refresh_nonce() { } /** * Return form placeholder markup * * @since 1.6.1 * * @param int $id Id. * @param bool $render Render. * * @return mixed|void */ public function get_form_placeholder($id, $render = \true) { } /** * Get Additional CSS class to be aplied based on fields style (enclosed or not) * * @since 1.0.5 * @return string */ public function get_fields_type_class() { } /** * Get Additional CSS class to be aplied based on get_form_design * * @since 1.0.5 * @return string */ public function get_form_design_class() { } /** * Return form submit button markup * * @since 1.0 * * @param int $form_id Form Id. * @param bool $render Render. * * @return mixed|void */ public function get_submit($form_id, $render = \true) { } /** * Return button markup * * @since 1.0 * @return mixed */ public function get_button_markup() { } /** * Submit button text * * @since 1.0 * @return string */ public function get_submit_button_text() { } /** * Start button text * * @param array $settings Module settings. * @return string */ public function get_start_button_text($settings = \null) { } /** * Return Form ID required message * * @since 1.0 * @return mixed */ public function message_required() { } /** * Return Module ID not found message * * @since 1.0 * @return string */ public function message_not_found() { } /** * Get module ID * * @since 1.11 * * @return string */ public function get_module_id() { } /** * Check if form should be displayed * * @since 1.6.1 * * @param bool $is_preview Is preview. * * @return bool */ public function is_displayable($is_preview) { } /** * Ajax submit * Check if the form is ajax submit * * @since 1.0 * @return bool */ public function is_ajax_submit() { } /** * Return styles template path * * @param string $theme Theme. * * @since 1.0 * @return bool|string */ public function styles_template_path($theme) { } /** * Get specific template if exists, otherwise get global one * * @param string $theme Design theme. * @param string $filename Filename. * @return string */ public static function get_template($theme, $filename) { } /** * Get Properties styles of each rendered modules * * @return array */ public function get_styles_properties() { } /** * Get custom CSS. * * @param array $properties Module properties. * @return string */ protected static function get_custom_css($properties) { } /** * Initiate `forminatorFront` front javascript for rendered module(s) * * @since 1.0 */ public function forminator_render_front_scripts() { } /** * Return form fields * * @since 1.0 * @return array */ public function get_fields() { } /** * Return form fields markup * * @since 1.0 * * @param bool $render Render. * * @return mixed|void */ public function render_fields($render = \true) { } /** * Return referer url field markup * * @since ? * * @param bool $render Render. * * @return string|void */ public function referer_url_field($render = \true) { } /** * Return field classes * * @since 1.0 * * @param array $field Field. * * @return string */ public function get_classes( /* @noinspection PhpUnusedParameterInspection */ $field ) { } /** * Return markup before field * * @since 1.0 * * @param array $field Field. * * @return mixed */ public function render_field_before($field) { } /** * Return markup after field * * @since 1.0 * * @param array $field Field. * * @return mixed */ public function render_field_after($field) { } /** * Return sanitized form data * * @since 1.0 * * @param string $content Content. * * @return mixed */ public function sanitize_output($content) { } /** * Return field markup * * @since 1.0 * * @param array $field Field. * * @return mixed|void */ public function render_field($field) { } /** * Return form settings * * @since 1.0 * @return array */ public function get_form_settings() { } /** * Check has lead * * @param array $form_settings Form settings. * * @return bool */ public function has_lead($form_settings = \null) { } /** * Check has lead * * @param array $form_settings Form settings. * * @return bool */ public function has_skip_form($form_settings = \null) { } /** * Check has lead * * @param array|null $form_settings Form settings. * * @return bool */ public function get_leads_id($form_settings = \null) { } /** * Check has lead * * @param array|null $form_settings Form settings. * @return bool */ public function get_form_placement($form_settings = \null) { } /** * Return field ID * * @since 1.0 * * @param array $field Field. * * @return string */ public function get_field_id($field) { } /** * Return post ID * * @since 1.0 * @return int|string|bool */ public function get_post_id() { } /** * Return form type * * @since 1.0 * @return string */ public function get_form_type() { } /** * Return form design * * @since 1.0 * @return string */ public function get_form_design() { } /** * Return fields style * * @since 1.0 * @return string */ public function get_fields_style() { } /** * Render form header * * @param string $maybe_error Error message. * * @since 1.0 */ public function render_form_header($maybe_error = '') { } /** * Render form header * * @since 1.0 */ public function render_form_authentication() { } /** * Form enctype * * @since 1.0 * @return string */ public function form_enctype() { } /** * Form extra classes * * @since 1.0 */ public function form_extra_classes() { } /** * Check if can track views * * @since 1.0 * @return bool */ public function can_track_views() { } /** * Define cache constants * * @since 1.6.1 */ public function maybe_define_cache_constants() { } /** * Get load ajax status * * @since 1.6.1 * * @param bool $force Force. * @param int $quiz_id Quiz ID - uses only for Form Lead. * * @return bool */ public function is_ajax_load($force = \false, $quiz_id = \null) { } /** * Set Breakdance SSR preview flag for the current render. * * @param bool $is_preview Is preview. * * @return void */ protected function set_breakdance_ssr_preview($is_preview) { } /** * Render stylesheet link tags for Breakdance SSR preview. * * @return string */ protected function get_breakdance_preview_styles_html() { } /** * Render Breakdance SSR preview markup in the required order. * * Order matters here: print the captured styles and inline styles first, * then output the HTML and front scripts for the preview response. * * @param string $html HTML markup to output. * @param bool $is_preview Is preview. * * @return void */ protected function render_breakdance_ssr_preview_markup($html, $is_preview) { } /** * Capture the style handles added during Breakdance SSR preview asset enqueue. * * @param array $before_style_handles Style handles queued before enqueue. * * @return void */ protected function set_breakdance_preview_style_handles($before_style_handles) { } /** * Script loader module via ajax * * @since 1.6.1 * * @param bool $is_preview Is preview. * @param array $preview_data Preview data. * @param array $lead_data Lead data. * @param array $is_block_editor Is block editor. */ public function ajax_loader($is_preview, $preview_data = array(), $lead_data = array(), $is_block_editor = \false) { } /** * Ajax handler to load module * * @since 1.6.1 */ public static function ajax_load_module() { } /** * Update live preview */ public static function update_live_preview() { } /** * Get Front class based on module post type * * @param string $type Post type. * @return string */ public static function get_front_class($type) { } /** * Ajax response for displaying module * * @since 1.6.1 * @since 1.6.2 add $extra args * * @param int $id Id. * @param bool $is_preview Is preview. * @param bool $data Data. * @param bool $hide Hide. * @param array $last_submit_data Last submit data. * @param array $extra extra config to display. * @param int $quiz_id Quiz Id. * @param int $render_id Optional. The render id to force for module. * * @return array */ public function ajax_display($id, $is_preview = \false, $data = \false, $hide = \true, $last_submit_data = array(), $extra = array(), $quiz_id = 0, $render_id = 0) { } /** * Return front-end styles * * @param obj|null $model Model obj. * @param bool $echo_styles Optional. Echo or return. * @return string */ public function generate_styles($model = \null, $echo_styles = \true) { } /** * Generate CSS file. * * @param int $id Module ID. */ public static function regenerate_css_file($id) { } /** * Return font specific front-end styles * * @since 1.0 */ public function print_styles() { } /** * Generate nonce field * Respect _wp_http_referer to avoid being replaced when ajax load enabled * * @since 1.6.2 * * @param string $action Action. * @param string $name Name. * @param string $referer_url Optional. Referer URL. * * @return string */ protected function nonce_field($action, $name, $referer_url = '') { } /** * Returns the render id of a given module. * * @since 1.15.12 * * @param int $module_id Optional. Module id. * * @return int The render id. */ public static function get_render_id($module_id = \null) { } /** * Returns all render ids of runtime. * * @since 1.15.12 * * @return array A list which contains all render ids. */ public static function get_render_ids() { } /** * Set draft_data * * @param bool $is_draft_enabled Is draft enabled. * * @since 1.17.0 * * @return string */ public function set_draft_data($is_draft_enabled) { } /** * Get draft page from entry data * * @since 1.17.0 * * @return string */ public function get_draft_page() { } /** * Get abandonment required fields * * @return string */ public function get_abandonment_required_fields() { } /** * Create edit form button * * @since 1.17.0 * * @param int $module_id Module Id. * @param string $module_type Module type. * @param bool $is_preview Is preview. * * @return string */ public function edit_module_link($module_id, $module_type, $is_preview = \false) { } } /** * The Forminator_CForm_Front class. * * @package Forminator */ /** * Front render class for custom forms * * @since 1.0 */ class Forminator_CForm_Front extends \Forminator_Render_Form { /** * Module slug * * @var string */ protected static $module_slug = 'form'; /** * Forminator_PayPal_Express * * @var null|Forminator_PayPal_Express */ private static $paypal = \null; /** * Paypal forms * * @var array */ private static $paypal_forms = array(); /** * Inline rules * * @var string */ private $inline_rules = ''; /** * Inline messages * * @var string */ private $inline_messages = ''; /** * All wrappers * * @var array */ public static $all_wrappers = array(); /** * Parent groups * * @var array */ private $parent_groups; /** * Model data * * @var Forminator_Form_Model */ public $lead_model = \null; /** * Load wp_enqueue_editor or not * * @var bool */ public static $load_wp_enqueue_editor = \false; /** * Return class instance * * @since 1.0 * @return Forminator_CForm_Front */ public static function get_instance() { } /** * Render Breakdance SSR preview in the required order. * * Order matters here: enqueue assets first so we can capture style handles, * print the collected styles and inline styles next, then output the HTML. * * @param bool $hide If true, display: none will be added on the form markup. * @param bool $is_preview Is preview. * @param int $render_id Render ID. * * @return void */ private function render_breakdance_ssr_preview($hide, $is_preview, $render_id) { } /** * Enqueue Breakdance SSR preview assets and collect the generated style handles. * * @param bool $is_preview Is preview. * * @return void */ private function enqueue_breakdance_ssr_preview_assets($is_preview) { } /** * Whether font key should be applied to the current form or not. * * @param string $font_setting_key Font settings key. * @return bool */ private function has($font_setting_key) { } /** * Display form method * * @since 1.0 * * @param int $id Id. * @param bool $is_preview Is preview. * @param bool $data Data. * @param bool $hide If true, display: none will be added on the form markup and later removed with JS. * @param array $quiz_model Quiz model. */ public function display($id, $is_preview = \false, $data = \false, $hide = \true, $quiz_model = \null) { } /** * Header message to handle error message * * @param string $maybe_error Error message. * * @since 1.0 */ public function render_form_header($maybe_error = '') { } /** * Footer handle * * @since 1.12 */ public function render_form_authentication() { } /** * Enqueue form scripts * * @since 1.0 * * @param bool $is_preview Is preview. * @param bool $is_ajax_load Is ajax load. */ public function enqueue_form_scripts($is_preview, $is_ajax_load = \false) { } /** * Enqueue form assets for the current rendering mode. * * @param bool $is_preview Is preview. * @param bool $is_ajax_load Is ajax load. * * @return Forminator_Assets_Enqueue_Form */ private function enqueue_form_assets($is_preview, $is_ajax_load) { } /** * Load jQuery ui styles for fields for None and basic design style. * * @param bool $is_ajax_load Is it loading via AJAX. **/ private function load_jquery_styles(bool $is_ajax_load): void { } /** * PayPal Script url parameters * * @param string $script Script URL. * * @return string */ public function paypal_script_argument($script) { } /** * Return form wrappers & fields * * @since 1.0 * @return array|mixed */ public function get_wrappers() { } /** * Return form wrappers & fields * * @since 1.0 * @return array|mixed */ public function get_fields() { } /** * Get submit field * * @since 1.6 * * @return array */ public function get_submit_field() { } /** * Get Pagination field * * @since 1.6 * * @return array */ public function get_pagination_field() { } /** * Return before wrapper markup * * @since 1.0 * * @param array $wrapper Wrapper. * * @return mixed */ public function render_wrapper_before($wrapper) { } /** * Return after wrapper markup * * @since 1.0 * * @param array $wrapper Wrapper. * * @return mixed */ public function render_wrapper_after($wrapper) { } /** * Extra form classes for ajax * * @since 1.0 */ public function form_extra_classes() { } /** * Return true if we have only hidden field in the row * * @param array $wrapper Wrapper. * * @since 1.7 * @return bool */ public function is_only_hidden($wrapper) { } /** * Get filtered wrappers by group. If group ID is empty - it returns ungrouped wrappers * * @param string $group_id Group ID. * @return array */ public static function get_grouped_wrappers($group_id = '') { } /** * Return fields markup * * @since 1.0 * * @param bool $render Render. * * @return string|void */ public function render_fields($render = \true) { } /** * Render wrappers with fields * * @param array $wrappers Wrappers with fields. * @param array $pagination_fields Pagination fields. * @return string */ public function render_wrappers($wrappers, $pagination_fields = array()) { } /** * Return if the row is pagination * * @since 1.0 * * @param array $wrapper Wrapper. * * @return bool */ public function is_pagination_row($wrapper) { } /** * Return if only single field in the wrapper * * @since 1.0 * * @param array $wrapper Wrapper. * * @return bool */ public function is_single_field($wrapper) { } /** * Return pagination header * * @since 1.0 * @return string */ public function pagination_header() { } /** * Return pagination start markup * * @param array $element Element. * * @since 1.0 * @return string */ public function pagination_start($element = array()) { } /** * Get Pagination Properties as array * * @since 1.1 * * @return array */ public function get_pagination_properties() { } /** * Get paypal Properties as array * * @since 1.1 * * @return array */ public function get_paypal_properties() { } /** * Return pagination content start markup * * @since 1.0 * @return string */ public function pagination_content_start() { } /** * Return pagination content end markup * * @since 1.0 * @return string */ public function pagination_content_end() { } /** * Return submit field custom class * * @since 1.6 * @return mixed */ public function get_submit_custom_clas() { } /** * Return pagination submit button markup * * @since 1.0 * @return string */ public function pagination_submit_button() { } /** * Return pagination end markup * * @since 1.0 * @return string */ public function pagination_end() { } /** * Return pagination start markup * * @since 1.0 * * @param array $field Field. * @param array $pagination Pagination. * @param string $step Step number. * * @return string */ public function pagination_step($field, $pagination, $step) { } /** * Return field markup * * @since 1.0 * @since 1.17.0 Add draft_value parameter * * @param array $field Field. * * @return mixed */ public function get_field($field) { } /** * Check if field is invisible * * @param mixed $field Form Field. * @return bool */ private function is_invisible_field($field) { } /** * Check if all fields are invisible. * * @param mixed $fields Form Fields. * @return bool */ private function is_only_invisible_field($fields) { } /** * Return field markup * * @since 1.0 * @since 1.17.0 Add draft_value parameter * * @param array $field Field. * * @return mixed */ public function render_field($field) { } /** * Return field ID * * @since 1.0 * * @param array $field Field. * * @return string */ public function get_id($field) { } /** * Return field columns * * @since 1.0 * * @param array $field Field. * * @return string */ public function get_cols($field) { } /** * Return field type * * @since 1.0 * * @param array $field Field. * * @return mixed */ public function get_field_type($field) { } /** * Return placeholder * * @since 1.0 * * @param array $field Field. * * @return mixed */ public function get_placeholder($field) { } /** * Return field label * * @since 1.0 * * @param array $field Field. * * @return mixed */ public function get_field_label($field) { } /** * Return description markup * * @since 1.0 * * @param array $field Field. * * @return mixed */ public function get_description($field) { } /** * Return field before markup * * @since 1.0 * * @param array $field Field. * * @return mixed */ public function render_field_before($field) { } /** * Return field after markup * * @since 1.0 * * @param array $field Field. * * @return mixed */ public function render_field_after($field) { } /** * Return Form Settins * * @since 1.0 * @return mixed */ public function get_form_settings() { } /** * Return if hidden field * * @since 1.0 * * @param array $field Field. * * @return mixed */ public static function is_hidden($field) { } /** * Return Form Design * * @since 1.0 * @return mixed|string */ public function get_form_design() { } /** * Return fields style * * @since 1.0 * @return mixed */ public function get_fields_style() { } /** * Check if honeypot protection is enabled * * @since 1.0 * @return bool */ public function is_honeypot_enabled() { } /** * Check if form has a captcha field * * @since 1.0 * @return bool */ public function has_captcha() { } /** * Check if form has a recaptcha field * * @since 1.15.5 * @return bool */ public function is_recaptcha() { } /** * Check if form has Cloudflare turnstile captcha. * * @return bool */ public function is_turnstile() { } /** * Check if form has a date field * * @since 1.0 * @return bool */ public function has_date() { } /** * Check if form has a date field * * @since 1.0 * @return bool */ public function has_upload() { } /** * Check if form has a pagination field * * @since 1.0 * @return bool */ public function has_pagination() { } /** * Return if field is pagination * * @since 1.0 * * @param array $field Field. * * @return bool */ public function is_pagination($field) { } /** * Return if field is paypal * * @since 1.0 * * @param array $field Field. * * @return bool */ public function is_paypal($field) { } /** * Return field classes * * @since 1.0 * * @param array $field Field. * * @return string */ public function get_classes($field) { } /** * Return fields conditions for JS * * @since 1.0 * * @param array $id Id. * * @return mixed */ public function get_relations($id) { } /** * Compare element_id with precision elements * * @since 1.13 * * @param string $element_id Element Id. * * @return bool */ public function compare_element_id_with_precision_elements($element_id) { } /** * Change condition value with specified precision * * @since 1.13 * * @param string $condition_value Condition value. * @param array $field Field. * * @return string */ public function change_condition_value_with_precision($condition_value, $field) { } /** * Return fields conditions for JS * * @since 1.0 * @return mixed */ public function get_conditions() { } /** * Get parent group * * @param array $fields Fields. * @param string $field_id Field slug. * @return string */ private function get_parent_group($fields, $field_id) { } /** * Get parent groups for all fields * * @param array $fields Fields. * @return array */ private function get_parent_groups($fields) { } /** * Check field is conditional * * @since 1.0 * * @param array $field Field. * * @return bool */ public function is_conditional($field) { } /** * Set the form encryption type if there is an upload * * @since 1.0 * @return string */ public function form_enctype() { } /** * Has paypal * * @since 1.0 * @return bool */ public function has_paypal() { } /** * Return button markup * * @since 1.6 * @return mixed */ public function get_button_markup() { } /** * PayPal button markup * * @since 1.0 * * @param int $form_id Form Id. * * @return mixed */ public function get_paypal_button_markup($form_id) { } /** * Return form submit button markup * * @since 1.0 * * @param int $form_id Form Id. * @param bool $render Render. * @param int $render_id Render Id. * * @return mixed|void */ public function get_submit($form_id, $render = \true, $render_id = 0) { } /** * Submit button text * * @since 1.0 * @return string */ public function get_submit_button_text() { } /** * Return custom submit button text * * @since 1.0 * @return string */ public function get_custom_submit_text() { } /** * Return if custom submit button text * * @since 1.0 * @return bool */ public function has_custom_submit_text() { } /** * Render honeypot field * * @since 1.0 * * @param string $html - the button html. * @param int $form_id - the current form id. * @param int $post_id - the current post id. * @param string $nonce - the nonce field. * * @return string $html */ public function render_honeypot_field( $html, $form_id, /* @noinspection PhpUnusedParameterInspection */ $post_id, /* @noinspection PhpUnusedParameterInspection */ $nonce ) { } /** * Get CSS prefix * * @param string $prefix Default prefix. * @param array $properties CSS properties. * @param string $slug Slug. * @return string */ protected static function get_css_prefix($prefix, $properties, $slug) { } /** * Get PayPal field properties * * @since 1.7.1 * * @return array */ public function get_pp_field_properties() { } /** * Return if form pagination has header * * @since 1.0 * @return bool */ public function has_pagination_header() { } /** * Get pagination type * * @since 1.1 * @return string */ public function get_pagination_type() { } /** * Prints Javascript required for each form with PayPal * * @since 1.0 */ public function print_paypal_scripts() { } /** * Defines translatable strings to pass to datepicker * Add other strings if required * * @since 1.0.5 */ public function get_strings_for_calendar() { } /** * Return if form use google font * * @since 1.0 * @since 1.2 Deprecate function * @return bool */ public function has_google_font() { } /** * Return google font * * @since 1.0 * @since 1.2 Deprecated Function * @return string */ public function get_google_font() { } /** * Return if form use inline validation * * @since 1.0 * @return bool */ public function has_inline_validation() { } /** * Render Front Script * * @since 1.0 * @since 1.1 add pagination properties on `window` */ public function forminator_render_front_scripts() { } /** * Render Front-end behavior Script * * @since 1.39 */ public function forminator_render_front_submission_behavior_scripts() { } /** * Get Output of addons after_render_form * * @since 1.1 * @return string */ public function do_after_render_form_for_addons() { } /** * Get Output of addons before render form fields * * @since 1.1 * @return string */ public function do_before_render_form_fields_for_addons() { } /** * Get Output of addons after render form fields * * @since 1.1 * @return string */ public function do_after_render_form_fields_for_addons() { } /** * Get Google Fonts setup on a form * * @since 1.2 * @return array */ public function get_google_fonts() { } /** * Check if field with type exist on a form, and check if its setting match * * @since 1.2 * * @param string $field_type Field type. * @param string|null $setting_name Setting name. * @param string|null $setting_value Setting value. * * @return bool */ public function has_field_type_with_setting_value($field_type, $setting_name = \null, $setting_value = \null) { } /** * Find last captcha * * @since 1.6 * @return array|bool */ public function find_first_captcha() { } /** * Get forminatorFront js init options to be passed * * @since 1.6.1 * * @param array $form_properties Form properties. * * @return array */ public function get_front_init_options($form_properties) { } /** * Return calculations time in ms * * @since 1.11 * * @return mixed */ public function get_memoize_time() { } /** * Return if form reset after submit is enabled * * @since 1.12 * * @return mixed */ public function is_reset_enabled() { } /** * Return if form has submission loader enabled * * @param array $properties Properties. * * @since 1.7.1 * * @return bool */ public function form_has_loader($properties) { } /** * Return loader label * * @param array $properties Properties. * * @since 1.7.1 * * @return mixed */ public function get_loader_label($properties) { } /** * Set options to Model object. * * @param object $form_model Model. * @param array $data Data. * @return object */ protected function set_form_model_data($form_model, $data) { } /** * Html markup of form * * @since 1.6.1 * * @param bool $hide Hide. * @param bool $is_preview Is preview. * @param int $render_id Render Id. * * @return false|string */ public function get_html($hide = \true, $is_preview = \false, $render_id = 0) { } /** * Set module properties * * @param int|null $render_id Render Id. */ protected function set_forms_properties($render_id = \null) { } /** * Check if form has a phone field * * @since 1.6.1 * @return bool */ public function has_phone() { } /** * Check if form has a postdata field * * @since 1.6.1 * @return bool */ public function has_postdata() { } /** * Check if form has a stripe field * * @since 1.7 * @return bool */ public function has_stripe() { } /** * Get stripe settings * * @return array|bool */ public function get_stripe_settings() { } /** * Is form has a group field with enabled repeater option? * * @return bool */ private function has_repeater() { } /** * Check if form has a editor field * * @since 1.7 * @return bool */ public function has_editor() { } /** * Check if form given field type * * @param string $type Field type. * * @since 1.14 * @return bool */ public function has_field_type($type) { } /** * Check login form * * @return bool */ public function is_login_form() { } /** * Render a message if form is hidden * * @since 1.11 * * @param string $hidden_form_message Message. * * @return string */ public function render_hidden_form_message($hidden_form_message) { } /** * Check if Custom form has upload field * * @since 1.7 * @return bool */ public function has_multiupload() { } /** * Get lead skip text * * @param array $form_settings Form settings. * * @return bool */ public function get_skip_text($form_settings) { } /** * Render skip form content * * @return string */ public function render_skip_form_content() { } /** * Check if form has a formatting field * * @since 1.15.1 * @return bool */ public function has_formatting() { } /** * Get 2FA provider * * @return array[] */ public function get_2FA_poviders() { } /** * Get Save draft button * * @param array $form_settings Form settings. * * @return string */ public function get_save_draft_button($form_settings) { } } /** * Front user class for custom login forms * * @since 1.11 */ class Forminator_CForm_Front_User_Login extends \Forminator_User { /** * Remember cookie number * * @var int */ protected $remember_cookie_number; /** * Remember cookie type * * @var string */ protected $remember_cookie_type; /** * Form settings * * @var array */ public $settings; /** * Forminator_CForm_Front_User_Login constructor */ public function __construct() { } /** * Change cookie expiration * * @param int $expiration Expiration. * @param int $user_id User Id. * @param bool $remember Remember. * * @return int */ public function change_cookie_expiration($expiration, $user_id, $remember) { } /** * Is "Remember Me" submitted? * * @return bool */ private function is_submitted_remember_me() { } /** * Process login * * @param object $custom_form Custom form. * @param Forminator_Form_Entry_Model $entry Form Entry model. * @param array $field_data_array Field data. * * @return array */ public function process_login($custom_form, \Forminator_Form_Entry_Model $entry, $field_data_array) { } /** * Redirect page if form is submitted through ajax and defender Pwned passwords is enabled * * @since 1.15.1 * * @param string $url URL. * @param string $action Action. */ public function force_change_password($url, $action) { } /** * Get element ID for "Remember Me". There may be several checkboxes in the form. * "Remember Me" is the last form field. Before the submit button. * * @param Forminator_Form_Model $custom_form Form model. * * @return int */ public static function get_element_id_for_remember_me($custom_form) { } /** * Show/Hide the field Remember Me * * @param array $wrappers Wrappers. * @param int $id Id. * * @return array */ public static function render_fields($wrappers, $id) { } /** * Show 2FA Nav * * @param array $providers Providers. * * @return string */ public function forminator_show_2fa_nav($providers) { } } /** * Front user class for custom registration forms * * @since 1.11 */ class Forminator_CForm_Front_User_Registration extends \Forminator_User { /** * User data * * @var array */ private $user_data = array(); /** * Mail sender * * @var string */ private $mail_sender; /** * Forminator_CForm_Front_User_Registration constructor */ public function __construct() { } /** * Change submitted data * * @param string $value Field value. * @param array $custom_form Custom form. * @param string $column_name Column name. * @param array $data Data. * * @return string */ public function change_field_value($value, $custom_form, $column_name, $data) { } /** * Check activation method * * @param string $method Method. * * @return bool */ private function check_activation_method($method) { } /** * Show submit_errors * * @param string $submit_errors Error message. * @param int $form_id Form Id. * @param array $field_data_array Field data. * * @return bool|string */ public function submit_errors($submit_errors, $form_id, $field_data_array) { } /** * Change submitted data * * @param string $new_value New value. */ public function change_submitted_data($new_value) { } /** * Handle activation user * * @param array $user_data User data. * @param array $custom_form Custom form. * @param Forminator_Form_Entry_Model $entry Form entry model. * * @return bool|void */ public function handle_user_activation($user_data, $custom_form, $entry) { } /** * Create user * * @param array $new_user_data New user data. * @param array $custom_form Custom form. * @param Forminator_Form_Entry_Model $entry Form entry model. * @param bool $is_user_signon Is user sign-on. * * @return int|string|void|WP_Error */ public function create_user($new_user_data, $custom_form, $entry, $is_user_signon = \false) { } /** * Check a pending activation for the specified user_login or user_email. * * @param string $key user_login or user_email. * @param string $value Value. * * @return bool */ public function pending_activation_exists($key, $value) { } /** * Validate registration mapping data * * @param object $custom_form Custom form. * @param array $field_data_array Field data. * @param bool $is_approve Is approve. * * @return array */ public function validate($custom_form, $field_data_array, $is_approve = \false) { } /** * Process validation * * @param Forminator_Form_Model $custom_form Custom form. * @param array $field_data_array Field data. * * @return array|mixed */ public function process_validation($custom_form, $field_data_array) { } /** * Process registration * * @param Forminator_Form_Model $custom_form Form model. * @param Forminator_Form_Entry_Model $entry Form Entry model. * * @return array|mixed */ public function process_registration($custom_form, \Forminator_Form_Entry_Model $entry) { } /** * Validation for email fields * * @param string $email Email. * * @return array */ private function validate_email($email) { } /** * Validation for username fields * * @param string $username User name. * * @return array */ private function validate_username($username) { } /** * Automatic login * * @param int $user_id User Id. * @return void */ private function automatic_login($user_id) { } /** * Validation for multi site * * @param array $validate Validate. * @param Forminator_Form_Model $custom_form Form model. * @param bool $is_approve Is approve. * * @return array */ public function multisite_validation($validate, $custom_form, $is_approve) { } /** * Create site * * @param int $user_id User Id. * @param Forminator_Form_Model $custom_form Form model. * @param Forminator_Form_Entry_Model $entry Form entry model. * @param string $password Password. * * @return bool|int */ public function create_site($user_id, $custom_form, $entry, $password) { } /** * May be remove user from network main site. * * @param array $setting Setting. * @param int $user_id User Id. * @return bool */ private function maybe_remove_user_from_main_site($setting, $user_id) { } /** * Get root role from settings. * * @param mixed $setting Settings. * @return string|null */ private function get_root_role($setting) { } /** * Get user data * * @param bool|int $user_id User Id. * @param array $prepare_user_data Prepare user data. * * @return bool|array */ private function get_user_data($user_id = \false, $prepare_user_data = array()) { } /** * Replace site data * * @param array $setting Settings. * @return array */ private function replace_site_data($setting) { } /** * Get site data * * @param array $setting Setting. * @param int $user_id User Id. * @param array $prepare_user_data Prepare user data. * * @return array */ public function get_site_data($setting, $user_id, $prepare_user_data = array()) { } /** * Get custom user meta * * @param array $setting Setting. * * @return array */ public function get_custom_user_meta($setting) { } /** * Add user meta * * @param int $user_id User Id. * @param array $setting Setting. * @param object $custom_form Custom form. * @param object $entry Entry. * * @return void */ public function add_user_meta($user_id, $setting, $custom_form, $entry) { } /** * Change notifications * * @param string $activation_method Activation method. * @param array $notifications Notifications. * * @return array */ private function change_notifications($activation_method, $notifications) { } /** * Get the set password url for the specified user. * * @global wpdb $wpdb WordPress database object for queries. * @global PasswordHash $wp_hasher Portable PHP password hashing framework instance. * * @param WP_User $user User object. * * @return string */ public function get_set_password_url($user) { } /** * Overrides wp_new_user_notification to email login credentials to a newly-registered user. * * @param int $user_id User ID. * @param string $plaintext_pass The password being sent to the user. * @param string $notify Optional. Type of notification that should happen. Accepts 'admin' or an empty. * string (admin only), 'user', or 'both' (admin and user). Default empty. */ public function forminator_new_user_notification($user_id, $plaintext_pass = '', $notify = '') { } /** * Get conditional user role * * @param array $settings Settings. * * @return string */ public function conditional_user_role($settings) { } } /** * Class Forminator_Custom_Forms */ class Forminator_Custom_Forms extends \Forminator_Module { /** * Module instance * * @var null */ private static $instance = \null; /** * Store template objects * * @var array */ public $templates = array(); /** * Return the plugin instance * * @since 1.0 * @return Forminator_Module */ public static function get_instance() { } /** * Init * * @since 1.0 * @since 1.0.6 Include General Data Protecion */ public function init() { } /** * Set templates */ private function set_templates() { } /** * Load module Admin part * * @since 1.0 */ public function load_admin() { } /** * Load front part * * @since 1.0 */ public function load_front() { } /** * Register CPT * * @since 1.0 */ public function register_cpt() { } /** * Add custom post status for Leads forms */ public static function add_custom_post_status() { } /** * Migrate leads forms * * @param string $new_version New plugin version. * @param string $old_version Old plugin version. * @return null */ public static function migrate_leads_forms($new_version, $old_version) { } /** * Module options * * @since 1.0 * @return array */ public function options() { } /** * Order templates by priorty * * @since 1.0 * @param object $b Template. * @param object $a Template. * * @return int */ public function order_templates($b, $a) { } /** * Get templates * * @since 1.0 * @return array */ public function get_templates() { } /** * Filter accessible templates * * @param array $templates Templates. * @return array */ public function filter_accessible_templates($templates) { } /** * Make templates info translatable * * @param array $templates - templates. * * @return array */ public static function make_templates_info_translatable($templates) { } /** * Translate category name * * @param string $name - category name. * @return string */ public static function translate_category_name($name) { } /** * Translate template name * * @param string $name - template name. * * @return string */ public static function translate_template_name($name) { } /** * Translate template description * * @param string $description - template description. * * @return string */ public static function translate_template_description($description) { } /** * Get preset templates */ public function get_preset_templates() { } /** * Prepare templates data * * @param array $templates - templates. * * @return array */ public function prepare_templates_data($templates) { } /** * Get free templates * * @return array */ public function get_free_templates() { } /** * Get main templates * * @return array */ public function get_main_templates(): array { } /** * Get Template Category * * @return array */ public function get_templates_categories(): array { } /** * Add free templates category * * @param array $categories - categories. * * @return array */ private function add_free_templates_category($categories) { } /** * Get Pro static template categories * * @return array */ private function get_pro_static_template_categories(): array { } /** * Get Template count * * @param string $category Category. * * @return int */ public function get_templates_count_by_category($category) { } } /** * Class Forminator_CForm_General_Data_Protection * * General Data Protection Applied for Custom Form * * @since 1.0.6 */ class Forminator_CForm_General_Data_Protection extends \Forminator_General_Data_Protection { /** * Module slug * * @var string */ protected static $module_slug = 'form'; /** * Instances of custom form model * * Avoid overhead on multiple entries in the same form * * @var array */ private static $custom_form_model_instances = array(); /** * Forminator_CForm_General_Data_Protection constructor */ public function __construct() { } /** * Privacy Policy recommendation message * * @since 1.0.6 * @return string */ public function get_privacy_message() { } /** * Export form submission * * @since 1.0.6 * * @param string $email_address Email. * @param string $page Page. * * @return array */ public static function form_submissions_exporter($email_address, $page) { } /** * Get data mappers for retrieving entries meta * * @example [ * [ * 'meta_key' => 'FIELD_ID', * 'label' => 'LABEL', * 'type' => 'TYPE', * 'sub_metas' => [ * [ * 'key' => 'SUFFIX', * 'label' => 'LABEL', * ] * ], * ] * ] * * @since 1.0.6 * * @param Forminator_Form_Model|Forminator_Base_Form_Model $model Form model. * * @return array */ public static function get_custom_form_export_mappers($model) { } /** * Eraser * * @since 1.0.6 * * @param string $email_address Email. * @param string $page Page. * * @return array */ public static function form_submissions_eraser($email_address, $page) { } /** * Clean up form submissions * * @since 1.0.6 * * @return bool */ public function personal_data_cleanup() { } /** * Delete entries that have exceeded the retention period * Overrides global setting * * @param array $overridden_forms_privacy Forms privacy. * * @since 1.17.0 */ public function cleanup_expired_entries($overridden_forms_privacy) { } /** * Cleanup IP Address based on settings * * @since 1.5.4 */ public function cleanup_ip_address() { } /** * Cleanup User's Geolocation data based on settings */ public function cleanup_geolocation() { } } /** * User data for registration and login forms * * @since 1.11 */ class Forminator_CForm_User_Data { /** * Forminator_CForm_User_Data constructor */ public function __construct() { } /** * Approve * * @throws Exception When there is an error. */ public function approve_user() { } /** * Delete unconfirmed user * * @throws Exception When there is an error. */ public function delete_unconfirmed_user() { } /** * Change submission entries. * * @param array $iterator Iterator. * @param Forminator_Form_Entry_Model $entry Form entry model. * * @return array */ public function change_entries_iterator($iterator, $entry) { } /** * Resend activation link of entry */ public function resend_activation_link() { } /** * Resend Notification Email */ public function resend_notification_email() { } /** * Resend Draft Email from admin entries page */ public function resend_draft_email() { } /** * Approve user by link */ public function admin_approve_user_by_link() { } /** * Delete user signup. * * @param int $user_id User Id. */ public function delete_signup_user($user_id) { } /** * Delete user signup bt activation. * * @param string $activation_key Activation key. * * @return bool|Forminator_CForm_User_Signups|int|mysqli_result|resource|WP_Error|null */ public function delete_signup_by_activation($activation_key) { } } /** * Front user class for signups * * @since 1.11 */ class Forminator_CForm_User_Signups { /** * Meta * * @var array */ public $meta; /** * Entry * * @var Forminator_Form_Entry_Model */ public $entry; /** * Form * * @var Forminator_Base_Form_Model */ public $form; /** * Settings * * @var array */ public $settings; /** * Submitted data * * @var array */ public $submitted_data; /** * User data * * @var array */ public $user_data; /** * Dynamic properties. * * @var array */ private $properties = array(); /** * Magic method to handle setting dynamic properties * * @param string $name Property name. * @param mixed $value Property value. */ public function __set($name, $value) { } /** * Magic method to handle getting dynamic properties * * @param string $name Property name. * * @return mixed */ public function __get($name) { } /** * Forminator_CForm_User_Signups constructor * * @param array $signup Signup. */ public function __construct($signup) { } /** * Get * * @param mixed $key Key. * * @return Forminator_CForm_User_Signups|WP_Error */ public static function get($key) { } /** * Get activation method * * @return mixed */ public function get_activation_method() { } /** * Set as activated * * @return bool|int */ public function set_as_activated() { } /** * Get activation email * * @param mixed $key Key. * @return mixed */ public static function get_activation_email($key) { } /** * Check to exist table * * @param string $table_name Table name. * * @return bool */ public static function table_exists($table_name) { } /** * Create Signups table */ public static function create_signups_table() { } /** * Install signups * * @return void */ private static function install_signups() { } /** * Add signups property to $wpdb object. Used by several MS functions. */ private static function add_signups_to_wpdb() { } /** * Delete * * @return bool|int */ public function delete() { } /** * Delete signup entry by user data * * @param string $user_key User key. * @param string $user_value Value. * * @return int|bool */ public static function delete_by_user($user_key, $user_value) { } /** * Prep signups functionality * * @return void */ public static function prep_signups_functionality() { } /** * Get pending activations * * @param string $activation_key Activation key. * * @return array|object|null */ public static function get_pending_activations($activation_key) { } /** * May be suppress signup user notification * * @param mixed $user User. * @param string $user_email Email. * @param string $key Key. * @return mixed */ public static function maybe_suppress_signup_user_notification($user, $user_email, $key) { } /** * May be suppress signup blog notification * * @param mixed $domain Domain. * @param mixed $path Path. * @param mixed $title Title. * @param mixed $user User. * @param mixed $user_email User email. * @param mixed $key Key. * @return mixed */ public static function maybe_suppress_signup_blog_notification($domain, $path, $title, $user, $user_email, $key) { } /** * Is manual activation * * @param string $key Key. * @return bool */ public static function is_manual_activation($key) { } /** * Modify signup user notification message * * @param mixed $message Message. * @param mixed $user User. * @param mixed $user_email User email. * @param mixed $key Key. * @return string */ public static function modify_signup_user_notification_message($message, $user, $user_email, $key) { } /** * Modify signup blog notification message * * @param mixed $message Message. * @param mixed $domain Domain. * @param mixed $path Path. * @param mixed $title Tittle. * @param mixed $user User. * @param mixed $user_email User email. * @param mixed $key Key. * @return string */ public static function modify_signup_blog_notification_message($message, $domain, $path, $title, $user, $user_email, $key) { } /** * Add site name filter * * @param mixed $user User. * @return mixed */ public static function add_site_name_filter($user) { } /** * Remove site name filter. * * @param mixed $user User. * @return mixed */ public static function remove_site_name_filter($user) { } /** * Modify site name * * @param mixed $site_name Site name. * @return mixed */ public static function modify_site_name($site_name) { } /** * Add meta of a user sign-up * * @param Forminator_Form_Entry_Model $entry Form entry model. * @param string $meta_key Meta key name. * @param string $meta_value Meta value. */ public static function add_signup_meta($entry, $meta_key, $meta_value) { } /** * Activate signup * * @param string $key Key. * @param bool $is_user_signon Is user sign-on. * * @return array|Forminator_CForm_User_Signups|WP_Error */ public static function activate_signup($key, $is_user_signon) { } /** * Delete signup * * @param mixed $key Key. * * @return bool|int|WP_Error */ public static function delete_signup($key) { } } /** * Class Forminator_Poll_Admin * * @property Forminator_Polls module * @since 1.0 */ class Forminator_Poll_Admin extends \Forminator_Admin_Module { /** * Module objects * * @var array */ public $module; /** * Init * * @since 1.0 */ public function init() { } /** * Add module pages to Admin * * @since 1.0 */ public function add_menu_pages() { } /** * Pass module defaults to JS * * @since 1.0 * @param array $data Data. * * @return mixed */ public function add_js_defaults($data) { } /** * Localize modules * * @since 1.0 * @param array $data Data. * * @return mixed */ public function add_l10n_strings($data) { } /** * Return default module settings * * @since 1.14 * * @param string $name Form name. * @param array $settings Settings. * * @return array[] */ public static function get_default_settings($name, $settings = array()) { } /** * Create quiz module * * @since 1.14 */ public function create_module() { } /** * Create poll * * @param string $name Name. * @param string $status Status. * @param object $template Template. * @return int post ID */ public static function create($name, $status, $template = \null) { } /** * Check if poll has valid answers. * * A poll is considered valid if it has at least one answer with a non-empty title. * * @param array $answers Poll answers. * @return bool True if poll has valid answers, false otherwise. */ public static function has_valid_answers($answers) { } /** * Update poll * * @param string $id Module ID. * @param string $title Name. * @param string $status Status. * @param object $template Template. * @return WP_Error post ID */ public static function update($id, $title, $status, $template) { } } /** * Class Forminator_Poll_View_Page * * @since 1.0 */ class Forminator_Poll_View_Page extends \Forminator_Admin_View_Page { /** * Moduel type * * @var string */ protected static $module_slug = 'poll'; /** * Initialise variables * * @since 1.0 */ public function before_render() { } /** * Action delete * * @param int $id ID. */ public function delete_action($id) { } /** * Get model name * * @since 1.0 * @return string */ public function get_model_name() { } /** * Map Custom Votes * * @since 1.0.5 * @example { * 'ELEMENT_ID' => [ * 'EXTRA_VALUE' => COUNT * ], * 'answer-2' => [ * 'skip it' => 9 * ] * } * * @return array */ public function map_custom_votes() { } /** * Get Element Title * * @since 1.0.5 * * @param string $element_id Element Id. * * @return mixed */ public function get_field_title($element_id) { } /** * Render the chart * Generate the google charts js for the chart * * @since 1.0 */ public function render_pie_chart() { } /** * Override style used for displayed chart * * @since 1.5.4 * * @return void */ public function chart_style_override() { } } /** * Class Forminator_Poll_New_Page * * @since 1.0 */ class Forminator_Poll_New_Page extends \Forminator_Admin_Page { /** * Return wizard title * * @since 1.0 * @return mixed */ public function getWizardTitle() { } /** * Add page screen hooks * * @since 1.6.1 * * @param string $hook Hook. */ public function enqueue_scripts($hook) { } } /** * Class Forminator_Poll_Page * * @since 1.0 */ class Forminator_Poll_Page extends \Forminator_Admin_Module_Edit_Page { /** * Module slug * * @var string */ protected static $module_slug = 'poll'; /** * Return module array * * @since 1.14.10 * * @param int $id Id. * @param string $title Title. * @param array $views Views. * @param string $date Date. * @param string $status Status. * @param mixed $model Model. * * @return array */ protected static function module_array($id, $title, $views, $date, $status, $model) { } /** * Bulk actions * * @since 1.0 * @return array */ public function bulk_actions() { } /** * Update Module Status * * Override parent method to add poll-specific validation before publishing. * Prevents blank polls (without question and answers) from being published * from the poll dashboard. * * @param int $id Module Id. * @param string $status Module status. * @return WP_Error|void WP_Error if validation fails, void otherwise. */ public function update_module_status($id, $status) { } } /** * Class Forminator_Poll_Renderer_Entries * * @since 1.0.5 */ class Forminator_Poll_Renderer_Entries extends \Forminator_Poll_View_Page { /** * Forminator_Poll_Renderer_Entries constructor * * @noinspection PhpMissingParentConstructorInspection * * Construct Entries Renderer * * @since 1.0.5 * * @param string $folder Folder. */ public function __construct($folder) { } } /** * Front action for polls * * @since 1.0 */ class Forminator_Poll_Front_Action extends \Forminator_Front_Action { /** * Module slug * * @var string */ protected static $module_slug = 'poll'; /** * Entry type * * @var string */ public static $entry_type = 'poll'; /** * Handle form action * * @since 1.0 * * @param bool $preview Preview. * * @return bool|array */ protected function handle_form($preview = \false) { } /** * Check if submission is possible. * * @param bool $freeze Optional. Should it prevent parallel requests. False by default. * @throws Exception When there is an error. */ private static function can_submit($freeze = \false) { } /** * Get field data * * @return string * @throws Exception When there is an error. */ private static function get_field_data() { } /** * Get field data array * * @param object $entry Entry object. * @return array */ private static function get_field_data_array($entry) { } /** * Save entry fields * * @param object $entry Entry object. */ private static function save_entry_fields($entry) { } /** * Send email * * @param object $entry Entry. */ private static function send_email($entry) { } /** * Get submission response */ private static function get_response() { } /** * Prepare response array * * @param array $response response array. * @param object $poll Module. * @param array $setting Settings. * @param array $post_data Post data. * @return array */ private static function prepare_response($response, $poll, $setting, $post_data) { } /** * Get Chart data of Poll * * @param Forminator_Poll_Model $poll Poll model. * * @return array */ private static function get_chart_data(\Forminator_Poll_Model $poll) { } /** * Response message * * @param int $form_id Form Id. * @param int $render_id Render Id. * * @since 1.0 */ public function form_response_message($form_id, $render_id) { } /** * Executor On form submit for attached addons * * @see Forminator_Integration_Poll_Hooks::on_module_submit() * @since 1.6.1 * * @return bool true on success|string error message from addon otherwise * @throws Exception When there is an error. */ private static function attach_addons_on_poll_submit() { } /** * Set Browser Cookie when poll submit * * @param int $form_id Form Id. */ public static function set_vote_browser_cookie($form_id) { } } /** * The Forminator_Assets_Enqueue_Poll class. * * @package Forminator */ /** * Conditionally load assets class * * @since 1.11 */ class Forminator_Assets_Enqueue_Poll extends \Forminator_Assets_Enqueue { /** * Module slug * * @var string */ protected static $module_slug = 'poll'; /** * Enqueue form styles * * @param object $render_obj Forminator_Poll_Front object. * @since 1.11 */ public function enqueue_styles($render_obj) { } /** * Enqueue form scripts * * @since 1.11 */ public function enqueue_scripts() { } /** * Check if poll has custom answer * * @since 1.11 * @param array $fields Fields. * * @return bool */ public function has_custom_answer($fields) { } } /** * The Forminator_Poll_Front_Mail class. * * @package Forminator */ /** * Forminator_Poll_Front_Mail * * @since 1.6.1 */ class Forminator_Poll_Front_Mail extends \Forminator_Mail { /** * Module slug * * @var string */ protected static $module_slug = 'poll'; /** * Replace all placeholders for mail properties * * @param array $settings Settings. * @param string $option_name Current option name. * @param object $module Module. * @param object $entry Saved entry. * @return string */ private function replace_placeholders($settings, $option_name, $module, $entry) { } /** * Process mail * * @since 1.6.1 * * @param Forminator_Poll_Model $poll Poll Model. * @param Forminator_Form_Entry_Model $entry Form entry model. */ public function process_mail($poll, \Forminator_Form_Entry_Model $entry) { } /** * Prepare headers. * * @param array $setting Settings. * @param object $poll Module. * @param array $data Submitted data. * @param object $entry Saved entry. * @return array */ private function prepare_headers($setting, $poll, $data, $entry) { } /** * Get Recipients of admin emails * * @since 1.6.1 * @since 1.6.2 add $poll model, $entry * * @param array $setting backward compat param. * @param Forminator_Poll_Model $poll Poll Model. * @param Forminator_Form_Entry_Model $entry Form entry model. * @param array $lead_model Lead model. * @param string $result_slug Result slug. * * @return array */ public function get_admin_email_recipients($setting, $poll = \null, $entry = \null, $lead_model = array(), $result_slug = '') { } } /** * The Forminator_Poll_Front class. * * @package Forminator */ /** * Front render class for custom forms * * @since 1.0 */ class Forminator_Poll_Front extends \Forminator_Render_Form { /** * Module slug * * @var string */ protected static $module_slug = 'poll'; /** * Scripts of graph results * * @var array */ private static $graph_result_scripts = array(); /** * Default Combination of Chart Colors * * @var array */ public static $default_chart_colors = array('#F4B414', '#1ABC9C', '#097BAA', '#18485D', '#D30606'); /** * Render Breakdance SSR preview in the required order. * * Order matters here: enqueue assets first so we can capture style handles, * print the collected styles and inline styles next, then output the HTML. * * @param bool $hide If true, display: none will be added on the form markup. * @param bool $is_preview Is preview. * * @return void */ private function render_breakdance_ssr_preview($hide, $is_preview) { } /** * Enqueue Breakdance SSR preview assets and collect the generated style handles. * * @return void */ private function enqueue_breakdance_ssr_preview_assets() { } /** * Display form method * * @since 1.0 * * @param int $id Id. * @param bool $is_preview Is preview. * @param bool $data Data. * @param bool $hide If true, display: none will be added on the form markup and later removed with JS. */ public function display($id, $is_preview = \false, $data = \false, $hide = \true) { } /** * Return form fields * * @since 1.0 * @return array|mixed */ public function get_fields() { } /** * Poll question * * @param object $model model. * * @since 1.0 * @return string */ public static function get_poll_question($model) { } /** * Poll Description * * @param object $model model. * * @since 1.0 * @return string */ public static function get_poll_description($model) { } /** * Poll Image * * @since 1.5.3 * @return string */ public function get_poll_image() { } /** * Poll header * * @param string $maybe_error Error message. * * @since 1.0 * @return string */ public function render_form_header($maybe_error = '') { } /** * Poll question * * @since 1.0 * @return string */ public function get_submit_button_text() { } /** * Button markup * * @param array $form_settings Form settings. * * @since 1.0 * @return string */ public function get_button_markup($form_settings = array()) { } /** * Extra form classes for ajax * * @since 1.0 * @return string */ public function form_extra_classes() { } /** * Return before wrapper markup * * @since 1.0 * * @param array $wrapper Wrapper. * * @return string */ public function render_wrapper_before($wrapper) { } /** * Return after wrapper markup * * @since 1.0 * * @param array $wrapper Wrapper. * * @return mixed */ public function render_wrapper_after($wrapper) { } /** * Return fields markup * * @since 1.0 * * @param bool $render Render. * * @return string */ public function render_fields($render = \true) { } /** * Return field markup of Radio for poll * * @since 1.0 * * @param array $field Field. * @param string $uniq_id Unique Id. * * @return mixed */ public function render_field_radio($field, $uniq_id) { } /** * Radio field markup * * @since 1.0 * * @param array $field Field. * @param int $id Id. * @param string $name Name. * * @return mixed */ public function radio_field_markup($field, $id, $name) { } /** * Render extra field * * @since 1.0 * * @param array $field Field. * @param string $uniq_id Unique Id. * @param array $form_settings Form settings. * * @return mixed */ public function render_extra_field($field, $uniq_id, $form_settings = array()) { } /** * Return form design * * @since 1.0 * @return mixed */ public function get_form_design() { } /** * Results chart * * @param array $settings Settings. * * @since 1.0 * @return string */ public static function get_chart_design($settings) { } /** * Results chart design * * @since 1.0 * @return string */ private function get_show_results() { } /** * Show results after poll submit * * @since 1.0 * @return bool */ private function show_results() { } /** * Show link after submit * * @since 1.0 * @return bool */ private function show_link() { } /** * Render success * * @param bool $render Render. * @param array $form_settings Settings. * * @since 1.0 * @return string */ public function render_success($render = \true, $form_settings = array()) { } /** * Graph scripts * * @return void */ public function graph_scripts() { } /** * Return chart type * * @return string */ public function get_chart_type() { } /** * Get Options for google chart * * @param object $model Model. * * @return array */ public static function get_default_chart_options($model) { } /** * Success footer scripts * * @param object $model Model. * @param string $container_id Container Id. * * @since 1.0 */ public function success_footer_script($model, $container_id) { } /** * Return if view votes setting is enabled * * @since 1.0 * @return bool */ public function has_votes_enabled() { } /** * Get CSS prefix * * @param string $prefix Default prefix. * @param array $properties CSS properties. * @param string $slug Slug. * @return string */ protected static function get_css_prefix($prefix, $properties, $slug) { } /** * Html markup of form * * @since 1.6.1 * * @param bool $hide Hide. * @param bool $is_preview Is preview. * * @return false|string */ public function get_html($hide = \true, $is_preview = \false) { } /** * Set module properties * * @param bool $rendered Rendered flag. */ protected function set_forms_properties($rendered = \false) { } /** * Set options to Model object. * * @param object $form_model Model. * @param array $data Data. * @return object */ protected function set_form_model_data($form_model, $data) { } /** * Enqueue poll scripts * * @param bool $is_preview Is preview. * @param bool $is_ajax_load Is ajax load. */ public function enqueue_form_scripts($is_preview, $is_ajax_load = \false) { } /** * Get forminatorFront js init options to be passed * * @since 1.6.1 * * @param array $form_properties Form properties. * * @return array */ public function get_front_init_options($form_properties) { } /** * Skip ajax loader JS when the poll was already fully rendered (user already voted). * * @param bool $is_preview Is preview. * @param array $preview_data Preview data. * @param array $lead_data Lead data. * @param bool $is_block_editor Is block editor. */ public function ajax_loader($is_preview, $preview_data = array(), $lead_data = array(), $is_block_editor = \false) { } } /** * Class Forminator_Polls * * @since 1.0 */ class Forminator_Polls extends \Forminator_Module { /** * Module instance * * @var null */ private static $instance = \null; /** * Return the plugin instance * * @since 1.0 * @return self */ public static function get_instance() { } /** * Initialize * * @since 1.0 * @since 1.0.6 Add General Data Protection */ public function init() { } /** * Load module Admin part * * @since 1.0 */ public function load_admin() { } /** * Load front part * * @since 1.0 */ public function load_front() { } /** * Register CPT * * @since 1.0 */ public function register_cpt() { } /** * Module option * * @return array */ public function options() { } } /** * Class Forminator_Polls_General_Data_Protection * * General Data Protection Applied for Polls * * @since 1.0.6 */ class Forminator_Polls_General_Data_Protection extends \Forminator_General_Data_Protection { /** * Module slug * * @var string */ protected static $module_slug = 'poll'; /** * Forminator_Polls_General_Data_Protection constructor */ public function __construct() { } /** * Add Privacy Message * * @since 1.0.6 * * @return string */ public function get_privacy_message() { } /** * Anon IP * * @since 1.0.6 * @return bool */ public function personal_data_cleanup() { } /** * Anonymize IP votes * * @since 1.6 */ public function anonymize_ip_votes() { } /** * Remove poll's submissions * * @since 1.6 */ public function remove_poll_submissions() { } } /** * Class Forminator_Quiz_Admin * * @property string page_edit_nowrong * @property Forminator_Module module * @property string page_edit_knowledge * * @since 1.0 */ class Forminator_Quiz_Admin extends \Forminator_Admin_Module { /** * Module objects * * @var array */ public $module; /** * Page nowrong edit * * @var string */ public $page_edit_nowrong; /** * Page knowledge edit * * @var string */ public $page_edit_knowledge; /** * Initialize * * @since 1.0 */ public function init() { } /** * Include required files * * @since 1.0 */ public function includes() { } /** * Add module pages to Admin * * @since 1.0 */ public function add_menu_pages() { } /** * Remove necessary pages from menu * * @since 1.0 */ public function hide_menu_pages() { } /** * Is the type of the quiz "knowledge" * * @since 1.0 * @return bool */ public function is_knowledge_wizard() { } /** * Is the type of the quiz "no wrong answer" * * @since 1.0 * @return bool */ public function is_nowrong_wizard() { } /** * Highlight parent page in sidebar * * @deprecated 1.1 No longer used because this function override prohibited WordPress global of $plugin_page * @since 1.0 * * @param string $file File. * * @return mixed */ public function highlight_admin_parent($file) { } /** * Highlight submenu on admin page * * @since 1.1 * * @param string $submenu_file Sub menu file. * @param string $parent_file Parent file. * * @return string */ public function admin_submenu_file($submenu_file, $parent_file) { } /** * Pass module defaults to JS * * @since 1.0 * * @param array $data Date. * * @return mixed */ public function add_js_defaults($data) { } /** * Common quiz default data * * @return array */ private static function common_default_data() { } /** * Knowledge quiz default data * * @param string $name Form name. * @param bool $has_leads Has lead. * * @since 1.14 * * @return array */ public static function knowledge_default_data($name, $has_leads) { } /** * No wrong quiz default data * * @since 1.14 * * @param string $name Form name. * @param bool $has_leads Has lead. * * @return array */ public static function nowrong_default_data($name, $has_leads) { } /** * Localize modules strings * * @since 1.0 * * @param array $data Data. * * @return mixed */ public function add_l10n_strings($data) { } /** * Create quiz module * * @since 1.14 */ public function create_module() { } /** * Create quiz * * @param string $name Name. * @param string $status Status. * @param object $template Template. * @return int post ID */ public static function create($name, $status, $template) { } /** * Update quiz * * @param string $id Module ID. * @param string $title Name. * @param string $status Status. * @param object $template Template. * @return WP_Error post ID */ public static function update($id, $title, $status, $template) { } /** * Create leads form * * @since 1.14 * * @param string $name Form name. * * @return mixed */ public static function create_leads_form($name) { } /** * Return quiz notifications * * @since 1.1 * * @param Forminator_Quiz_Model|null $quiz Quiz model. * * @return mixed */ public function get_quiz_notifications($quiz) { } } /** * Class Forminator_Quiz_View_Page * * @since 1.0 */ class Forminator_Quiz_View_Page extends \Forminator_Admin_View_Page { /** * Fields * * @var array */ protected $lead_fields = array(); /** * Lead form * * @since 1.6.2 * @var Forminator_Integration[] */ protected $lead_cform = \null; /** * Module type * * @var string */ protected static $module_slug = 'quiz'; /** * Initialise variables * * @since 1.0 */ public function before_render() { } /** * Action delete_all */ public function delete_all_action() { } /** * Get fields * * @since 1.0 * @return array */ public function get_lead_fields() { } /** * Check if quiz has leads * * @since 1.14 * * @return bool */ public function has_leads() { } /** * Check if quiz lead id * * @since 1.14 * * @return int */ public function lead_id() { } /** * Get paged * * @since 1.0 * @return int */ public function get_paged() { } /** * Get total entries * * @since 1.0 * @return int */ public function get_total_entries() { } /** * Get form type * * @since 1.0 * @return mixed */ public function get_form_type() { } /** * Get form type param * * @since 1.5.4 * @return string */ protected function forminator_get_form_type() { } /** * Get integrations data * * @since 1.6.2 * * @param Forminator_Form_Entry_Model $entry Form entry model. * * @return array */ public function get_integrations_data_from_entry(\Forminator_Form_Entry_Model $entry) { } /** * Entries iterator * * @return array */ public function entries_iterator() { } /** * Build Html Entries Header */ public function entries_header() { } } /** * Class Forminator_Quiz_New_Knowledge * * @since 1.0 */ class Forminator_Quiz_New_Knowledge extends \Forminator_Admin_Page { /** * Return wizard title * * @since 1.0 * @return mixed */ public function getWizardTitle() { } /** * Add page screen hooks * * @since 1.6.2 * @param string $hook Hook. */ public function enqueue_scripts($hook) { } } /** * Class Forminator_Quiz_New_NoWrong * * @since 1.0 */ class Forminator_Quiz_New_NoWrong extends \Forminator_Admin_Page { /** * Return wizard title * * @since 1.0 */ public function getWizardTitle() { } /** * Add page screen hooks * * @since 1.6.2 * @param string $hook Hook. */ public function enqueue_scripts($hook) { } } /** * Class Forminator_Quiz_Page * * @since 1.0 */ class Forminator_Quiz_Page extends \Forminator_Admin_Module_Edit_Page { /** * Module slug * * @var string */ protected static $module_slug = 'quiz'; /** * Return module array * * @since 1.14.10 * * @param int $id Id. * @param string $title Title. * @param array $views Views. * @param string $date Date. * @param string $status Status. * @param mixed $model Model. * * @return array */ protected static function module_array($id, $title, $views, $date, $status, $model) { } /** * Check if quiz has leads * * @param object $model Form model. * * @return bool */ public static function has_leads($model) { } /** * Check has lead * * @param object $model Form model. * * @return int */ public static function get_leads_id($model) { } /** * Return leads rate * * @since 1.14 * * @param array $module Module. * * @return float|int */ public static function getLeadsRate($module) { } /** * Bulk actions * * @since 1.0 * @return array */ public function bulk_actions() { } } /** * Class Forminator_Quiz_Renderer_Entries * * @since 1.0.5 */ class Forminator_Quiz_Renderer_Entries extends \Forminator_Quiz_View_Page { /** * Construct Entries Renderer * * @noinspection PhpMissingParentConstructorInspection * * @since 1.0.5 * * @param string $folder Folder. */ public function __construct($folder) { } } /** * Front action for quizzes * * @since 1.0 */ class Forminator_Quiz_Front_Action extends \Forminator_Front_Action { /** * Module slug * * @var string */ protected static $module_slug = 'quiz'; /** * Entry type * * @since 1.0 * @var string */ public static $entry_type = 'quizzes'; /** * Entry type * * @since 1.0 * @var string */ public $model = \null; /** * Handle quiz submit * * @since 1.0 * @since 1.1 refactor $_POST to get_post_data to be able pre-processed * @since 1.6.2 add $is_preview as arg * * @param bool $is_preview Is preview. */ public function submit_quizzes($is_preview = \false) { } /** * Check if submission is possible. */ private static function can_submit() { } /** * Process No wrong quiz * * @since 1.0 * @since 1.6.2 add $is_preview as arg * * @param Forminator_Quiz_Model $model Quiz model. * @param bool $is_preview Is preview. */ private function process_nowrong_submit($model, $is_preview = \false) { } /** * Get result quiz buttons * * @param object $model Model. * @param bool $is_material_design True if material design is selected. * @return string */ private static function get_result_quiz_buttons($model, $is_material_design = \false) { } /** * Render No wrong result * * @since 1.0 * * @param Forminator_Quiz_Model $model Quiz model. * @param array $result Result. * @param Forminator_Form_Entry_Model $entry Form entry model. * * @return string */ private function render_nowrong_result($model, $result, \Forminator_Form_Entry_Model $entry) { } /** * Process knowledge quiz * * @since 1.0 * @since 1.6.2 add $is_preview on arg * * @param object $model Quiz model. * @param bool $is_preview Is preview. */ private function process_knowledge_submit($model, $is_preview = \false) { } /** * Process knowledge quiz - multiple answers * * @since 1.14.2 * * @param object $model Model. * @param bool $is_preview Is preview. */ private function process_knowledge_submit_multiple_answers($model, $is_preview = \false) { } /** * Render knowledge result * * @since 1.0 * * @param string $text Text. * @param object $model Model. * @param string $right_answers Right answers. * @param string $total_answers Total answers. * * @return string */ private function render_knowledge_result($text, $model, $right_answers, $total_answers) { } /** * Save entry * * @since 1.0 * @return void /json Json response */ public function save_entry() { } /** * Save entry * * @since 1.6 * @return void */ public function save_entry_preview() { } /** * Save entry * * @since 1.0 * @since 1.2 return entry id on success, or false on fail * @since 1.6.2 change 1st arg from form_id to quiz model * - Add $is_preview as func arg * * @param Forminator_Quiz_Model $quiz Quiz model. * @param mixed $field_data Field data. * @param bool $is_preview Is preview. * * @return Forminator_Form_Entry_Model */ private function save_form_entry($quiz, $field_data, $is_preview = \false) { } /** * Footer message * * @return void */ public function footer_message() { } /** * Handle submit * * @return void */ public function handle_submit() { } /** * Executor On quiz submit for attached addons * * @see Forminator_Integration_Quiz_Hooks::on_module_submit() * @since 1.6.2 * * @param int $quiz_id Quiz Id. * @param Forminator_Quiz_Model $quiz_model Quiz model. * * @return bool true on success|string error message from addon otherwise */ private function attach_addons_on_quiz_submit($quiz_id, \Forminator_Quiz_Model $quiz_model) { } /** * Check has lead skip * * @return bool */ public function has_skip_form() { } } /** * The Forminator_Assets_Enqueue_Quiz class. * * @package Forminator */ /** * Conditionally load assets class * * @since 1.12 */ class Forminator_Assets_Enqueue_Quiz extends \Forminator_Assets_Enqueue { /** * Module slug * * @var string */ protected static $module_slug = 'quiz'; /** * Enqueue form styles * * @since 1.12 */ public function enqueue_styles() { } /** * Enqueue scripts * * @since 1.11 */ public function enqueue_scripts() { } } /** * The Forminator_Quiz_Front_Mail class. * * @package Forminator */ /** * Forminator_Quiz_Front_Mail * * @since 1.6.2 */ class Forminator_Quiz_Front_Mail extends \Forminator_Mail { /** * Module slug * * @var string */ protected static $module_slug = 'quiz'; /** * Replace all placeholders for mail properties * * @param array $settings Settings. * @param string $option_name Current option name. * @param object $module Module. * @param object $entry Saved entry. * @param object $lead_model Lead module. * @return string */ private function replace_placeholders($settings, $option_name, $module, $entry, $lead_model) { } /** * Process mail * * @since 1.6.2 * * @param Forminator_Quiz_Model $quiz Quiz model. * @param Forminator_Form_Entry_Model $entry Form entry model. * @param array $final_res Final response. */ public function process_mail($quiz, \Forminator_Form_Entry_Model $entry, $final_res = array()) { } /** * Prepare headers. * * @param array $notification Settings. * @param object $quiz Module. * @param array $data Submitted data. * @param object $entry Saved entry. * @param object $lead_model Lead module. * @return array */ private function prepare_headers($notification, $quiz, $data, $entry, $lead_model) { } /** * Get Recipient * * @param string $recipient Recipient. * @param object $quiz Quiz model. * @param object $entry Entry model. * @param object $lead_model Lead model. * * @return string */ public function get_recipient($recipient, $quiz, $entry, $lead_model) { } /** * Lead file attachment * * @param object $lead_model Lead model. * @param object $entry Entry model. * * @return array|mixed */ public function get_lead_file_attachment($lead_model, $entry) { } /** * Check if notification is routing * * @since 1.0 * * @param array $routing Routing. * @param object $quiz_model Quiz model. * @param string $result_slug Result slug. * * @return bool */ public function is_routing($routing, $quiz_model, $result_slug = '') { } /** * Check if Field is hidden based on conditions property and POST-ed data * * @since 1.0 * * @param array $notification Notification. * @param array $form_data Form data. * @param object $quiz_model Quiz model. * @param string $result_slug Result slug for personality quiz. * * @return bool */ public function is_condition($notification, $form_data, $quiz_model, $result_slug = '') { } } /** * Front render class for custom forms */ class Forminator_QForm_Front extends \Forminator_Render_Form { /** * Module slug * * @var string */ protected static $module_slug = 'quiz'; /** * Lead data * * @var array */ protected static $lead_data = array(); /** * Steps count * * @var int */ private static $steps_count = 1; /** * Render Breakdance SSR preview in the required order. * * Order matters here: enqueue assets first so we can capture style handles, * print the collected styles and inline styles next, then output the HTML. * * @param bool $hide If true, display: none will be added on the form markup. * @param bool $is_preview Is preview. * * @return void */ private function render_breakdance_ssr_preview($hide, $is_preview) { } /** * Enqueue Breakdance SSR preview assets and collect the generated style handles. * * @return void */ private function enqueue_breakdance_ssr_preview_assets() { } /** * Enqueue quiz Google fonts. * * @return void */ private function enqueue_google_fonts() { } /** * Display form method * * @since 1.0 * * @param int $id Id. * @param bool $is_preview Is preview. * @param bool|array $data Data. * @param bool $hide If true, display: none will be added on the form markup and later removed with JS. */ public function display($id, $is_preview = \false, $data = \false, $hide = \true) { } /** * Set lead data */ private function set_lead_data() { } /** * Return fields * * @since 1.0 * @return array */ public function get_fields() { } /** * Return form fields markup * * @since 1.0 * * @param bool $render Render. * * @return mixed */ public function render_fields($render = \true) { } /** * Return pagination content start markup * * @param int $module_id Module Id. * @param int $step Step. * @param int $page_indicator Page indicator. * * @return string */ private static function pagination_content_start($module_id, $step, $page_indicator) { } /** * Return pagination end markup * * @return string */ private static function pagination_content_end() { } /** * Render field * * @since 1.0 * * @param array $field Field. * @param bool $last_field Last field. * * @return mixed */ public function render_field($field, $last_field = \false) { } /** * Render No wrong quiz * * @since 1.0 * * @param array $field Field. * @param bool $last_field Last field. * * @return string */ private function render_nowrong($field, $last_field) { } /** * Render knowledge quiz * * @since 1.0 * * @param array $field Field. * @param bool $last_field Last field. * * @return string */ private function render_knowledge($field, $last_field) { } /** * Returns true if there is more than 1 correct answer * * @param array $answers Array of answers. * @return string */ private function is_muti_choice($answers) { } /** * Returns question intro according the order. * * @param array $field Field data. * @param string $field_slug Field slug. * @return string */ private function get_question_intro($field, $field_slug) { } /** * Return Save to preview message * * @since 1.0 * @return mixed */ public function message_save_to_preview() { } /** * Return form design * * @since 1.0 * @since 1.2 Added Theme and Filter * @return mixed|string */ public function get_form_design() { } /** * Render quiz header * * @param string $maybe_error Message. * * @since 1.0 * @return string */ public function render_form_header($maybe_error = '') { } /** * Get submit data * * @return array */ public function get_submit_data() { } /** * Return form submit button markup * * @since 1.0 * * @param int $form_id Form id. * @param bool $render Render. * * @return mixed */ public function get_submit($form_id, $render = \true) { } /** * Return styles template path * * @param string $theme Theme. * * @since 1.0 * @return bool|string */ public function styles_template_path($theme) { } /** * Get CSS prefix * * @param string $prefix Default prefix. * @param array $properties CSS properties. * @param string $slug Slug. * @return string */ protected static function get_css_prefix($prefix, $properties, $slug) { } /** * Get Quiz Theme * * @since 1.2 * @return string */ public function get_quiz_theme() { } /** * Get Google Fonts setup on a quiz * * @since 1.2 * @return array */ public function get_google_fonts() { } /** * Html markup of form * * @since 1.6.1 * * @param bool $hide Hide. * @param bool $is_preview Is preview. * * @return false|string */ public function get_html($hide = \true, $is_preview = \false) { } /** * Set module properties */ protected function set_forms_properties() { } /** * Set options to Model object. * * @param object $form_model Model. * @param array $data Data. * @return object */ protected function set_form_model_data($form_model, $data) { } /** * Enqueue quiz scripts * * @param bool $is_preview Is preview. * @param bool $is_ajax_load Is ajax load. */ public function enqueue_form_scripts($is_preview, $is_ajax_load = \false) { } /** * Get forminatorFront js init options to be passed * * @since 1.6.1 * * @param array $form_properties Form properties. * * @return array */ public function get_front_init_options($form_properties) { } /** * Return if form has submission loader enabled * * @param array $properties Properties. * * @since 1.7.1 * * @return bool */ public function form_has_loader($properties) { } /** * Ajax handler to reload module * * @since 1.11 * * @return void */ public static function ajax_reload_module() { } /** * Lead wrapper start * * @return string */ public function lead_wrapper_start() { } /** * Lead wrapper end * * @return string */ public function lead_wrapper_end() { } } /** * Front render class for custom forms */ class Forminator_QForm_Result extends \Forminator_Result { /** * Post type * * @var string */ protected $post_type = 'quizzes'; /** * Get og description * * @param Forminator_Form_Entry_Model $entry Form entry model. * * @return string */ public function get_og_description($entry) { } /** * Get og title * * @param Forminator_Form_Entry_Model $entry Form entry model. * * @since 1.7 * * @return string */ public function get_og_title($entry) { } /** * Get og URL * * @since 1.7 * * @return string */ public function get_og_url() { } /** * Get og image * * @param Forminator_Form_Entry_Model $entry Form entry model. * * @since 1.7 * * @return string */ public function get_og_image($entry) { } /** * Get og description * * @param Forminator_Quiz_Model $quiz Quiz model. * @param Forminator_Form_Entry_Model $entry Form entry model. * * @return string */ private function get_og_description_knowledge($quiz, $entry) { } /** * Get og description * * @param Forminator_Quiz_Model $quiz Quiz model. * @param Forminator_Form_Entry_Model $entry Form entry model. * * @return string */ private function get_og_description_nowrong($quiz, $entry) { } /** * Not printing any styles * just filtering canonical URL * * @since 1.7 */ public function print_styles() { } /** * Print result header * * @return void */ public function print_result_header() { } /** * Is public allowed * * @inheritdoc * @param object $entry Entry model. */ public function is_public_allowed($entry) { } } /** * Class Forminator_Quizzes * * @since 1.0 */ class Forminator_Quizzes extends \Forminator_Module { /** * Module instance * * @var null|Forminator_Quizzes */ private static $instance = \null; /** * Return the plugin instance * * @return Forminator_Quizzes */ public static function get_instance() { } /** * Initialize * * @since 1.0 */ public function init() { } /** * Load module Admin part * * @since 1.0 */ public function load_admin() { } /** * Load front part * * @since 1.0 */ public function load_front() { } /** * Register CPT * * @since 1.0 */ public function register_cpt() { } /** * Module options * * @since 1.0 * @return array */ public function options() { } } /** * Class Forminator_Quiz_General_Data_Protection * * General Data Protection Applied for Quiz * * @since 1.6.2 */ class Forminator_Quiz_General_Data_Protection extends \Forminator_General_Data_Protection { /** * Module slug * * @var string */ protected static $module_slug = 'quiz'; /** * Forminator_Quiz_General_Data_Protection constructor */ public function __construct() { } /** * Add Privacy Message * * @since 1.0.6 * * @return string */ public function get_privacy_message() { } /** * Clean up quiz submissions * * @since 1.6.2 * * @return bool */ public function personal_data_cleanup() { } } /** * Forminator Akismet protection * Use the akismet api to check for possible spam posted * * Akismet API: http://akismet.com/development/api/ */ class Forminator_Akismet extends \Forminator_Spam_Protection { /** * Plugin instance * * @var null|Forminator_Akismet */ private static $instance = \null; /** * Return the plugin instance * * @return Forminator_Akismet * * @since 1.0 */ public static function get_instance() { } /** * Check if the plugin or setting is enabled * * @since 1.0 * @return bool */ public function is_enabled() { } /** * Handle spam protection * * @see process_spam_protection * * @since 1.0 * @param bool $is_spam - if the data is spam. * @param array $posted_params - the posted parameters. * @param int $form_id - the form id. * @param string $form_type - the form type. * * @return bool $is_spam */ protected function handle_spam_protection($is_spam, $posted_params, $form_id, $form_type) { } /** * Check if Akismet protection is enabled * * @param int $id Module ID. * @return bool */ private static function is_protection_enabled($id) { } /** * Check akismet if the data is spam * * @since 1.0 * @param array $post_data - the post data. * @param int $form_id - the form id. * * @return bool */ private function akismet_check($post_data, $form_id) { } /** * Build http query * The default build_query function misses out alot of things * * @since 1.0 * @param array $args - the arguments. * @param string $key Key. * * @return string */ private function build_query($args, $key = '') { } } /** * Class Forminator_Widget * * @since 1.0 */ class Forminator_Widget extends \WP_Widget { /** * Forminator_Widget constructor. * * @since 1.0 */ public function __construct() { } /** * Outputs the content of the widget * * @since 1.0 * * @param array $args Arguments. * @param array $instance Instance. */ public function widget($args, $instance) { } /** * Outputs the options form on admin * * @since 1.0 * @since 1.3 add return empty string to comply with WP_Widget * * @param array $instance The widget options. * * @return string */ public function form($instance) { } /** * Processing widget options on save * * @since 1.0 * * @param array $new_instance The new options. * @param array $old_instance The previous options. * * @return array */ public function update($new_instance, $old_instance) { } } /** * The Forminator_Integration_Simple class. * * @package Forminator */ /** * Class Forminator_Integration_Simple */ final class Forminator_Integration_Simple extends \Forminator_Integration { /** * Slug * * @var string */ protected $_slug = 'simple'; /** * Version * * @var string */ protected $_version = \FORMINATOR_ADDON_SIMPLE_VERSION; /** * Minimum Forminator version * * @var string */ protected $_min_forminator_version = '1.1'; /** * Short title * * @var string */ protected $_short_title = 'simple'; /** * Title * * @var string */ protected $_title = 'Simple'; /** * Forminator_Integration_Simple constructor */ public function __construct() { } /** * Flag for check if and addon connected (global settings suchs as api key complete) * * @return bool */ public function is_connected() { } /** * Authorized Callback * * @return bool */ public function is_authorized() { } /** * Flag for check if and addon connected to a form(form settings such as list name completed) * * @param int $module_id Form ID. * @param string $module_slug Module type. * @param bool $check_lead Check is lead connected or not. * @return bool */ public function is_module_connected($module_id, $module_slug = 'form', $check_lead = \false) { } } /** * The Forminator_Autofill_Simple class. * * @package Forminator */ /* @noinspection PhpUndefinedClassInspection */ /** * Class Forminator_Autofill_Simple */ class Forminator_Autofill_Simple extends \Forminator_Autofill_Provider_Abstract { /** * Slug * * @var string */ protected $_slug = 'simple'; /** * Name * * @var string */ protected $_name = 'Simple'; /** * Short name * * @var string */ protected $_short_name = 'Simple'; /** * Simple data * * @var array */ private $my_simple_data; /** * Forminator_Autofill_Provider_Interface * * @var Forminator_Autofill_Provider_Interface|Forminator_Autofill_Simple|null */ private static $_instance = \null; /** * Get instance * * @return Forminator_Autofill_Provider_Interface|Forminator_Autofill_Simple|null */ public static function get_instance() { } /** * Forminator_Autofill_Simple constructor */ public function __construct() { } /** * Define what field to be hooked and what attribute will be used as auto fill provider * * @example [ * 'FIELD_TYPE_TO_HOOK' => [ * 'PROVIDER_SLUG.ATTRIBUTE_PROVIDER_KEY' * ], * 'text' => [ * 'simple.simple_text', * ], * 'number' => [ * 'simple.simple_number', * ] * * * ]; * @return array */ public function get_attribute_to_hook() { } /** * Init your fillable data here, like feching data from your server or database, etc */ public function init() { } /** * Check if autofill provider can be enabled * * @example check settings or domain * when its false, it wont show up on select autofill value of form setting * * @return bool */ public function is_enabled() { } /** * Check if its fillable * * @example when when get data from server failed, then it shouldn't be fillable * * @return bool */ public function is_fillable() { } /** * Get value simple text * * @return string */ public function get_value_simple_text() { } /** * Get value simple number * * @return int */ public function get_value_simple_number() { } } } namespace ForminatorGoogleAddon { /* * Copyright 2014 Google Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ function oauth2client_php_autoload($className) { } } namespace ForminatorGoogleAddon\GuzzleHttp { /** * Debug function used to describe the provided value type and class. * * @param mixed $input Any type of variable to describe the type of. This * parameter misses a typehint because of that. * * @return string Returns a string containing the type of the variable and * if a class is provided, the class name. * * @deprecated describe_type will be removed in guzzlehttp/guzzle:8.0. Use Utils::describeType instead. */ function describe_type($input): string { } /** * Parses an array of header lines into an associative array of headers. * * @param iterable $lines Header lines array of strings in the following * format: "Name: Value" * * @deprecated headers_from_lines will be removed in guzzlehttp/guzzle:8.0. Use Utils::headersFromLines instead. */ function headers_from_lines(iterable $lines): array { } /** * Returns a debug stream based on the provided variable. * * @param mixed $value Optional value * * @return resource * * @deprecated debug_resource will be removed in guzzlehttp/guzzle:8.0. Use Utils::debugResource instead. */ function debug_resource($value = null) { } /** * Chooses and creates a default handler to use based on the environment. * * The returned handler is not wrapped by any default middlewares. * * @return callable(\Psr\Http\Message\RequestInterface, array): \GuzzleHttp\Promise\PromiseInterface Returns the best handler for the given system. * * @throws \RuntimeException if no viable Handler is available. * * @deprecated choose_handler will be removed in guzzlehttp/guzzle:8.0. Use Utils::chooseHandler instead. */ function choose_handler(): callable { } /** * Get the default User-Agent string to use with Guzzle. * * @deprecated default_user_agent will be removed in guzzlehttp/guzzle:8.0. Use Utils::defaultUserAgent instead. */ function default_user_agent(): string { } /** * Returns the default cacert bundle for the current system. * * First, the openssl.cafile and curl.cainfo php.ini settings are checked. * If those settings are not configured, then the common locations for * bundles found on Red Hat, CentOS, Fedora, Ubuntu, Debian, FreeBSD, OS X * and Windows are checked. If any of these file locations are found on * disk, they will be utilized. * * Note: the result of this function is cached for subsequent calls. * * @throws \RuntimeException if no bundle can be found. * * @deprecated default_ca_bundle will be removed in guzzlehttp/guzzle:8.0. This function is not needed in PHP 5.6+. */ function default_ca_bundle(): string { } /** * Creates an associative array of lowercase header names to the actual * header casing. * * @deprecated normalize_header_keys will be removed in guzzlehttp/guzzle:8.0. Use Utils::normalizeHeaderKeys instead. */ function normalize_header_keys(array $headers): array { } /** * Returns true if the provided host matches any of the no proxy areas. * * This method will strip a port from the host if it is present. Each pattern * can be matched with an exact match (e.g., "foo.com" == "foo.com") or a * partial match: (e.g., "foo.com" == "baz.foo.com" and ".foo.com" == * "baz.foo.com", but ".foo.com" != "foo.com"). * * Areas are matched in the following cases: * 1. "*" (without quotes) always matches any hosts. * 2. An exact match. * 3. The area starts with "." and the area is the last part of the host. e.g. * '.mit.edu' will match any host that ends with '.mit.edu'. * * @param string $host Host to check against the patterns. * @param string[] $noProxyArray An array of host patterns. * * @throws Exception\InvalidArgumentException * * @deprecated is_host_in_noproxy will be removed in guzzlehttp/guzzle:8.0. Use Utils::isHostInNoProxy instead. */ function is_host_in_noproxy(string $host, array $noProxyArray): bool { } /** * Wrapper for json_decode that throws when an error occurs. * * @param string $json JSON data to parse * @param bool $assoc When true, returned objects will be converted * into associative arrays. * @param int $depth User specified recursion depth. * @param int $options Bitmask of JSON decode options. * * @return object|array|string|int|float|bool|null * * @throws Exception\InvalidArgumentException if the JSON cannot be decoded. * * @see https://www.php.net/manual/en/function.json-decode.php * @deprecated json_decode will be removed in guzzlehttp/guzzle:8.0. Use Utils::jsonDecode instead. */ function json_decode(string $json, bool $assoc = \false, int $depth = 512, int $options = 0) { } /** * Wrapper for JSON encoding that throws when an error occurs. * * @param mixed $value The value being encoded * @param int $options JSON encode option bitmask * @param int $depth Set the maximum depth. Must be greater than zero. * * @throws Exception\InvalidArgumentException if the JSON cannot be encoded. * * @see https://www.php.net/manual/en/function.json-encode.php * @deprecated json_encode will be removed in guzzlehttp/guzzle:8.0. Use Utils::jsonEncode instead. */ function json_encode($value, int $options = 0, int $depth = 512): string { } } namespace { /** * Forminator addon active campaign directory. * * @return string */ function forminator_addon_activecampaign_dir() { } /** * Addon aweber directory path * * @return string */ function forminator_addon_aweber_dir() { } /** * Forminator addon campaign monitor directory. * * @return string */ function forminator_addon_campaignmonitor_dir() { } /** * Forminator addon Google sheet directory path * * @return string */ function forminator_addon_googlesheet_dir() { } /** * Instance of Gutenberb Integration * * @since 1.0 Gutenberg Integration * * @return Forminator_Gutenberg */ function forminator_gutenberg() { } /** * Forminator addon hubspot directory path * * @return string */ function forminator_addon_hubspot_dir() { } /** * Forminator addon slack directory path. * * @return string */ function forminator_addon_slack_dir() { } /** * Forminator addon trello directoty path * * @return string */ function forminator_addon_trello_dir() { } /** * Forminator addon webhook directory path * * @return string */ function forminator_addon_webhook_dir() { } /** * Validate a webhook URL with temporarily extended allowed ports. * * WordPress's wp_http_validate_url() only allows ports 80, 443, and 8080. * This function temporarily hooks into the `http_allowed_safe_ports` filter * to add extra ports during validation, then removes the filter immediately. * * By default only port 8443 is added. Use the `forminator_webhook_allowed_ports` * filter to customise the list. * * @since 1.53.0 * * @param string $url The webhook URL to validate. * * @return string|false The validated URL on success, false on failure. */ function forminator_webhook_validate_url($url) { } /** * Extend the list of allowed safe ports for webhook URL validation. * * @since 1.53.0 * * @param int[] $ports Existing allowed port numbers. * @return int[] Modified array with extra ports added. */ function forminator_webhook_extend_ports($ports) { } /** * Template admin/views/custom-form/entries/content-details.php * * @package Forminator */ /** * Content details of Submissions * * @param array $detail_item Item details. * @param boolean $inside_group Is this content inside Group field or not. */ function forminator_submissions_content_details($detail_item, $inside_group = \false) { } /** * Remove quantity for Stripe One-Time payments * * @param array $sub_entries - The sub entries. * @param string $item_type - The field type. * * @return array */ function forminator_submissions_remove_quantity($sub_entries, $item_type) { } /** * Forminator instance. */ function forminator() { } /** * Return plugin URL * * @since 1.0 * @return string */ function forminator_plugin_url() { } /** * Return plugin path * * @since 1.0 * @return string */ function forminator_plugin_dir() { } /** * Return plugin path * * @since 1.0.5 * @return string */ function forminator_addons_dir() { } /** * Check if payments functionality are disabled * * @return bool */ function forminator_payments_disabled(): bool { } /** * Check if form abandonment functionality are disabled * * @return bool */ function forminator_form_abandonment_disabled(): bool { } /** * Check if addons functionality are disabled * * @since 1.46.0 * @return boolean */ function forminator_addons_disabled() { } /** * Check if creating index files is disabled * * @since 1.48.0 * @return boolean */ function forminator_create_index_file_disabled() { } /** * Check if CSS regeneration is disabled when enqueuing the CSS file. * * @since 1.48.0 * @return boolean */ function forminator_disable_regenerate_css_on_form_load() { } /** * Check if usage tracking functionality are disabled * * @since 1.48.0 * @return boolean */ function forminator_usage_tracking_disabled() { } /** * Check if feedback functionality is disabled. * * @since 1.49.0 * @return boolean */ function forminator_feedback_disabled() { } /** * Addon helper functions. * * @package Forminator */ /** * Get registered addon instance by `$slug` * * @since 1.1 * * @param string $slug Addon slug. * * @return Forminator_Integration|null */ function forminator_get_addon($slug) { } /** * Get Pro Addon List * * @todo : Verify pro addon list from non user modifiable data source (API or similar others) * * @since 1.1 * @return array */ function forminator_get_pro_addon_list() { } /** * Get all add-ons as list * * @since 1.1 * @return array */ function forminator_get_registered_addons_list() { } /** * Sort addons * * @param array $a Addon. * @param array $b Addon. * * @return mixed */ function sort_addons($a, $b) { } /** * Get registered addons grouped by connected status * * @since 1.1 * @return array */ function forminator_get_registered_addons_grouped_by_connected() { } /** * Get addon instances that connected with a module * * @todo make instances static and available through runtime * * @param int $module_id Module ID. * @param string $module_type Module type. * * @return Forminator_Integration[] */ function forminator_get_addons_instance_connected_with_module($module_id, $module_type) { } /** * Get addon(s) in array format grouped by connected / not connected with $module_id * * Every addon inside this array will be formatted first by @see Forminator_Integration::to_array_with_form() * * @since 1.1 * * @param int $module_id Module ID. * @param string $module_type Module type. * @param bool $connected_only Return connected integrations only. * * @return array */ function forminator_get_registered_addons_grouped_by_module_connected($module_id, $module_type, $connected_only = \false) { } /** * Group addons by module. It's used only for forminator_get_registered_addons_grouped_by_module_connected() * * @param array $grouped_addons Grouped addons. * @param object $addon Addon object. * @param array $addon_settings Addon settings. * @param int $module_id Module ID. * @param string $module_type Module type. * @return array $grouped_addons */ function forminator_group_addons_by_module($grouped_addons, $addon, $addon_settings, $module_id, $module_type) { } /** * Attach default addon hooks for Addon. * * Call when needed only, * defined in @see Forminator_Integration::global_hookable() * and @see Forminator_Integration::admin_hookable on admin mode * * @since 1.1 * * @param Forminator_Integration $addon Addon. */ function forminator_maybe_attach_addon_hook(\Forminator_Integration $addon) { } /** * Helper Check if addon is active * * @since 1.1 * * @param string $slug Addon slug. * * @return bool */ function forminator_addon_is_active($slug) { } /** * Get allowed field type available for addon * * @since 1.1 * @return array */ function forminator_get_allowed_field_types_for_addon() { } /** * Format Form Fields * * @since 1.1 * * @param Forminator_Base_Form_Model $custom_form_model Base form model. * * @return array */ function forminator_addon_format_form_fields(\Forminator_Base_Form_Model $custom_form_model) { } /** * Flatten multiple field * * @since 1.1 * * @param array $field_array Field. * * @return array|bool array flatten multi-field or false, when its not considered as multi-field */ function forminator_addon_flatten_mutiple_field($field_array) { } /** * Formatted submmiited data of Form to used by addon * * @since 1.1 * @since 1.3 add entry fields as parameter to trace back submit data to entry fields to be added * * @param array $form_fields Existing form fields. * @param array $current_entry_fields Current entry fields. * * @return array */ function forminator_format_submitted_data_for_addon($form_fields, $current_entry_fields = array()) { } /** * Format form settings to used by addon * * @since 1.1 * * @param Forminator_Base_Form_Model $custom_form Base form model. * * @return array formatted and filtered form settings */ function forminator_addon_format_form_settings(\Forminator_Base_Form_Model $custom_form) { } /** * Find addon meta data from entry model that saved on db * * @since 1.1 * * @param Forminator_Integration $connected_addon Connected addon. * @param Forminator_Form_Entry_Model $entry_model Form entry model. * * @return array */ function forminator_find_addon_meta_data_from_entry_model(\Forminator_Integration $connected_addon, \Forminator_Form_Entry_Model $entry_model) { } /** * Generate Html for **single** addon * * Used on Integrations page, and Form Settings Integration Tab * * @param array $addon that already formatted to_array. * @param int $module_id Module Id. * @param string $module_slug Module type. * @param bool $show_pro_info Show PRO info. * @param bool $is_active (show as active addon ?). * * @return string */ function forminator_addon_row_html_markup($addon, $module_id, $module_slug = 'form', $show_pro_info = \true, $is_active = \true) { } /** * Add log of forminator addon related if permitted * * To be this can be active : * - WP_DEBUG : true * - FORMINATOR_ADDON_DEBUG : true * - forminator_addon_enable_log : true * * @see forminator_maybe_log() * * @since 1.1 * @since 1.3 add FORMINATOR_ADDON_DEBUG as enabled flag */ function forminator_addon_maybe_log() { } /** * Replacer custom form vars * * @since 1.2 * * @param string $content Content. * @param array $submitted_data Submitted data. * @param Forminator_Form_Model $custom_form Form model. * @param array $entry_meta Entry meta. * @param bool $allow_html Allow HTML. * @param mixed $entry Entry. * * @return mixed|string */ function forminator_addon_replace_custom_vars($content, $submitted_data, \Forminator_Form_Model $custom_form, $entry_meta, $allow_html = \false, $entry = \null) { } /** * Get admin url of addon integration page * * @since 1.2 * * @param mixed $addon Addon. * @param mixed $section Section. * @param bool $with_nonce With nonce. * @param string $identifier Identifier. * * @return string */ function forminator_addon_integration_section_admin_url($addon, $section, $with_nonce = \true, $identifier = '') { } /** * Get Registered Addons * * @since 1.5.3 * * @return Forminator_Integration[] */ function forminator_get_registered_addons() { } /** * Find addon meta data from entry model that saved on db * * @since 1.5.3 * * @param Forminator_Form_Entry_Model $entry_model Form entry model. * * @return array */ function forminator_find_addon_slugs_from_entry_model(\Forminator_Form_Entry_Model $entry_model) { } /** * Format poll settings to used by addon * * @since 1.6.1 * * @param Forminator_Base_Form_Model $poll Base form model. * * @return array formatted and filtered form settings */ function forminator_addon_format_poll_settings(\Forminator_Base_Form_Model $poll) { } /** * Format Poll Fields (contains poll answers) * * @since 1.6.1 * * @param Forminator_Base_Form_Model $poll Base form model. * * @return array */ function forminator_addon_format_poll_fields(\Forminator_Base_Form_Model $poll) { } /** * Format quiz settings to used by addon * * @since 1.6.2 * * @param Forminator_Quiz_Model $quiz Quiz model. * * @return array formatted and filtered form settings */ function forminator_addon_format_quiz_settings(\Forminator_Quiz_Model $quiz) { } /** * Lead form data * * @param array $submitted_data Submitted data. * * @return Forminator_Form_Entry_Model|null */ function forminator_lead_form_data($submitted_data) { } /** * Addons lead submitted data * * @param array $form_fields Form fields. * @param mixed $entries Entries. * * @return array */ function forminator_addons_lead_submitted_data($form_fields, $entries) { } /** * Get lead data * * @param array $quiz_settings Quiz settings. * @param array $submitted_data Submitted data. * @param array $addons_fields Addon fields. * * @return array */ function get_addons_lead_form_entry_data($quiz_settings, $submitted_data, $addons_fields) { } /** * Get quiz data * * @param mixed $quiz Quiz. * @param array $data Data. * @param array $quiz_entry_fields Quiz entry fields. * * @return mixed */ function get_quiz_submitted_data($quiz, $data, $quiz_entry_fields) { } /** * Flag whether doc link should shown or not for addons * * @since 1.14.2 * @return bool */ function forminator_is_show_addons_documentation_link() { } /** * Callable function for Autofill related * * @package Forminator */ /** * Build autofill providers from $slug_attributes array * * @since 1.0.5 * * @param array $slug_attributes Slug attributes. * * @return array */ function forminator_build_autofill_providers($slug_attributes) { } /** * Init autofill provider by its slug * * @since 1.0.5 * * @param string $provider_slug provider slug. * * @return Forminator_Autofill_Provider_Abstract|null */ function forminator_autofill_init_provider($provider_slug) { } /** * Core helper functions. * * @package Forminator */ /** * Return needed cap for admin pages * * @since 1.0 * @return string */ function forminator_get_admin_cap() { } /** * Checks if user is allowed to perform the ajax actions * * @since 1.0 * @since 1.28 Added $slug param. * * @param string $slug The page slug that will be used for identifying permission. * * @return bool */ function forminator_is_user_allowed($slug = '') { } /** * Check if array value exists * * @since 1.0 * * @param array $array_values Array for check value exists. * @param string $key - the string key. * * @return bool */ function forminator_array_value_exists($array_values, $key) { } /** * Check for theme and return key. * * @since 1.36.0 * * @param string $key - default key value. * @param string $theme - current theme of the form. * @since 1.0 * @return string */ function forminator_get_prefixed_key_name($key, $theme) { } /** * Check if array value exists * * @since 1.14.7 * * @param array $properties All properties. * @param string $key Key. */ function forminator_echo_font_weight($properties, $key) { } /** * Convert object to array * * @since 1.0 * * @param object $object_values Object for convert to array. * * @return array */ function forminator_object_to_array($object_values) { } /** * Return AJAX url * * @since 1.0 * @return mixed */ function forminator_ajax_url() { } /** * Checks if the AJAX call is valid * For logged-in usage only. * * @since 1.0 * @since 1.17 Added $query_arg * @since 1.28 Added $page_slug For determining capability to check. * * @param string $action Ajax action. * @param mixed $query_arg Query arguments. * @param string $page_slug Page slug. */ function forminator_validate_ajax($action, $query_arg = \false, $page_slug = '') { } /** * Checks if the AJAX call is valid * * @param string $action Action name. * @param string|bool $query_arg Query arg. * * @return void */ function forminator_validate_nonce_ajax($action, $query_arg = \false) { } /** * Enqueue admin fonts * * @since 1.0 */ function forminator_admin_enqueue_fonts() { } /** * Enqueue admin styles * * @since 1.0 * @since 1.1 Remove forminator-admin css after migrate to shared-ui */ function forminator_admin_enqueue_styles() { } /** * Enqueue jQuery UI scripts on admin * * @since 1.13 Loaded locally * @since 1.0 */ function forminator_admin_jquery_ui() { } /** * Load admin scripts * * @since 1.0 */ function forminator_admin_jquery_ui_init() { } /** * Enqueue SUI scripts on admin * * @since 1.1 */ function forminator_sui_scripts() { } /** * Remove select2 script of PMPro on admin * * @since 1.36 */ function forminator_remove_pmpro_scripts() { } /** * Enqueue common admin scripts * * @since 1.0 * @param bool $is_new_page Load scripts for new page classes. */ function forminator_common_admin_enqueue_scripts($is_new_page = \false) { } /** * Enqueue color picker alpha scripts * * @since 1.14 */ function forminator_enqueue_color_picker_alpha() { } /** * Enqueue front-end styles * * Only use core here, if the style dynamically loaded, then load on model * * @since 1.0 */ function forminator_print_front_styles() { } /** * Enqueue front-end script * * Only use core here, if the style dynamically loaded, then load on model * * @since 1.0 */ function forminator_print_front_scripts() { } /** * Return front-end localization data * * @since 1.0 */ function forminator_localize_data() { } /** * Return existing templates * * @since 1.0 * * @param string $path Path. * @param array $args Arguments. * * @return mixed */ function forminator_template($path, $args = array()) { } /** * Return if template exist * * @since 1.0 * * @param string $path Path. * * @return bool */ function forminator_template_exist($path) { } /** * Return if paypal settings are filled * * @since 1.0 * @return bool */ function forminator_has_paypal_settings() { } /** * Return if captcha settings are filled * * @since 1.0 * @return bool */ function forminator_has_captcha_settings() { } /** * Return if captcha v2 settings are filled * * @since 1.0 * @return bool */ function forminator_has_v2_captcha_settings() { } /** * Return if captcha v2 invisible settings are filled * * @since 1.0 * @return bool */ function forminator_has_v2_invisible_captcha_settings() { } /** * Return if captcha v3 settings are filled * * @since 1.0 * @return bool */ function forminator_has_v3_captcha_settings() { } /** * Return if hCaptcha keys are filled * * @since 1.15.5 * @return bool */ function forminator_has_hcaptcha_settings() { } /** * Return if Cloudflare Turnstile keys are filled * * @return bool */ function forminator_has_turnstile_settings(): bool { } /** * Return if Stripe is is_connected * * @since 1.7 * @return bool */ function forminator_has_stripe_connected() { } /** * Return form ID * * @since 1.0 * @return int */ function forminator_get_form_id_helper() { } /** * Get Page IDs * * @since 1.2 * @return array */ function forminator_get_page_ids_helper() { } /** * Return form type * * @param mixed $common_name Common name. * * @since 1.0 * @return int|null|string */ function forminator_get_form_type_helper($common_name = \false) { } /** * Forminator get exporter info * * @since 1.0 * * @param string $info Exporter Info. * @param string $key Key. * * @return mixed */ function forminator_get_exporter_info($info, $key) { } /** * Return current logged in username * * @since 1.0 * @return string */ function forminator_get_current_username() { } /** * Delete export logs * * @since 1.0 * * @param int $form_id Form Id. * * @return bool */ function delete_export_logs($form_id) { } /** * Forminator get export logs * * @since 1.0 * * @param int $form_id Form Id. * * @return array */ function forminator_get_export_logs($form_id) { } /** * Get the current post ID from server context (AJAX or non-AJAX). * * @since 1.53.0 * * @return int Post ID or 0 if not available. */ function forminator_get_current_post_id() { } /** * Return current page url * * @since 1.0.3 * * @return mixed */ function forminator_get_current_url() { } /** * Detect whether current request comes from Breakdance builder SSR preview. * * @since 1.54.0 * * @return bool */ function forminator_is_breakdance_builder_preview() { } /** * Detect whether current request comes from any page builder preveiw page * * @since 1.13 * * @return bool */ function forminator_is_page_builder_preview() { } /** * Return week day from number * * @since 1.0 * * @param string $day Day. * * @return string */ function forminator_get_day_translated($day) { } /** * Add log of forminator * * By default it will check `WP_DEBUG` and `FORMINATOR_DEBUG` * Then will check `filters` * * @since 1.1 * @since 1.3 add FORMINATOR_DEBUG as enabled flag */ function forminator_maybe_log() { } /** * Helper to cast variable to target type * * @since 1.6 * * @param mixed $variable Variable. * @param string $type Variable type. * * @return mixed */ function forminator_var_type_cast($variable, $type) { } /** * Get chart colors combination for Polls * * @since 1.5.3 * * @param int $poll_id Poll Id. * @param bool $accessibility_enabled Enable accessibility. * * @return array */ function forminator_get_poll_chart_colors($poll_id = \null, $accessibility_enabled = \false) { } /** * Return CAPTCHA languages * * @since 1.5.4 * @return array */ function forminator_get_captcha_languages() { } /** * Flag whether doc link should shown or not * * @since 1.6 * @return bool */ function forminator_is_show_documentation_link() { } /** * Flag whether branding should shown or not * * @since 1.6 * @return bool */ function forminator_is_show_branding() { } /** * Check if whitelabel enable. * * @return bool */ function forminator_can_whitelabel() { } /** * Get Dashboard settings * * @since 1.6.3 * * @param string|null $widget Widget. * @param mixed $default_value Default value. * * @return array|mixed */ function forminator_get_dashboard_settings($widget = \null, $default_value = array()) { } /** * Reset Forminator Settings * * @see forminator_delete_custom_options() * @see forminator_delete_addon_options() * @see forminator_delete_custom_posts() * @since 1.6.3 */ function forminator_reset_settings() { } /** * Get Forminator CPT names * * @return array */ function forminator_form_types() { } /** * DON'T USE IT!!! It's only for backward compatibility * Get prefix based on module slug. * * @param string $module_slug Module slug. * @param string $form_prefix Optional. Prefix before Custom Form type or `post_type` value. * @param bool $ucfirst Optional. With capital the first letter. * @param bool $plural Optional. Plural or singular. * @return string */ function forminator_get_prefix($module_slug, $form_prefix = '', $ucfirst = \false, $plural = \false) { } /** * Add Slash in string * * @since 1.8 * * @param string $value Values to add slashes. * @param string $char Character. * * @return string */ function forminator_addcslashes($value, $char = '"\/') { } /** * Return URL link. * * @since 1.13 * * @param string $link_for Accepts: 'docs', 'plugin', 'rate', 'support', 'roadmap'. * @param string $campaign Utm campaign tag to be used in link. Default: ''. * * @return string */ function forminator_get_link($link_for, $campaign = '') { } /** * Check if the plugin is active network wide. * * @since 1.13 forminator_membership_status * @since 1.18.2 Change how membership is detected * * @return bool */ function forminator_can_install_pro() { } /** * Check if the plugin is active network wide. * * @since 1.13 * * @return bool */ function forminator_is_networkwide() { } /** * Check if user is a WPMU DEV admin. * * @since 3.1.4 * * @return bool */ function is_wpmu_dev_admin() { } /** * Check membership status * * Possible return values: * 'free' - Free hub membership. * 'single' - Single membership (i.e. only 1 project is licensed) * 'unit' - One or more projects licensed * 'full' - Full membership, no restrictions. * 'paused' - Membership access is paused. * 'expired' - Expired membership. * '' - (empty string) If user is not logged in or with an unknown type. * * @since 1.24.1 * * @return mixed */ function forminator_get_wpmudev_membership() { } /** * Check if site is connected * * @since 1.24.1 * * @return bool */ function forminator_is_site_connected_to_hub() { } /** * Global tracking * * @return mixed|null */ function forminator_global_tracking() { } /** * Get forminator capabilities. * * @return array */ function forminator_get_capabilities() { } /** * Apply forminator capabilities. * * @param object $subject Either WP_User or WP_Role object. * @param array $permission The current permission setting. * * @return [type] */ function forminator_apply_capabilities($subject, $permission) { } /** * Get the appropriate capability based on Permission settings. * * @param string $page_slug Used for determining capability. * Can also be used for getting cap for 'current_user_can' function. * * @return string */ function forminator_get_permission($page_slug) { } /** * Delete forminator permissions and revoke caps. * Used on uninstallation and * * @since 1.28.0 */ function forminator_delete_permissions() { } /** * Searches for $needle in the multidimensional array $haystack. * * @url https://stackoverflow.com/a/28473219 * * @param mixed $needle The item to search for. * @param array $haystack The array to search. * * @return array|bool The indices of $needle in $haystack across the * various dimensions. FALSE if $needle was not found. */ function forminator_recursive_array_search($needle, $haystack) { } /** * Get Accessible user roles * * @return array */ function forminator_get_accessible_user_roles() { } /** * Check registration form permissions and access. * * @param array $settings Settings. * @return bool|WP_Error */ function forminator_check_registration_form_permissions($settings) { } /** * Validate registration form settings. * * @param array $settings Settings. * @return bool|WP_Error */ function forminator_validate_registration_form_settings($settings) { } /** * Can the current user approve a user and create a site. * * @param object $signup Signup. * @return bool */ function forminator_can_approve_user_and_create_site($signup) { } /** * Can apply forminator default color * * @param array $settings Form settings. * @return bool */ function forminator_can_apply_default_color($settings) { } /** * Schedule recurring action. * * @param string $action Action name. * @param int $interval Expiration time in seconds. * * @return bool */ function forminator_set_recurring_action(string $action, int $interval): bool { } /** * Check if cloud templates are disabled * * @return bool */ function forminator_cloud_templates_disabled(): bool { } /** * Check if user registration is enabled in WordPress settings. * * @return bool */ function forminator_is_user_registration_enabled() { } /** * Check if site registration is enabled in WordPress settings. * * @return bool */ function forminator_is_site_registration_enabled() { } /** * Currency list * * @return mixed */ function forminator_pp_currency_list() { } /** * Return list of currencies for Stripe * updated: Oct 21, 2020 * Removed currencies but might be supported back later (18): * BHD, BYR, CUP, SVC, EEK, GHC, GGP, IRR, IMP, JEP, KWD, LVL, LTL, KPW, OMR, SYP, TVD, VEF * Added currencies (31): * AMD, AOA, BDT, BIF, CDF, CVE, DJF, DZD, ETB, GMD, GNF, HTG, KMF, LSL, MDL, MGA, MMK, MOP, * MRO, MVR, MWK, PGK, RWF, SLL, STD, SZL, TJS, TOP, TZS, UGX, VUV, WST, XPF * * @since 1.0 * @since 1.15 Added new supported currencies and removed unsupported * @since 1.20 Added JOD * * @url Stripe Currencies: https://stripe.com/docs/currencies * @url Unicode hex table: https://gist.github.com/mroyce/a7e37ced540f45104de4cc03224937c7 * * @return array */ function forminator_currency_list() { } /** * Get currency * * @since 1.0 * @param string $currency_code - the currency code. * * @return string */ function forminator_get_currency($currency_code) { } /** * Get currency symbol * * @since 1.0 * @return string */ function forminator_get_currency_symbol() { } /** * Return custom form * * @param int $id Id. * @param bool $is_preview Is preview?. * @param bool $is_block_editor Is block editor?. * * @since 1.0 * @return mixed */ function forminator_form($id, $is_preview = \false, $is_block_editor = \false) { } /** * Return custom form * * @param int $id Id. * @param bool $is_preview Is preview?. * @param bool $hidden Is hidden?. * * @since 1.0 * @return mixed */ function forminator_poll($id, $is_preview = \false, $hidden = \true) { } /** * Return custom form * * @param int $id Id. * @param bool $is_preview Is preview?. * @param bool $hidden Is hidden?. * * @since 1.0 * @return mixed */ function forminator_quiz($id, $is_preview = \false, $hidden = \true) { } /** * Return module * * @param int $id Id. * @param string $type Form type. * @param bool $ajax Is Ajax?. * @param mixed $data Data. * * @since 1.0 * @return mixed */ function forminator_preview($id, $type, $ajax = \false, $data = \false) { } /** * Return stripslashed string or array * * @param string $val Content to strip slashes. * * @since 1.0 * @return mixed */ function forminator_stripslashes_deep($val) { } /** * Sanitize field * * @since 1.0.2 * * @param mixed $field Field. * @param null|string $key Key. * * @return array|string */ function forminator_sanitize_field(&$field, $key = \null) { } /** * Forminator sanitation for module settings before saving. * Used for sanitizing form integration settings description field. * * @param array $fields Fields. * * @return mixed */ function forminator_sanitize_array_field($fields) { } /** * Forminator decode HTML entity * * @param array $fields Fields. * * @return mixed */ function forminator_decode_html_entity($fields) { } /** * Sort fields so that grouped fields appear immediately after their parent group. * * @since 1.51.0 * @param array $fields Array of field arrays. * @return array Sorted fields array. */ function forminator_sort_fields_with_groups(array $fields): array { } /** * Sanitize text area * * @param string $field Field value. * * @return string */ function forminator_sanitize_textarea($field) { } /** * Return the array of ALL fields objects * * @since 1.0 * @return mixed */ function forminator_get_fields() { } /** * Return the array of PRO fields for promotion PRO version * * @return array */ function forminator_get_pro_fields() { } /** * Return all existing custom fields * * @since 1.0 * @deprecated 1.5.4 * @return mixed */ function forminator_get_existing_cfields() { } /** * Convert array to array compatible with field values * * @since 1.0 * * @param array $array_values Field values. * @param bool $replace_value Replace value. * * @return array */ function forminator_to_field_array($array_values, $replace_value = \false) { } /** * Return max upload limit from server * * @since 1.6 * @return int Mb */ function forminator_get_max_upload() { } /** * Return users list * * @since 1.6 * @return array */ function forminator_list_users() { } /** * Return post type list * * @since 1.7 * @return array */ function forminator_post_type_list() { } /** * Return post type Categories * * @since 1.7 * * @param string $type Type. * * @return array */ function forminator_post_categories($type = '') { } /** * Return vars * * @since 1.0 * @since 1.5 add `user_id` * * @param bool $for_hidden_field For hidden field. @since 1.15.6. * * @return mixed */ function forminator_get_vars($for_hidden_field = \false) { } /** * Return Stripe vars * * @since 1.7 * @return mixed */ function forminator_get_payment_vars() { } /** * Return Stripe subscription vars * * @since 1.38 * @return array */ function forminator_get_stripe_subscription_vars() { } /** * Return required icon * * @since 1.0 * @return string */ function forminator_get_required_icon() { } /** * Return week days * * @since 1.0 * @return array */ function forminator_week_days() { } /** * Return name prefixes * * @since 1.0 * @return array */ function forminator_get_name_prefixes() { } /** * Translate name prefix * * @param string $prefix Prefix. * @param Forminator_Form_Model|null $form_model Form model. * @return string */ function forminator_translate_name_prefix($prefix, $form_model = \null) { } /** * Return field id by string * * @since 1.0 * * @param string $field_id Field id. * * @return mixed */ function forminator_clear_field_id($field_id) { } /** * Return filtered editor content with form data * * @since 1.0 * @param string $content Content. * @param Forminator_Form_Model|null $custom_form Forminator_Form_Model. * @param Forminator_Form_Entry_Model|null $entry Forminator_Form_Entry_Model. * @param bool $get_labels Optional. Set true for getting labels instead of values for select, radio and checkbox. * @param bool $urlencode Encode URL. * @param mixed $user_meta User meta. * @param bool $is_pdf Is PDF. * @return mixed */ function forminator_replace_form_data($content, ?\Forminator_Form_Model $custom_form = \null, ?\Forminator_Form_Entry_Model $entry = \null, $get_labels = \false, $urlencode = \false, $user_meta = \false, $is_pdf = \false) { } /** * Rewrite sibling field placeholders inside HTML field content for a repeated copy. * * @param string $value HTML content containing placeholders. * @param string $parent_group Parent repeater group slug. * @param string $suffix Numeric copy suffix without leading dash (e.g. '2'). * @param Forminator_Form_Model $custom_form Form model. * @return string */ function forminator_rewrite_html_field_placeholders(string $value, string $parent_group, string $suffix, \Forminator_Form_Model $custom_form): string { } /** * Get value from from entry * * @since 1.46 * @param string $element_id Field Id. * @param Forminator_Form_Model|null $custom_form Forminator_Form_Model. * @param Forminator_Form_Entry_Model|null $entry Forminator_Form_Entry_Model. * @param bool $get_labels Optional. Set true for getting labels instead of values for select, radio and checkbox. * @param bool $urlencode Encode URL. * @param mixed $user_meta User meta. * @param bool $is_pdf Is PDF. * @return mixed */ function forminator_get_value_from_form_entry($element_id, ?\Forminator_Form_Model $custom_form = \null, ?\Forminator_Form_Entry_Model $entry = \null, $get_labels = \false, $urlencode = \false, $user_meta = \false, $is_pdf = \false) { } /** * Resolve draft entry display value for select, radio and checkbox fields. * * @since 1.54.0 * * @param Forminator_Form_Entry_Model $entry Entry model. * @param string $element_id Element ID (meta key). * @param string $field_type Field type. * @param string $value Current display value. * @param Forminator_Form_Model|null $form Form model. * * @return string Label or original value. */ function forminator_resolve_draft_display_value($entry, $element_id, $field_type, $value, $form = \null) { } /** * Replace select, checkbox and radio fields data * * @since 1.23.0 * * @param Forminator_Form_Model $custom_form Forminator_Form_Model. * @param string $element_id Element Id. * @param array $data Data. * @param bool $is_pdf Is PDF. * @param bool $print_value Whether to show values instead of labels. * * @return mixed */ function forminator_replace_field_data($custom_form, $element_id, $data, $is_pdf = \false, $print_value = \false) { } /** * Format custom form data variables to html formatted * * @since 1.0.3 * * @param string $content Content. * @param Forminator_Form_Model $custom_form Forminator_Form_Model. * @param Forminator_Form_Entry_Model $entry Forminator_Form_Entry_Model. * @param array $excluded Excluded. * * @return mixed */ function forminator_replace_custom_form_data($content, \Forminator_Form_Model $custom_form, \Forminator_Form_Entry_Model $entry, $excluded = array()) { } /** * Replace placeholder occurrences inside URLs with provided value. * * @param string $content Original content. * @param string $placeholder Placeholder. * @param string $value Replacement value. * * @return string Updated content. */ function forminator_replace_placeholder_in_urls(string $content, string $placeholder, string $value): string { } /** * Get Html Formatted of form entry for email notification * * @since 1.0.3 * * @param Forminator_Form_Model $custom_form Forminator_Form_Model. * @param Forminator_Form_Entry_Model $entry Forminator_Form_Entry_Model. * @param boolean $exclude_empty [Optional] Exclude empty form entry. * * @return string */ function forminator_get_formatted_form_entry(\Forminator_Form_Model $custom_form, \Forminator_Form_Entry_Model $entry, $exclude_empty = \false) { } /** * Prepare Html Formatted of group field for email notification * * @param string $group_id Group ID. * @param Forminator_Form_Model $custom_form Forminator_Form_Model. * @param Forminator_Form_Entry_Model $entry Forminator_Form_Entry_Model. * @param boolean $exclude_empty Exclude empty form entry. * @param boolean $is_pdf Is PDF. * * @return string */ function forminator_prepare_formatted_group_field(string $group_id, \Forminator_Form_Model $custom_form, \Forminator_Form_Entry_Model $entry, bool $exclude_empty = \false, bool $is_pdf = \false): string { } /** * Prepare Html Formatted of form entry for email notification * * @param Forminator_Form_Model $custom_form Forminator_Form_Model. * @param Forminator_Form_Entry_Model $entry Forminator_Form_Entry_Model. * @param boolean $exclude_empty Exclude empty form entry. * @param array $form_fields Form fields. * @param string $repeater_suffix Repeater suffix. * @param boolean $show_label Show label. * @param string $list_tag List tag. * @param boolean $is_pdf Is PDF. * * @return string */ function forminator_prepare_formatted_form_entry(\Forminator_Form_Model $custom_form, \Forminator_Form_Entry_Model $entry, $exclude_empty, $form_fields = \null, $repeater_suffix = '', $show_label = \true, $list_tag = 'ol', $is_pdf = \false) { } /** * Get Html Formatted of form entry * * @since 1.0.3 * * @param Forminator_Form_Model $custom_form Forminator_Form_Model. * @param Forminator_Form_Entry_Model $entry Forminator_Form_Entry_Model. * * @return string */ function forminator_get_formatted_form_non_empty_entry(\Forminator_Form_Model $custom_form, \Forminator_Form_Entry_Model $entry) { } /** * Get field from registered entries * * @since 1.0.5 * @since 1.24 Added $user_meta * * @param string $element_id Element Id. * @param Forminator_Form_Model $custom_form Forminator_Form_Model. * @param Forminator_Form_Entry_Model $entry Forminator_Form_Entry_Model. * @param bool $user_meta Check if usage is for user meta. * * @return string */ function forminator_get_field_from_form_entry($element_id, \Forminator_Form_Model $custom_form, \Forminator_Form_Entry_Model $entry, $user_meta = \false) { } /** * Get Html Formatted of form name * * @since 1.0.3 * * @param Forminator_Form_Model $custom_form Forminator_Form_Model. * @param Forminator_Form_Entry_Model $entry Forminator_Form_Entry_Model. * * @return string */ function forminator_get_formatted_form_name(\Forminator_Form_Model $custom_form, \Forminator_Form_Entry_Model $entry) { } /** * Get Submission ID * * @since 1.1 * * @param Forminator_Form_Model|null $custom_form Forminator_Form_Model. * @param Forminator_Form_Entry_Model $entry Forminator_Form_Entry_Model. * * @return string */ function forminator_get_submission_id(?\Forminator_Form_Model $custom_form = \null, $entry = \null) { } /** * Get referer url * * @since ? * * @param string $embed_url Embed URL. * @return string */ function forminator_get_referer_url($embed_url = '') { } /** * Get Submission URL * * @since 1.11 * * @param Forminator_Form_Model $custom_form Forminator_Form_Model. * @param Forminator_Form_Entry_Model $entry Forminator_Form_Entry_Model. * * @return string */ function forminator_get_submission_url(\Forminator_Form_Model $custom_form, \Forminator_Form_Entry_Model $entry) { } /** * Get account approval link * * @since 1.11 * * @param Forminator_Form_Model $custom_form Forminator_Form_Model. * @param Forminator_Form_Entry_Model $entry Forminator_Form_Entry_Model. * * @return string */ function forminator_get_account_approval_link(\Forminator_Form_Model $custom_form, \Forminator_Form_Entry_Model $entry) { } /** * Get username from registration form * * @since 1.11 * * @param Forminator_Form_Model $custom_form Forminator_Form_Model. * @param Forminator_Form_Entry_Model $entry Forminator_Form_Entry_Model. * * @return string */ function forminator_get_formatted_username(\Forminator_Form_Model $custom_form, \Forminator_Form_Entry_Model $entry) { } /** * Get line break * * @since 1.11 * * @return string */ function forminator_get_formatted_line_break() { } /** * Get loggin URL * * @param string $embed_url Current URL. * @return string */ function forminator_get_login_url($embed_url) { } /** * Return filtered editor content with replaced variables * * @since 1.0 * @since 1.0.6 add `{form_id}` handle * * @param string $content Content to replace the variables. * @param int $id Id. * @param mixed $entry Entry. * * @return string */ function forminator_replace_variables($content, $id = \false, $entry = \null) { } /** * Render entry * Used in email notifications * TODO: refactor this * * @since 1.0 * @since 1.24 Added $att_id_only param. * * @param object $item - the entry. * @param string $column_name - the column name. * * @param null $field @since 1.0.5, optional Forminator_Form_Field_Model. * @param string $type Type. * @param bool $remove_empty Remove empty. * @param bool $att_id_only If output needs attachment ID only. E.g. when upload field is used with ACF file type. * @param string $separator Separator for some entries. Line break by default. (Added for PDF addon). * @param bool $show_label @since 1.25, added for PDF generation. * @return string */ function render_entry($item, $column_name, $field = \null, $type = '', $remove_empty = \false, $att_id_only = \false, $separator = '
', $show_label = \true) { } /** * Check, maybe field doesn't exist anymore * * @param string $element_id Field slug. * @param array $fields Fields. * @param int $form_id Form id. * @return boolean */ function forminator_old_field($element_id, $fields, $form_id) { } /** * Remove prefixes from field slug * * @param string $field_id Field slug. * @return string */ function forminator_remove_prefixes($field_id) { } /** * Return countries list * * @since 1.0 * @return array */ function forminator_get_countries_list() { } /** * Return sorted available fields * * @since 1.6 * * @param string $sort_attr Attribute. * @param int $sort_flag Sort flag. * * @return array */ function forminator_get_fields_sorted($sort_attr, $sort_flag = \SORT_ASC) { } /** * Retrieves the list of common file extensions and their types. * * Extending @see get_allowed_mime_types without filter * * @since 1.6 */ function forminator_get_ext_types() { } /** * Get Forminator extension types with MIME type values. * * Returns the raw mapping of extension keys to MIME types, grouped by category, * before array_keys() strips the MIME values. * * @since 1.53 * * @return array Category => array( 'ext_key' => 'mime/type', ... ). */ function forminator_get_ext_types_with_mime() { } /** * Format poll data variables to html formatted * * @since 1.6.1 * * @param string $content Content. * @param Forminator_Poll_Model $poll Forminator_Poll_Model. * @param array $data - submitted `_POST` data. * @param Forminator_Form_Entry_Model $entry Forminator_Form_Entry_Model. * * @return mixed */ function forminator_replace_poll_form_data($content, \Forminator_Poll_Model $poll, $data, \Forminator_Form_Entry_Model $entry) { } /** * Return vars for poll * * @since 1.6.1 * @return mixed */ function forminator_get_poll_vars() { } /** * Format quiz data variables to html formatted * * @since 1.6.2 * * @param string $content Content. * @param Forminator_Quiz_Model $quiz Forminator_Quiz_Model. * @param Forminator_Form_Entry_Model $entry Forminator_Form_Entry_Model. * * @return mixed */ function forminator_replace_quiz_form_data($content, \Forminator_Quiz_Model $quiz, \Forminator_Form_Entry_Model $entry) { } /** * Return uniq key value * * @since 1.13 * * @return string */ function forminator_unique_key() { } /** * Return vars for quiz * * @since 1.6.2 * @return array */ function forminator_get_quiz_vars() { } /** * Replace Stripe data * * @param string $content Content. * @param Forminator_Form_Model $custom_form Forminator_Form_Model. * @param Forminator_Form_Entry_Model $entry Forminator_Form_Entry_Model. * * @return mixed */ function forminator_replace_form_payment_data($content, ?\Forminator_Form_Model $custom_form = \null, ?\Forminator_Form_Entry_Model $entry = \null) { } /** * Payment data * * @param string $content Content. * @param Forminator_Form_Model $custom_form Forminator_Form_Model. * @param Forminator_Form_Entry_Model $entry Forminator_Form_Entry_Model. * * @return array|mixed */ function forminator_payment_data($content, $custom_form, $entry) { } /** * Get Default date format * * @param string $format Date format. * * @return string */ function datepicker_default_format($format) { } /** * Reformat date * * @since 1.18.0 * * @param string $date_value - The date. * @param string $date_format - The current date format. * @param string $new_format - The new date format. * * @return string */ function forminator_reformat_date($date_value, $date_format, $new_format) { } /** * Get entry field value helper * * @since 1.14 * * @param Forminator_Form_Entry_Model $entry Forminator_Form_Entry_Model. * @param array $mapper Mapper. * @param string $sub_meta_key Meta key. * @param bool $allow_html Allow HTML. * @param int $truncate Truncate. * * @return string */ function forminator_get_entry_field_value($entry, $mapper, $sub_meta_key = '', $allow_html = \false, $truncate = \PHP_INT_MAX) { } /** * Forminator upload path * * @return string|null|WP_Error */ function forminator_upload_root_temp() { } /** * Forminator Upload root * * @param string $base Base type. * * @return string|null|WP_Error */ function forminator_upload_root($base = 'path') { } /** * Forminator custom root * * @param array $dir Directory. * @param string $base Base. * * @return string */ function forminator_custom_upload_root($dir, $base) { } /** * Forminator get upload path * * @param int $form_id Form Id. * @param string $dir Directory. * @param string $base Base. * * @return string */ function forminator_get_upload_path($form_id, $dir = '', $base = 'path') { } /** * Forminator get upload url * * @param int $form_id Form Id. * @param string $dir Directory. * * @return string */ function forminator_get_upload_url($form_id, $dir = '') { } /** * Replace lead form data * * @param string $content Content. * @param array $quiz_settings Quiz settings. * @param Forminator_Form_Entry_Model|null $entry Forminator_Form_Entry_Model. * * @return string */ function forminator_replace_lead_form_data($content, $quiz_settings, ?\Forminator_Form_Entry_Model $entry = \null) { } /** * Lead form data * * @param Forminator_Form_Entry_Model $entry Entry Model. * * @return array */ function forminator_lead_entry_data($entry) { } /** * Lead form submitted data * * @param mixed $lead_entry Lead entry. * * @return array */ function forminator_lead_submitted_data($lead_entry) { } /** * Check how many instances of a field type exists in a given post ID * * @param string $field_type Field type. * * @return int */ function forminator_count_field_type_in_page($field_type) { } /** * Trim field values * * @since 1.15.15 * * @param array $value Value array. * * @return array */ function forminator_trim_array($value) { } /** * Convert special HTML entities back to characters * * @since 1.40 * @param array $value Value array. * @return array */ function forminator_htmlspecialchars_decode_array($value) { } /** * Get cloned fields keys * * @param object $entry Entry object. * @param array $original_keys All field slugs of the current group field. * @return array */ function forminator_get_cloned_field_keys($entry, $original_keys) { } /** * Truncate text * * @since 1.17.0 * * @param string $text Text for truncate. * @param int $truncate PHP_INT_MAX. */ function forminator_truncate_text($text, $truncate = \PHP_INT_MAX) { } /** * Query users. * * @since 1.20.0 * * @param string $search_string Search query. * @param array $exclude Array of user IDs to exclude from search. * * @return array */ function forminator_get_users_by_query($search_string, $exclude) { } /** * Forminator Get allow mime type * * @param array $mimes Mimes. * @param bool $allow Allow. * * @return array */ function forminator_allowed_mime_types($mimes = array(), $allow = \true) { } /** * List custom taxonomies * * @since 1.23.0 * @param array $meta_value Meta value. * @return array */ function forminator_list_custom_taxonomies($meta_value) { } /** * Emulate prepared_data * * @param Forminator_Base_Form_Model $custom_form_model Base form model. * @param object $entry Entry data. * @return array */ function recreate_prepared_data(\Forminator_Base_Form_Model $custom_form_model, $entry) { } /** * Return state code * * @since 1.32.0 * @param string $state Search state. * @return string */ function forminator_get_state_code($state) { } /** * Render Rating field * * @param mixed $rating_value Rating value. * @param array $rating_items Rating items. * * @return string */ function forminator_render_rating_field($rating_value, $rating_items) { } /** * Check if a file can be displayed as an image * * @param string $file_url File URL. * @return bool */ function forminator_can_display_as_image($file_url) { } /** * Get image markup for email notifications * * @param string $image_url Image URL. * @param string $alt_text Alt text for the image. * @param string $label Label to display below image. * @param string $context Context where this is used (radio, checkbox, signature, upload). * @return string */ function forminator_get_email_image_markup($image_url, $alt_text, $label = '', $context = '') { } /** * Return local timestamp * * @since 1.0 * * @param string $timestamp Timestamp. * * @return mixed */ function forminator_local_timestamp($timestamp = \null) { } /** * Return user IP * * @since 1.0 * @return string */ function forminator_user_ip() { } /** * Return user property * * @param mixed $property Property. * * @since 1.0 * @return string */ function forminator_get_user_data($property) { } /** * Return user property * * @since 1.0 * * @param string $property Property. * @param int $post_id Post Id. * @param string $default_value Default value. * * @return string */ function forminator_get_post_data($property, $post_id = \null, $default_value = '') { } /** * Return total custom form records * * @param string $status Status. * @since 1.0 * * @return int */ function forminator_cforms_total($status = '') { } /** * Return custom forms * * @since 1.0 * @return Forminator_Base_Form_Model[] */ function forminator_custom_forms() { } /** * Return conversion rate from module * * @param array $module Module. * * @since 1.0 * @return mixed */ function forminator_get_rate($module) { } /** * Return total polls form records * * @param string $status Status. * @since 1.0 * * @return int */ function forminator_polls_total($status = '') { } /** * Return polls * * @since 1.0 * @return Forminator_Base_Form_Model[] */ function forminator_polls_forms() { } /** * Return total quizzes records * * @param string $status Status. * @since 1.0 * * @return int */ function forminator_quizzes_total($status = '') { } /** * Return quizzes * * @since 1.0 * @return Forminator_Base_Form_Model[] */ function forminator_quizzes_forms() { } /** * Check if quiz has leads * * @param mixed $model Model. * * @since 1.14 * * @return bool */ function forminator_quiz_has_leads($model) { } /** * Return quiz edit url * * @since 1.0 * * @param array $module Module. * @param int $id Module id. * * @return mixed */ function forminator_quiz_get_edit_url($module, $id) { } /** * Return total forms * * @param string $status Status. * * @since 1.0 * * @return int */ function forminator_total_forms($status = '') { } /** * Return form nice name by id * * @since 1.0 * * @param int $id Id. * * @return mixed */ function forminator_get_form_name($id) { } /** * Central per page for form view * * @param string $type View type. * * @since 1.0 * @return int */ function forminator_form_view_per_page($type = 'listings') { } /** * Return admin page url by slug * * @param string $slug Slug. * * @since 1.0 * @return mixed */ function forminator_get_admin_link($slug) { } /** * Return JS model to form model * * @since 1.0 * * @param array $data Data. * * @return array */ function forminator_data_to_model_form($data) { } /** * Return JS model to form model * * @since 1.0 * * @param array $data Data. * * @return array */ function forminator_data_to_model_poll($data) { } /** * Return JS model to form model * * @since 1.0 * * @param array $data Data. * * @return array */ function forminator_data_to_model_quiz($data) { } /** * Prepares the custom css string * * @since 1.0 * * @param string $css_string CSS string. * @param string $prefix prefix. * @param bool|false $as_array Prepare css as array. * @param bool|true $separate_prefix Separate prefix. * @param string $wildcard string. * * @return array|string */ function forminator_prepare_css($css_string, $prefix, $as_array = \false, $separate_prefix = \true, $wildcard = '') { } /** * Handle all pagination * * @since 1.0 * * @param int $total - the total records. * @param string $type - The type of page (listings or entries). * @param null|bool $is_ajax - If using ajax. Added in 1.52. */ function forminator_list_pagination($total, $type = 'listings', $is_ajax = \false) { } /** * Get Form Model from id * * @since 1.0.5 * * @param int $id Form Id. * * @return bool|Forminator_Base_Form_Model|null */ function forminator_get_model_from_id($id) { } /** * Get Latest entry based on $entry_type * [custom-forms, quizzes, poll] * will return null if there is no entry * * @param string $entry_type Entry Type. * * @return Forminator_Form_Entry_Model|null */ function forminator_get_latest_entry($entry_type) { } /** * Get Time of latest entry created based on $entry_type * [custom-forms, quizzes, poll] * * @param string $entry_type Entry Type. * * @return string */ function forminator_get_latest_entry_time($entry_type) { } /** * Get Latest entry based on $form_id * will return null if there is no entry * * @param int $form_id Form id. * @param string $order Order by. * * @return Forminator_Form_Entry_Model|null */ function forminator_get_latest_entry_by_form_id($form_id, $order = 'DESC') { } /** * Get Time of latest entry created based on $form_id * * @param int $form_id Form Id. * @param string $order Order by. * * @return string */ function forminator_get_latest_entry_time_by_form_id($form_id, $order = 'DESC') { } /** * Get Time of view created based on $form_id * * @param int $form_id Form Id. * @param string $order Order by. * * @return string */ function forminator_get_latest_view_time_by_form_id($form_id, $order = 'DESC') { } /** * Update Form Submission retention * * @since 1.0.6 * * @param int $form_id Form Id. * @param int $retention_number Retention number. * @param int $retention_unit Retention unit. * @param bool $draft Draft. */ function forminator_update_form_submissions_retention($form_id, $retention_number, $retention_unit, $draft = \false) { } /** * Clone form submission retention * * @since 1.0.6 * * @param int $old_id Old Id. * @param int $new_id New Id. */ function forminator_clone_form_submissions_retention($old_id, $new_id) { } /** * Update poll submission retention * * @since 1.0.6 * * @param int $poll_id Poll Id. * @param int $retention_number Retention number. * @param int $retention_unit Retention unit. */ function forminator_update_poll_submissions_retention($poll_id, $retention_number, $retention_unit) { } /** * Clone poll ip retention * * @since 1.0.6 * * @param int $old_id Old Id. * @param int $new_id New id. */ function forminator_clone_poll_submissions_retention($old_id, $new_id) { } /** * Return form nice name by model * * @since 1.6.1 * * @param Forminator_Base_Form_Model $model Base form model. * * @return string */ function forminator_get_name_from_model($model) { } /** * Return social share message * * @since 1.10 * * @param mixed $model Model. * @param string $title Title. * @param string $result Result. * @return mixed|string */ function forminator_get_social_message($model, $title, $result) { } /** * Get Chart data of Poll * * @param Forminator_Poll_Model $poll Poll model. * * @return array */ function forminator_get_chart_data(\Forminator_Poll_Model $poll) { } /** * Get a specific property of an array. * * @since 1.11 * * @param array $array_values Array from which the property's value should be retrieved. * @param string $prop Name of the property to be retrieved. * @param string $default_value Optional. Value that should be returned if the property is not set or empty. Defaults to null. * * @return null|string|mixed The value */ function forminator_get_property($array_values, $prop, $default_value = \null) { } /** * Flag whether this is the main site or not * * @since 1.11 * @return bool */ function forminator_is_main_site() { } /** * Flag whether this is subdomain network or not * * @since 1.11 * @return bool */ function forminator_is_subdomain_network() { } /** * Return quiz name by id * * @since 1.14 * * @param int $id Id. * * @return string */ function forminator_get_quiz_name($id) { } /** * Defender compatibility * * @return array */ function forminator_defender_compatibility() { } /** * Get schedule time * * @param array $schedule Schedule. * * @return string */ function forminator_get_schedule_time($schedule) { } /** * Replace line breaks * * @since 1.50 * * @param string $value Value. * * @return string */ function forminator_replace_linebreaks($value) { } /** * Return all fonts * * @since 1.0 * @return mixed */ function forminator_get_all_fonts() { } /** * Load & return fonts from Google * * @since 1.0 * @return mixed */ function forminator_load_from_google() { } /** * Fetch fonts from Bunny Fonts API and transform to the expected format. * * @since 1.54.0 * @return array|false Transformed fonts array or false on failure. */ function forminator_fetch_bunny_fonts() { } /** * Build variant strings from weights and styles arrays. * * @since 1.54.0 * @param array $weights Font weights. * @param array $styles Font styles. * @return array Variant strings. */ function forminator_build_font_variants($weights, $styles) { } /** * Return font families * * @param bool $is_object Is object. * * @since 1.0 * @return mixed */ function forminator_get_font_families($is_object) { } /** * Return cached fonts, fetching from Bunny Fonts API when the refresh flag has expired. * * Fonts are persisted in a WordPress option and a transient flag controls when they * should be refreshed from the Bunny Fonts API (every 30 days by default). * * @since 1.0 * @since 1.54.0 Stores fonts in a WP option and uses a transient flag to schedule refreshes. * @return string JSON-encoded font list. */ function forminator_cached_fonts() { } /** * Importer helper functions. * * @package Forminator */ /** * Return status of external plugins for Import/export feature * * If this function return false, Import/export feature for the * plugin will be disabled * * @since 1.7 * @param string $plugin Name of the plugin. * @return bool */ function forminator_is_import_plugin_enabled($plugin) { } /** * Get plugin deactivation link * * @param string $plugin Name of the plugin. * @param string $slug Plugin slug. * * @since 1.7 * * @return bool */ function forminator_get_disable_url($plugin, $slug) { } /** * Return status of external plugins for Import/export feature * * If this function return false, Import/export feature for the * plugin will be disabled * * @since 1.7 * @param array $plugins Name of the plugins. * @return bool */ function forminator_are_import_plugins_enabled($plugins = array()) { } /** * Return all the contact forms from thirdparties * * @param string $type type. * * @since 1.7 * @return array list of forms */ function forminator_list_thirdparty_contact_forms($type) { } /** * Mail Helper function **/ /** * Set the message variables * * @since 1.0 * @param string $embed_id Embed Id. * @param string $embed_title Embed title. * @param string $embed_url Embed URL. * @param string $user_name User name. * @param string $user_email User email. * @param string $user_login User login. * @param string $site_url Site URL. * * @return array */ function forminator_set_message_vars($embed_id, $embed_title, $embed_url, $user_name, $user_email, $user_login, $site_url) { } /** * Get global sender email from Global Settings * * @since 1.1 * @return string */ function get_global_sender_email_address() { } /** * Get global sender name from Global Settings * * @since 1.1 * @return string */ function get_global_sender_name() { } /** * Return the array of modules objects * * @since 1.0 * @return mixed */ function forminator_get_modules() { } /** * Return specific module by ID * * @since 1.0 * @param int $id Module Id. * * @return bool */ function forminator_get_module($id) { } /** * Payment helper functions. * * @package Forminator */ /** * Check if stripe payment lib loaded * * @since 1.7.0 * * @param string $version Version. * * @return bool */ function forminator_payment_lib_stripe_version_loaded($version = \FORMINATOR_STRIPE_LIB_VERSION) { } /** * Get stripe php lib version * * @since 1.7.0 * @return int|string */ function forminator_payment_lib_stripe_get_version() { } /** * Check if PayPal payment lib loaded * * @since 1.7.1 * * @param string $version Version. * * @return bool */ function forminator_payment_lib_paypal_version_loaded($version = \FORMINATOR_PAYPAL_LIB_VERSION) { } // WRCS: DEFINED_VERSION. // phpcs:disable Generic.Functions.OpeningFunctionBraceKernighanRitchie.ContentAfterBrace /** * Registers this version of Action Scheduler. */ function action_scheduler_register_3_dot_9_dot_2() { } // phpcs:disable Generic.Functions.OpeningFunctionBraceKernighanRitchie.ContentAfterBrace /** * Initializes this version of Action Scheduler. */ function action_scheduler_initialize_3_dot_9_dot_2() { } /** * Deprecated API functions for scheduling actions * * Functions with the wc prefix were deprecated to avoid confusion with * Action Scheduler being included in WooCommerce core, and it providing * a different set of APIs for working with the action queue. * * @package ActionScheduler */ /** * Schedule an action to run one time. * * @param int $timestamp When the job will run. * @param string $hook The hook to trigger. * @param array $args Arguments to pass when the hook triggers. * @param string $group The group to assign this job to. * * @return string The job ID */ function wc_schedule_single_action($timestamp, $hook, $args = array(), $group = '') { } /** * Schedule a recurring action. * * @param int $timestamp When the first instance of the job will run. * @param int $interval_in_seconds How long to wait between runs. * @param string $hook The hook to trigger. * @param array $args Arguments to pass when the hook triggers. * @param string $group The group to assign this job to. * * @deprecated 2.1.0 * * @return string The job ID */ function wc_schedule_recurring_action($timestamp, $interval_in_seconds, $hook, $args = array(), $group = '') { } /** * Schedule an action that recurs on a cron-like schedule. * * @param int $timestamp The schedule will start on or after this time. * @param string $schedule A cron-link schedule string. * @see http://en.wikipedia.org/wiki/Cron * * * * * * * * ┬ ┬ ┬ ┬ ┬ ┬ * | | | | | | * | | | | | + year [optional] * | | | | +----- day of week (0 - 7) (Sunday=0 or 7) * | | | +---------- month (1 - 12) * | | +--------------- day of month (1 - 31) * | +-------------------- hour (0 - 23) * +------------------------- min (0 - 59) * @param string $hook The hook to trigger. * @param array $args Arguments to pass when the hook triggers. * @param string $group The group to assign this job to. * * @deprecated 2.1.0 * * @return string The job ID */ function wc_schedule_cron_action($timestamp, $schedule, $hook, $args = array(), $group = '') { } /** * Cancel the next occurrence of a job. * * @param string $hook The hook that the job will trigger. * @param array $args Args that would have been passed to the job. * @param string $group Action's group. * * @deprecated 2.1.0 */ function wc_unschedule_action($hook, $args = array(), $group = '') { } /** * Get next scheduled action. * * @param string $hook Action's hook. * @param array $args Action's args. * @param string $group Action's group. * * @deprecated 2.1.0 * * @return int|bool The timestamp for the next occurrence, or false if nothing was found */ function wc_next_scheduled_action($hook, $args = \null, $group = '') { } /** * Find scheduled actions * * @param array $args Possible arguments, with their default values: * 'hook' => '' - the name of the action that will be triggered * 'args' => NULL - the args array that will be passed with the action * 'date' => NULL - the scheduled date of the action. Expects a DateTime object, a unix timestamp, or a string that can parsed with strtotime(). Used in UTC timezone. * 'date_compare' => '<=' - operator for testing "date". accepted values are '!=', '>', '>=', '<', '<=', '=' * 'modified' => NULL - the date the action was last updated. Expects a DateTime object, a unix timestamp, or a string that can parsed with strtotime(). Used in UTC timezone. * 'modified_compare' => '<=' - operator for testing "modified". accepted values are '!=', '>', '>=', '<', '<=', '=' * 'group' => '' - the group the action belongs to * 'status' => '' - ActionScheduler_Store::STATUS_COMPLETE or ActionScheduler_Store::STATUS_PENDING * 'claimed' => NULL - TRUE to find claimed actions, FALSE to find unclaimed actions, a string to find a specific claim ID * 'per_page' => 5 - Number of results to return * 'offset' => 0 * 'orderby' => 'date' - accepted values are 'hook', 'group', 'modified', or 'date' * 'order' => 'ASC'. * @param string $return_format OBJECT, ARRAY_A, or ids. * * @deprecated 2.1.0 * * @return array */ function wc_get_scheduled_actions($args = array(), $return_format = \OBJECT) { } /** * General API functions for scheduling actions * * @package ActionScheduler. */ /** * Enqueue an action to run one time, as soon as possible * * @param string $hook The hook to trigger. * @param array $args Arguments to pass when the hook triggers. * @param string $group The group to assign this job to. * @param bool $unique Whether the action should be unique. It will not be scheduled if another pending or running action has the same hook and group parameters. * @param int $priority Lower values take precedence over higher values. Defaults to 10, with acceptable values falling in the range 0-255. * * @return int The action ID. Zero if there was an error scheduling the action. */ function as_enqueue_async_action($hook, $args = array(), $group = '', $unique = \false, $priority = 10) { } /** * Schedule an action to run one time * * @param int $timestamp When the job will run. * @param string $hook The hook to trigger. * @param array $args Arguments to pass when the hook triggers. * @param string $group The group to assign this job to. * @param bool $unique Whether the action should be unique. It will not be scheduled if another pending or running action has the same hook and group parameters. * @param int $priority Lower values take precedence over higher values. Defaults to 10, with acceptable values falling in the range 0-255. * * @return int The action ID. Zero if there was an error scheduling the action. */ function as_schedule_single_action($timestamp, $hook, $args = array(), $group = '', $unique = \false, $priority = 10) { } /** * Schedule a recurring action * * @param int $timestamp When the first instance of the job will run. * @param int $interval_in_seconds How long to wait between runs. * @param string $hook The hook to trigger. * @param array $args Arguments to pass when the hook triggers. * @param string $group The group to assign this job to. * @param bool $unique Whether the action should be unique. It will not be scheduled if another pending or running action has the same hook and group parameters. * @param int $priority Lower values take precedence over higher values. Defaults to 10, with acceptable values falling in the range 0-255. * * @return int The action ID. Zero if there was an error scheduling the action. */ function as_schedule_recurring_action($timestamp, $interval_in_seconds, $hook, $args = array(), $group = '', $unique = \false, $priority = 10) { } /** * Schedule an action that recurs on a cron-like schedule. * * @param int $timestamp The first instance of the action will be scheduled * to run at a time calculated after this timestamp matching the cron * expression. This can be used to delay the first instance of the action. * @param string $schedule A cron-link schedule string. * @see http://en.wikipedia.org/wiki/Cron * * * * * * * * ┬ ┬ ┬ ┬ ┬ ┬ * | | | | | | * | | | | | + year [optional] * | | | | +----- day of week (0 - 7) (Sunday=0 or 7) * | | | +---------- month (1 - 12) * | | +--------------- day of month (1 - 31) * | +-------------------- hour (0 - 23) * +------------------------- min (0 - 59) * @param string $hook The hook to trigger. * @param array $args Arguments to pass when the hook triggers. * @param string $group The group to assign this job to. * @param bool $unique Whether the action should be unique. It will not be scheduled if another pending or running action has the same hook and group parameters. * @param int $priority Lower values take precedence over higher values. Defaults to 10, with acceptable values falling in the range 0-255. * * @return int The action ID. Zero if there was an error scheduling the action. */ function as_schedule_cron_action($timestamp, $schedule, $hook, $args = array(), $group = '', $unique = \false, $priority = 10) { } /** * Cancel the next occurrence of a scheduled action. * * While only the next instance of a recurring or cron action is unscheduled by this method, that will also prevent * all future instances of that recurring or cron action from being run. Recurring and cron actions are scheduled in * a sequence instead of all being scheduled at once. Each successive occurrence of a recurring action is scheduled * only after the former action is run. If the next instance is never run, because it's unscheduled by this function, * then the following instance will never be scheduled (or exist), which is effectively the same as being unscheduled * by this method also. * * @param string $hook The hook that the job will trigger. * @param array $args Args that would have been passed to the job. * @param string $group The group the job is assigned to. * * @return int|null The scheduled action ID if a scheduled action was found, or null if no matching action found. */ function as_unschedule_action($hook, $args = array(), $group = '') { } /** * Cancel all occurrences of a scheduled action. * * @param string $hook The hook that the job will trigger. * @param array $args Args that would have been passed to the job. * @param string $group The group the job is assigned to. */ function as_unschedule_all_actions($hook, $args = array(), $group = '') { } /** * Check if there is an existing action in the queue with a given hook, args and group combination. * * An action in the queue could be pending, in-progress or async. If the is pending for a time in * future, its scheduled date will be returned as a timestamp. If it is currently being run, or an * async action sitting in the queue waiting to be processed, in which case boolean true will be * returned. Or there may be no async, in-progress or pending action for this hook, in which case, * boolean false will be the return value. * * @param string $hook Name of the hook to search for. * @param array $args Arguments of the action to be searched. * @param string $group Group of the action to be searched. * * @return int|bool The timestamp for the next occurrence of a pending scheduled action, true for an async or in-progress action or false if there is no matching action. */ function as_next_scheduled_action($hook, $args = \null, $group = '') { } /** * Check if there is a scheduled action in the queue but more efficiently than as_next_scheduled_action(). * * It's recommended to use this function when you need to know whether a specific action is currently scheduled * (pending or in-progress). * * @since 3.3.0 * * @param string $hook The hook of the action. * @param array $args Args that have been passed to the action. Null will matches any args. * @param string $group The group the job is assigned to. * * @return bool True if a matching action is pending or in-progress, false otherwise. */ function as_has_scheduled_action($hook, $args = \null, $group = '') { } /** * Find scheduled actions * * @param array $args Possible arguments, with their default values. * 'hook' => '' - the name of the action that will be triggered. * 'args' => NULL - the args array that will be passed with the action. * 'date' => NULL - the scheduled date of the action. Expects a DateTime object, a unix timestamp, or a string that can parsed with strtotime(). Used in UTC timezone. * 'date_compare' => '<=' - operator for testing "date". accepted values are '!=', '>', '>=', '<', '<=', '='. * 'modified' => NULL - the date the action was last updated. Expects a DateTime object, a unix timestamp, or a string that can parsed with strtotime(). Used in UTC timezone. * 'modified_compare' => '<=' - operator for testing "modified". accepted values are '!=', '>', '>=', '<', '<=', '='. * 'group' => '' - the group the action belongs to. * 'status' => '' - ActionScheduler_Store::STATUS_COMPLETE or ActionScheduler_Store::STATUS_PENDING. * 'claimed' => NULL - TRUE to find claimed actions, FALSE to find unclaimed actions, a string to find a specific claim ID. * 'per_page' => 5 - Number of results to return. * 'offset' => 0. * 'orderby' => 'date' - accepted values are 'hook', 'group', 'modified', 'date' or 'none'. * 'order' => 'ASC'. * * @param string $return_format OBJECT, ARRAY_A, or ids. * * @return array */ function as_get_scheduled_actions($args = array(), $return_format = \OBJECT) { } /** * Helper function to create an instance of DateTime based on a given * string and timezone. By default, will return the current date/time * in the UTC timezone. * * Needed because new DateTime() called without an explicit timezone * will create a date/time in PHP's timezone, but we need to have * assurance that a date/time uses the right timezone (which we almost * always want to be UTC), which means we need to always include the * timezone when instantiating datetimes rather than leaving it up to * the PHP default. * * @param mixed $date_string A date/time string. Valid formats are explained in http://php.net/manual/en/datetime.formats.php. * @param string $timezone A timezone identifier, like UTC or Europe/Lisbon. The list of valid identifiers is available http://php.net/manual/en/timezones.php. * * @return ActionScheduler_DateTime */ function as_get_datetime_object($date_string = \null, $timezone = 'UTC') { } /** * The Forminator_Widget functions. * * @package Forminator */ /** * Register widget * * @since 1.0 */ function forminator_widget_register_widget() { } /** * Forminator addon simple URL * * @return string */ function forminator_addon_simple_url() { } /** * Load forminator addon simple * * @return void */ function load_forminator_addon_simple() { } /** * Load forminator autofill simple * * @return void */ function load_forminator_autofill_simple() { } /** * Drop custom tables * * @since 1.0.2 * @since 1.14.10 Added $db_prefix parameter * * @param string $db_prefix - database prefix. */ function forminator_drop_custom_tables($db_prefix = 'wp_') { } /** * Clear custom posts * * @since 1.0.2 */ function forminator_delete_custom_posts() { } /** * Delete custom options and addon options * * @since 1.0.2 * @since 1.0.6 Delete privacy options * @since 1.14.10 Deletes all forminator options including the addons' options * @since 1.14.10 Added $db_prefix parameter * * @param string $db_prefix - database prefix. */ function forminator_delete_custom_options($db_prefix = 'wp_') { } /** * Clear the module submissions cache data * * @since 1.14.10 Added $db_prefix parameter * * @param string $db_prefix - database prefix. */ function forminator_clear_module_submissions($db_prefix = 'wp_') { } /** * Remove forminator files in uploads folder */ function forminator_remove_upload_files() { } }