Manager class for forms.
Description
Source
File: src/db-objects/forms/form-manager.php
class Form_Manager extends Core_Manager {
use Title_Manager_Trait, Slug_Manager_Trait, Author_Manager_Trait, Meta_Manager_Trait, Capability_Manager_Trait, REST_API_Manager_Trait, Manager_With_Children_Trait;
/**
* The frontend submission handler.
*
* @since 1.0.0
* @var Form_Frontend_Submission_Handler
*/
protected $frontend_submission_handler;
/**
* The frontend output handler.
*
* @since 1.0.0
* @var Form_Frontend_Output_Handler
*/
protected $frontend_output_handler;
/**
* The form list page handler.
*
* @since 1.0.0
* @var Form_List_Page_Handler
*/
protected $list_page_handler;
/**
* The form edit page handler.
*
* @since 1.0.0
* @var Form_Edit_Page_Handler
*/
protected $edit_page_handler;
/**
* The legacy upgrades instance. TODO: Remove this property in the future.
*
* @since 1.0.0
* @var Legacy_Upgrades
*/
protected $legacy_upgrades;
/**
* The Template API service definition.
*
* @since 1.0.0
* @static
* @var string
*/
protected static $service_template = Template::class;
/**
* The Option API service definition.
*
* @since 1.0.0
* @static
* @var string
*/
protected static $service_options = Options::class;
/**
* The Assets API service definition.
*
* @since 1.0.0
* @static
* @var string
*/
protected static $service_assets = Assets::class;
/**
* The AJAX API service definition.
*
* @since 1.0.0
* @static
* @var string
*/
protected static $service_ajax = AJAX::class;
/**
* Constructor.
*
* @since 1.0.0
*
* @param string $prefix The instance prefix.
* @param array $services {
* Array of service instances.
*
* @type Form_Capabilities $capabilities The capabilities instance.
* @type Template $template The template instance.
* @type Options $options The options instance.
* @type Assets $assets The assets instance.
* @type AJAX $ajax The AJAX instance.
* @type DB $db The database instance.
* @type Cache $cache The cache instance.
* @type Meta $meta The meta instance.
* @type Error_Handler $error_handler The error handler instance.
* }
* @param Translations_Form_Manager $translations Translations instance.
*/
public function __construct( $prefix, $services, $translations ) {
$this->class_name = Form::class;
$this->collection_class_name = Form_Collection::class;
$this->query_class_name = Form_Query::class;
$this->rest_controller_class_name = REST_Forms_Controller::class;
$this->singular_slug = 'form';
$this->plural_slug = 'forms';
$this->table_name = 'posts';
$this->cache_group = 'posts';
$this->meta_type = 'post';
$this->fetch_callback = array( $this, 'fetch_from_db' );
$this->primary_property = 'id';
$this->title_property = 'title';
$this->slug_property = 'slug';
$this->author_property = 'author';
$this->public = true;
$this->frontend_submission_handler = new Form_Frontend_Submission_Handler( $this );
$this->frontend_output_handler = new Form_Frontend_Output_Handler( $this );
$this->list_page_handler = new Form_List_Page_Handler( $this );
$this->edit_page_handler = new Form_Edit_Page_Handler( $this );
// TODO: Remove this instantiation in the future.
$this->legacy_upgrades = new Legacy_Upgrades( $prefix );
parent::__construct( $prefix, $services, $translations );
if ( defined( 'WP_CLI' ) && WP_CLI ) {
$command = new CLI_Forms_Command( $this );
$command->add( str_replace( '_', ' ', $this->prefix ) . str_replace( '_', '-', $this->singular_slug ) );
}
}
/**
* Returns the form frontend submission handler.
*
* @since 1.0.0
*
* @return Form_Frontend_Submission_Handler Frontend submission handler instance.
*/
public function frontend_submission_handler() {
return $this->frontend_submission_handler;
}
/**
* Returns the form frontend output handler.
*
* @since 1.0.0
*
* @return Form_Frontend_Output_Handler Frontend output handler instance.
*/
public function frontend_output_handler() {
return $this->frontend_output_handler;
}
/**
* Returns the form list page handler.
*
* @since 1.0.0
*
* @return Form_List_Page_Handler List page handler instance.
*/
public function list_page_handler() {
return $this->list_page_handler;
}
/**
* Returns the form edit page handler.
*
* @since 1.0.0
*
* @return Form_Edit_Page_Handler Edit page handler instance.
*/
public function edit_page_handler() {
return $this->edit_page_handler;
}
/**
* Adds the service hooks.
*
* @since 1.0.0
*/
public function add_hooks() {
if ( ! $this->hooks_added ) {
add_shortcode( "{$this->get_prefix()}form", array( $this->frontend_output_handler, 'get_shortcode_content' ) );
add_shortcode( 'form', array( $this->frontend_output_handler, 'get_deprecated_shortcode_content' ) );
}
return parent::add_hooks();
}
/**
* Removes the service hooks.
*
* @since 1.0.0
*/
public function remove_hooks() {
if ( $this->hooks_added ) {
remove_shortcode( "{$this->get_prefix()}form" );
remove_shortcode( 'form' );
}
return parent::remove_hooks();
}
/**
* Internal method to insert a new form into the database.
*
* @since 1.0.0
*
* @param array $args Array of column => value pairs for the new database row.
* @return int|false The ID of the new form, or false on failure.
*/
protected function insert_into_db( $args ) {
$args = $this->map_args( $args );
$result = wp_insert_post( $args, true );
if ( is_wp_error( $result ) ) {
return false;
}
return $result;
}
/**
* Internal method to update an existing form in the database.
*
* @since 1.0.0
*
* @param int $form_id ID of the form to update.
* @param array $args Array of column => value pairs to update in the database row.
* @return bool True on success, or false on failure.
*/
protected function update_in_db( $form_id, $args ) {
$args = $this->map_args( $args );
$args['ID'] = $form_id;
$result = wp_update_post( $args, true );
if ( is_wp_error( $result ) ) {
return false;
}
return true;
}
/**
* Internal method to delete a form from the database.
*
* @since 1.0.0
*
* @param int $form_id ID of the form to delete.
* @return bool True on success, or false on failure.
*/
protected function delete_from_db( $form_id ) {
return (bool) wp_delete_post( $form_id, true );
}
/**
* Internal method to fetch a form from the database.
*
* @since 1.0.0
*
* @param int $form_id ID of the form to fetch.
* @return WP_Post|null Post object of the form, or null if not found.
*/
protected function fetch_from_db( $form_id ) {
$post = get_post( $form_id );
if ( ! $post || $this->get_prefix() . 'form' !== $post->post_type ) {
return null;
}
// TODO: Remove this logic in the future.
$this->legacy_upgrades->maybe_upgrade_legacy_form_meta( $post->ID );
return $post;
}
/**
* Maps form arguments to regular post arguments.
*
* @since 1.0.0
*
* @param array $args Arguments as `$property => $value` pairs.
* @return array Mapped arguments.
*/
protected function map_args( $args ) {
$mapped_args = array();
foreach ( $args as $property => $value ) {
switch ( $property ) {
case 'slug':
$mapped_args['post_name'] = $value;
break;
case 'timestamp':
$mapped_args['post_date'] = '0000-00-00 00:00:00';
$mapped_args['post_date_gmt'] = date( 'Y-m-d H:i:s', $value );
break;
case 'timestamp_modified':
$mapped_args['post_modified'] = '0000-00-00 00:00:00';
$mapped_args['post_modified_gmt'] = date( 'Y-m-d H:i:s', $value );
break;
case 'title':
case 'author':
case 'status':
$mapped_args[ 'post_' . $property ] = $value;
}
}
$mapped_args['post_type'] = $this->get_prefix() . 'form';
return $mapped_args;
}
/**
* Deletes sub-components of a form that is about to be deleted.
*
* @since 1.0.0
*
* @param int $post_id Post ID. Will only be handled if a form ID.
*/
protected function maybe_delete_form_subcomponents( $post_id ) {
$form = $this->get( $post_id );
if ( ! $form ) {
return;
}
$containers = $form->get_containers();
foreach ( $containers as $container ) {
$container->delete();
}
$submissions = $form->get_submissions();
foreach ( $submissions as $submission ) {
$submission->delete();
}
}
/**
* Registers settings for the REST API.
*
* @since 1.0.0
*/
protected function register_settings() {
$settings_page = new Form_Settings_Page( 'form_settings', torro()->admin_pages(), $this );
$settings_page->register_rest_api_settings();
}
/**
* Starts a PHP session if the current request is any frontend form request.
*
* @since 1.0.0
*/
protected function maybe_start_session() {
if ( is_admin() ) {
return;
}
if ( is_singular() && $this->get_prefix() . 'form' === get_post_type( get_queried_object_id() ) || isset( $_POST['torro_submission'] ) ) {
if ( ! isset( $_SESSION ) && ! headers_sent() ) {
session_start();
}
}
}
/**
* Upgrades legacy form meta when a form is accessed in the admin.
*
* TODO: Remove this method in the future.
*
* @since 1.0.0
*
* @param WP_Screen $screen Current screen object.
*/
private function maybe_upgrade_legacy_form_meta( $screen ) {
if ( 'post' !== $screen->base ) {
return;
}
if ( $this->get_prefix() . 'form' !== $screen->post_type ) {
return;
}
if ( empty( $_GET['post'] ) ) {
return;
}
$this->legacy_upgrades->maybe_upgrade_legacy_form_meta( (int) $_GET['post'] );
}
/**
* Upgrades legacy form attachments when the admin is initialized.
*
* TODO: Remove this method in the future.
*
* @since 1.0.0
*/
private function maybe_upgrade_legacy_form_attachments() {
$this->legacy_upgrades->maybe_upgrade_legacy_form_attachment_statuses();
}
/**
* Sets up all action and filter hooks for the service.
*
* This method must be implemented and then be called from the constructor.
*
* @since 1.0.0
*/
protected function setup_hooks() {
parent::setup_hooks();
if ( method_exists( $this, 'register_rest_routes' ) ) {
$this->filters[] = array(
'name' => 'rest_api_init',
'callback' => array( $this, 'register_rest_routes' ),
'priority' => 10,
'num_args' => 0,
);
}
$this->actions[] = array(
'name' => 'rest_api_init',
'callback' => array( $this, 'register_settings' ),
'priority' => 1,
'num_args' => 0,
);
$this->actions[] = array(
'name' => 'wp',
'callback' => array( $this, 'maybe_start_session' ),
'priority' => 1,
'num_args' => 0,
);
$this->actions[] = array(
'name' => 'before_delete_post',
'callback' => array( $this, 'maybe_delete_form_subcomponents' ),
'priority' => 10,
'num_args' => 1,
);
$this->actions[] = array(
'name' => 'wp',
'callback' => array( $this->frontend_submission_handler, 'maybe_handle_form_submission' ),
'priority' => 10,
'num_args' => 0,
);
$this->filters[] = array(
'name' => 'wp_enqueue_scripts',
'callback' => array( $this->frontend_output_handler, 'maybe_enqueue_frontend_assets' ),
'priority' => 10,
'num_args' => 0,
);
$this->filters[] = array(
'name' => 'the_content',
'callback' => array( $this->frontend_output_handler, 'maybe_get_form_content' ),
'priority' => 10,
'num_args' => 1,
);
$this->filters[] = array(
'name' => "manage_edit-{$this->get_prefix()}form_columns",
'callback' => array( $this->list_page_handler, 'maybe_adjust_table_columns' ),
'priority' => 10,
'num_args' => 1,
);
$this->actions[] = array(
'name' => "manage_{$this->get_prefix()}form_posts_custom_column",
'callback' => array( $this->list_page_handler, 'maybe_render_custom_table_column' ),
'priority' => 10,
'num_args' => 2,
);
$this->actions[] = array(
'name' => 'post_row_actions',
'callback' => array( $this->list_page_handler, 'maybe_adjust_row_actions' ),
'priority' => 10,
'num_args' => 2,
);
$this->actions[] = array(
'name' => 'page_row_actions',
'callback' => array( $this->list_page_handler, 'maybe_adjust_row_actions' ),
'priority' => 10,
'num_args' => 2,
);
$this->actions[] = array(
'name' => 'edit_form_after_title',
'callback' => array( $this->edit_page_handler, 'maybe_render_form_canvas' ),
'priority' => 10,
'num_args' => 1,
);
$this->actions[] = array(
'name' => "add_meta_boxes_{$this->get_prefix()}form",
'callback' => array( $this->edit_page_handler, 'maybe_add_meta_boxes' ),
'priority' => 10,
'num_args' => 1,
);
$this->actions[] = array(
'name' => 'admin_enqueue_scripts',
'callback' => array( $this->edit_page_handler, 'maybe_enqueue_assets' ),
'priority' => 10,
'num_args' => 1,
);
$this->actions[] = array(
'name' => 'admin_footer-post.php',
'callback' => array( $this->edit_page_handler, 'maybe_print_templates' ),
'priority' => 10,
'num_args' => 0,
);
$this->actions[] = array(
'name' => 'admin_footer-post-new.php',
'callback' => array( $this->edit_page_handler, 'maybe_print_templates' ),
'priority' => 10,
'num_args' => 0,
);
$this->actions[] = array(
'name' => "save_post_{$this->get_prefix()}form",
'callback' => array( $this->edit_page_handler, 'maybe_handle_save_request' ),
'priority' => 10,
'num_args' => 1,
);
$this->actions[] = array(
'name' => "admin_action_{$this->get_prefix()}duplicate_form",
'callback' => array( $this->edit_page_handler, 'action_duplicate_form' ),
'priority' => 10,
'num_args' => 0,
);
$this->actions[] = array(
'name' => 'admin_notices',
'callback' => array( $this->edit_page_handler, 'maybe_show_duplicate_form_feedback' ),
'priority' => 10,
'num_args' => 0,
);
$this->actions[] = array(
'name' => 'get_sample_permalink_html',
'callback' => array( $this->edit_page_handler, 'maybe_add_duplicate_button' ),
'priority' => 10,
'num_args' => 5,
);
$this->actions[] = array(
'name' => 'get_sample_permalink_html',
'callback' => array( $this->edit_page_handler, 'maybe_add_submissions_button' ),
'priority' => 10,
'num_args' => 5,
);
$this->actions[] = array(
'name' => 'post_submitbox_misc_actions',
'callback' => array( $this->edit_page_handler, 'maybe_render_shortcode' ),
'priority' => 10,
'num_args' => 1,
);
$this->actions[] = array(
'name' => 'post_edit_form_tag',
'callback' => array( $this->edit_page_handler, 'maybe_print_post_form_novalidate' ),
'priority' => 10,
'num_args' => 1,
);
// TODO: Remove these hooks in the future.
$this->actions[] = array(
'name' => 'current_screen',
'callback' => array( $this, 'maybe_upgrade_legacy_form_meta' ),
'priority' => 10,
'num_args' => 1,
);
$this->actions[] = array(
'name' => 'admin_init',
'callback' => array( $this, 'maybe_upgrade_legacy_form_attachments' ),
'priority' => 100,
'num_args' => 0,
);
}
}
Changelog
| Version | Description |
|---|---|
| 1.0.0 | Introduced. |
Methods
- add_child_manager — Adds a child manager.
- get_child_manager — Retrieves a child manager.