103 lines
2.4 KiB
PHP
103 lines
2.4 KiB
PHP
<?php
|
|
|
|
namespace WPForms\Admin\Builder;
|
|
|
|
use WPForms\Helpers\CacheBase;
|
|
|
|
/**
|
|
* Form templates cache handler.
|
|
*
|
|
* @since 1.6.8
|
|
*/
|
|
class TemplatesCache extends CacheBase {
|
|
|
|
/**
|
|
* Determine if the class is allowed to load.
|
|
*
|
|
* @since 1.6.8
|
|
*
|
|
* @return bool
|
|
*/
|
|
protected function allow_load() {
|
|
|
|
$has_permissions = wpforms_current_user_can( [ 'create_forms', 'edit_forms' ] );
|
|
$allowed_requests = wpforms_is_admin_ajax() || wpforms_is_admin_page( 'builder' ) || wpforms_is_admin_page( 'templates' );
|
|
$allow = wp_doing_cron() || wpforms_doing_wp_cli() || ( $has_permissions && $allowed_requests );
|
|
|
|
/**
|
|
* Whether to load this class.
|
|
*
|
|
* @since 1.7.2
|
|
*
|
|
* @param bool $allow True or false.
|
|
*/
|
|
return (bool) apply_filters( 'wpforms_admin_builder_templatescache_allow_load', $allow ); // phpcs:ignore WPForms.PHP.ValidateHooks.InvalidHookName
|
|
}
|
|
|
|
/**
|
|
* Provide settings.
|
|
*
|
|
* @since 1.6.8
|
|
*
|
|
* @return array Settings array.
|
|
*/
|
|
protected function setup() {
|
|
|
|
return [
|
|
|
|
// Remote source URL.
|
|
'remote_source' => 'https://wpforms.com/templates/api/get/',
|
|
|
|
// Cache file.
|
|
'cache_file' => 'templates.json',
|
|
|
|
/**
|
|
* Time-to-live of the templates cache files in seconds.
|
|
*
|
|
* This applies to `uploads/wpforms/cache/templates.json`
|
|
* and all *.json files in `uploads/wpforms/cache/templates/` directory.
|
|
*
|
|
* @since 1.6.8
|
|
*
|
|
* @param integer $cache_ttl Cache time-to-live, in seconds.
|
|
* Default value: WEEK_IN_SECONDS.
|
|
*/
|
|
'cache_ttl' => (int) apply_filters( 'wpforms_admin_builder_templates_cache_ttl', WEEK_IN_SECONDS ),
|
|
|
|
// Scheduled update action.
|
|
'update_action' => 'wpforms_admin_builder_templates_cache_update',
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Prepare data to store in a local cache.
|
|
*
|
|
* @since 1.6.8
|
|
*
|
|
* @param array $data Raw data received by the remote request.
|
|
*
|
|
* @return array Prepared data for caching.
|
|
*/
|
|
protected function prepare_cache_data( $data ) {
|
|
|
|
if (
|
|
empty( $data ) ||
|
|
! is_array( $data ) ||
|
|
empty( $data['status'] ) ||
|
|
$data['status'] !== 'success' ||
|
|
empty( $data['data'] )
|
|
) {
|
|
return [];
|
|
}
|
|
|
|
$cache_data = $data['data'];
|
|
|
|
// Strip the word "Template" from the end of each template name.
|
|
foreach ( $cache_data['templates'] as $slug => $template ) {
|
|
$cache_data['templates'][ $slug ]['name'] = preg_replace( '/\sTemplate$/', '', $template['name'] );
|
|
}
|
|
|
|
return $cache_data;
|
|
}
|
|
}
|