<?php
if ( ! defined( 'ABSPATH' ) ) {
die( 'You are not allowed to call this page directly.' );
}
/**
* @since 5.3
*/
class FrmApplicationsController {
/**
* Add Applications menu item to sidebar and define Applications index page.
*
* @return void
*/
public static function menu() {
$label = __( 'Applications', 'formidable' );
$cap = self::get_required_capability();
if ( ! current_user_can( $cap ) && is_callable( 'FrmProApplicationsHelper::get_custom_applications_capability' ) ) {
$custom_applications_cap = FrmProApplicationsHelper::get_custom_applications_capability();
if ( current_user_can( $custom_applications_cap ) ) {
$cap = $custom_applications_cap;
$slug = 'edit-tags.php?taxonomy=frm_application';
$callback = '';
}
}
if ( ! isset( $slug ) ) {
$slug = 'formidable-applications';
$callback = array( self::class, 'landing_page' );
}
add_submenu_page( 'formidable', 'Formidable | ' . $label, $label, $cap, $slug, $callback );
}
/**
* Get the required capability for accessing the Applications dashboard.
*
* @since 5.3.1
*
* @return string
*/
private static function get_required_capability() {
if ( is_callable( 'FrmProApplicationsHelper::get_required_templates_capability' ) ) {
return FrmProApplicationsHelper::get_required_templates_capability();
}
return 'frm_edit_forms';
}
/**
* Render Applications index page.
*
* @return void
*/
public static function landing_page() {
require self::get_view_path() . 'index.php';
}
/**
* Get path to application views.
*
* @return string
*/
private static function get_view_path() {
return FrmAppHelper::plugin_path() . '/classes/views/applications/';
}
/**
* Get information about applications via AJAX action.
*
* @return void
*/
public static function get_applications_data() {
FrmAppHelper::permission_check( 'frm_view_forms' );
check_ajax_referer( 'frm_ajax', 'nonce' );
$view = FrmAppHelper::get_param( 'view', '', 'get', 'sanitize_text_field' );
$data = array();
if ( 'applications' !== $view ) {
FrmAppHelper::permission_check( self::get_required_capability() );
// view may be 'applications', 'templates', or empty.
$data['templates'] = self::get_prepared_template_data();
$data['categories'] = FrmApplicationTemplate::get_categories();
} else {
FrmAppHelper::permission_check( 'frm_edit_applications' );
}
/**
* @param array $data
*/
$data = apply_filters( 'frm_applications_data', $data );
wp_send_json_success( $data );
}
/**
* Retrieve API data and return a reduced set back with some restructuring applied to make it easier to read.
*
* @return array<array>
*/
private static function get_prepared_template_data() {
$api = new FrmApplicationApi();
$applications = $api->get_api_info();
$applications = array_filter( $applications, 'is_array' );
$unlocked_templates = array();
$locked_templates = array();
foreach ( $applications as $key => $application ) {
if ( ! is_numeric( $key ) ) {
// Skip "error" or any other non-numeric key.
continue;
}
if ( ! empty( $application['url'] ) ) {
$unlocked_templates[] = $application;
} else {
$locked_templates[] = $application;
}
}
$unlocked_templates = self::sort_templates( $unlocked_templates );
$applications = $unlocked_templates;
if ( current_user_can( 'administrator' ) || current_user_can( 'frm_change_settings' ) ) {
$locked_templates = self::sort_templates( $locked_templates );
$applications = array_merge( $applications, $locked_templates );
}
FrmApplicationTemplate::init();
return array_reduce( $applications, array( self::class, 'reduce_template' ), array() );
}
/**
* @param array $total the accumulated array of reduced application data.
* @param array $current data for the current template from the API.
*
* @return array<array>
*/
private static function reduce_template( $total, $current ) {
$template = new FrmApplicationTemplate( $current );
$js_object = $template->as_js_object();
if ( $js_object ) {
$total[] = $js_object;
}
return $total;
}
/**
* Sort applications alphabetically.
*
* @param array<array> $applications
*
* @return array<array>
*/
private static function sort_templates( $applications ) {
usort(
$applications,
function ( $a, $b ) {
return strcmp( $a['name'], $b['name'] );
}
);
return $applications;
}
/**
* @usedby FrmAppController::admin_init().
*
* @since 6.8
*
* @return void
*/
public static function load_page() {
self::load_assets();
}
/**
* @return void
*/
public static function load_assets() {
$plugin_url = FrmAppHelper::plugin_url();
$version = FrmAppHelper::plugin_version();
wp_enqueue_style( 'formidable-admin' );
wp_enqueue_style( 'formidable-grids' );
$js_dependencies = array(
'wp-i18n',
// This prevents a console error "wp.hooks is undefined" in WP versions older than 5.7.
'wp-hooks',
'formidable_dom',
);
wp_register_script( 'formidable_applications', $plugin_url . '/js/admin/applications.js', $js_dependencies, $version, true );
wp_register_style( 'formidable_applications', $plugin_url . '/css/admin/applications.css', array(), $version );
$js_vars = array(
'proUpgradeUrl' => FrmAppHelper::admin_upgrade_link( 'applications' ),
);
wp_localize_script( 'formidable_applications', 'frmApplicationsVars', $js_vars );
wp_enqueue_script( 'formidable_applications' );
wp_set_script_translations( 'formidable_applications', 'formidable' );
wp_enqueue_style( 'formidable_applications' );
do_action( 'frm_applications_assets' );
}
/**
* @return void
*/
public static function dequeue_scripts() {
if ( 'formidable-applications' === FrmAppHelper::simple_get( 'page', 'sanitize_title' ) ) {
FrmAppHelper::dequeue_extra_global_scripts();
}
}
/**
* @param string $title
* @param string $context values include 'index', 'list', and 'edit'.
*
* @return void
*/
public static function render_applications_header( $title, $context ) {
FrmAppHelper::print_admin_banner( true );
require self::get_view_path() . 'header.php';
}
}