From 6f705c856db915a42facdf1f8217445fbd5fc422 Mon Sep 17 00:00:00 2001 From: Gary Jones Date: Mon, 12 Aug 2024 20:24:22 +0100 Subject: [PATCH 01/56] Deploy: Don't include .git/ directory --- .distignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.distignore b/.distignore index 19f14f4..eb83f6e 100644 --- a/.distignore +++ b/.distignore @@ -3,6 +3,7 @@ # The deploy Action will use rsync + .distignore if the .distignore exists, # so it doesn't care what may or may not be ignored via .gitignore. +/.git/ /.github/ /bin/ /tests/ From b7af9af4e1065dd7696cb7ae8e9990f9699e8ada Mon Sep 17 00:00:00 2001 From: Gary Jones Date: Sat, 10 Aug 2024 16:43:49 +0100 Subject: [PATCH 02/56] CS: Run PHPCBF No intentional changes in behaviour - mostly whitespace changes to ensure more compliance with coding standards. --- functions.php | 7 +- includes/class-zoninator-api-controller.php | 207 +- .../class-zoninator-api-filter-search.php | 1 - .../class-zoninator-api-schema-converter.php | 16 +- .../class-zoninator-rest-bootstrap.php | 10 +- .../class-zoninator-rest-classloader.php | 10 +- .../class-zoninator-rest-controller.php | 11 +- .../class-zoninator-rest-environment.php | 18 +- .../class-zoninator-rest-model.php | 65 +- ...class-zoninator-rest-controller-action.php | 18 +- ...class-zoninator-rest-controller-bundle.php | 3 +- .../class-zoninator-rest-controller-crud.php | 18 +- ...ss-zoninator-rest-controller-extension.php | 18 +- .../class-zoninator-rest-controller-model.php | 16 +- .../class-zoninator-rest-controller-route.php | 10 +- ...ass-zoninator-rest-controller-settings.php | 4 +- .../data/class-zoninator-rest-data-mapper.php | 12 +- .../class-zoninator-rest-data-serializer.php | 4 +- ...ass-zoninator-rest-data-store-abstract.php | 4 +- ...ninator-rest-data-store-customposttype.php | 46 +- .../class-zoninator-rest-data-store-nil.php | 2 +- ...class-zoninator-rest-data-store-option.php | 15 +- ...class-zoninator-rest-field-declaration.php | 42 +- ...ninator-rest-field-declaration-builder.php | 1 - ...s-zoninator-rest-interfaces-data-store.php | 2 +- ...ator-rest-interfaces-model-declaration.php | 5 +- ...class-zoninator-rest-model-declaration.php | 2 +- .../class-zoninator-rest-model-definition.php | 30 +- .../class-zoninator-rest-model-settings.php | 25 +- ...ss-zoninator-rest-model-validationdata.php | 2 +- ...inator-rest-model-declaration-settings.php | 28 +- .../class-zoninator-rest-type-nullable.php | 2 +- .../class-zoninator-rest-type-registry.php | 30 +- .../class-zoninator-rest-type-typedarray.php | 4 +- widget.zone-posts.php | 33 +- zoninator.php | 2434 +++++++++-------- 36 files changed, 1659 insertions(+), 1496 deletions(-) diff --git a/functions.php b/functions.php index 4f9cd2e..74ad95c 100644 --- a/functions.php +++ b/functions.php @@ -7,6 +7,7 @@ function z_get_zoninator() { /** * Get a list of all zones + * * @return array List of all zones */ function z_get_zones() { @@ -68,9 +69,11 @@ function z_get_post_zones( $post_id = 0 ) { } function z_get_loop_post_id_or_default( $post_id = 0 ) { - if( ! $post_id ) { + if ( ! $post_id ) { global $post; - if( $post && isset( $post->ID ) ) $post_id = $post->ID; + if ( $post && isset( $post->ID ) ) { + $post_id = $post->ID; + } } return $post_id; } diff --git a/includes/class-zoninator-api-controller.php b/includes/class-zoninator-api-controller.php index 748e8cb..208c7ca 100644 --- a/includes/class-zoninator-api-controller.php +++ b/includes/class-zoninator-api-controller.php @@ -7,21 +7,21 @@ * Class Zoninator_Api_Controller */ class Zoninator_Api_Controller extends Zoninator_REST_Controller { - const ZONE_ITEM_URL_REGEX = '/zones/(?P[\d]+)'; - const ZONE_ITEM_POSTS_URL_REGEX = '/zones/(?P[\d]+)/posts'; + const ZONE_ITEM_URL_REGEX = '/zones/(?P[\d]+)'; + const ZONE_ITEM_POSTS_URL_REGEX = '/zones/(?P[\d]+)/posts'; const ZONE_ITEM_POSTS_POST_REGEX = '/zones/(?P[\d]+)/posts/(?P\d+)'; - const INVALID_ZONE_ID = 'invalid-zone-id'; - const INVALID_POST_ID = 'invalid-post-id'; - const ZONE_ID_POST_ID_REQUIRED = 'zone-id-post-id-required'; + const INVALID_ZONE_ID = 'invalid-zone-id'; + const INVALID_POST_ID = 'invalid-post-id'; + const ZONE_ID_POST_ID_REQUIRED = 'zone-id-post-id-required'; const ZONE_ID_POST_IDS_REQUIRED = 'zone-id-post-ids-required'; - const ZONE_ID_REQUIRED = 'zone-id-required'; - const ZONE_FEED_ERROR = 'zone-feed-error'; - const TERM_REQUIRED = 'term-required'; - const PERMISSION_DENIED = 'permission-denied'; - const ZONE_NOT_FOUND = 'zone-not-found'; - const POST_NOT_FOUND = 'post-not-found'; - const INVALID_ZONE_SETTINGS = 'invalid-zone-settings'; + const ZONE_ID_REQUIRED = 'zone-id-required'; + const ZONE_FEED_ERROR = 'zone-feed-error'; + const TERM_REQUIRED = 'term-required'; + const PERMISSION_DENIED = 'permission-denied'; + const ZONE_NOT_FOUND = 'zone-not-found'; + const POST_NOT_FOUND = 'post-not-found'; + const INVALID_ZONE_SETTINGS = 'invalid-zone-settings'; /** * Instance * @@ -43,7 +43,7 @@ class Zoninator_Api_Controller extends Zoninator_REST_Controller { */ function __construct( $instance ) { $this->instance = $instance; - $this->base = '/'; + $this->base = '/'; } /** @@ -109,9 +109,11 @@ function get_zones( $request ) { $results = $this->instance->get_zones(); if ( is_wp_error( $results ) ) { - return $this->bad_request( array( - 'message' => $results->get_error_message(), - ) ); + return $this->bad_request( + array( + 'message' => $results->get_error_message(), + ) + ); } $zones = array_map( array( $this, '_filter_zone_properties' ), $results ); @@ -126,21 +128,27 @@ function get_zones( $request ) { * @return WP_Error|WP_REST_Response */ function create_zone( $request ) { - $name = $this->_get_param( $request, 'name', '' ); - $slug = $this->_get_param( $request, 'slug', $name ); + $name = $this->_get_param( $request, 'name', '' ); + $slug = $this->_get_param( $request, 'slug', $name ); $description = $this->_get_param( $request, 'description', '' ); - $result = $this->instance->insert_zone( $slug, $name, array( - 'description' => $description, - ) ); + $result = $this->instance->insert_zone( + $slug, + $name, + array( + 'description' => $description, + ) + ); if ( is_wp_error( $result ) ) { - return $this->bad_request( array( - 'message' => $result->get_error_message(), - ) ); + return $this->bad_request( + array( + 'message' => $result->get_error_message(), + ) + ); } - $zone = $this->instance->get_zone( $result[ 'term_id' ] ); + $zone = $this->instance->get_zone( $result['term_id'] ); return $this->created( $this->_filter_zone_properties( $zone ) ); } @@ -152,12 +160,12 @@ function create_zone( $request ) { * @return WP_Error|WP_REST_Response */ function update_zone( $request ) { - $zone_id = $this->_get_param( $request, 'zone_id', 0, 'absint' ); - $name = $this->_get_param( $request, 'name', '' ); - $slug = $this->_get_param( $request, 'slug', '' ); + $zone_id = $this->_get_param( $request, 'zone_id', 0, 'absint' ); + $name = $this->_get_param( $request, 'name', '' ); + $slug = $this->_get_param( $request, 'slug', '' ); $description = $this->_get_param( $request, 'description', '', 'strip_tags' ); - $zone = $this->instance->get_zone( $zone_id ); + $zone = $this->instance->get_zone( $zone_id ); $update_params = array(); if ( ! $zone ) { @@ -165,23 +173,25 @@ function update_zone( $request ) { } if ( $name ) { - $update_params[ 'name' ] = $name; + $update_params['name'] = $name; } if ( $slug ) { - $update_params[ 'slug' ] = $slug; + $update_params['slug'] = $slug; } if ( $description ) { - $update_params[ 'details' ] = array( 'description' => $description ); + $update_params['details'] = array( 'description' => $description ); } $result = $this->instance->update_zone( $zone, $update_params ); if ( is_wp_error( $result ) ) { - return $this->bad_request( array( - 'message' => $result->get_error_message(), - ) ); + return $this->bad_request( + array( + 'message' => $result->get_error_message(), + ) + ); } return $this->ok( array( 'success' => true ) ); @@ -205,9 +215,11 @@ function delete_zone( $request ) { $result = $this->instance->delete_zone( $zone ); if ( is_wp_error( $result ) ) { - return $this->bad_request( array( - 'message' => $result->get_error_message(), - ) ); + return $this->bad_request( + array( + 'message' => $result->get_error_message(), + ) + ); } return $this->ok( array( 'success' => true ) ); @@ -242,7 +254,7 @@ public function get_zone_posts( $request ) { * @return WP_Error|WP_REST_Response */ function update_zone_posts( $request ) { - $zone_id = $this->_get_param( $request, 'zone_id', 0, 'absint' ); + $zone_id = $this->_get_param( $request, 'zone_id', 0, 'absint' ); $post_ids = $this->_get_param( $request, 'post_ids', array() ); if ( ! $this->instance->get_zone( $zone_id ) ) { @@ -252,9 +264,11 @@ function update_zone_posts( $request ) { $posts = array_map( 'get_post', $post_ids ); if ( count( $posts ) !== count( array_filter( $posts ) ) ) { - return $this->bad_request( array( - 'message' => $this->translations[ self::INVALID_POST_ID ], - ) ); + return $this->bad_request( + array( + 'message' => $this->translations[ self::INVALID_POST_ID ], + ) + ); } $result = $this->instance->add_zone_posts( $zone_id, $posts ); @@ -275,7 +289,7 @@ function update_zone_posts( $request ) { function zone_update_lock( $request ) { $zone_id = $this->_get_param( $request, 'zone_id', 0, 'absint' ); if ( ! $zone_id ) { - return $this->_bad_request(self::ZONE_ID_REQUIRED, __('zone id required', 'zoninator')); + return $this->_bad_request( self::ZONE_ID_REQUIRED, __( 'zone id required', 'zoninator' ) ); } $zone = $this->instance->get_zone( $zone_id ); @@ -286,18 +300,24 @@ function zone_update_lock( $request ) { $zone_locked = $this->instance->is_zone_locked( $zone ); if ( $zone_locked ) { $locking_user = get_userdata( $zone_locked ); - return new WP_REST_Response( array( - 'zone_id' => $this->instance->get_zone_id( $zone ), - 'blocked' => true, - ), 400); + return new WP_REST_Response( + array( + 'zone_id' => $this->instance->get_zone_id( $zone ), + 'blocked' => true, + ), + 400 + ); } $this->instance->lock_zone( $zone_id ); - return new WP_REST_Response( array( - 'zone_id' => $this->instance->get_zone_id( $zone ), - 'timeout' => $this->instance->zone_lock_period, - 'max_lock_period' => $this->instance->zone_max_lock_period, - ), 200 ); + return new WP_REST_Response( + array( + 'zone_id' => $this->instance->get_zone_id( $zone ), + 'timeout' => $this->instance->zone_lock_period, + 'max_lock_period' => $this->instance->zone_max_lock_period, + ), + 200 + ); } /** @@ -347,7 +367,7 @@ public function is_numeric( $item ) { } public function is_numeric_array( $items ) { - return count( $items ) === count( array_filter( $items, 'is_numeric') ); + return count( $items ) === count( array_filter( $items, 'is_numeric' ) ); } public function sanitize_string( $item ) { @@ -357,8 +377,8 @@ public function sanitize_string( $item ) { /** * @param WP_REST_Request $object * @param $var - * @param string $default - * @param string $sanitize_callback + * @param string $default + * @param string $sanitize_callback * @return array|mixed|null|string */ private function _get_param( $object, $var, $default = '', $sanitize_callback = '' ) { @@ -374,44 +394,44 @@ private function _get_param( $object, $var, $default = '', $sanitize_callback = public function _params_for_create_zone() { return array( - 'name' => array( - 'type' => 'string', + 'name' => array( + 'type' => 'string', 'sanitize_callback' => array( $this, 'sanitize_string' ), - 'default' => '', - 'required' => false + 'default' => '', + 'required' => false, ), - 'slug' => array( - 'type' => 'string', + 'slug' => array( + 'type' => 'string', 'sanitize_callback' => array( $this, 'sanitize_string' ), - 'default' => '', - 'required' => false, + 'default' => '', + 'required' => false, ), 'description' => array( - 'type' => 'string', + 'type' => 'string', 'sanitize_callback' => array( $this, 'sanitize_string' ), - 'default' => '', - 'required' => false, - ) + 'default' => '', + 'required' => false, + ), ); } public function _params_for_update_zone() { return array( - 'name' => array( - 'type' => 'string', + 'name' => array( + 'type' => 'string', 'sanitize_callback' => array( $this, 'sanitize_string' ), - 'required' => false + 'required' => false, ), - 'slug' => array( - 'type' => 'string', + 'slug' => array( + 'type' => 'string', 'sanitize_callback' => array( $this, 'sanitize_string' ), - 'required' => false, + 'required' => false, ), 'description' => array( - 'type' => 'string', + 'type' => 'string', 'sanitize_callback' => array( $this, 'sanitize_string' ), - 'required' => false, - ) + 'required' => false, + ), ); } @@ -421,35 +441,38 @@ public function _get_zone_id_param() { 'type' => 'integer', 'validate_callback' => array( $this, 'is_numeric' ), 'sanitize_callback' => 'absint', - 'required' => true - ) + 'required' => true, + ), ); } public function _get_zone_post_rest_route_params() { $zone_params = $this->_get_zone_id_param(); - return array_merge( array( - 'post_ids' => array( - 'type' => 'array', - 'validate_callback' => array( $this, 'is_numeric_array' ), - 'required' => true, - 'items' => array( 'type' => 'integer' ), + return array_merge( + array( + 'post_ids' => array( + 'type' => 'array', + 'validate_callback' => array( $this, 'is_numeric_array' ), + 'required' => true, + 'items' => array( 'type' => 'integer' ), + ), ), - ), $zone_params ); + $zone_params + ); } public function _filter_zone_properties( $zone ) { $data = $zone->to_array(); return array( - 'term_id' => $data[ 'term_id' ], - 'slug' => $data[ 'slug' ], - 'name' => $data[ 'name' ], - 'description' => $data[ 'description' ], + 'term_id' => $data['term_id'], + 'slug' => $data['slug'], + 'name' => $data['name'], + 'description' => $data['description'], ); } - private function _bad_request($code, $message) { + private function _bad_request( $code, $message ) { return new WP_Error( $code, $message, array( 'status' => 400 ) ); } @@ -457,9 +480,9 @@ private function _bad_request($code, $message) { * @param $zone_id * @return bool|WP_Error */ - private function _permissions_check($action, $zone_id = null ) { + private function _permissions_check( $action, $zone_id = null ) { if ( ! $this->instance->check( $action, $zone_id ) ) { - return new WP_Error( self::PERMISSION_DENIED, __('Sorry, you\'re not supposed to do that...', 'zoninator' ) ); + return new WP_Error( self::PERMISSION_DENIED, __( 'Sorry, you\'re not supposed to do that...', 'zoninator' ) ); } return true; } diff --git a/includes/class-zoninator-api-filter-search.php b/includes/class-zoninator-api-filter-search.php index 3dbaeef..2da3039 100644 --- a/includes/class-zoninator-api-filter-search.php +++ b/includes/class-zoninator-api-filter-search.php @@ -75,4 +75,3 @@ function date_before_set( $model, $item ) { return $this->strip_tags( $this->strip_slashes( $item ) ); } } - diff --git a/includes/class-zoninator-api-schema-converter.php b/includes/class-zoninator-api-schema-converter.php index 45f7751..6b23284 100644 --- a/includes/class-zoninator-api-schema-converter.php +++ b/includes/class-zoninator-api-schema-converter.php @@ -8,9 +8,9 @@ class Zoninator_Api_Schema_Converter { * @return mixed */ public function as_schema( $model_definition ) { - $fields = $model_definition->get_fields(); + $fields = $model_definition->get_fields(); $properties = array(); - $required = array(); + $required = array(); foreach ( $fields as $field_declaration ) { /** * Our declaration @@ -23,9 +23,9 @@ public function as_schema( $model_definition ) { } } $schema = array( - '$schema' => 'http://json-schema.org/schema#', - 'title' => $model_definition->get_name(), - 'type' => 'object', + '$schema' => 'http://json-schema.org/schema#', + 'title' => $model_definition->get_name(), + 'type' => 'object', 'properties' => (array) apply_filters( 'rest_api_schema_properties', $properties, $model_definition ), ); @@ -53,9 +53,9 @@ public function as_args( $model_definition ) { * @var Zoninator_REST_Field_Declaration $field_declaration */ $arg = array( - 'description' => $field_declaration->get_description(), - 'type' => $type_schema['type'], - 'required' => $field_declaration->is_required(), + 'description' => $field_declaration->get_description(), + 'type' => $type_schema['type'], + 'required' => $field_declaration->is_required(), ); if ( ! $field_declaration->is_required() ) { diff --git a/lib/zoninator_rest/class-zoninator-rest-bootstrap.php b/lib/zoninator_rest/class-zoninator-rest-bootstrap.php index 0af4812..29feb30 100644 --- a/lib/zoninator_rest/class-zoninator-rest-bootstrap.php +++ b/lib/zoninator_rest/class-zoninator-rest-bootstrap.php @@ -58,7 +58,7 @@ public static function is_compatible() { * @return string */ public static function get_base_dir() { - return untrailingslashit( dirname( __FILE__ ) ); + return untrailingslashit( __DIR__ ); } /** @@ -69,10 +69,10 @@ public static function get_base_dir() { */ public static function create( $class_loader = null ) { if ( empty( $class_loader ) ) { - include_once( 'interfaces/class-zoninator-rest-interfaces-classloader.php' ); - include_once( 'class-zoninator-rest-classloader.php' ); - $prefix = str_replace( '_Bootstrap', '', __CLASS__ ); - $base_dir = self::get_base_dir(); + include_once 'interfaces/class-zoninator-rest-interfaces-classloader.php'; + include_once 'class-zoninator-rest-classloader.php'; + $prefix = str_replace( '_Bootstrap', '', __CLASS__ ); + $base_dir = self::get_base_dir(); $class_loader = new Zoninator_REST_Classloader( $prefix, $base_dir ); } return new self( $class_loader ); diff --git a/lib/zoninator_rest/class-zoninator-rest-classloader.php b/lib/zoninator_rest/class-zoninator-rest-classloader.php index 2816525..2bf45a2 100644 --- a/lib/zoninator_rest/class-zoninator-rest-classloader.php +++ b/lib/zoninator_rest/class-zoninator-rest-classloader.php @@ -43,9 +43,9 @@ class Zoninator_REST_Classloader implements Zoninator_REST_Interfaces_Classloade * @throws Exception Throws if an invalid directory is provided. */ public function __construct( $prefix, $base_dir ) { - $this->loaded_classes = array(); - $this->prefix = $prefix; - $this->base_dir = $base_dir; + $this->loaded_classes = array(); + $this->prefix = $prefix; + $this->base_dir = $base_dir; if ( ! is_dir( $this->base_dir ) ) { throw new Exception( 'base_dir does not exist: ' . $this->base_dir ); } @@ -86,7 +86,7 @@ public function get_path_to_class_file( $class_name ) { public function class_name_to_relative_path( $class_name, $prefix = null ) { $lowercase = strtolower( $this->prefixed_class_name( $class_name, $prefix ) ); $file_name = 'class-' . str_replace( '_', '-', $lowercase ) . '.php'; - $parts = explode( '_', strtolower( $this->strip_prefix( $class_name, $prefix ) ) ); + $parts = explode( '_', strtolower( $this->strip_prefix( $class_name, $prefix ) ) ); array_pop( $parts ); $parts[] = $file_name; return implode( DIRECTORY_SEPARATOR, $parts ); @@ -137,7 +137,7 @@ private function include_class_file( $path_to_the_class ) { if ( ! file_exists( $path_to_the_class ) ) { throw new Exception( $path_to_the_class . ' not found' ); } - $included = include_once( $path_to_the_class ); + $included = include_once $path_to_the_class; $this->loaded_classes[ $path_to_the_class ] = $included; return $this; diff --git a/lib/zoninator_rest/class-zoninator-rest-controller.php b/lib/zoninator_rest/class-zoninator-rest-controller.php index e64fa18..e9f8bd4 100644 --- a/lib/zoninator_rest/class-zoninator-rest-controller.php +++ b/lib/zoninator_rest/class-zoninator-rest-controller.php @@ -171,9 +171,12 @@ public function bad_request( $data ) { * @return WP_REST_Response */ public function not_found( $message ) { - return $this->respond( array( - 'message' => $message, - ), self::HTTP_NOT_FOUND ); + return $this->respond( + array( + 'message' => $message, + ), + self::HTTP_NOT_FOUND + ); } /** @@ -260,7 +263,7 @@ function permissions_check( $request, $action = 'any' ) { * @return Zoninator_REST_Controller_Route */ function add_route( $pattern = '' ) { - $route = new Zoninator_REST_Controller_Route( $this, $pattern ); + $route = new Zoninator_REST_Controller_Route( $this, $pattern ); $this->routes[ $pattern ] = $route; return $this->routes[ $pattern ]; } diff --git a/lib/zoninator_rest/class-zoninator-rest-environment.php b/lib/zoninator_rest/class-zoninator-rest-environment.php index 619b5b2..276130b 100644 --- a/lib/zoninator_rest/class-zoninator-rest-environment.php +++ b/lib/zoninator_rest/class-zoninator-rest-environment.php @@ -20,8 +20,8 @@ */ class Zoninator_REST_Environment { const REGISTRABLE = 'IRegistrable'; - const BUNDLES = 'Bundles'; - const MODELS = 'Models'; + const BUNDLES = 'Bundles'; + const MODELS = 'Models'; /** * This environment's registered REST bundles @@ -75,12 +75,12 @@ class Zoninator_REST_Environment { * @param Zoninator_REST_Bootstrap $bootstrap The bootstrap. */ public function __construct( $bootstrap ) { - $this->bootstrap = $bootstrap; - $this->has_started = false; - $this->rest_apis = array(); - $this->variables = array(); + $this->bootstrap = $bootstrap; + $this->has_started = false; + $this->rest_apis = array(); + $this->variables = array(); $this->model_definitions = array(); - $this->type_registry = new Zoninator_REST_Type_Registry(); + $this->type_registry = new Zoninator_REST_Type_Registry(); $this->type_registry->initialize( $this ); // initialize our array vars. $this->array_var( self::MODELS ) @@ -93,7 +93,7 @@ public function __construct( $bootstrap ) { * * All builders are evaluated lazily when needed * - * @param string $where The queue to push the builder to. + * @param string $where The queue to push the builder to. * @param Zoninator_REST_Interfaces_Builder $builder The builder to push. * * @return Zoninator_REST_Environment $this @@ -402,7 +402,7 @@ function define_model( $declaration ) { */ private function add_rest_bundle( $bundle ) { Zoninator_REST_Expect::is_a( $bundle, 'Zoninator_REST_Interfaces_Controller_Bundle' ); - $key = $bundle->get_prefix(); + $key = $bundle->get_prefix(); $this->rest_apis[ $key ] = $bundle; return $this; } diff --git a/lib/zoninator_rest/class-zoninator-rest-model.php b/lib/zoninator_rest/class-zoninator-rest-model.php index 12df88f..b6998cf 100644 --- a/lib/zoninator_rest/class-zoninator-rest-model.php +++ b/lib/zoninator_rest/class-zoninator-rest-model.php @@ -75,7 +75,7 @@ function __construct( $data = array(), $args = array() ) { $data = $this->deserialize( $data ); } $this->raw_data = $data; - $data_keys = array_keys( $data ); + $data_keys = array_keys( $data ); foreach ( $data_keys as $key ) { $this->set( $key, $this->raw_data[ $key ] ); @@ -93,7 +93,7 @@ function __construct( $data = array(), $args = array() ) { */ public function get( $field_name, $args = array() ) { Zoninator_REST_Expect::that( $this->has( $field_name ), 'Field ' . $field_name . 'is not defined' ); - $fields = $this->get_fields(); + $fields = $this->get_fields(); $field_declaration = $fields[ $field_name ]; $this->set_field_if_unset( $field_declaration ); @@ -148,7 +148,7 @@ public function has( $field ) { */ public function validate() { $validation_errors = array(); - $fields = self::get_fields(); + $fields = self::get_fields(); foreach ( $fields as $key => $field_declaration ) { $is_valid = $this->run_field_validations( $field_declaration ); if ( is_wp_error( $is_valid ) ) { @@ -174,8 +174,8 @@ public function sanitize() { * * @var Zoninator_REST_Field_Declaration $field_declaration */ - $field_name = $field_declaration->get_name(); - $value = $this->get( $field_name ); + $field_name = $field_declaration->get_name(); + $value = $this->get( $field_name ); $custom_sanitization = $field_declaration->get_sanitizer(); if ( ! empty( $custom_sanitization ) ) { $value = $this->call( $custom_sanitization, array( $this, $value ) ); @@ -217,11 +217,13 @@ protected function run_field_validations( $field_declaration ) { foreach ( $field_declaration->get_validations() as $validation ) { $result = $this->call( $validation, array( $value ) ); if ( is_wp_error( $result ) ) { - $result->add_data(array( - 'reason' => $result->get_error_messages(), - 'field' => $field_declaration->get_data_transfer_name(), - 'value' => $value, - ) ); + $result->add_data( + array( + 'reason' => $result->get_error_messages(), + 'field' => $field_declaration->get_data_transfer_name(), + 'value' => $value, + ) + ); return $result; } } @@ -236,8 +238,8 @@ protected function run_field_validations( $field_declaration ) { * @return mixed */ private function prepare_value( $field_declaration ) { - $key = $field_declaration->get_name(); - $value = $this->data[ $key ]; + $key = $field_declaration->get_name(); + $value = $this->data[ $key ]; $before_return = $field_declaration->before_get(); if ( isset( $before_return ) && ! empty( $before_return ) ) { $value = $this->call( $before_return, array( $value, $key ) ); @@ -279,7 +281,7 @@ public function get_fields( $filter_by_type = null ) { */ $instance = new $class_name(); if ( ! isset( self::$fields_by_class_name[ $class_name ] ) ) { - $fields = $instance->declare_fields(); + $fields = $instance->declare_fields(); self::$fields_by_class_name[ $class_name ] = self::initialize_field_map( $fields ); } @@ -317,7 +319,7 @@ private static function initialize_field_map( $declared_field_builders ) { * * @var Zoninator_REST_Field_Declaration $field Field Builder. */ - $field = $field_builder->build(); + $field = $field_builder->build(); $fields[ $field->get_name() ] = $field; } return $fields; @@ -373,7 +375,7 @@ public function get_environment() { */ public function with_environment( $environment ) { Zoninator_REST_Expect::is_a( $environment, 'Zoninator_REST_Environment' ); - $class_name = get_class( $this ); + $class_name = get_class( $this ); self::$environments_by_class_name[ $class_name ] = $environment; return $this; } @@ -453,7 +455,7 @@ public function get_dto_field_mappings() { function to_dto() { $result = array(); foreach ( $this->get_dto_field_mappings() as $mapping_name => $field_name ) { - $value = $this->get( $field_name ); + $value = $this->get( $field_name ); $result[ $mapping_name ] = $value; } @@ -469,7 +471,7 @@ function to_dto() { */ private function map_data( $data, $updating = false ) { $request_data = array(); - $fields = $this->get_fields(); + $fields = $this->get_fields(); foreach ( $fields as $field ) { /** * Field @@ -479,10 +481,10 @@ private function map_data( $data, $updating = false ) { if ( $field->is_kind( Zoninator_REST_Field_Declaration::DERIVED ) ) { continue; } - $dto_name = $field->get_data_transfer_name(); + $dto_name = $field->get_data_transfer_name(); $field_name = $field->get_name(); if ( isset( $data[ $dto_name ] ) && ! ( $updating && $field->is_primary() ) ) { - $value = $data[ $dto_name ]; + $value = $data[ $dto_name ]; $request_data[ $field_name ] = $value; } } @@ -562,9 +564,12 @@ public static function from_raw_data( $post ) { } $merged_data = array_merge( $raw_post_data, $flattened_meta ); - return self::create( $merged_data, array( - 'deserialize' => true, - ) ); + return self::create( + $merged_data, + array( + 'deserialize' => true, + ) + ); } /** @@ -575,17 +580,17 @@ public static function from_raw_data( $post ) { */ public function deserialize( $data ) { $field_declarations = $this->get_fields(); - $raw_data = array(); - $post_array_keys = array_keys( $data ); + $raw_data = array(); + $post_array_keys = array_keys( $data ); foreach ( $field_declarations as $declaration ) { /** * Declaration * * @var Zoninator_REST_Field_Declaration $declaration */ - $key = $declaration->get_name(); + $key = $declaration->get_name(); $mapping = $declaration->get_map_from(); - $value = null; + $value = null; if ( in_array( $key, $post_array_keys, true ) ) { // simplest case: we got a $key for this, so just map it. $value = $this->deserialize_field( $declaration, $data[ $key ] ); @@ -616,8 +621,8 @@ function serialize( $field_type = null ) { * * @var Zoninator_REST_Field_Declaration $field_declaration */ - $what_to_map_to = $field_declaration->get_map_from(); - $value = $this->get( $field_declaration->get_name() ); + $what_to_map_to = $field_declaration->get_map_from(); + $value = $this->get( $field_declaration->get_name() ); $field_values_to_insert[ $what_to_map_to ] = $this->serialize_field( $field_declaration, $value ); } @@ -628,7 +633,7 @@ function serialize( $field_type = null ) { * Deserialize * * @param Zoninator_REST_Field_Declaration $field_declaration Declaration. - * @param mixed $value Value. + * @param mixed $value Value. * @return mixed the deserialized value */ private function deserialize_field( $field_declaration, $value ) { @@ -643,7 +648,7 @@ private function deserialize_field( $field_declaration, $value ) { * Serialize * * @param Zoninator_REST_Field_Declaration $field_declaration Declaration. - * @param mixed $value Value. + * @param mixed $value Value. * @return mixed * @throws Zoninator_REST_Exception If call fails. */ diff --git a/lib/zoninator_rest/controller/class-zoninator-rest-controller-action.php b/lib/zoninator_rest/controller/class-zoninator-rest-controller-action.php index a26c876..948a5aa 100644 --- a/lib/zoninator_rest/controller/class-zoninator-rest-controller-action.php +++ b/lib/zoninator_rest/controller/class-zoninator-rest-controller-action.php @@ -19,12 +19,12 @@ class Zoninator_REST_Controller_Action { * @var array */ private $actions_to_http_methods = array( - 'index' => WP_REST_Server::READABLE, - 'show' => WP_REST_Server::READABLE, - 'create' => WP_REST_Server::CREATABLE, + 'index' => WP_REST_Server::READABLE, + 'show' => WP_REST_Server::READABLE, + 'create' => WP_REST_Server::CREATABLE, 'update' => WP_REST_Server::EDITABLE, 'delete' => WP_REST_Server::DELETABLE, - 'any' => WP_REST_Server::ALLMETHODS, + 'any' => WP_REST_Server::ALLMETHODS, ); /** @@ -59,16 +59,16 @@ class Zoninator_REST_Controller_Action { * Zoninator_REST_Controller_Action constructor. * * @param Zoninator_REST_Controller $controller Controller. - * @param string $action_name The action Name. + * @param string $action_name The action Name. */ public function __construct( $controller, $action_name ) { $is_known_action = in_array( $action_name, array_keys( $this->actions_to_http_methods ), true ); Zoninator_REST_Expect::that( $is_known_action, 'Unknown method: ' . $action_name ); - $this->controller = $controller; - $this->action_name = $action_name; - $this->handler = null; - $this->args = null; + $this->controller = $controller; + $this->action_name = $action_name; + $this->handler = null; + $this->args = null; $this->permission_callback = null; } diff --git a/lib/zoninator_rest/controller/class-zoninator-rest-controller-bundle.php b/lib/zoninator_rest/controller/class-zoninator-rest-controller-bundle.php index 328ed64..28a03ec 100644 --- a/lib/zoninator_rest/controller/class-zoninator-rest-controller-bundle.php +++ b/lib/zoninator_rest/controller/class-zoninator-rest-controller-bundle.php @@ -47,7 +47,7 @@ class Zoninator_REST_Controller_Bundle implements Zoninator_REST_Interfaces_Cont * @param array $endpoints Builders. */ function __construct( $bundle_prefix, $endpoints ) { - $this->prefix = $bundle_prefix; + $this->prefix = $bundle_prefix; $this->endpoints = $endpoints; } @@ -96,4 +96,3 @@ function get_prefix() { return $this->prefix; } } - diff --git a/lib/zoninator_rest/controller/class-zoninator-rest-controller-crud.php b/lib/zoninator_rest/controller/class-zoninator-rest-controller-crud.php index 2ca226d..af73b72 100644 --- a/lib/zoninator_rest/controller/class-zoninator-rest-controller-crud.php +++ b/lib/zoninator_rest/controller/class-zoninator-rest-controller-crud.php @@ -19,12 +19,12 @@ class Zoninator_REST_Controller_CRUD extends Zoninator_REST_Controller_Model imp */ public function setup() { $this->add_route( '/' ) - ->add_action( $this->action( 'index', array( $this, 'get_items' ) ) ) + ->add_action( $this->action( 'index', array( $this, 'get_items' ) ) ) ->add_action( $this->action( 'create', array( $this, 'create_item' ) ) ); $this->add_route( '/(?P\d+)' ) - ->add_action( $this->action( 'show', array( $this, 'get_item' ) ) ) - ->add_action( $this->action( 'update', array( $this, 'update_item' ) ) ) + ->add_action( $this->action( 'show', array( $this, 'get_item' ) ) ) + ->add_action( $this->action( 'update', array( $this, 'update_item' ) ) ) ->add_action( $this->action( 'delete', array( $this, 'delete_item' ) ) ); } @@ -39,7 +39,7 @@ public function get_items( $request ) { if ( null === $item_id ) { $models = $this->get_model_data_store()->get_entities(); - $data = $this->prepare_dto( $models ); + $data = $this->prepare_dto( $models ); return $this->ok( $data ); } @@ -125,9 +125,11 @@ protected function create_or_update( $request, $is_update = false ) { return $this->bad_request( $id_or_error ); } - $dto = $this->prepare_dto( array( - 'id' => absint( $id_or_error ), - ) ); + $dto = $this->prepare_dto( + array( + 'id' => absint( $id_or_error ), + ) + ); return $is_update ? $this->ok( $dto ) : $this->created( $dto ); } @@ -158,7 +160,7 @@ public function delete_item( $request ) { * @return array */ protected function model_to_dto( $model ) { - $result = parent::model_to_dto( $model ); + $result = parent::model_to_dto( $model ); $result['_links'] = $this->add_links( $model ); return $result; } diff --git a/lib/zoninator_rest/controller/class-zoninator-rest-controller-extension.php b/lib/zoninator_rest/controller/class-zoninator-rest-controller-extension.php index 5835429..f996c6f 100644 --- a/lib/zoninator_rest/controller/class-zoninator-rest-controller-extension.php +++ b/lib/zoninator_rest/controller/class-zoninator-rest-controller-extension.php @@ -43,7 +43,7 @@ class Zoninator_REST_Controller_Extension implements Zoninator_REST_Interfaces_R */ function __construct( $object_to_extend, $model_definition_name ) { $this->model_definition_name = $model_definition_name; - $this->object_to_extend = $object_to_extend; + $this->object_to_extend = $object_to_extend; } /** @@ -55,7 +55,7 @@ function __construct( $object_to_extend, $model_definition_name ) { * @return bool|WP_Error true if valid otherwise error. */ function register( $environment ) { - $this->environment = $environment; + $this->environment = $environment; $this->model_definition = $this->environment->model( $this->model_definition_name ); if ( ! $this->model_definition ) { return new WP_Error( 'model-not-found' ); @@ -74,10 +74,14 @@ function register( $environment ) { * @param Zoninator_REST_Field_Declaration $field Field. */ private function register_field( $field ) { - register_rest_field( $this->object_to_extend, $field->get_data_transfer_name(), array( - 'get_callback' => $field->get_reader(), - 'update_callback' => $field->get_updater(), - 'schema' => $field->as_item_schema_property(), - ) ); + register_rest_field( + $this->object_to_extend, + $field->get_data_transfer_name(), + array( + 'get_callback' => $field->get_reader(), + 'update_callback' => $field->get_updater(), + 'schema' => $field->as_item_schema_property(), + ) + ); } } diff --git a/lib/zoninator_rest/controller/class-zoninator-rest-controller-model.php b/lib/zoninator_rest/controller/class-zoninator-rest-controller-model.php index 2bcaf7b..a38caa3 100644 --- a/lib/zoninator_rest/controller/class-zoninator-rest-controller-model.php +++ b/lib/zoninator_rest/controller/class-zoninator-rest-controller-model.php @@ -43,7 +43,7 @@ class Zoninator_REST_Controller_Model extends Zoninator_REST_Controller implemen * @param string $model_class_name A Definition or a definition name. */ public function __construct( $base, $model_class_name ) { - $this->base = $base; + $this->base = $base; $this->model_class_name = $model_class_name; } @@ -67,7 +67,7 @@ protected function get_model_prototype() { * @return bool|WP_Error true if valid otherwise error. */ public function register( $bundle, $environment ) { - $this->model_prototype = $environment->model( $this->model_class_name ); + $this->model_prototype = $environment->model( $this->model_class_name ); $this->model_data_store = $this->model_prototype->get_data_store(); return parent::register( $bundle, $environment ); } @@ -83,9 +83,9 @@ public function register( $bundle, $environment ) { */ public function get_item_schema() { $model_definition = $this->get_model_prototype(); - $fields = $model_definition->get_fields(); - $properties = array(); - $required = array(); + $fields = $model_definition->get_fields(); + $properties = array(); + $required = array(); foreach ( $fields as $field_declaration ) { /** * Our declaration @@ -98,9 +98,9 @@ public function get_item_schema() { } } $schema = array( - '$schema' => 'http://json-schema.org/schema#', - 'title' => $model_definition->get_name(), - 'type' => 'object', + '$schema' => 'http://json-schema.org/schema#', + 'title' => $model_definition->get_name(), + 'type' => 'object', 'properties' => (array) apply_filters( 'mixtape_rest_api_schema_properties', $properties, $this->get_model_prototype() ), ); diff --git a/lib/zoninator_rest/controller/class-zoninator-rest-controller-route.php b/lib/zoninator_rest/controller/class-zoninator-rest-controller-route.php index 6176100..2e77fff 100644 --- a/lib/zoninator_rest/controller/class-zoninator-rest-controller-route.php +++ b/lib/zoninator_rest/controller/class-zoninator-rest-controller-route.php @@ -46,12 +46,12 @@ class Zoninator_REST_Controller_Route { * Zoninator_REST_Controller_Route constructor. * * @param Zoninator_REST_Controller $controller A Controller. - * @param string $pattern Pattern. + * @param string $pattern Pattern. */ public function __construct( $controller, $pattern ) { - $this->controller = $controller; - $this->pattern = $pattern; - $this->actions = array(); + $this->controller = $controller; + $this->pattern = $pattern; + $this->actions = array(); $this->http_methods = explode( ', ', WP_REST_Server::ALLMETHODS ); } @@ -74,7 +74,7 @@ public function add_action( $action ) { * @return array */ public function as_array() { - $result = array(); + $result = array(); $result['pattern'] = $this->pattern; $result['actions'] = array(); foreach ( $this->actions as $action => $route_action ) { diff --git a/lib/zoninator_rest/controller/class-zoninator-rest-controller-settings.php b/lib/zoninator_rest/controller/class-zoninator-rest-controller-settings.php index 3194464..05ea322 100644 --- a/lib/zoninator_rest/controller/class-zoninator-rest-controller-settings.php +++ b/lib/zoninator_rest/controller/class-zoninator-rest-controller-settings.php @@ -55,7 +55,7 @@ public function create_item( $request ) { * @return WP_REST_Response */ protected function create_or_update( $request ) { - $is_update = $request->get_method() !== 'POST'; + $is_update = $request->get_method() !== 'POST'; $model_to_update = $this->model_prototype->get_data_store()->get_entity( null ); if ( empty( $model_to_update ) ) { return $this->not_found( 'Model does not exist' ); @@ -79,7 +79,7 @@ protected function create_or_update( $request ) { } $model = $this->model_prototype->get_data_store()->get_entity( null ); - $dto = $this->prepare_dto( $model ); + $dto = $this->prepare_dto( $model ); return $is_update ? $this->ok( $dto ) : $this->created( $dto ); } diff --git a/lib/zoninator_rest/data/class-zoninator-rest-data-mapper.php b/lib/zoninator_rest/data/class-zoninator-rest-data-mapper.php index 08ea6bc..ba932dd 100644 --- a/lib/zoninator_rest/data/class-zoninator-rest-data-mapper.php +++ b/lib/zoninator_rest/data/class-zoninator-rest-data-mapper.php @@ -45,7 +45,7 @@ function __construct( $definition, $serializer ) { * @return array */ function raw_data_to_model_data( $data, $field_declarations ) { - $raw_data = array(); + $raw_data = array(); $post_array_keys = array_keys( $data ); foreach ( $field_declarations as $declaration ) { /** @@ -53,9 +53,9 @@ function raw_data_to_model_data( $data, $field_declarations ) { * * @var Zoninator_REST_Field_Declaration $declaration */ - $key = $declaration->get_name(); + $key = $declaration->get_name(); $mapping = $declaration->get_map_from(); - $value = null; + $value = null; if ( in_array( $key, $post_array_keys, true ) ) { // simplest case: we got a $key for this, so just map it. $value = $this->serializer->deserialize( $declaration, $data[ $key ] ); @@ -73,7 +73,7 @@ function raw_data_to_model_data( $data, $field_declarations ) { * Transform Model to raw data array * * @param Zoninator_REST_Interfaces_Model $model Model. - * @param null|string $field_type Type. + * @param null|string $field_type Type. * @return array */ function model_to_data( $model, $field_type = null ) { @@ -84,8 +84,8 @@ function model_to_data( $model, $field_type = null ) { * * @var Zoninator_REST_Field_Declaration $field_declaration */ - $what_to_map_to = $field_declaration->get_map_from(); - $value = $model->get( $field_declaration->get_name() ); + $what_to_map_to = $field_declaration->get_map_from(); + $value = $model->get( $field_declaration->get_name() ); $field_values_to_insert[ $what_to_map_to ] = $this->serializer->serialize( $field_declaration, $value ); } diff --git a/lib/zoninator_rest/data/class-zoninator-rest-data-serializer.php b/lib/zoninator_rest/data/class-zoninator-rest-data-serializer.php index 52dc711..4fa3f38 100644 --- a/lib/zoninator_rest/data/class-zoninator-rest-data-serializer.php +++ b/lib/zoninator_rest/data/class-zoninator-rest-data-serializer.php @@ -33,7 +33,7 @@ function __construct( $model_definition ) { * Deserialize * * @param Zoninator_REST_Field_Declaration $field_declaration Declaration. - * @param mixed $value Value. + * @param mixed $value Value. * @return mixed the deserialized value */ function deserialize( $field_declaration, $value ) { @@ -45,7 +45,7 @@ function deserialize( $field_declaration, $value ) { * Serialize * * @param Zoninator_REST_Field_Declaration $field_declaration Declaration. - * @param mixed $value Value. + * @param mixed $value Value. * @return mixed * @throws Zoninator_REST_Exception If call fails. */ diff --git a/lib/zoninator_rest/data/store/class-zoninator-rest-data-store-abstract.php b/lib/zoninator_rest/data/store/class-zoninator-rest-data-store-abstract.php index 0ad89b1..bf84d9d 100644 --- a/lib/zoninator_rest/data/store/class-zoninator-rest-data-store-abstract.php +++ b/lib/zoninator_rest/data/store/class-zoninator-rest-data-store-abstract.php @@ -33,11 +33,11 @@ abstract class Zoninator_REST_Data_Store_Abstract implements Zoninator_REST_Inte * Zoninator_REST_Data_Store_Abstract constructor. * * @param null|Zoninator_REST_Model $model_prototype Def. - * @param array $args Args. + * @param array $args Args. */ public function __construct( $model_prototype = null, $args = array() ) { $this->type_serializers = array(); - $this->args = $args; + $this->args = $args; Zoninator_REST_Expect::is_a( $model_prototype, 'Zoninator_REST_Interfaces_Model' ); $this->set_model_factory( $model_prototype ); } diff --git a/lib/zoninator_rest/data/store/class-zoninator-rest-data-store-customposttype.php b/lib/zoninator_rest/data/store/class-zoninator-rest-data-store-customposttype.php index f05fc19..54ff78c 100644 --- a/lib/zoninator_rest/data/store/class-zoninator-rest-data-store-customposttype.php +++ b/lib/zoninator_rest/data/store/class-zoninator-rest-data-store-customposttype.php @@ -24,7 +24,7 @@ class Zoninator_REST_Data_Store_CustomPostType extends Zoninator_REST_Data_Store * Mixtape_Data_Store_CustomPostType constructor. * * @param null|Zoninator_REST_Model_Definition $model_prototype Def. - * @param array $args Args. + * @param array $args Args. */ public function __construct( $model_prototype = null, $args = array() ) { $this->post_type = isset( $args['post_type'] ) ? $args['post_type'] : 'post'; @@ -39,11 +39,13 @@ public function __construct( $model_prototype = null, $args = array() ) { * @return Zoninator_REST_Model_Collection */ public function get_entities( $filter = null ) { - $query = new WP_Query( array( - 'post_type' => $this->post_type, - 'post_status' => 'any', - ) ); - $posts = $query->get_posts(); + $query = new WP_Query( + array( + 'post_type' => $this->post_type, + 'post_status' => 'any', + ) + ); + $posts = $query->get_posts(); $collection = array(); foreach ( $posts as $post ) { $collection[] = $this->create_from_post( $post ); @@ -75,8 +77,8 @@ public function get_entity( $id ) { */ private function create_from_post( $post ) { $field_declarations = $this->get_model_prototype()->get_fields(); - $raw_post_data = $post->to_array(); - $raw_meta_data = get_post_meta( $post->ID ); // assumes we are only ever adding one postmeta per key. + $raw_post_data = $post->to_array(); + $raw_meta_data = get_post_meta( $post->ID ); // assumes we are only ever adding one postmeta per key. $flattened_meta = array(); foreach ( $raw_meta_data as $key => $value_arr ) { @@ -84,24 +86,30 @@ private function create_from_post( $post ) { } $merged_data = array_merge( $raw_post_data, $flattened_meta ); - return $this->get_model_prototype()->create( $merged_data, array( - 'deserialize' => true, - ) ); + return $this->get_model_prototype()->create( + $merged_data, + array( + 'deserialize' => true, + ) + ); } /** * Delete * * @param Zoninator_REST_Interfaces_Model $model Model. - * @param array $args Args. + * @param array $args Args. * @return mixed */ public function delete( $model, $args = array() ) { $id = $model->get_id(); - $args = wp_parse_args( $args, array( - 'force_delete' => false, - ) ); + $args = wp_parse_args( + $args, + array( + 'force_delete' => false, + ) + ); do_action( 'mixtape_data_store_delete_model_before', $model, $id ); @@ -130,9 +138,9 @@ public function delete( $model, $args = array() ) { * @return mixed|WP_Error */ public function upsert( $model ) { - $id = $model->get_id(); - $updating = ! empty( $id ); - $fields = $model->serialize( Zoninator_REST_Field_Declaration::FIELD ); + $id = $model->get_id(); + $updating = ! empty( $id ); + $fields = $model->serialize( Zoninator_REST_Field_Declaration::FIELD ); $meta_fields = $model->serialize( Zoninator_REST_Field_Declaration::META ); if ( ! isset( $fields['post_type'] ) ) { $fields['post_type'] = $this->post_type; @@ -164,7 +172,7 @@ public function upsert( $model ) { 'mixtape-error-creating-meta', 'There was an error updating/creating an entity field', array( - 'field_key' => $meta_key, + 'field_key' => $meta_key, 'field_value' => $meta_value, ) ); diff --git a/lib/zoninator_rest/data/store/class-zoninator-rest-data-store-nil.php b/lib/zoninator_rest/data/store/class-zoninator-rest-data-store-nil.php index 81a2281..d6fef95 100644 --- a/lib/zoninator_rest/data/store/class-zoninator-rest-data-store-nil.php +++ b/lib/zoninator_rest/data/store/class-zoninator-rest-data-store-nil.php @@ -39,7 +39,7 @@ public function get_entity( $id ) { * Delete * * @param Zoninator_REST_Interfaces_Model $model Model. - * @param array $args Args. + * @param array $args Args. * @return bool */ public function delete( $model, $args = array() ) { diff --git a/lib/zoninator_rest/data/store/class-zoninator-rest-data-store-option.php b/lib/zoninator_rest/data/store/class-zoninator-rest-data-store-option.php index 5c4114b..de3c80a 100644 --- a/lib/zoninator_rest/data/store/class-zoninator-rest-data-store-option.php +++ b/lib/zoninator_rest/data/store/class-zoninator-rest-data-store-option.php @@ -25,7 +25,7 @@ class Zoninator_REST_Data_Store_Option extends Zoninator_REST_Data_Store_Abstrac * Zoninator_REST_Data_Store_Option constructor. * * @param Zoninator_REST_Model $model_prototype Def. - * @param array $args Args. + * @param array $args Args. */ public function __construct( $model_prototype, $args = array() ) { parent::__construct( $model_prototype, $args ); @@ -51,7 +51,7 @@ public function get_entities( $filter = null ) { */ public function get_entity( $id ) { $field_declarations = $this->get_model_prototype()->get_fields(); - $raw_data = array(); + $raw_data = array(); foreach ( $field_declarations as $field_declaration ) { /** * Field Declaration @@ -64,16 +64,19 @@ public function get_entity( $id ) { } } - return $this->get_model_prototype()->create( $raw_data, array( - 'deserialize' => true, - ) ); + return $this->get_model_prototype()->create( + $raw_data, + array( + 'deserialize' => true, + ) + ); } /** * Delete * * @param Zoninator_REST_Interfaces_Model $model Model. - * @param array $args Args. + * @param array $args Args. * @return mixed */ public function delete( $model, $args = array() ) { diff --git a/lib/zoninator_rest/field/class-zoninator-rest-field-declaration.php b/lib/zoninator_rest/field/class-zoninator-rest-field-declaration.php index 50431d7..0fd121a 100644 --- a/lib/zoninator_rest/field/class-zoninator-rest-field-declaration.php +++ b/lib/zoninator_rest/field/class-zoninator-rest-field-declaration.php @@ -169,32 +169,32 @@ public function __construct( $args ) { throw new Zoninator_REST_Exception( 'every field should have a kind (one of ' . implode( ',', $this->field_kinds ) . ')' ); } - $this->name = $args['name']; - $this->description = $this->value_or_default( $args, 'description', '' ); + $this->name = $args['name']; + $this->description = $this->value_or_default( $args, 'description', '' ); - $this->kind = $args['kind']; - $this->type = $this->value_or_default( $args, 'type', Zoninator_REST_Type::any() ); - $this->choices = $this->value_or_default( $args, 'choices', null ); - $this->default_value = $this->value_or_default( $args, 'default_value' ); + $this->kind = $args['kind']; + $this->type = $this->value_or_default( $args, 'type', Zoninator_REST_Type::any() ); + $this->choices = $this->value_or_default( $args, 'choices', null ); + $this->default_value = $this->value_or_default( $args, 'default_value' ); - $this->map_from = $this->value_or_default( $args, 'map_from' ); - $this->data_transfer_name = $this->value_or_default( $args, 'data_transfer_name', $this->get_name() ); + $this->map_from = $this->value_or_default( $args, 'map_from' ); + $this->data_transfer_name = $this->value_or_default( $args, 'data_transfer_name', $this->get_name() ); - $this->primary = $this->value_or_default( $args, 'primary', false ); - $this->required = $this->value_or_default( $args, 'required', false ); - $this->supported_outputs = $this->value_or_default( $args, 'supported_outputs', array( 'json' ) ); + $this->primary = $this->value_or_default( $args, 'primary', false ); + $this->required = $this->value_or_default( $args, 'required', false ); + $this->supported_outputs = $this->value_or_default( $args, 'supported_outputs', array( 'json' ) ); - $this->sanitizer = $this->value_or_default( $args, 'sanitizer' ); - $this->validations = $this->value_or_default( $args, 'validations', array() ); + $this->sanitizer = $this->value_or_default( $args, 'sanitizer' ); + $this->validations = $this->value_or_default( $args, 'validations', array() ); - $this->serializer = $this->value_or_default( $args, 'serializer' ); - $this->deserializer = $this->value_or_default( $args, 'deserializer' ); + $this->serializer = $this->value_or_default( $args, 'serializer' ); + $this->deserializer = $this->value_or_default( $args, 'deserializer' ); - $this->before_get = $this->value_or_default( $args, 'before_get' ); - $this->before_set = $this->value_or_default( $args, 'before_set' ); + $this->before_get = $this->value_or_default( $args, 'before_get' ); + $this->before_set = $this->value_or_default( $args, 'before_set' ); - $this->reader = $this->value_or_default( $args, 'reader' ); - $this->updater = $this->value_or_default( $args, 'updater' ); + $this->reader = $this->value_or_default( $args, 'reader' ); + $this->updater = $this->value_or_default( $args, 'updater' ); } /** @@ -279,8 +279,8 @@ public function supports_output_type( $type ) { * @return array */ public function as_item_schema_property() { - $schema = $this->type->schema(); - $schema['context'] = array( 'view', 'edit' ); + $schema = $this->type->schema(); + $schema['context'] = array( 'view', 'edit' ); $schema['description'] = $this->get_description(); if ( $this->get_choices() ) { diff --git a/lib/zoninator_rest/field/declaration/class-zoninator-rest-field-declaration-builder.php b/lib/zoninator_rest/field/declaration/class-zoninator-rest-field-declaration-builder.php index 8fc4825..1f70ea0 100644 --- a/lib/zoninator_rest/field/declaration/class-zoninator-rest-field-declaration-builder.php +++ b/lib/zoninator_rest/field/declaration/class-zoninator-rest-field-declaration-builder.php @@ -133,7 +133,6 @@ public function with_deserializer( $deserializer ) { */ public function with_required( $required = true ) { return $this->with( 'required', $required ); - } /** diff --git a/lib/zoninator_rest/interfaces/data/class-zoninator-rest-interfaces-data-store.php b/lib/zoninator_rest/interfaces/data/class-zoninator-rest-interfaces-data-store.php index 21dce65..a6b4601 100644 --- a/lib/zoninator_rest/interfaces/data/class-zoninator-rest-interfaces-data-store.php +++ b/lib/zoninator_rest/interfaces/data/class-zoninator-rest-interfaces-data-store.php @@ -36,7 +36,7 @@ public function get_entity( $id ); * Delete a Model * * @param Zoninator_REST_Interfaces_Model $model The model to delete. - * @param array $args Args. + * @param array $args Args. * @return mixed */ public function delete( $model, $args = array() ); diff --git a/lib/zoninator_rest/interfaces/model/class-zoninator-rest-interfaces-model-declaration.php b/lib/zoninator_rest/interfaces/model/class-zoninator-rest-interfaces-model-declaration.php index 83b3084..c5b4917 100644 --- a/lib/zoninator_rest/interfaces/model/class-zoninator-rest-interfaces-model-declaration.php +++ b/lib/zoninator_rest/interfaces/model/class-zoninator-rest-interfaces-model-declaration.php @@ -49,7 +49,7 @@ function declare_fields( $environment ); * @param array $args The args. * @return mixed */ - function call( $method, $args = array()); + function call( $method, $args = array() ); /** * Get this model's unique identifier @@ -63,7 +63,7 @@ function get_id( $model ); * Set this model's unique identifier * * @param Zoninator_REST_Interfaces_Model $model The model. - * @param mixed $id The id. + * @param mixed $id The id. * * @return Zoninator_REST_Interfaces_Model The model. */ @@ -75,5 +75,4 @@ function set_id( $model, $id ); * @return string This declaration's name. */ function get_name(); - } diff --git a/lib/zoninator_rest/model/class-zoninator-rest-model-declaration.php b/lib/zoninator_rest/model/class-zoninator-rest-model-declaration.php index c29dd74..6393073 100644 --- a/lib/zoninator_rest/model/class-zoninator-rest-model-declaration.php +++ b/lib/zoninator_rest/model/class-zoninator-rest-model-declaration.php @@ -68,7 +68,7 @@ function get_id( $model ) { * Set the id * * @param Zoninator_REST_Interfaces_Model $model The model. - * @param mixed $new_id The new id. + * @param mixed $new_id The new id. * * @return mixed|null */ diff --git a/lib/zoninator_rest/model/class-zoninator-rest-model-definition.php b/lib/zoninator_rest/model/class-zoninator-rest-model-definition.php index 0bb2ff9..d2065f2 100644 --- a/lib/zoninator_rest/model/class-zoninator-rest-model-definition.php +++ b/lib/zoninator_rest/model/class-zoninator-rest-model-definition.php @@ -63,21 +63,21 @@ class Zoninator_REST_Model_Definition implements Zoninator_REST_Interfaces_Permi /** * Mixtape_Model_Definition constructor. * - * @param Zoninator_REST_Environment $environment The Environment. - * @param Zoninator_REST_Interfaces_Model_Declaration $model_declaration Declaration. + * @param Zoninator_REST_Environment $environment The Environment. + * @param Zoninator_REST_Interfaces_Model_Declaration $model_declaration Declaration. * @param Zoninator_REST_Interfaces_Data_Store|Zoninator_REST_Data_Store_Builder $data_store Store. - * @param Zoninator_REST_Interfaces_Permissions_Provider $permissions_provider Provider. + * @param Zoninator_REST_Interfaces_Permissions_Provider $permissions_provider Provider. * * @throws Zoninator_REST_Exception Throws if wrong types or null args provided. */ function __construct( $environment, $model_declaration, $data_store, $permissions_provider ) { - Zoninator_REST_Expect::that( null !== $environment , '$environment cannot be null' ); - Zoninator_REST_Expect::that( null !== $model_declaration , '$model_declaration cannot be null' ); - Zoninator_REST_Expect::that( null !== $data_store , '$data_store cannot be null' ); + Zoninator_REST_Expect::that( null !== $environment, '$environment cannot be null' ); + Zoninator_REST_Expect::that( null !== $model_declaration, '$model_declaration cannot be null' ); + Zoninator_REST_Expect::that( null !== $data_store, '$data_store cannot be null' ); Zoninator_REST_Expect::that( null !== $permissions_provider, '$permissions_provider cannot be null' ); // Fail if provided with inappropriate types. - Zoninator_REST_Expect::is_a( $environment , 'Zoninator_REST_Environment' ); - Zoninator_REST_Expect::is_a( $model_declaration , 'Zoninator_REST_Interfaces_Model_Declaration' ); + Zoninator_REST_Expect::is_a( $environment, 'Zoninator_REST_Environment' ); + Zoninator_REST_Expect::is_a( $model_declaration, 'Zoninator_REST_Interfaces_Model_Declaration' ); Zoninator_REST_Expect::is_a( $permissions_provider, 'Zoninator_REST_Interfaces_Permissions_Provider' ); $this->field_declarations = null; @@ -195,8 +195,8 @@ function create_instance( $data ) { * Note: Values change in place. * * @param Zoninator_REST_Interfaces_Model $model The model. - * @param array $data The data (key-value assumed). - * @param bool $updating Is this an update?. + * @param array $data The data (key-value assumed). + * @param bool $updating Is this an update?. * * @return Zoninator_REST_Interfaces_Model|WP_Error * @throws Zoninator_REST_Exception Throws. @@ -260,7 +260,7 @@ function get_dto_field_mappings() { function model_to_dto( $model ) { $result = array(); foreach ( $this->get_dto_field_mappings() as $mapping_name => $field_name ) { - $value = $model->get( $field_name ); + $value = $model->get( $field_name ); $result[ $mapping_name ] = $value; } @@ -296,7 +296,7 @@ public function permissions_check( $request, $action ) { */ private function map_data( $data, $updating = false ) { $request_data = array(); - $fields = $this->get_field_declarations(); + $fields = $this->get_field_declarations(); foreach ( $fields as $field ) { /** * Field @@ -306,10 +306,10 @@ private function map_data( $data, $updating = false ) { if ( $field->is_kind( Zoninator_REST_Field_Declaration::DERIVED ) ) { continue; } - $dto_name = $field->get_data_transfer_name(); + $dto_name = $field->get_data_transfer_name(); $field_name = $field->get_name(); if ( isset( $data[ $dto_name ] ) && ! ( $updating && $field->is_primary() ) ) { - $value = $data[ $dto_name ]; + $value = $data[ $dto_name ]; $request_data[ $field_name ] = $value; } } @@ -331,7 +331,7 @@ private function initialize_field_map( $declared_field_builders ) { * * @var Zoninator_REST_Field_Declaration $field Field Builder. */ - $field = $field_builder->build(); + $field = $field_builder->build(); $fields[ $field->get_name() ] = $field; } return $fields; diff --git a/lib/zoninator_rest/model/class-zoninator-rest-model-settings.php b/lib/zoninator_rest/model/class-zoninator-rest-model-settings.php index f1c0fb1..4d727f4 100644 --- a/lib/zoninator_rest/model/class-zoninator-rest-model-settings.php +++ b/lib/zoninator_rest/model/class-zoninator-rest-model-settings.php @@ -40,9 +40,9 @@ protected function default_for_attribute( $field_data, $attribute ) { /** * On Field Setup * - * @param string $field_name Name. + * @param string $field_name Name. * @param Zoninator_REST_Field_Declaration_Builder $field_builder Builder. - * @param array $field_data Data. + * @param array $field_data Data. * @param Zoninator_REST_Environment $env Env. * @return void */ @@ -55,16 +55,16 @@ protected function on_field_setup( $field_name, $field_builder, $field_data, $en * @return array */ public function declare_fields() { - $env = $this->get_environment(); + $env = $this->get_environment(); $settings_per_group = $this->get_settings(); - $fields = array(); + $fields = array(); foreach ( $settings_per_group as $group_name => $group_data ) { $group_fields = $group_data[1]; foreach ( $group_fields as $field_data ) { $field_builder = $this->field_declaration_builder_from_data( $env, $field_data ); - $fields[] = $field_builder; + $fields[] = $field_builder; } } return $fields; @@ -113,18 +113,18 @@ public function set_id( $new_id ) { * Build declarations from array * * @param Zoninator_REST_Environment $env Environment. - * @param array $field_data Data. + * @param array $field_data Data. * @return Zoninator_REST_Field_Declaration_Builder */ private function field_declaration_builder_from_data( $env, $field_data ) { - $field_name = $field_data['name']; + $field_name = $field_data['name']; $field_builder = $env->field( $field_name ); $default_value = isset( $field_data['std'] ) ? $field_data['std'] : $this->default_for_attribute( $field_data, 'std' ); - $label = isset( $field_data['label'] ) ? $field_data['label'] : $field_name; - $description = isset( $field_data['desc'] ) ? $field_data['desc'] : $label; - $setting_type = isset( $field_data['type'] ) ? $field_data['type'] : null; - $choices = isset( $field_data['options'] ) ? array_keys( $field_data['options'] ) : null; - $field_type = 'string'; + $label = isset( $field_data['label'] ) ? $field_data['label'] : $field_name; + $description = isset( $field_data['desc'] ) ? $field_data['desc'] : $label; + $setting_type = isset( $field_data['type'] ) ? $field_data['type'] : null; + $choices = isset( $field_data['options'] ) ? array_keys( $field_data['options'] ) : null; + $field_type = 'string'; if ( 'checkbox' === $setting_type ) { $field_type = 'boolean'; @@ -135,7 +135,6 @@ private function field_declaration_builder_from_data( $env, $field_data ) { $field_builder ->with_serializer( array( $this, 'bool_to_bit' ) ) ->with_deserializer( array( $this, 'bit_to_bool' ) ); - } elseif ( 'select' === $setting_type ) { $field_type = 'string'; } else { diff --git a/lib/zoninator_rest/model/class-zoninator-rest-model-validationdata.php b/lib/zoninator_rest/model/class-zoninator-rest-model-validationdata.php index 9e83f1a..afa83a7 100644 --- a/lib/zoninator_rest/model/class-zoninator-rest-model-validationdata.php +++ b/lib/zoninator_rest/model/class-zoninator-rest-model-validationdata.php @@ -35,7 +35,7 @@ class Zoninator_REST_Model_ValidationData { /** * Mixtape_Model_ValidationData constructor. * - * @param mixed $value The value. + * @param mixed $value The value. * @param Zoninator_REST_Interfaces_Model $model The Model. * @param Zoninator_REST_Field_Declaration $field The Field. */ diff --git a/lib/zoninator_rest/model/declaration/class-zoninator-rest-model-declaration-settings.php b/lib/zoninator_rest/model/declaration/class-zoninator-rest-model-declaration-settings.php index bdfa3d6..7e197d9 100644 --- a/lib/zoninator_rest/model/declaration/class-zoninator-rest-model-declaration-settings.php +++ b/lib/zoninator_rest/model/declaration/class-zoninator-rest-model-declaration-settings.php @@ -13,8 +13,7 @@ * Class Mixtape_Model_Declaration_Settings * Represents a single setting field */ -class Zoninator_REST_Model_Declaration_Settings extends Zoninator_REST_Model_Declaration - implements Zoninator_REST_Interfaces_Permissions_Provider { +class Zoninator_REST_Model_Declaration_Settings extends Zoninator_REST_Model_Declaration implements Zoninator_REST_Interfaces_Permissions_Provider { /** * Get Settings @@ -39,9 +38,9 @@ protected function default_for_attribute( $field_data, $attribute ) { /** * On Field Setup * - * @param string $field_name Name. + * @param string $field_name Name. * @param Zoninator_REST_Field_Declaration_Builder $field_builder Builder. - * @param array $field_data Data. + * @param array $field_data Data. * @param Zoninator_REST_Environment $env Env. * @return void */ @@ -56,14 +55,14 @@ protected function on_field_setup( $field_name, $field_builder, $field_data, $en */ function declare_fields( $env ) { $settings_per_group = $this->get_settings(); - $fields = array(); + $fields = array(); foreach ( $settings_per_group as $group_name => $group_data ) { $group_fields = $group_data[1]; foreach ( $group_fields as $field_data ) { $field_builder = $this->field_declaration_builder_from_data( $env, $field_data ); - $fields[] = $field_builder; + $fields[] = $field_builder; } } return $fields; @@ -103,7 +102,7 @@ function get_id( $model ) { * Set ID * * @param Zoninator_REST_Interfaces_Model $model Model. - * @param mixed $new_id New ID. + * @param mixed $new_id New ID. * @return Zoninator_REST_Interfaces_Model $this */ function set_id( $model, $new_id ) { @@ -114,18 +113,18 @@ function set_id( $model, $new_id ) { * Build declarations from array * * @param Zoninator_REST_Environment $env Environment. - * @param array $field_data Data. + * @param array $field_data Data. * @return Zoninator_REST_Field_Declaration_Builder */ private function field_declaration_builder_from_data( $env, $field_data ) { - $field_name = $field_data['name']; + $field_name = $field_data['name']; $field_builder = $env->field( $field_name ); $default_value = isset( $field_data['std'] ) ? $field_data['std'] : $this->default_for_attribute( $field_data, 'std' ); - $label = isset( $field_data['label'] ) ? $field_data['label'] : $field_name; - $description = isset( $field_data['desc'] ) ? $field_data['desc'] : $label; - $setting_type = isset( $field_data['type'] ) ? $field_data['type'] : null; - $choices = isset( $field_data['options'] ) ? array_keys( $field_data['options'] ) : null; - $field_type = 'string'; + $label = isset( $field_data['label'] ) ? $field_data['label'] : $field_name; + $description = isset( $field_data['desc'] ) ? $field_data['desc'] : $label; + $setting_type = isset( $field_data['type'] ) ? $field_data['type'] : null; + $choices = isset( $field_data['options'] ) ? array_keys( $field_data['options'] ) : null; + $field_type = 'string'; if ( 'checkbox' === $setting_type ) { $field_type = 'boolean'; @@ -136,7 +135,6 @@ private function field_declaration_builder_from_data( $env, $field_data ) { $field_builder ->with_serializer( array( $this, 'bool_to_bit' ) ) ->with_deserializer( array( $this, 'bit_to_bool' ) ); - } elseif ( 'select' === $setting_type ) { $field_type = 'string'; } else { diff --git a/lib/zoninator_rest/type/class-zoninator-rest-type-nullable.php b/lib/zoninator_rest/type/class-zoninator-rest-type-nullable.php index 3712378..5dde989 100644 --- a/lib/zoninator_rest/type/class-zoninator-rest-type-nullable.php +++ b/lib/zoninator_rest/type/class-zoninator-rest-type-nullable.php @@ -69,7 +69,7 @@ public function sanitize( $value ) { * Schema */ function schema() { - $schema = parent::schema(); + $schema = parent::schema(); $schema['type'] = array_unique( array_merge( $schema['type'], array( 'null' ) ) ); } } diff --git a/lib/zoninator_rest/type/class-zoninator-rest-type-registry.php b/lib/zoninator_rest/type/class-zoninator-rest-type-registry.php index 12cdfca..f081045 100644 --- a/lib/zoninator_rest/type/class-zoninator-rest-type-registry.php +++ b/lib/zoninator_rest/type/class-zoninator-rest-type-registry.php @@ -33,7 +33,7 @@ class Zoninator_REST_Type_Registry { /** * Define a new type * - * @param string $identifier The Identifier. + * @param string $identifier The Identifier. * @param Zoninator_REST_Interfaces_Type $instance The type instance. * * @return Zoninator_REST_Type_Registry $this @@ -61,7 +61,6 @@ function definition( $type ) { // maybe lazy-register missing compound type. $parts = explode( ':', $type ); if ( count( $parts ) > 1 ) { - $container_type = $parts[0]; if ( ! in_array( $container_type, $this->container_types, true ) ) { throw new Zoninator_REST_Exception( $container_type . ' is not a known container type' ); @@ -110,16 +109,21 @@ public function initialize( $environment ) { return; } - $this->types = apply_filters( 'mixtape_type_registry_register_types', array( - 'any' => new Zoninator_REST_Type( 'any' ), - 'string' => new Zoninator_REST_Type_String(), - 'integer' => new Zoninator_REST_Type_Integer(), - 'int' => new Zoninator_REST_Type_Integer(), - 'uint' => new Zoninator_REST_Type_Integer( true ), - 'number' => new Zoninator_REST_Type_Number(), - 'float' => new Zoninator_REST_Type_Number(), - 'boolean' => new Zoninator_REST_Type_Boolean(), - 'array' => new Zoninator_REST_Type_Array(), - ), $this, $environment ); + $this->types = apply_filters( + 'mixtape_type_registry_register_types', + array( + 'any' => new Zoninator_REST_Type( 'any' ), + 'string' => new Zoninator_REST_Type_String(), + 'integer' => new Zoninator_REST_Type_Integer(), + 'int' => new Zoninator_REST_Type_Integer(), + 'uint' => new Zoninator_REST_Type_Integer( true ), + 'number' => new Zoninator_REST_Type_Number(), + 'float' => new Zoninator_REST_Type_Number(), + 'boolean' => new Zoninator_REST_Type_Boolean(), + 'array' => new Zoninator_REST_Type_Array(), + ), + $this, + $environment + ); } } diff --git a/lib/zoninator_rest/type/class-zoninator-rest-type-typedarray.php b/lib/zoninator_rest/type/class-zoninator-rest-type-typedarray.php index 34b84ab..2c93b04 100644 --- a/lib/zoninator_rest/type/class-zoninator-rest-type-typedarray.php +++ b/lib/zoninator_rest/type/class-zoninator-rest-type-typedarray.php @@ -63,8 +63,8 @@ public function cast( $value ) { * @return array */ function schema() { - $schema = parent::schema(); - $schema['type'] = 'array'; + $schema = parent::schema(); + $schema['type'] = 'array'; $schema['items'] = $this->item_type_definition->schema(); return $schema; } diff --git a/widget.zone-posts.php b/widget.zone-posts.php index cee118c..2bf1357 100644 --- a/widget.zone-posts.php +++ b/widget.zone-posts.php @@ -7,8 +7,8 @@ class Zoninator_ZonePosts_Widget extends WP_Widget { function __construct() { $widget_ops = array( - 'classname' => 'widget-zone-posts', - 'description' => __( 'Use this widget to display a list of posts from any zone.', 'zoninator' ) + 'classname' => 'widget-zone-posts', + 'description' => __( 'Use this widget to display a list of posts from any zone.', 'zoninator' ), ); $this->alt_option_name = 'widget_zone_posts'; @@ -25,10 +25,11 @@ function __construct() { function widget( $args, $instance ) { $cache_key = 'widget-zone-posts'; - $cache = wp_cache_get( $cache_key, 'widget' ); + $cache = wp_cache_get( $cache_key, 'widget' ); - if ( ! is_array( $cache ) ) + if ( ! is_array( $cache ) ) { $cache = array(); + } if ( isset( $cache[ $args['widget_id'] ] ) ) { echo $cache[ $args['widget_id'] ]; @@ -39,16 +40,19 @@ function widget( $args, $instance ) { $zone_id = $instance['zone_id'] ? $instance['zone_id'] : 0; $show_description = $instance['show_description'] ? 1 : 0; - if ( ! $zone_id ) + if ( ! $zone_id ) { return; + } $zone = z_get_zone( $zone_id ); - if ( ! $zone ) + if ( ! $zone ) { return; + } $posts = z_get_posts_in_zone( $zone_id ); - if ( empty( $posts ) ) + if ( empty( $posts ) ) { return; + } ?> @@ -82,14 +86,21 @@ function widget( $args, $instance ) { } function update( $new_instance, $old_instance ) { - $instance = $old_instance; - $new_instance = wp_parse_args( (array) $new_instance, array( 'zone_id' => 0, 'show_description' => 0 ) ); + $instance = $old_instance; + $new_instance = wp_parse_args( + (array) $new_instance, + array( + 'zone_id' => 0, + 'show_description' => 0, + ) + ); $instance['zone_id'] = absint( $new_instance['zone_id'] ); $instance['show_description'] = $new_instance['show_description'] ? 1 : 0; $this->flush_widget_cache(); $alloptions = wp_cache_get( 'alloptions', 'options' ); - if ( isset( $alloptions['widget-zone-posts'] ) ) + if ( isset( $alloptions['widget-zone-posts'] ) ) { delete_option( 'widget-zone-posts' ); + } return $instance; } @@ -140,6 +151,6 @@ function form( $instance ) {

- '' +if ( ! class_exists( 'Zoninator' ) ) : + define( 'ZONINATOR_VERSION', '0.10.0' ); + define( 'ZONINATOR_PATH', __DIR__ ); + define( 'ZONINATOR_URL', trailingslashit( plugins_url( '', __FILE__ ) ) ); + + require_once ZONINATOR_PATH . '/functions.php'; + require_once ZONINATOR_PATH . '/widget.zone-posts.php'; + + class Zoninator { + + var $key = 'zoninator'; + var $zone_taxonomy = 'zoninator_zones'; + var $zone_term_prefix = 'zone-'; + var $zone_meta_prefix = '_zoninator_order_'; + var $zone_nonce_prefix = 'zone-nonce'; + var $zone_ajax_nonce_action = 'ajax-action'; + var $zone_lock_period = 30; // number of seconds a lock is valid for + var $zone_max_lock_period = 600; // max number of seconds for all locks in a session + var $post_types = null; + var $zone_detail_defaults = array( + 'description' => '', // Add additional properties here! - ); - var $zone_messages = null; - var $posts_per_page = 10; - /** - * @var Zoninator_Api - */ - public $rest_api = null; - /** - * @var array|string[] Default post types that support zones. - */ - public $default_post_types = array( 'post' ); - - function __construct() { - add_action( 'init', array( $this, 'init' ), 99 ); // init later after other post types have been registered + ); + var $zone_messages = null; + var $posts_per_page = 10; + /** + * @var Zoninator_Api + */ + public $rest_api = null; + /** + * @var array|string[] Default post types that support zones. + */ + public $default_post_types = array( 'post' ); - add_action( 'plugins_loaded', array( $this, 'load_textdomain' ) ); + function __construct() { + add_action( 'init', array( $this, 'init' ), 99 ); // init later after other post types have been registered - add_action( 'widgets_init', array( $this, 'widgets_init' ) ); + add_action( 'plugins_loaded', array( $this, 'load_textdomain' ) ); - add_action( 'init', array( $this, 'add_zone_feed' ) ); + add_action( 'widgets_init', array( $this, 'widgets_init' ) ); - add_action( 'template_redirect', array( $this, 'do_zoninator_feeds' ) ); + add_action( 'init', array( $this, 'add_zone_feed' ) ); - add_action( 'split_shared_term', array( $this, 'split_shared_term' ), 10, 4 ); + add_action( 'template_redirect', array( $this, 'do_zoninator_feeds' ) ); - $this->maybe_add_rest_api(); - } + add_action( 'split_shared_term', array( $this, 'split_shared_term' ), 10, 4 ); - public function maybe_add_rest_api() { - global $wp_version; - if ( version_compare( $wp_version, '4.7', '<' ) ) { - return false; + $this->maybe_add_rest_api(); } - include_once 'includes/class-zoninator-api.php'; - $this->rest_api = new Zoninator_Api( $this ); - } - - function add_zone_feed() { - add_rewrite_tag( '%' . $this->zone_taxonomy . '%', '([^&]+)' ); - add_rewrite_rule( '^zones/([^/]+)/feed.json/?$', 'index.php?' . $this->zone_taxonomy . '=$matches[1]', 'top' ); - } - - function init() { - $this->zone_messages = array( - 'insert-success' => __( 'The zone was successfully created.', 'zoninator' ), - 'update-success' => __( 'The zone was successfully updated.', 'zoninator' ), - 'delete-success' => __( 'The zone was successfully deleted.', 'zoninator' ), - 'error-general' => __( 'Sorry, something went wrong! Please try again?', 'zoninator' ), - 'error-zone-lock' => __( 'Sorry, this zone is in use by %s and is currently locked. Please try again later.', 'zoninator' ), - 'error-zone-lock-max' => __( 'Sorry, you have reached the maximum idle limit and will now be redirected to the Dashboard.', 'zoninator' ), - ); - - $this->zone_lock_period = apply_filters( 'zoninator_zone_lock_period', $this->zone_lock_period ); - $this->zone_max_lock_period = apply_filters( 'zoninator_zone_max_lock_period', $this->zone_max_lock_period ); - $this->posts_per_page = apply_filters( 'zoninator_posts_per_page', $this->posts_per_page ); - - do_action( 'zoninator_pre_init' ); - - // Default post type support - foreach( $this->default_post_types as $post_type ) - add_post_type_support( $post_type, $this->zone_taxonomy ); - - // Register taxonomy - if( ! taxonomy_exists( $this->zone_taxonomy ) ) { - register_taxonomy( $this->zone_taxonomy, $this->get_supported_post_types(), array( - 'label' => __( 'Zones', 'zoninator' ), - 'hierarchical' => false, - 'query_var' => false, - 'rewrite' => false, - 'public' => false, + public function maybe_add_rest_api() { + global $wp_version; + if ( version_compare( $wp_version, '4.7', '<' ) ) { + return false; + } - ) ); + include_once 'includes/class-zoninator-api.php'; + $this->rest_api = new Zoninator_Api( $this ); } - add_action( 'admin_init', array( $this, 'admin_controller' ) ); - add_action( 'admin_init', array( $this, 'admin_init' ) ); - - add_action( 'admin_menu', array( $this, 'admin_page_init' ) ); - - # Add default advanced search fields - add_action( 'zoninator_advanced_search_fields', array( $this, 'zone_advanced_search_cat_filter' ) ); - add_action( 'zoninator_advanced_search_fields', array( $this, 'zone_advanced_search_date_filter' ), 20 ); - - do_action( 'zoninator_post_init' ); - } - - public function load_textdomain() { - load_plugin_textdomain( 'zoninator', false, basename( ZONINATOR_PATH ) . '/language' ); - } + function add_zone_feed() { + add_rewrite_tag( '%' . $this->zone_taxonomy . '%', '([^&]+)' ); + add_rewrite_rule( '^zones/([^/]+)/feed.json/?$', 'index.php?' . $this->zone_taxonomy . '=$matches[1]', 'top' ); + } - function widgets_init() { - register_widget( 'Zoninator_ZonePosts_Widget' ); - } + function init() { + $this->zone_messages = array( + 'insert-success' => __( 'The zone was successfully created.', 'zoninator' ), + 'update-success' => __( 'The zone was successfully updated.', 'zoninator' ), + 'delete-success' => __( 'The zone was successfully deleted.', 'zoninator' ), + 'error-general' => __( 'Sorry, something went wrong! Please try again?', 'zoninator' ), + 'error-zone-lock' => __( 'Sorry, this zone is in use by %s and is currently locked. Please try again later.', 'zoninator' ), + 'error-zone-lock-max' => __( 'Sorry, you have reached the maximum idle limit and will now be redirected to the Dashboard.', 'zoninator' ), + ); - // Add necessary AJAX actions - function admin_ajax_init( ) { - add_action( 'wp_ajax_zoninator_reorder_posts', array( $this, 'ajax_reorder_posts' ) ); - add_action( 'wp_ajax_zoninator_add_post', array( $this, 'ajax_add_post' ) ); - add_action( 'wp_ajax_zoninator_remove_post', array( $this, 'ajax_remove_post' ) ); - add_action( 'wp_ajax_zoninator_search_posts', array( $this, 'ajax_search_posts' ) ); - add_action( 'wp_ajax_zoninator_update_lock', array( $this, 'ajax_update_lock' ) ); - add_action( 'wp_ajax_zoninator_update_recent', array( $this, 'ajax_recent_posts' ) ); + $this->zone_lock_period = apply_filters( 'zoninator_zone_lock_period', $this->zone_lock_period ); + $this->zone_max_lock_period = apply_filters( 'zoninator_zone_max_lock_period', $this->zone_max_lock_period ); + $this->posts_per_page = apply_filters( 'zoninator_posts_per_page', $this->posts_per_page ); - } + do_action( 'zoninator_pre_init' ); - function admin_init() { + // Default post type support + foreach ( $this->default_post_types as $post_type ) { + add_post_type_support( $post_type, $this->zone_taxonomy ); + } - $this->admin_ajax_init(); + // Register taxonomy + if ( ! taxonomy_exists( $this->zone_taxonomy ) ) { + register_taxonomy( + $this->zone_taxonomy, + $this->get_supported_post_types(), + array( + 'label' => __( 'Zones', 'zoninator' ), + 'hierarchical' => false, + 'query_var' => false, + 'rewrite' => false, + 'public' => false, - // Enqueue Scripts and Styles - add_action( 'admin_enqueue_scripts', array( $this, 'admin_enqueue_scripts' ) ); - add_action( 'admin_enqueue_scripts', array( $this, 'admin_enqueue_styles' ) ); - } + ) + ); + } - function admin_page_init() { - // Set up page - add_menu_page( __( 'Zoninator', 'zoninator' ), __( 'Zones', 'zoninator' ), $this->_get_manage_zones_cap(), $this->key, array( $this, 'admin_page' ), '', 11 ); - } + add_action( 'admin_init', array( $this, 'admin_controller' ) ); + add_action( 'admin_init', array( $this, 'admin_init' ) ); - function admin_enqueue_scripts() { - if( $this->is_zoninator_page() ) { - wp_enqueue_script( 'zoninator-js', ZONINATOR_URL . 'js/zoninator.js', array( 'jquery', 'jquery-ui-core', 'jquery-ui-widget', 'jquery-ui-mouse', 'jquery-ui-position', 'jquery-ui-sortable', 'jquery-ui-autocomplete' ), ZONINATOR_VERSION, true ); - - $options = array( - 'baseUrl' => $this->_get_zone_page_url(), - 'adminUrl' => admin_url(), - 'ajaxNonceAction' => $this->_get_nonce_key( $this->zone_ajax_nonce_action ), - 'errorGeneral' => $this->_get_message( 'error-general' ), - 'errorZoneLock' => sprintf( $this->_get_message( 'error-zone-lock' ), __( 'another user', 'zoninator' ) ), - 'errorZoneLockMax' => $this->_get_message( 'error-zone-lock-max' ), - 'zoneLockPeriod' => $this->zone_lock_period, - 'zoneLockPeriodMax' => $this->zone_max_lock_period, - ); - wp_localize_script( 'zoninator-js', 'zoninatorOptions', $options ); + add_action( 'admin_menu', array( $this, 'admin_page_init' ) ); - // For mobile support - // http://github.com/furf/jquery-ui-touch-punch - wp_enqueue_script( 'jquery-ui-touch-punch', ZONINATOR_URL . 'js/jquery.ui.touch-punch.min.js', array( 'jquery-ui-core', 'jquery-ui-widget', 'jquery-ui-mouse' ) ); + // Add default advanced search fields + add_action( 'zoninator_advanced_search_fields', array( $this, 'zone_advanced_search_cat_filter' ) ); + add_action( 'zoninator_advanced_search_fields', array( $this, 'zone_advanced_search_date_filter' ), 20 ); + do_action( 'zoninator_post_init' ); } - } - function admin_enqueue_styles() { - if( $this->is_zoninator_page() ) { - wp_enqueue_style( 'zoninator-jquery-ui', ZONINATOR_URL . 'css/jquery-ui/smoothness/jquery-ui-zoninator.css', false, ZONINATOR_VERSION, 'all' ); - wp_enqueue_style( 'zoninator-styles', ZONINATOR_URL . 'css/zoninator.css', false, ZONINATOR_VERSION, 'all' ); + public function load_textdomain() { + load_plugin_textdomain( 'zoninator', false, basename( ZONINATOR_PATH ) . '/language' ); } - } - function admin_controller() { - if( $this->is_zoninator_page() ) { - $action = $this->_get_request_var( 'action' ); + function widgets_init() { + register_widget( 'Zoninator_ZonePosts_Widget' ); + } - switch( $action ) { + // Add necessary AJAX actions + function admin_ajax_init() { + add_action( 'wp_ajax_zoninator_reorder_posts', array( $this, 'ajax_reorder_posts' ) ); + add_action( 'wp_ajax_zoninator_add_post', array( $this, 'ajax_add_post' ) ); + add_action( 'wp_ajax_zoninator_remove_post', array( $this, 'ajax_remove_post' ) ); + add_action( 'wp_ajax_zoninator_search_posts', array( $this, 'ajax_search_posts' ) ); + add_action( 'wp_ajax_zoninator_update_lock', array( $this, 'ajax_update_lock' ) ); + add_action( 'wp_ajax_zoninator_update_recent', array( $this, 'ajax_recent_posts' ) ); + } - case 'insert': - case 'update': - $zone_id = $this->_get_post_var( 'zone_id', 0, 'absint' ); + function admin_init() { - $this->verify_nonce( $action ); - $this->verify_access( $action, $zone_id ); + $this->admin_ajax_init(); - $name = $this->_get_post_var( 'name', '', array( $this, '_sanitize_value' ) ); - $slug = $this->_get_post_var( 'slug', sanitize_title( $name ) ); - $details = array( - 'description' => $this->_get_post_var( 'description', '', array( $this, '_sanitize_value' ) ) - ); + // Enqueue Scripts and Styles + add_action( 'admin_enqueue_scripts', array( $this, 'admin_enqueue_scripts' ) ); + add_action( 'admin_enqueue_scripts', array( $this, 'admin_enqueue_styles' ) ); + } - // TODO: handle additional properties - if( $zone_id ) { - $result = $this->update_zone( $zone_id, array( - 'name' => $name, - 'slug' => $slug, - 'details' => $details - ) ); + function admin_page_init() { + // Set up page + add_menu_page( __( 'Zoninator', 'zoninator' ), __( 'Zones', 'zoninator' ), $this->_get_manage_zones_cap(), $this->key, array( $this, 'admin_page' ), '', 11 ); + } - } else { - $result = $this->insert_zone( $slug, $name, $details ); - } + function admin_enqueue_scripts() { + if ( $this->is_zoninator_page() ) { + wp_enqueue_script( 'zoninator-js', ZONINATOR_URL . 'js/zoninator.js', array( 'jquery', 'jquery-ui-core', 'jquery-ui-widget', 'jquery-ui-mouse', 'jquery-ui-position', 'jquery-ui-sortable', 'jquery-ui-autocomplete' ), ZONINATOR_VERSION, true ); + + $options = array( + 'baseUrl' => $this->_get_zone_page_url(), + 'adminUrl' => admin_url(), + 'ajaxNonceAction' => $this->_get_nonce_key( $this->zone_ajax_nonce_action ), + 'errorGeneral' => $this->_get_message( 'error-general' ), + 'errorZoneLock' => sprintf( $this->_get_message( 'error-zone-lock' ), __( 'another user', 'zoninator' ) ), + 'errorZoneLockMax' => $this->_get_message( 'error-zone-lock-max' ), + 'zoneLockPeriod' => $this->zone_lock_period, + 'zoneLockPeriodMax' => $this->zone_max_lock_period, + ); + wp_localize_script( 'zoninator-js', 'zoninatorOptions', $options ); + + // For mobile support + // http://github.com/furf/jquery-ui-touch-punch + wp_enqueue_script( 'jquery-ui-touch-punch', ZONINATOR_URL . 'js/jquery.ui.touch-punch.min.js', array( 'jquery-ui-core', 'jquery-ui-widget', 'jquery-ui-mouse' ) ); + } + } - if( is_wp_error( $result ) ) { - wp_redirect( add_query_arg( 'message', 'error-general' ) ); - exit; - } else { - if( ! $zone_id && isset( $result['term_id'] ) ) - $zone_id = $result['term_id']; + function admin_enqueue_styles() { + if ( $this->is_zoninator_page() ) { + wp_enqueue_style( 'zoninator-jquery-ui', ZONINATOR_URL . 'css/jquery-ui/smoothness/jquery-ui-zoninator.css', false, ZONINATOR_VERSION, 'all' ); + wp_enqueue_style( 'zoninator-styles', ZONINATOR_URL . 'css/zoninator.css', false, ZONINATOR_VERSION, 'all' ); + } + } - // Redirect with success message - $message = sprintf( '%s-success', $action ); - wp_redirect( $this->_get_zone_page_url( array( 'action' => 'edit', 'zone_id' => $zone_id, 'message' => $message ) ) ); + function admin_controller() { + if ( $this->is_zoninator_page() ) { + $action = $this->_get_request_var( 'action' ); + + switch ( $action ) { + case 'insert': + case 'update': + $zone_id = $this->_get_post_var( 'zone_id', 0, 'absint' ); + + $this->verify_nonce( $action ); + $this->verify_access( $action, $zone_id ); + + $name = $this->_get_post_var( 'name', '', array( $this, '_sanitize_value' ) ); + $slug = $this->_get_post_var( 'slug', sanitize_title( $name ) ); + $details = array( + 'description' => $this->_get_post_var( 'description', '', array( $this, '_sanitize_value' ) ), + ); + + // TODO: handle additional properties + if ( $zone_id ) { + $result = $this->update_zone( + $zone_id, + array( + 'name' => $name, + 'slug' => $slug, + 'details' => $details, + ) + ); + } else { + $result = $this->insert_zone( $slug, $name, $details ); + } + + if ( is_wp_error( $result ) ) { + wp_redirect( add_query_arg( 'message', 'error-general' ) ); + exit; + } else { + if ( ! $zone_id && isset( $result['term_id'] ) ) { + $zone_id = $result['term_id']; + } + + // Redirect with success message + $message = sprintf( '%s-success', $action ); + wp_redirect( + $this->_get_zone_page_url( + array( + 'action' => 'edit', + 'zone_id' => $zone_id, + 'message' => $message, + ) + ) + ); + exit; + } + break; + + case 'delete': + $zone_id = $this->_get_request_var( 'zone_id', 0, 'absint' ); + + $this->verify_nonce( $action ); + $this->verify_access( $action, $zone_id ); + + if ( $zone_id ) { + $result = $this->delete_zone( $zone_id ); + } + + if ( is_wp_error( $result ) ) { + $redirect_args = array( 'error' => $result->get_error_messages() ); + } else { + $redirect_args = array( 'message' => 'delete-success' ); + } + + wp_redirect( $this->_get_zone_page_url( $redirect_args ) ); exit; - } - break; - - case 'delete': - $zone_id = $this->_get_request_var( 'zone_id', 0, 'absint' ); - - $this->verify_nonce( $action ); - $this->verify_access( $action, $zone_id ); - - if( $zone_id ) { - $result = $this->delete_zone( $zone_id ); - } - - if( is_wp_error( $result ) ) { - $redirect_args = array( 'error' => $result->get_error_messages() ); - } else { - $redirect_args = array( 'message' => 'delete-success' ); - } - - wp_redirect( $this->_get_zone_page_url( $redirect_args ) ); - exit; + } } } - } - function admin_page() { - global $zoninator_admin_page; + function admin_page() { + global $zoninator_admin_page; - $view = $this->_get_value_or_default( 'view', $zoninator_admin_page, 'edit.php' ); - $view = sprintf( '%s/views/%s', ZONINATOR_PATH, $view ); - $title = __( 'Zones', 'zoninator' ); + $view = $this->_get_value_or_default( 'view', $zoninator_admin_page, 'edit.php' ); + $view = sprintf( '%s/views/%s', ZONINATOR_PATH, $view ); + $title = __( 'Zones', 'zoninator' ); - $zones = $this->get_zones( apply_filters( 'zoninator_admin_page_get_zones_args', array() ) ); + $zones = $this->get_zones( apply_filters( 'zoninator_admin_page_get_zones_args', array() ) ); - $default_active_zone = 0; - if( ! $this->_current_user_can_add_zones() ) { - if( ! empty( $zones ) ) - $default_active_zone = $zones[0]->term_id; - } + $default_active_zone = 0; + if ( ! $this->_current_user_can_add_zones() ) { + if ( ! empty( $zones ) ) { + $default_active_zone = $zones[0]->term_id; + } + } - $active_zone_id = $this->_get_request_var( 'zone_id', $default_active_zone, 'absint' ); - $active_zone = ! empty( $active_zone_id ) ? $this->get_zone( $active_zone_id ) : array(); - if ( ! empty( $active_zone ) ) - $title = __( 'Edit Zone', 'zoninator' ); + $active_zone_id = $this->_get_request_var( 'zone_id', $default_active_zone, 'absint' ); + $active_zone = ! empty( $active_zone_id ) ? $this->get_zone( $active_zone_id ) : array(); + if ( ! empty( $active_zone ) ) { + $title = __( 'Edit Zone', 'zoninator' ); + } - $message = $this->_get_message( $this->_get_get_var( 'message', '', 'urldecode' ) ); - $error = $this->_get_get_var( 'error', '', 'urldecode' ); + $message = $this->_get_message( $this->_get_get_var( 'message', '', 'urldecode' ) ); + $error = $this->_get_get_var( 'error', '', 'urldecode' ); - ?> + ?>

- _current_user_can_add_zones() ) : - $new_link = $this->_get_zone_page_url( array( 'action' => 'new' ) ); ?> - + _current_user_can_add_zones() ) : + $new_link = $this->_get_zone_page_url( array( 'action' => 'new' ) ); + ?> + @@ -308,12 +324,12 @@ function admin_page() {

- +

- +

@@ -321,26 +337,33 @@ function admin_page() {
- admin_page_zone_tabs( $zones, $active_zone_id ); ?> - admin_page_zone_edit( $active_zone ); ?> + admin_page_zone_tabs( $zones, $active_zone_id ); ?> + admin_page_zone_edit( $active_zone ); ?>
- _get_zone_page_url( array( 'action' => 'new' ) ); - ?> + function admin_page_zone_tabs( $zones, $active_zone_id = 0 ) { + $new_link = $this->_get_zone_page_url( array( 'action' => 'new' ) ); + ?>
- + get_zone_id( $zone ); ?> - _get_zone_page_url( array( 'action' => 'edit', 'zone_id' => $zone_id ) ); ?> - - + _get_zone_page_url( + array( + 'action' => 'edit', + 'zone_id' => $zone_id, + ) + ); + ?> + + name ); ?> name ); ?> @@ -350,35 +373,40 @@ function admin_page_zone_tabs( $zones, $active_zone_id = 0 ) {
- _get_value_or_default( 'term_id', $zone, 0, 'absint' ); - $zone_name = $this->_get_value_or_default( 'name', $zone ); - $zone_slug = $this->_get_value_or_default( 'slug', $zone, '', array( $this, 'get_unformatted_zone_slug' ) ); - $zone_description = $this->_get_value_or_default( 'description', $zone ); + function admin_page_zone_edit( $zone = null ) { + $zone_id = $this->_get_value_or_default( 'term_id', $zone, 0, 'absint' ); + $zone_name = $this->_get_value_or_default( 'name', $zone ); + $zone_slug = $this->_get_value_or_default( 'slug', $zone, '', array( $this, 'get_unformatted_zone_slug' ) ); + $zone_description = $this->_get_value_or_default( 'description', $zone ); - $zone_posts = $zone_id ? $this->get_zone_posts( $zone ) : array(); + $zone_posts = $zone_id ? $this->get_zone_posts( $zone ) : array(); - $zone_locked = $this->is_zone_locked( $zone_id ); + $zone_locked = $this->is_zone_locked( $zone_id ); - $delete_link = $this->_get_zone_page_url( array( 'action' => 'delete', 'zone_id' => $zone_id ) ); - $delete_link = wp_nonce_url( $delete_link, $this->_get_nonce_key( 'delete' ) ); - ?> + $delete_link = $this->_get_zone_page_url( + array( + 'action' => 'delete', + 'zone_id' => $zone_id, + ) + ); + $delete_link = wp_nonce_url( $delete_link, $this->_get_nonce_key( 'delete' ) ); + ?>
- _current_user_can_add_zones() ) || ( $zone_id != 0 && $this->_current_user_can_manage_zones() ) ) : ?> - + _current_user_can_add_zones() ) || ( $zone_id != 0 && $this->_current_user_can_manage_zones() ) ) : ?> +
-

_get_message( 'error-zone-lock' ), sprintf( '%s', esc_attr( $locking_user->user_email ), esc_html( $locking_user->display_name ) ) ); ?>

+

_get_message( 'error-zone-lock' ), sprintf( '%s', esc_attr( $locking_user->user_email ), esc_html( $locking_user->display_name ) ) ); ?>

- _current_user_can_edit_zones( $zone_id ) && ! $zone_locked ) : ?> + _current_user_can_edit_zones( $zone_id ) && ! $zone_locked ) : ?>
@@ -389,7 +417,7 @@ function admin_page_zone_edit( $zone = null ) {
- +
@@ -404,18 +432,18 @@ function admin_page_zone_edit( $zone = null ) { - - + + _get_nonce_key( 'update' ) ); ?> _get_nonce_key( 'insert' ) ); ?>
- + - - + +
@@ -444,7 +472,7 @@ function admin_page_zone_edit( $zone = null ) {
- +
@@ -458,7 +486,7 @@ function admin_page_zone_edit( $zone = null ) {
- +

zone_advanced_search_filters(); ?> @@ -473,7 +501,7 @@ function admin_page_zone_edit( $zone = null ) {
- + admin_page_zone_post( $post, $zone ); ?>
@@ -486,20 +514,25 @@ function admin_page_zone_edit( $zone = null ) {
- array( $this, 'admin_page_zone_post_col_position' ), - 'info' => array( $this, 'admin_page_zone_post_col_info' ) - ), $post, $zone ); - ?> + function admin_page_zone_post( $post, $zone ) { + $columns = apply_filters( + 'zoninator_zone_post_columns', + array( + 'position' => array( $this, 'admin_page_zone_post_col_position' ), + 'info' => array( $this, 'admin_page_zone_post_col_info' ), + ), + $post, + $zone + ); + ?>
- $column_callback ) : ?> - + $column_callback ) : ?> + @@ -509,1221 +542,1292 @@ function admin_page_zone_post( $post, $zone ) {
- get_post_order( $post->ID, $zone ); - ?> + function admin_page_zone_post_col_position( $post, $zone ) { + $current_position = $this->get_post_order( $post->ID, $zone ); + ?> - %s', get_edit_post_link( $post->ID ), __( 'Opens in new window', 'zoninator' ), __( 'Edit', 'zoninator' ) ), - sprintf( '%s', __( 'Remove this item from the zone', 'zoninator' ), __( 'Remove', 'zoninator' ) ), - sprintf( '%s', get_permalink( $post->ID ), __( 'Opens in new window', 'zoninator' ), __( 'View', 'zoninator' ) ), + %s', get_edit_post_link( $post->ID ), __( 'Opens in new window', 'zoninator' ), __( 'Edit', 'zoninator' ) ), + sprintf( '%s', __( 'Remove this item from the zone', 'zoninator' ), __( 'Remove', 'zoninator' ) ), + sprintf( '%s', get_permalink( $post->ID ), __( 'Opens in new window', 'zoninator' ), __( 'View', 'zoninator' ) ), // Move To // Copy To - ); - ?> - (%s)', esc_html( $post->post_title ), esc_html( $post->post_status ) ); ?> + ); + ?> + (%s)', esc_html( $post->post_title ), esc_html( $post->post_status ) ); ?>
- + function zone_advanced_search_filters() { + ?>
- _get_post_var( 'zone_advanced_filter_taxonomy', '', 'absint' ); - ?> + function zone_advanced_search_cat_filter() { + $current_cat = $this->_get_post_var( 'zone_advanced_filter_taxonomy', '', 'absint' ); + ?> - __( 'Show all Categories', 'zoninator' ), - 'selected' => $current_cat, - 'name' => 'zone_advanced_filter_taxonomy', - 'id' => 'zone_advanced_filter_taxonomy', - 'hide_if_empty' => true, - ) ) ); - } + __( 'Show all Categories', 'zoninator' ), + 'selected' => $current_cat, + 'name' => 'zone_advanced_filter_taxonomy', + 'id' => 'zone_advanced_filter_taxonomy', + 'hide_if_empty' => true, + ) + ) + ); + } - function zone_advanced_search_date_filter() { - $current_date = $this->_get_post_var( 'zone_advanced_filter_date', apply_filters( 'zoninator_advanced_filter_date_default', '' ), 'striptags' ); - $date_filters = apply_filters( 'zoninator_advanced_filter_date', array( 'all', 'today', 'yesterday') ); - ?> + function zone_advanced_search_date_filter() { + $current_date = $this->_get_post_var( 'zone_advanced_filter_date', apply_filters( 'zoninator_advanced_filter_date_default', '' ), 'striptags' ); + $date_filters = apply_filters( 'zoninator_advanced_filter_date', array( 'all', 'today', 'yesterday' ) ); + ?> - _get_post_var( 'cat', '', 'absint' ); + $date = $this->_get_post_var( 'date', '', 'striptags' ); + $zone_id = $this->_get_post_var( 'zone_id', 0, 'absint' ); - function ajax_recent_posts() { + $limit = $this->posts_per_page; + $post_types = $this->get_supported_post_types(); + $zone_posts = $this->get_zone_posts( $zone_id ); + $zone_post_ids = wp_list_pluck( $zone_posts, 'ID' ); - $cat = $this->_get_post_var( 'cat', '', 'absint' ); - $date = $this->_get_post_var( 'date', '', 'striptags' ); - $zone_id = $this->_get_post_var( 'zone_id', 0, 'absint' ); + // Verify nonce + $this->verify_nonce( $this->zone_ajax_nonce_action ); + $this->verify_access( '', $zone_id ); - $limit = $this->posts_per_page; - $post_types = $this->get_supported_post_types(); - $zone_posts = $this->get_zone_posts( $zone_id ); - $zone_post_ids = wp_list_pluck( $zone_posts, 'ID' ); + if ( is_wp_error( $zone_posts ) ) { + $status = 0; + $content = $zone_posts->get_error_message(); + } else { + $args = apply_filters( + 'zoninator_recent_posts_args', + array( + 'posts_per_page' => $limit, + 'order' => 'DESC', + 'orderby' => 'post_date', + 'post_type' => $post_types, + 'ignore_sticky_posts' => true, + 'post_status' => array( 'publish', 'future' ), + 'post__not_in' => $zone_post_ids, + 'suppress_filters' => false, + ) + ); - // Verify nonce - $this->verify_nonce( $this->zone_ajax_nonce_action ); - $this->verify_access( '', $zone_id ); + if ( $this->_validate_category_filter( $cat ) ) { + $args['cat'] = $cat; + } - if( is_wp_error( $zone_posts ) ) { - $status = 0; - $content = $zone_posts->get_error_message(); - } else { - $args = apply_filters( 'zoninator_recent_posts_args', array( - 'posts_per_page' => $limit, - 'order' => 'DESC', - 'orderby' => 'post_date', - 'post_type' => $post_types, - 'ignore_sticky_posts' => true, - 'post_status' => array( 'publish', 'future' ), - 'post__not_in' => $zone_post_ids, - 'suppress_filters' => false, - ) ); + if ( $this->_validate_date_filter( $date ) ) { + $filter_date_parts = explode( '-', $date ); + $args['year'] = $filter_date_parts[0]; + $args['monthnum'] = $filter_date_parts[1]; + $args['day'] = $filter_date_parts[2]; + } - if ( $this->_validate_category_filter( $cat ) ) { - $args['cat'] = $cat; + $content = ''; + $recent_posts = get_posts( $args ); + foreach ( $recent_posts as $post ) : + $content .= sprintf( '', $post->ID, get_the_title( $post->ID ) . ' (' . $post->post_status . ')' ); + endforeach; + wp_reset_postdata(); + $status = 1; } - if ( $this->_validate_date_filter( $date ) ) { - $filter_date_parts = explode( '-', $date ); - $args['year'] = $filter_date_parts[0]; - $args['monthnum'] = $filter_date_parts[1]; - $args['day'] = $filter_date_parts[2]; + $empty_label = ''; + if ( ! $content ) { + $empty_label = __( 'No results found', 'zoninator' ); + } elseif ( $cat ) { + $empty_label = sprintf( __( 'Choose post from %s', 'zoninator' ), get_the_category_by_ID( $cat ) ); + } else { + $empty_label = __( 'Choose a post', 'zoninator' ); } - $content = ''; - $recent_posts = get_posts( $args ); - foreach ( $recent_posts as $post ) : - $content .= sprintf( '', $post->ID, get_the_title( $post->ID ) . ' (' . $post->post_status . ')' ); - endforeach; - wp_reset_postdata(); - $status = 1; - } + $content = '' . $content; - $empty_label = ''; - if ( ! $content ) { - $empty_label = __( 'No results found', 'zoninator' ); - } elseif ( $cat ) { - $empty_label = sprintf( __( 'Choose post from %s', 'zoninator' ), get_the_category_by_ID( $cat ) ); - } else { - $empty_label = __( 'Choose a post', 'zoninator' ); + $this->ajax_return( $status, $content ); } - $content = '' . $content; + function zone_admin_recent_posts_dropdown( $zone_id ) { - $this->ajax_return( $status, $content ); - } + $limit = $this->posts_per_page; + $post_types = $this->get_supported_post_types(); + $zone_posts = $this->get_zone_posts( $zone_id ); + $zone_post_ids = wp_list_pluck( $zone_posts, 'ID' ); - function zone_admin_recent_posts_dropdown( $zone_id ) { - - $limit = $this->posts_per_page; - $post_types = $this->get_supported_post_types(); - $zone_posts = $this->get_zone_posts( $zone_id ); - $zone_post_ids = wp_list_pluck( $zone_posts, 'ID' ); - - $args = apply_filters( 'zoninator_recent_posts_args', array( - 'posts_per_page' => $limit, - 'order' => 'DESC', - 'orderby' => 'post_date', - 'post_type' => $post_types, - 'ignore_sticky_posts' => true, - 'post_status' => array( 'publish', 'future' ), - 'post__not_in' => $zone_post_ids, - 'suppress_filters' => false, - ) ); - - $recent_posts = get_posts( $args ); - ?> + $args = apply_filters( + 'zoninator_recent_posts_args', + array( + 'posts_per_page' => $limit, + 'order' => 'DESC', + 'orderby' => 'post_date', + 'post_type' => $post_types, + 'ignore_sticky_posts' => true, + 'post_status' => array( 'publish', 'future' ), + 'post__not_in' => $zone_post_ids, + 'suppress_filters' => false, + ) + ); + + $recent_posts = get_posts( $args ); + ?>
-
+
- + function zone_admin_search_form() { + ?>
- +

- key; - } else { - return ! empty( $screen->id ) && strstr( $screen->id, $this->key ); + if ( empty( $screen ) ) { + return ! empty( $_REQUEST['page'] ) && sanitize_key( $_REQUEST['page'] ) == $this->key; + } else { + return ! empty( $screen->id ) && strstr( $screen->id, $this->key ); + } } - } - function ajax_return( $status, $content = '', $action = '' ) { - $action = ! empty( $action ) ? $action : $this->zone_ajax_nonce_action; - $nonce = wp_create_nonce( $this->_get_nonce_key( $action ) ); + function ajax_return( $status, $content = '', $action = '' ) { + $action = ! empty( $action ) ? $action : $this->zone_ajax_nonce_action; + $nonce = wp_create_nonce( $this->_get_nonce_key( $action ) ); - echo json_encode( array( - 'status' => $status, - 'content' => $content, - 'nonce' => $nonce, - ) ); - exit; - } + echo json_encode( + array( + 'status' => $status, + 'content' => $content, + 'nonce' => $nonce, + ) + ); + exit; + } - function ajax_add_post() { - $zone_id = $this->_get_post_var( 'zone_id', 0, 'absint' ); - $post_id = $this->_get_post_var( 'post_id', 0, 'absint' ); + function ajax_add_post() { + $zone_id = $this->_get_post_var( 'zone_id', 0, 'absint' ); + $post_id = $this->_get_post_var( 'post_id', 0, 'absint' ); - // Verify nonce - $this->verify_nonce( $this->zone_ajax_nonce_action ); - $this->verify_access( '', $zone_id ); + // Verify nonce + $this->verify_nonce( $this->zone_ajax_nonce_action ); + $this->verify_access( '', $zone_id ); - // Validate - if( ! $zone_id || ! $post_id ) - $this->ajax_return( 0 ); + // Validate + if ( ! $zone_id || ! $post_id ) { + $this->ajax_return( 0 ); + } - $result = $this->add_zone_posts( $zone_id, $post_id, true ); + $result = $this->add_zone_posts( $zone_id, $post_id, true ); - if( is_wp_error( $result ) ) { - $status = 0; - $content = $result->get_error_message(); - } else { - $post = get_post( $post_id ); - $zone = $this->get_zone( $zone_id ); + if ( is_wp_error( $result ) ) { + $status = 0; + $content = $result->get_error_message(); + } else { + $post = get_post( $post_id ); + $zone = $this->get_zone( $zone_id ); + + ob_start(); + $this->admin_page_zone_post( $post, $zone ); + $content = ob_get_contents(); + ob_end_clean(); - ob_start(); - $this->admin_page_zone_post( $post, $zone ); - $content = ob_get_contents(); - ob_end_clean(); + $status = 1; + } - $status = 1; + $this->ajax_return( $status, $content ); } - $this->ajax_return( $status, $content ); - } + function ajax_remove_post() { + $zone_id = $this->_get_post_var( 'zone_id', 0, 'absint' ); + $post_id = $this->_get_post_var( 'post_id', 0, 'absint' ); - function ajax_remove_post() { - $zone_id = $this->_get_post_var( 'zone_id', 0, 'absint' ); - $post_id = $this->_get_post_var( 'post_id', 0, 'absint' ); + // Verify nonce + $this->verify_nonce( $this->zone_ajax_nonce_action ); + $this->verify_access( '', $zone_id ); - // Verify nonce - $this->verify_nonce( $this->zone_ajax_nonce_action ); - $this->verify_access( '', $zone_id ); + // Validate + if ( ! $zone_id || ! $post_id ) { + $this->ajax_return( 0 ); + } - // Validate - if( ! $zone_id || ! $post_id ) - $this->ajax_return( 0 ); + $result = $this->remove_zone_posts( $zone_id, $post_id ); - $result = $this->remove_zone_posts( $zone_id, $post_id ); + if ( is_wp_error( $result ) ) { + $status = 0; + $content = $result->get_error_message(); + } else { + $status = 1; + $content = ''; + } - if( is_wp_error( $result ) ) { - $status = 0; - $content = $result->get_error_message(); - } else { - $status = 1; - $content = ''; + $this->ajax_return( $status, $content ); } - $this->ajax_return( $status, $content ); - } + function ajax_reorder_posts() { + $zone_id = $this->_get_post_var( 'zone_id', 0, 'absint' ); + $post_ids = (array) $this->_get_post_var( 'posts', array(), 'absint' ); - function ajax_reorder_posts() { - $zone_id = $this->_get_post_var( 'zone_id', 0, 'absint' ); - $post_ids = (array) $this->_get_post_var( 'posts', array(), 'absint' ); + // Verify nonce + $this->verify_nonce( $this->zone_ajax_nonce_action ); + $this->verify_access( '', $zone_id ); - // Verify nonce - $this->verify_nonce( $this->zone_ajax_nonce_action ); - $this->verify_access( '', $zone_id ); + // validate + if ( ! $zone_id || empty( $post_ids ) ) { + $this->ajax_return( 0 ); + } - // validate - if( ! $zone_id || empty( $post_ids ) ) - $this->ajax_return( 0 ); + $result = $this->add_zone_posts( $zone_id, $post_ids, false ); - $result = $this->add_zone_posts( $zone_id, $post_ids, false ); + if ( is_wp_error( $result ) ) { + $status = 0; + $content = $result->get_error_message(); + } else { + $status = 1; + $content = ''; + } - if( is_wp_error( $result ) ) { - $status = 0; - $content = $result->get_error_message(); - } else { - $status = 1; - $content = ''; + $this->ajax_return( $status, $content ); } - $this->ajax_return( $status, $content ); - } + // TODO: implement in front-end + function ajax_move_zone_post( $from_zone, $to_zone, $post_id ) { + $from_zone_id = $this->_get_post_var( 'from_zone_id', 0, 'absint' ); + $to_zone_id = $this->_get_post_var( 'to_zone_id', 0, 'absint' ); - // TODO: implement in front-end - function ajax_move_zone_post( $from_zone, $to_zone, $post_id ) { - $from_zone_id = $this->_get_post_var( 'from_zone_id', 0, 'absint' ); - $to_zone_id = $this->_get_post_var( 'to_zone_id', 0, 'absint' ); + $this->verify_nonce( $this->zone_ajax_nonce_action ); - $this->verify_nonce( $this->zone_ajax_nonce_action ); + // TODO: validate both zones exist, post exists - // TODO: validate both zones exist, post exists + // Add to new zone + $this->add_zone_posts( $to_zone_id, $post_id, true ); - // Add to new zone - $this->add_zone_posts( $to_zone_id, $post_id, true ); + // Remove from old zone + $this->remove_zone_posts( $from_zone_id, $post_id ); + } - // Remove from old zone - $this->remove_zone_posts( $from_zone_id, $post_id ); - } + function ajax_search_posts() { - function ajax_search_posts() { + $q = $this->_get_request_var( 'term', '', 'stripslashes' ); - $q = $this->_get_request_var( 'term', '', 'stripslashes' ); + if ( ! empty( $q ) ) { + $filter_cat = $this->_get_request_var( 'cat', '', 'absint' ); + $filter_date = $this->_get_request_var( 'date', '', 'striptags' ); - if( ! empty( $q ) ) { + $post_types = $this->get_supported_post_types(); + $limit = $this->_get_request_var( 'limit', $this->posts_per_page ); + if ( $limit <= 0 ) { + $limit = $this->posts_per_page; + } + $exclude = (array) $this->_get_request_var( 'exclude', array(), 'absint' ); - $filter_cat = $this->_get_request_var( 'cat', '', 'absint' ); - $filter_date = $this->_get_request_var( 'date', '', 'striptags' ); + $args = apply_filters( + 'zoninator_search_args', + array( + 's' => $q, + 'post__not_in' => $exclude, + 'posts_per_page' => $limit, + 'post_type' => $post_types, + 'post_status' => array( 'publish', 'future' ), + 'order' => 'DESC', + 'orderby' => 'post_date', + 'suppress_filters' => true, + 'no_found_rows' => true, + ) + ); - $post_types = $this->get_supported_post_types(); - $limit = $this->_get_request_var( 'limit', $this->posts_per_page ); - if( $limit <= 0 ) - $limit = $this->posts_per_page; - $exclude = (array) $this->_get_request_var( 'exclude', array(), 'absint' ); + if ( $this->_validate_category_filter( $filter_cat ) ) { + $args['cat'] = $filter_cat; + } - $args = apply_filters( 'zoninator_search_args', array( - 's' => $q, - 'post__not_in' => $exclude, - 'posts_per_page' => $limit, - 'post_type' => $post_types, - 'post_status' => array( 'publish', 'future' ), - 'order' => 'DESC', - 'orderby' => 'post_date', - 'suppress_filters' => true, - 'no_found_rows' => true, - ) ); + if ( $this->_validate_date_filter( $filter_date ) ) { + $filter_date_parts = explode( '-', $filter_date ); + $args['year'] = $filter_date_parts[0]; + $args['monthnum'] = $filter_date_parts[1]; + $args['day'] = $filter_date_parts[2]; + } - if ( $this->_validate_category_filter( $filter_cat ) ) { - $args['cat'] = $filter_cat; - } + $query = new WP_Query( $args ); + $stripped_posts = array(); - if ( $this->_validate_date_filter( $filter_date ) ) { - $filter_date_parts = explode( '-', $filter_date ); - $args['year'] = $filter_date_parts[0]; - $args['monthnum'] = $filter_date_parts[1]; - $args['day'] = $filter_date_parts[2]; - } + if ( ! $query->have_posts() ) { + echo json_encode( array() ); + exit; + } - $query = new WP_Query( $args ); - $stripped_posts = array(); + foreach ( $query->posts as $post ) { + $stripped_posts[] = apply_filters( + 'zoninator_search_results_post', + array( + 'title' => ! empty( $post->post_title ) ? $post->post_title : __( '(no title)', 'zoninator' ), + 'post_id' => $post->ID, + 'date' => get_the_time( get_option( 'date_format' ), $post ), + 'post_type' => $post->post_type, + 'post_status' => $post->post_status, + ), + $post + ); + } - if ( ! $query->have_posts() ) { - echo json_encode( array() ); + echo json_encode( $stripped_posts ); exit; } - - foreach( $query->posts as $post ) { - $stripped_posts[] = apply_filters( 'zoninator_search_results_post', array( - 'title' => ! empty( $post->post_title ) ? $post->post_title : __( '(no title)', 'zoninator' ), - 'post_id' => $post->ID, - 'date' => get_the_time( get_option( 'date_format' ), $post ), - 'post_type' => $post->post_type, - 'post_status' => $post->post_status, - ), $post ); - } - - echo json_encode( $stripped_posts ); - exit; } - } - - function ajax_update_lock() { - $zone_id = $this->_get_post_var( 'zone_id', 0, 'absint' ); - $this->verify_nonce( $this->zone_ajax_nonce_action ); - $this->verify_access( '', $zone_id ); + function ajax_update_lock() { + $zone_id = $this->_get_post_var( 'zone_id', 0, 'absint' ); - if( ! $zone_id ) - exit; + $this->verify_nonce( $this->zone_ajax_nonce_action ); + $this->verify_access( '', $zone_id ); - if( ! $this->is_zone_locked( $zone_id ) ) { - $this->lock_zone( $zone_id ); - $this->ajax_return( 1, '' ); - } - } - - function get_supported_post_types() { - if( isset( $this->post_types ) ) - return $this->post_types; - - $this->post_types = array(); + if ( ! $zone_id ) { + exit; + } - foreach( get_post_types() as $post_type ) { - if( post_type_supports( $post_type, $this->zone_taxonomy ) ) - array_push( $this->post_types, $post_type ); + if ( ! $this->is_zone_locked( $zone_id ) ) { + $this->lock_zone( $zone_id ); + $this->ajax_return( 1, '' ); + } } - return $this->post_types; - } + function get_supported_post_types() { + if ( isset( $this->post_types ) ) { + return $this->post_types; + } - /** - * Registers a post type to be available for zones - * - * @param string|array $post_types A post type string or array of post type strings to register. - * @return bool True if any post types were added, false if not. - */ - function register_zone_post_type( $post_types = '' ) { + $this->post_types = array(); - $did_register_post_types = false; + foreach ( get_post_types() as $post_type ) { + if ( post_type_supports( $post_type, $this->zone_taxonomy ) ) { + array_push( $this->post_types, $post_type ); + } + } - if ( ! is_array( $post_types ) ) { - $post_types = array( $post_types ); + return $this->post_types; } - foreach ( $post_types as $post_type ) { + /** + * Registers a post type to be available for zones + * + * @param string|array $post_types A post type string or array of post type strings to register. + * @return bool True if any post types were added, false if not. + */ + function register_zone_post_type( $post_types = '' ) { - if ( ! post_type_exists( $post_type ) ) { - continue; - } + $did_register_post_types = false; - add_post_type_support( $post_type, $this->zone_taxonomy ); - register_taxonomy_for_object_type( $this->zone_taxonomy, $post_type ); + if ( ! is_array( $post_types ) ) { + $post_types = array( $post_types ); + } - // Clear Zoninator supported post types cache - unset( $this->post_types ); + foreach ( $post_types as $post_type ) { + if ( ! post_type_exists( $post_type ) ) { + continue; + } - $did_register_post_types = true; + add_post_type_support( $post_type, $this->zone_taxonomy ); + register_taxonomy_for_object_type( $this->zone_taxonomy, $post_type ); - } + // Clear Zoninator supported post types cache + unset( $this->post_types ); - return $did_register_post_types; + $did_register_post_types = true; + } - } + return $did_register_post_types; + } - function insert_zone( $slug, $name = '', $details = array() ) { + function insert_zone( $slug, $name = '', $details = array() ) { - // slug cannot be empty - if( empty( $slug ) ) - return new WP_Error( 'zone-empty-slug', __( 'Slug is a required field.', 'zoninator' ) ); + // slug cannot be empty + if ( empty( $slug ) ) { + return new WP_Error( 'zone-empty-slug', __( 'Slug is a required field.', 'zoninator' ) ); + } - $slug = $this->get_formatted_zone_slug( $slug ); - $name = ! empty( $name ) ? $name : $slug; + $slug = $this->get_formatted_zone_slug( $slug ); + $name = ! empty( $name ) ? $name : $slug; - $details = wp_parse_args( $details, $this->zone_detail_defaults ); - $details = maybe_serialize( stripslashes_deep( $details ) ); + $details = wp_parse_args( $details, $this->zone_detail_defaults ); + $details = maybe_serialize( stripslashes_deep( $details ) ); - $args = array( - 'slug' => $slug, - 'description' => $details, - ); + $args = array( + 'slug' => $slug, + 'description' => $details, + ); - // Filterize to allow other inputs - $args = apply_filters( 'zoninator_insert_zone', $args ); + // Filterize to allow other inputs + $args = apply_filters( 'zoninator_insert_zone', $args ); - return wp_insert_term( $name, $this->zone_taxonomy, $args ); - } + return wp_insert_term( $name, $this->zone_taxonomy, $args ); + } - function update_zone( $zone, $data = array() ) { - $zone_id = $this->get_zone_id( $zone ); + function update_zone( $zone, $data = array() ) { + $zone_id = $this->get_zone_id( $zone ); - if( $this->zone_exists( $zone_id ) ) { - $zone = $this->get_zone( $zone ); + if ( $this->zone_exists( $zone_id ) ) { + $zone = $this->get_zone( $zone ); - $name = $this->_get_value_or_default( 'name', $data, $zone->name ); - $slug = $this->_get_value_or_default( 'slug', $data, $zone->slug, array( $this, 'get_formatted_zone_slug' ) ); - $details = $this->_get_value_or_default( 'details', $data, array() ); + $name = $this->_get_value_or_default( 'name', $data, $zone->name ); + $slug = $this->_get_value_or_default( 'slug', $data, $zone->slug, array( $this, 'get_formatted_zone_slug' ) ); + $details = $this->_get_value_or_default( 'details', $data, array() ); - // TODO: Back-fill current zone details - //$details = wp_parse_args( $details, $this->zone_detail_defaults ); - $details = wp_parse_args( $details, $this->zone_detail_defaults ); - $details = maybe_serialize( stripslashes_deep( $details ) ); + // TODO: Back-fill current zone details + // $details = wp_parse_args( $details, $this->zone_detail_defaults ); + $details = wp_parse_args( $details, $this->zone_detail_defaults ); + $details = maybe_serialize( stripslashes_deep( $details ) ); - $args = array( - 'name' => $name, - 'slug' => $slug, - 'description' => $details - ); + $args = array( + 'name' => $name, + 'slug' => $slug, + 'description' => $details, + ); - // Filterize to allow other inputs - $args = apply_filters( 'zoninator_update_zone', $args, $zone_id, $zone ); + // Filterize to allow other inputs + $args = apply_filters( 'zoninator_update_zone', $args, $zone_id, $zone ); - return wp_update_term( $zone_id, $this->zone_taxonomy, $args ); + return wp_update_term( $zone_id, $this->zone_taxonomy, $args ); + } + return new WP_Error( 'invalid-zone', __( 'Sorry, that zone doesn\'t exist.', 'zoninator' ) ); } - return new WP_Error( 'invalid-zone', __( 'Sorry, that zone doesn\'t exist.', 'zoninator' ) ); - } - function delete_zone( $zone ) { - $zone_id = $this->get_zone_id( $zone ); - $meta_key = $this->get_zone_meta_key( $zone ); + function delete_zone( $zone ) { + $zone_id = $this->get_zone_id( $zone ); + $meta_key = $this->get_zone_meta_key( $zone ); - $this->_empty_zone_posts_cache( $meta_key ); + $this->_empty_zone_posts_cache( $meta_key ); - if( $this->zone_exists( $zone_id ) ) { - // Delete all post associations for the zone - $this->remove_zone_posts( $zone_id ); + if ( $this->zone_exists( $zone_id ) ) { + // Delete all post associations for the zone + $this->remove_zone_posts( $zone_id ); - // Delete the term - $delete = wp_delete_term( $zone_id, $this->zone_taxonomy ); + // Delete the term + $delete = wp_delete_term( $zone_id, $this->zone_taxonomy ); - if( ! $delete ) { - return new WP_Error( 'delete-zone', __( 'Sorry, we couldn\'t delete the zone.', 'zoninator' ) ); - } else { - do_action( 'zoninator_delete_zone', $zone_id ); - return $delete; + if ( ! $delete ) { + return new WP_Error( 'delete-zone', __( 'Sorry, we couldn\'t delete the zone.', 'zoninator' ) ); + } else { + do_action( 'zoninator_delete_zone', $zone_id ); + return $delete; + } } + return new WP_Error( 'invalid-zone', __( 'Sorry, that zone doesn\'t exist.', 'zoninator' ) ); } - return new WP_Error( 'invalid-zone', __( 'Sorry, that zone doesn\'t exist.', 'zoninator' ) ); - } - /** - * @param $zone - * @param $posts - * @param bool $append - * @return bool|WP_Error - */ - function add_zone_posts( $zone, $posts, $append = false ) { - $zone = $this->get_zone( $zone ); - $meta_key = $this->get_zone_meta_key( $zone ); - - $this->_empty_zone_posts_cache( $meta_key ); - - if( $append ) { - // Order should be the highest post order - $last_post = $this->get_last_post_in_zone( $zone ); - if( $last_post ) - $order = $this->get_post_order( $last_post, $zone ); - else + /** + * @param $zone + * @param $posts + * @param bool $append + * @return bool|WP_Error + */ + function add_zone_posts( $zone, $posts, $append = false ) { + $zone = $this->get_zone( $zone ); + $meta_key = $this->get_zone_meta_key( $zone ); + + $this->_empty_zone_posts_cache( $meta_key ); + + if ( $append ) { + // Order should be the highest post order + $last_post = $this->get_last_post_in_zone( $zone ); + if ( $last_post ) { + $order = $this->get_post_order( $last_post, $zone ); + } else { + $order = 0; + } + } else { $order = 0; - } else { - $order = 0; - $this->remove_zone_posts( $zone ); - } + $this->remove_zone_posts( $zone ); + } - foreach( (array) $posts as $post ) { - $post_id = $this->get_post_id( $post ); - if( $post_id ) { - $order++; - update_metadata( 'post', $post_id, $meta_key, $order, true ); + foreach ( (array) $posts as $post ) { + $post_id = $this->get_post_id( $post ); + if ( $post_id ) { + ++$order; + update_metadata( 'post', $post_id, $meta_key, $order, true ); + } + // TODO: remove_object_terms -- but need remove object terms function :( } - // TODO: remove_object_terms -- but need remove object terms function :( - } - clean_term_cache( $this->get_zone_id( $zone ), $this->zone_taxonomy ); // flush cache for our zone term and related APC caches + clean_term_cache( $this->get_zone_id( $zone ), $this->zone_taxonomy ); // flush cache for our zone term and related APC caches - do_action( 'zoninator_add_zone_posts', $posts, $zone ); + do_action( 'zoninator_add_zone_posts', $posts, $zone ); - return true; - } + return true; + } - /** - * @param $zone - * @param null $posts - * @return bool|WP_Error - */ - function remove_zone_posts( $zone, $posts = null ) { - $zone = $this->get_zone( $zone ); - $meta_key = $this->get_zone_meta_key( $zone ); + /** + * @param $zone + * @param null $posts + * @return bool|WP_Error + */ + function remove_zone_posts( $zone, $posts = null ) { + $zone = $this->get_zone( $zone ); + $meta_key = $this->get_zone_meta_key( $zone ); - $this->_empty_zone_posts_cache( $meta_key ); + $this->_empty_zone_posts_cache( $meta_key ); - // if null, delete all - if( ! $posts ) - $posts = $this->get_zone_posts( $zone ); + // if null, delete all + if ( ! $posts ) { + $posts = $this->get_zone_posts( $zone ); + } - foreach( (array) $posts as $post ) { - $post_id = $this->get_post_id( $post ); - if( $post_id ) - delete_metadata( 'post', $post_id, $meta_key ); - } + foreach ( (array) $posts as $post ) { + $post_id = $this->get_post_id( $post ); + if ( $post_id ) { + delete_metadata( 'post', $post_id, $meta_key ); + } + } - clean_term_cache( $this->get_zone_id( $zone ), $this->zone_taxonomy ); // flush cache for our zone term and related APC caches + clean_term_cache( $this->get_zone_id( $zone ), $this->zone_taxonomy ); // flush cache for our zone term and related APC caches - do_action( 'zoninator_remove_zone_posts', $posts, $zone ); - } + do_action( 'zoninator_remove_zone_posts', $posts, $zone ); + } - function get_zone_posts( $zone, $args = array() ) { - // Check cache first - if( $posts = $this->get_zone_posts_from_cache( $zone, $args ) ) - return $posts; + function get_zone_posts( $zone, $args = array() ) { + // Check cache first + if ( $posts = $this->get_zone_posts_from_cache( $zone, $args ) ) { + return $posts; + } - $query = $this->get_zone_query( $zone, $args ); - $posts = $query->posts; + $query = $this->get_zone_query( $zone, $args ); + $posts = $query->posts; - // Add posts to cache - $this->add_zone_posts_to_cache( $posts, $zone, $args ); + // Add posts to cache + $this->add_zone_posts_to_cache( $posts, $zone, $args ); - return $posts; - } + return $posts; + } - function get_zone_query( $zone, $args = array() ) { - $meta_key = $this->get_zone_meta_key( $zone ); + function get_zone_query( $zone, $args = array() ) { + $meta_key = $this->get_zone_meta_key( $zone ); - $defaults = array( - 'order' => 'ASC', - 'posts_per_page' => -1, - 'post_type' => $this->get_supported_post_types(), - 'ignore_sticky_posts' => '1', // don't want sticky posts messing up our order - ); + $defaults = array( + 'order' => 'ASC', + 'posts_per_page' => -1, + 'post_type' => $this->get_supported_post_types(), + 'ignore_sticky_posts' => '1', // don't want sticky posts messing up our order + ); - // Default to published posts on the front-end - if ( ! is_admin() ) - $defaults['post_status'] = array( 'publish' ); + // Default to published posts on the front-end + if ( ! is_admin() ) { + $defaults['post_status'] = array( 'publish' ); + } - if ( is_admin() ) // skip APC in the admin - $defaults['suppress_filters'] = true; + if ( is_admin() ) { // skip APC in the admin + $defaults['suppress_filters'] = true; + } - $args = wp_parse_args( $args, $defaults ); + $args = wp_parse_args( $args, $defaults ); - // Un-overridable args - $args['orderby'] = 'meta_value_num'; - $args['meta_key'] = $meta_key; + // Un-overridable args + $args['orderby'] = 'meta_value_num'; + $args['meta_key'] = $meta_key; - /* // 3.1-friendly, though missing sort support which is why we're using the old way - if( function_exists( 'get_post_format' ) ) { + /* + // 3.1-friendly, though missing sort support which is why we're using the old way + if( function_exists( 'get_post_format' ) ) { $args['meta_query'] = array( array( 'key' => $meta_key, 'type' => 'NUMERIC' ) ); - } else { + } else { $args['meta_key'] = $meta_key; + } + */ + return new WP_Query( $args ); } - */ - return new WP_Query( $args ); - } - - function get_last_post_in_zone( $zone ) { - return $this->get_single_post_in_zone( $zone, array( - 'order' => 'DESC', - ) ); - } - function get_first_post_in_zone( $zone ) { - return $this->get_single_post_in_zone( $zone ); - } + function get_last_post_in_zone( $zone ) { + return $this->get_single_post_in_zone( + $zone, + array( + 'order' => 'DESC', + ) + ); + } - function get_prev_post_in_zone( $zone, $post_id ) { - // TODO: test this works - $order = $this->get_post_order_in_zone( $zone, $post_id ); + function get_first_post_in_zone( $zone ) { + return $this->get_single_post_in_zone( $zone ); + } - return $this->get_single_post_in_zone( $zone, array( - 'meta_value' => $order, - 'meta_compare' => '<=' - ) ); - } + function get_prev_post_in_zone( $zone, $post_id ) { + // TODO: test this works + $order = $this->get_post_order_in_zone( $zone, $post_id ); - function get_next_post_in_zone( $zone, $post_id ) { - // TODO: test this works - $order = $this->get_post_order_in_zone( $zone, $post_id ); + return $this->get_single_post_in_zone( + $zone, + array( + 'meta_value' => $order, + 'meta_compare' => '<=', + ) + ); + } - return $this->get_single_post_in_zone( $zone, array( - 'meta_value' => $order, - 'meta_compare' => '>=' - ) ); + function get_next_post_in_zone( $zone, $post_id ) { + // TODO: test this works + $order = $this->get_post_order_in_zone( $zone, $post_id ); - } + return $this->get_single_post_in_zone( + $zone, + array( + 'meta_value' => $order, + 'meta_compare' => '>=', + ) + ); + } - function get_single_post_in_zone( $zone, $args = array() ) { + function get_single_post_in_zone( $zone, $args = array() ) { - $args = wp_parse_args( $args, array( - 'posts_per_page' => 1, - 'showposts' => 1, - ) ); + $args = wp_parse_args( + $args, + array( + 'posts_per_page' => 1, + 'showposts' => 1, + ) + ); - $post = $this->get_zone_posts( $zone, $args ); + $post = $this->get_zone_posts( $zone, $args ); - if( is_array( $post ) && ! empty( $post ) ) - return array_pop( $post ); + if ( is_array( $post ) && ! empty( $post ) ) { + return array_pop( $post ); + } - return false; - } + return false; + } - function get_zones_for_post( $post_id ) { - // TODO: build this out + function get_zones_for_post( $post_id ) { + // TODO: build this out - // get_object_terms - // get_terms + // get_object_terms + // get_terms - // OR + // OR - // get all meta_keys that match the prefix - // strip the prefix + // get all meta_keys that match the prefix + // strip the prefix - // OR + // OR - // get all zones and see if there's a matching meta entry - // strip the prefix from keys + // get all zones and see if there's a matching meta entry + // strip the prefix from keys - // array_map( 'absint', $zone_ids ) - // $zones = array(); - // foreach( $zone_ids as $zone_id ) { + // array_map( 'absint', $zone_ids ) + // $zones = array(); + // foreach( $zone_ids as $zone_id ) { // $zones[] = get_zone( $zone_id ); - //} - //return $zones; - } - - function get_zones( $args = array() ) { + // } + // return $zones; + } - $args = wp_parse_args( $args, array( - 'orderby' => 'id', - 'order' => 'ASC', - 'hide_empty' => 0, - ) ); + function get_zones( $args = array() ) { - $zones = get_terms( $this->zone_taxonomy, $args ); + $args = wp_parse_args( + $args, + array( + 'orderby' => 'id', + 'order' => 'ASC', + 'hide_empty' => 0, + ) + ); - if ( ! is_wp_error( $zones ) ) { - // Add extra fields in description as properties - foreach ( $zones as $zone ) { - $zone = $this->_fill_zone_details( $zone ); - } + $zones = get_terms( $this->zone_taxonomy, $args ); - return $zones; - } + if ( ! is_wp_error( $zones ) ) { + // Add extra fields in description as properties + foreach ( $zones as $zone ) { + $zone = $this->_fill_zone_details( $zone ); + } - return false; - } + return $zones; + } - function get_zone( $zone ) { - if( is_int( $zone ) ) { - $field = 'id'; - } elseif( is_string( $zone ) ) { - $field = 'slug'; - $zone = $this->get_zone_slug( $zone ); - } elseif( is_object( $zone ) ) { - return $zone; - } else { return false; } - if ( function_exists( 'wpcom_vip_get_term_by' ) ) { - $zone = wpcom_vip_get_term_by( $field, $zone, $this->zone_taxonomy ); - } else { - $zone = get_term_by( $field, $zone, $this->zone_taxonomy ); - } - - if( ! $zone ) - return false; - - return $this->_fill_zone_details( $zone ); - } + function get_zone( $zone ) { + if ( is_int( $zone ) ) { + $field = 'id'; + } elseif ( is_string( $zone ) ) { + $field = 'slug'; + $zone = $this->get_zone_slug( $zone ); + } elseif ( is_object( $zone ) ) { + return $zone; + } else { + return false; + } - function lock_zone( $zone, $user_id = 0 ) { - $zone_id = $this->get_zone_id( $zone ); + if ( function_exists( 'wpcom_vip_get_term_by' ) ) { + $zone = wpcom_vip_get_term_by( $field, $zone, $this->zone_taxonomy ); + } else { + $zone = get_term_by( $field, $zone, $this->zone_taxonomy ); + } - if( ! $zone_id ) - return false; + if ( ! $zone ) { + return false; + } - if( ! $user_id ) { - $user = wp_get_current_user(); - $user_id = $user->ID; + return $this->_fill_zone_details( $zone ); } - $lock_key = $this->get_zone_meta_key( $zone ); - $expiry = $this->zone_lock_period + 1; // Add a one to avoid most race condition issues between lock expiry and ajax call - set_transient( $lock_key, $user->ID, $expiry ); + function lock_zone( $zone, $user_id = 0 ) { + $zone_id = $this->get_zone_id( $zone ); - // Possible alternative: set zone lock as property with time and user - } + if ( ! $zone_id ) { + return false; + } - // Not really needed with transients... - function unlock_zone( $zone ) { - $zone_id = $this->get_zone_id( $zone ); + if ( ! $user_id ) { + $user = wp_get_current_user(); + $user_id = $user->ID; + } - if( ! $zone_id ) - return false; + $lock_key = $this->get_zone_meta_key( $zone ); + $expiry = $this->zone_lock_period + 1; // Add a one to avoid most race condition issues between lock expiry and ajax call + set_transient( $lock_key, $user->ID, $expiry ); - $lock_key = $this->get_zone_meta_key( $zone ); + // Possible alternative: set zone lock as property with time and user + } - delete_transient( $lock_key ); - } + // Not really needed with transients... + function unlock_zone( $zone ) { + $zone_id = $this->get_zone_id( $zone ); - function is_zone_locked( $zone ) { - $zone_id = $this->get_zone_id( $zone ); - if( ! $zone_id ) - return false; + if ( ! $zone_id ) { + return false; + } - $user = wp_get_current_user(); - $lock_key = $this->get_zone_meta_key( $zone ); + $lock_key = $this->get_zone_meta_key( $zone ); - $lock = get_transient( $lock_key ); + delete_transient( $lock_key ); + } - // If lock doesn't exist, or check if current user same as lock user - if( ! $lock || absint( $lock ) === absint( $user->ID ) ) - return false; - else - // return user_id of locking user - return absint( $lock ); - } + function is_zone_locked( $zone ) { + $zone_id = $this->get_zone_id( $zone ); + if ( ! $zone_id ) { + return false; + } - function zone_exists( $zone ) { - $zone_id = $this->get_zone_id( $zone ); + $user = wp_get_current_user(); + $lock_key = $this->get_zone_meta_key( $zone ); - if( term_exists( $zone_id, $this->zone_taxonomy ) ) - return true; + $lock = get_transient( $lock_key ); - return false; - } + // If lock doesn't exist, or check if current user same as lock user + if ( ! $lock || absint( $lock ) === absint( $user->ID ) ) { + return false; + } else { // return user_id of locking user + return absint( $lock ); + } + } - function get_zone_id( $zone ) { - if( is_int( $zone ) ) - return $zone; + function zone_exists( $zone ) { + $zone_id = $this->get_zone_id( $zone ); - $zone = $this->get_zone( $zone ); - if( is_object( $zone ) ) - $zone = $zone->term_id; + if ( term_exists( $zone_id, $this->zone_taxonomy ) ) { + return true; + } - return (int)$zone; - } + return false; + } - function get_zone_meta_key( $zone ) { - $zone_id = $this->get_zone_id( $zone ); - return $this->zone_meta_prefix . $zone_id; - } + function get_zone_id( $zone ) { + if ( is_int( $zone ) ) { + return $zone; + } - function get_zone_slug( $zone ) { - if( is_int( $zone ) ) $zone = $this->get_zone( $zone ); + if ( is_object( $zone ) ) { + $zone = $zone->term_id; + } - if( is_object( $zone ) ) - $zone = $zone->slug; + return (int) $zone; + } - return $this->get_formatted_zone_slug( $zone ); - } + function get_zone_meta_key( $zone ) { + $zone_id = $this->get_zone_id( $zone ); + return $this->zone_meta_prefix . $zone_id; + } - function get_formatted_zone_slug( $slug ) { - return $slug; // legacy function -- slugs can no longer be changed - } - function get_unformatted_zone_slug( $slug ) { - return $slug; // legacy function -- slugs can no longer be changed - } + function get_zone_slug( $zone ) { + if ( is_int( $zone ) ) { + $zone = $this->get_zone( $zone ); + } - function get_post_id( $post ) { - if( is_int( $post ) ) - return $post; - elseif( is_array( $post ) ) - return absint( $post['ID'] ); - elseif( is_object( $post ) ) - return $post->ID; + if ( is_object( $zone ) ) { + $zone = $zone->slug; + } - return false; - } + return $this->get_formatted_zone_slug( $zone ); + } - function get_post_order( $post, $zone ) { - $post_id = $this->get_post_id( $post ); - $meta_key = $this->get_zone_meta_key( $zone ); + function get_formatted_zone_slug( $slug ) { + return $slug; // legacy function -- slugs can no longer be changed + } + function get_unformatted_zone_slug( $slug ) { + return $slug; // legacy function -- slugs can no longer be changed + } - return get_metadata( 'post', $post_id, $meta_key, true ); - } + function get_post_id( $post ) { + if ( is_int( $post ) ) { + return $post; + } elseif ( is_array( $post ) ) { + return absint( $post['ID'] ); + } elseif ( is_object( $post ) ) { + return $post->ID; + } - function verify_nonce( $action ) { - $action = $this->_get_nonce_key( $action ); - $nonce = $this->_get_request_var( $action ); + return false; + } - if( empty( $nonce ) ) - $nonce = $this->_get_request_var( '_wpnonce' ); + function get_post_order( $post, $zone ) { + $post_id = $this->get_post_id( $post ); + $meta_key = $this->get_zone_meta_key( $zone ); - if( ! wp_verify_nonce( $nonce, $action ) ) - $this->_unauthorized_access(); - } + return get_metadata( 'post', $post_id, $meta_key, true ); + } - function verify_access( $action = '', $zone_id = null ) { - // TODO: should check if zone locked - - $verify_function = ''; - switch( $action ) { - case 'insert': - $verify_function = '_current_user_can_add_zones'; - break; - case 'update': - case 'delete': - $verify_function = '_current_user_can_edit_zones'; - break; - default: - $verify_function = '_current_user_can_manage_zones'; - break; - } - - if( ! call_user_func( array( $this, $verify_function ), $zone_id ) ) - $this->_unauthorized_access(); - } + function verify_nonce( $action ) { + $action = $this->_get_nonce_key( $action ); + $nonce = $this->_get_request_var( $action ); - function _unauthorized_access() { - wp_die( __( 'Sorry, you\'re not supposed to do that...', 'zoninator' ) ); - } + if ( empty( $nonce ) ) { + $nonce = $this->_get_request_var( '_wpnonce' ); + } - function _fill_zone_details( $zone ) { - if( ! empty( $zone->zoninator_parsed ) && $zone->zoninator_parsed ) - return $zone; + if ( ! wp_verify_nonce( $nonce, $action ) ) { + $this->_unauthorized_access(); + } + } - $details = array(); + function verify_access( $action = '', $zone_id = null ) { + // TODO: should check if zone locked - if( ! empty( $zone->description ) ) - $details = maybe_unserialize( $zone->description ); + $verify_function = ''; + switch ( $action ) { + case 'insert': + $verify_function = '_current_user_can_add_zones'; + break; + case 'update': + case 'delete': + $verify_function = '_current_user_can_edit_zones'; + break; + default: + $verify_function = '_current_user_can_manage_zones'; + break; + } - $details = wp_parse_args( $details, $this->zone_detail_defaults ); + if ( ! call_user_func( array( $this, $verify_function ), $zone_id ) ) { + $this->_unauthorized_access(); + } + } - foreach( $details as $detail_key => $detail_value ) { - $zone->$detail_key = $detail_value; + function _unauthorized_access() { + wp_die( __( 'Sorry, you\'re not supposed to do that...', 'zoninator' ) ); } - $zone->zoninator_parsed = true; + function _fill_zone_details( $zone ) { + if ( ! empty( $zone->zoninator_parsed ) && $zone->zoninator_parsed ) { + return $zone; + } - return $zone; - } + $details = array(); - function do_zoninator_feeds() { - $query_var = get_query_var( $this->zone_taxonomy ); + if ( ! empty( $zone->description ) ) { + $details = maybe_unserialize( $zone->description ); + } - if ( ! empty( $query_var ) ) { - $zone_slug = get_query_var( $this->zone_taxonomy ); - $results = $this->get_zone_feed( $zone_slug ); - if ( is_wp_error( $results ) ) { - $this->send_user_error( $results->get_error_message() ); + $details = wp_parse_args( $details, $this->zone_detail_defaults ); + + foreach ( $details as $detail_key => $detail_value ) { + $zone->$detail_key = $detail_value; } - $this->json_return( $results, false ); - } - return; + $zone->zoninator_parsed = true; - } + return $zone; + } - private function filter_zone_feed_fields( $results ) { - $filtered_results = array(); - $whitelisted_fields = apply_filters( - 'zoninator_zone_feed_fields', - array( 'ID', 'post_date', 'post_title', 'post_content', 'post_excerpt', 'post_status', 'guid' ) - ); + function do_zoninator_feeds() { + $query_var = get_query_var( $this->zone_taxonomy ); - $filtered_results = array(); - $i = 0; - foreach ( $results as $result ) { - if ( ! isset( $filtered_results[ $i ] ) ) { - $filtered_results[$i] = new stdClass(); + if ( ! empty( $query_var ) ) { + $zone_slug = get_query_var( $this->zone_taxonomy ); + $results = $this->get_zone_feed( $zone_slug ); + if ( is_wp_error( $results ) ) { + $this->send_user_error( $results->get_error_message() ); + } + $this->json_return( $results, false ); } - foreach( $whitelisted_fields as $field ) { - if ( ! isset ( $filtered_results[$i] ) ) { - $filtered_results[$i] = new stdClass; + + return; + } + + private function filter_zone_feed_fields( $results ) { + $filtered_results = array(); + $whitelisted_fields = apply_filters( + 'zoninator_zone_feed_fields', + array( 'ID', 'post_date', 'post_title', 'post_content', 'post_excerpt', 'post_status', 'guid' ) + ); + + $filtered_results = array(); + $i = 0; + foreach ( $results as $result ) { + if ( ! isset( $filtered_results[ $i ] ) ) { + $filtered_results[ $i ] = new stdClass(); + } + foreach ( $whitelisted_fields as $field ) { + if ( ! isset( $filtered_results[ $i ] ) ) { + $filtered_results[ $i ] = new stdClass(); + } + $filtered_results[ $i ]->$field = $result->$field; } - $filtered_results[$i]->$field = $result->$field; + ++$i; } - $i++; + + return $filtered_results; } - return $filtered_results; - } + /** + * Encode some data and echo it (possibly without cached headers) + * + * @param array $data + */ + private function json_return( $data ) { - /** - * Encode some data and echo it (possibly without cached headers) - * - * @param array $data - */ - private function json_return( $data ) { + if ( $data == null ) { + return false; + } - if ( $data == NULL ) - return false; + header( 'Content-Type: application/json' ); + echo json_encode( $data ); + exit(); + } - header( 'Content-Type: application/json' ); - echo json_encode( $data ); - exit(); - } + private static function send_user_error( $message ) { + self::status_header_with_message( 406, $message ); + exit(); + } - private static function send_user_error( $message ) { - self::status_header_with_message( 406, $message ); - exit(); - } + /** + * Modify the header and description in the global array + * + * @global array $wp_header_to_desc + * @param int $status + * @param string $message + */ + private static function status_header_with_message( $status, $message ) { + global $wp_header_to_desc; - /** - * Modify the header and description in the global array - * - * @global array $wp_header_to_desc - * @param int $status - * @param string $message - */ - private static function status_header_with_message( $status, $message ) { - global $wp_header_to_desc; + $status = absint( $status ); + $official_message = isset( $wp_header_to_desc[ $status ] ) ? $wp_header_to_desc[ $status ] : ''; + $wp_header_to_desc[ $status ] = $message; - $status = absint( $status ); - $official_message = isset( $wp_header_to_desc[$status] ) ? $wp_header_to_desc[$status] : ''; - $wp_header_to_desc[$status] = $message; + status_header( $status ); - status_header( $status ); + $wp_header_to_desc[ $status ] = $official_message; + } - $wp_header_to_desc[$status] = $official_message; - } + // TODO: Caching needs to be testing properly before being implemented! + function get_zone_cache_key( $zone, $args = array() ) { + return ''; - // TODO: Caching needs to be testing properly before being implemented! - function get_zone_cache_key( $zone, $args = array() ) { - return ''; + $meta_key = $this->get_zone_meta_key( $zone ); + $hash = md5( serialize( $args ) ); + return $meta_key . $hash; + } - $meta_key = $this->get_zone_meta_key( $zone ); - $hash = md5( serialize( $args ) ); - return $meta_key . $hash; - } + function get_zone_posts_from_cache( $zone, $args = array() ) { + return false; // TODO: implement - function get_zone_posts_from_cache( $zone, $args = array() ) { - return false; // TODO: implement + $meta_key = $this->get_zone_meta_key( $zone ); + $cache_key = $this->get_zone_cache_key( $zone, $args ); + if ( $posts = wp_cache_get( $cache_key, $meta_key ) ) { + return $posts; + } + return false; + } - $meta_key = $this->get_zone_meta_key( $zone ); - $cache_key = $this->get_zone_cache_key( $zone, $args ); - if( $posts = wp_cache_get( $cache_key, $meta_key ) ) - return $posts; - return false; - } + function add_zone_posts_to_cache( $posts, $zone, $args = array() ) { + return; // TODO: implement - function add_zone_posts_to_cache( $posts, $zone, $args = array() ) { - return; // TODO: implement + $meta_key = $this->get_zone_meta_key( $zone ); + $cache_key = $this->get_zone_cache_key( $zone, $args ); + wp_cache_set( $cache_key, $posts, $meta_key ); + } - $meta_key = $this->get_zone_meta_key( $zone ); - $cache_key = $this->get_zone_cache_key( $zone, $args ); - wp_cache_set( $cache_key, $posts, $meta_key ); - } + // Handle 4.2 term-splitting + function split_shared_term( $old_term_id, $new_term_id, $term_taxonomy_id, $taxonomy ) { + if ( $this->zone_taxonomy === $taxonomy ) { + do_action( 'zoninator_split_shared_term', $old_term_id, $new_term_id, $term_taxonomy_id ); - // Handle 4.2 term-splitting - function split_shared_term( $old_term_id, $new_term_id, $term_taxonomy_id, $taxonomy ) { - if ( $this->zone_taxonomy === $taxonomy ) { - do_action( 'zoninator_split_shared_term', $old_term_id, $new_term_id, $term_taxonomy_id ); + // Quick, easy switcheroo; add posts to new zone id and remove from the old one. + $posts = $this->get_zone_posts( $old_term_id ); + if ( ! empty( $posts ) ) { + $this->add_zone_posts( $new_term_id, $posts ); + $this->remove_zone_posts( $old_term_id ); + } - // Quick, easy switcheroo; add posts to new zone id and remove from the old one. - $posts = $this->get_zone_posts( $old_term_id ); - if ( ! empty( $posts ) ) { - $this->add_zone_posts( $new_term_id, $posts ); - $this->remove_zone_posts( $old_term_id ); + do_action( 'zoninator_did_split_shared_term', $old_term_id, $new_term_id, $term_taxonomy_id ); } + } - do_action( 'zoninator_did_split_shared_term', $old_term_id, $new_term_id, $term_taxonomy_id ); + function _empty_zone_posts_cache( $meta_key ) { + return; // TODO: implement } - } - function _empty_zone_posts_cache( $meta_key ) { - return; // TODO: implement - } + function _get_message( $message_id, $encode = false ) { + $message = ''; - function _get_message( $message_id, $encode = false ) { - $message = ''; + if ( ! empty( $this->zone_messages[ $message_id ] ) ) { + $message = $this->zone_messages[ $message_id ]; + } - if( ! empty( $this->zone_messages[$message_id] ) ) - $message = $this->zone_messages[$message_id]; + if ( $encode ) { + $message = urlencode( $message ); + } - if( $encode ) - $message = urlencode( $message ); + return $message; + } - return $message; - } + function _get_nonce_key( $action ) { + return sprintf( '%s-%s', $this->zone_nonce_prefix, $action ); + } - function _get_nonce_key( $action ) { - return sprintf( '%s-%s', $this->zone_nonce_prefix, $action ); - } + function _current_user_can_add_zones() { + return current_user_can( $this->_get_add_zones_cap() ); + } - function _current_user_can_add_zones() { - return current_user_can( $this->_get_add_zones_cap() ); - } + function _current_user_can_edit_zones( $zone_id ) { + $has_cap = current_user_can( $this->_get_edit_zones_cap() ); + return apply_filters( 'zoninator_current_user_can_edit_zone', $has_cap, $zone_id ); + } - function _current_user_can_edit_zones( $zone_id ) { - $has_cap = current_user_can( $this->_get_edit_zones_cap() ); - return apply_filters( 'zoninator_current_user_can_edit_zone', $has_cap, $zone_id ); - } + function _current_user_can_manage_zones() { + return current_user_can( $this->_get_manage_zones_cap() ); + } - function _current_user_can_manage_zones() { - return current_user_can( $this->_get_manage_zones_cap() ); - } + function _get_add_zones_cap() { + return apply_filters( 'zoninator_add_zone_cap', 'edit_others_posts' ); + } - function _get_add_zones_cap() { - return apply_filters( 'zoninator_add_zone_cap', 'edit_others_posts' ); - } + function _get_edit_zones_cap() { + return apply_filters( 'zoninator_edit_zone_cap', 'edit_others_posts' ); + } - function _get_edit_zones_cap() { - return apply_filters( 'zoninator_edit_zone_cap', 'edit_others_posts' ); - } + function _get_manage_zones_cap() { + return apply_filters( 'zoninator_manage_zone_cap', 'edit_others_posts' ); + } - function _get_manage_zones_cap() { - return apply_filters( 'zoninator_manage_zone_cap', 'edit_others_posts' ); - } + function _get_zone_page_url( $args = array() ) { + $url = menu_page_url( $this->key, false ); - function _get_zone_page_url( $args = array() ) { - $url = menu_page_url( $this->key, false ); + foreach ( $args as $arg_key => $arg_value ) { + $url = add_query_arg( $arg_key, $arg_value, $url ); + } - foreach( $args as $arg_key => $arg_value ) { - $url = add_query_arg( $arg_key, $arg_value, $url ); + return $url; } - return $url; - } + function _validate_date_filter( $date ) { + return preg_match( '/([0-9]{4})-([0-9]{2})-([0-9]{2})/', $date ); + } - function _validate_date_filter( $date ) { - return preg_match( '/([0-9]{4})-([0-9]{2})-([0-9]{2})/', $date ); - } + function _validate_category_filter( $cat ) { + return $cat && get_term_by( 'id', $cat, 'category' ); + } - function _validate_category_filter( $cat ) { - return $cat && get_term_by( 'id', $cat, 'category' ); - } + function _sanitize_value( $var ) { + return htmlentities( stripslashes( $var ) ); + } - function _sanitize_value( $var ) { - return htmlentities( stripslashes( $var ) ); - } + function _get_value_or_default( $var, $object, $default = '', $sanitize_callback = '' ) { + if ( is_object( $object ) ) { + $value = ! empty( $object->$var ) ? $object->$var : $default; + } elseif ( is_array( $object ) ) { + $value = ! empty( $object[ $var ] ) ? $object[ $var ] : $default; + } else { + $value = $default; + } - function _get_value_or_default( $var, $object, $default = '', $sanitize_callback = '' ) { - if( is_object( $object ) ) - $value = ! empty( $object->$var ) ? $object->$var : $default; - elseif( is_array( $object ) ) - $value = ! empty( $object[$var] ) ? $object[$var] : $default; - else - $value = $default; + if ( is_callable( $sanitize_callback ) ) { + if ( is_array( $value ) ) { + $value = array_map( $sanitize_callback, $value ); + } else { + $value = call_user_func( $sanitize_callback, $value ); + } + } - if( is_callable( $sanitize_callback ) ) { - if( is_array( $value ) ) - $value = array_map( $sanitize_callback, $value ); - else - $value = call_user_func( $sanitize_callback, $value ); + return $value; } - return $value; - } - - function _get_request_var( $var, $default = '', $sanitize_callback = '' ) { - return $this->_get_value_or_default( $var, $_REQUEST, $default, $sanitize_callback ); - } + function _get_request_var( $var, $default = '', $sanitize_callback = '' ) { + return $this->_get_value_or_default( $var, $_REQUEST, $default, $sanitize_callback ); + } - function _get_get_var( $var, $default = '', $sanitize_callback = '' ) { - return $this->_get_value_or_default( $var, $_GET, $default, $sanitize_callback ); - } - function _get_post_var( $var, $default = '', $sanitize_callback = '' ) { - return $this->_get_value_or_default( $var, $_POST, $default, $sanitize_callback ); - } + function _get_get_var( $var, $default = '', $sanitize_callback = '' ) { + return $this->_get_value_or_default( $var, $_GET, $default, $sanitize_callback ); + } + function _get_post_var( $var, $default = '', $sanitize_callback = '' ) { + return $this->_get_value_or_default( $var, $_POST, $default, $sanitize_callback ); + } - public function get_admin_zone_post($post, $zone) { - return apply_filters('zoninator_zone_post_columns', array( - 'post_id' => $post->ID, - 'position' => array( - 'current_position' => intval( $this->get_post_order( $post->ID, $zone ) ), - 'change_position_message' => esc_attr__( 'Click and drag to change the position of this item.', 'zoninator' ), - 'key' => 'position' - ), - 'info' => array( - 'key' => 'info', - 'post' => array( - 'post_title' => esc_html( $post->post_title ), - 'post_status' => esc_html( $post->post_status ) - ), - 'action_link_data' => array( - array( - 'action' => 'edit', - 'anchor' => get_edit_post_link( $post->ID ), - 'title' => __( 'Opens in new window', 'zoninator' ), - 'text' => __( 'Edit', 'zoninator' ), - 'target' => "_blank" + public function get_admin_zone_post( $post, $zone ) { + return apply_filters( + 'zoninator_zone_post_columns', + array( + 'post_id' => $post->ID, + 'position' => array( + 'current_position' => intval( $this->get_post_order( $post->ID, $zone ) ), + 'change_position_message' => esc_attr__( 'Click and drag to change the position of this item.', 'zoninator' ), + 'key' => 'position', ), - array( - 'action' => 'delete', - 'anchor' => '#', - 'title' => '', - 'text' => __( 'Remove', 'zoninator' ) + 'info' => array( + 'key' => 'info', + 'post' => array( + 'post_title' => esc_html( $post->post_title ), + 'post_status' => esc_html( $post->post_status ), + ), + 'action_link_data' => array( + array( + 'action' => 'edit', + 'anchor' => get_edit_post_link( $post->ID ), + 'title' => __( 'Opens in new window', 'zoninator' ), + 'text' => __( 'Edit', 'zoninator' ), + 'target' => '_blank', + ), + array( + 'action' => 'delete', + 'anchor' => '#', + 'title' => '', + 'text' => __( 'Remove', 'zoninator' ), + ), + array( + 'action' => 'view', + 'anchor' => get_permalink( $post->ID ), + 'title' => __( 'Opens in new window', 'zoninator' ), + 'text' => __( 'View', 'zoninator' ), + 'target' => '_blank', + ), + ), ), - array( - 'action' => 'view', - 'anchor' => get_permalink( $post->ID ), - 'title' => __( 'Opens in new window', 'zoninator' ), - 'text' => __( 'View', 'zoninator' ), - 'target' => "_blank" - ) - ) - ) - ), $post, $zone); - } - - public function get_admin_zone_posts( $zone_or_id ) { - $zone = $this->get_zone( $zone_or_id ); - $posts = $this->get_zone_posts( $zone ); - $admin_zone_posts = array(); - - foreach ( $posts as $post ) { - $admin_zone_posts[] = $this->get_admin_zone_post( $post, $zone ); + ), + $post, + $zone + ); } - return $admin_zone_posts; - } + public function get_admin_zone_posts( $zone_or_id ) { + $zone = $this->get_zone( $zone_or_id ); + $posts = $this->get_zone_posts( $zone ); + $admin_zone_posts = array(); - /** - * @param $zone_slug_or_id - * @return array|WP_Error - */ - function get_zone_feed( $zone_slug_or_id ) { - $zone_id = $this->get_zone( $zone_slug_or_id ); + foreach ( $posts as $post ) { + $admin_zone_posts[] = $this->get_admin_zone_post( $post, $zone ); + } - if ( empty( $zone_id ) ) { - return new WP_Error( 'invalid-zone-supplied', __( 'Invalid zone supplied', 'zoninator' ) ); + return $admin_zone_posts; } - $results = $this->get_zone_posts( $zone_id, apply_filters( 'zoninator_json_feed_fields', array(), $zone_slug_or_id ) ); - $filtered_results = $this->filter_zone_feed_fields( $results ); + /** + * @param $zone_slug_or_id + * @return array|WP_Error + */ + function get_zone_feed( $zone_slug_or_id ) { + $zone_id = $this->get_zone( $zone_slug_or_id ); - return apply_filters( 'zoninator_json_feed_results', $filtered_results, $zone_slug_or_id ); - } + if ( empty( $zone_id ) ) { + return new WP_Error( 'invalid-zone-supplied', __( 'Invalid zone supplied', 'zoninator' ) ); + } - public function check( $action = '', $zone_id = null ) { - // TODO: should check if zone locked - if ( 'insert' == $action ) { - return $this->_current_user_can_add_zones(); - } + $results = $this->get_zone_posts( $zone_id, apply_filters( 'zoninator_json_feed_fields', array(), $zone_slug_or_id ) ); + $filtered_results = $this->filter_zone_feed_fields( $results ); - if ( 'update' == $action || 'delete' == $action ) { - return $this->_current_user_can_edit_zones( $zone_id ); + return apply_filters( 'zoninator_json_feed_results', $filtered_results, $zone_slug_or_id ); } - return $this->_current_user_can_manage_zones(); - } -} + public function check( $action = '', $zone_id = null ) { + // TODO: should check if zone locked + if ( 'insert' == $action ) { + return $this->_current_user_can_add_zones(); + } + + if ( 'update' == $action || 'delete' == $action ) { + return $this->_current_user_can_edit_zones( $zone_id ); + } -function Zoninator() { - global $zoninator; - if ( ! isset( $zoninator ) || null === $zoninator ) { - $zoninator = new Zoninator; + return $this->_current_user_can_manage_zones(); + } } - return $zoninator; -} -Zoninator(); + function Zoninator() { + global $zoninator; + if ( ! isset( $zoninator ) || null === $zoninator ) { + $zoninator = new Zoninator(); + } + return $zoninator; + } + Zoninator(); endif; From 00f49be7830943ee5df000d9fd4beb748c27f621 Mon Sep 17 00:00:00 2001 From: Gary Jones Date: Sat, 10 Aug 2024 16:46:43 +0100 Subject: [PATCH 03/56] CS: Add Rector with PHP 5.3 set https://getrector.com/find-rule?rectorSet=php-php-53 --- composer.json | 3 ++- .../class-zoninator-rest-environment.php | 2 +- rector.php | 26 +++++++++++++++++++ tests/bootstrap.php | 2 +- widget.zone-posts.php | 2 +- zoninator.php | 26 +++++++++---------- 6 files changed, 44 insertions(+), 17 deletions(-) create mode 100644 rector.php diff --git a/composer.json b/composer.json index c8c0226..98ece83 100644 --- a/composer.json +++ b/composer.json @@ -20,7 +20,8 @@ "phpcompatibility/phpcompatibility-wp": "^2.1", "phpunit/phpunit": "^9", "wp-coding-standards/wpcs": "^3", - "yoast/phpunit-polyfills": "^1" + "yoast/phpunit-polyfills": "^1", + "rector/rector": "^1.2" }, "scripts": { "cbf": [ diff --git a/lib/zoninator_rest/class-zoninator-rest-environment.php b/lib/zoninator_rest/class-zoninator-rest-environment.php index 276130b..77847a1 100644 --- a/lib/zoninator_rest/class-zoninator-rest-environment.php +++ b/lib/zoninator_rest/class-zoninator-rest-environment.php @@ -165,7 +165,7 @@ public function start() { do_action( 'mt_environment_before_start', $this, get_class( $this ) ); $this->load_pending_builders( self::MODELS ); $this->load_pending_builders( self::BUNDLES ); - $registrables = $this->get( self::REGISTRABLE ) ? $this->get( self::REGISTRABLE ) : array(); + $registrables = $this->get( self::REGISTRABLE ) ?: array(); foreach ( $registrables as $registrable ) { /** * A Registrable diff --git a/rector.php b/rector.php new file mode 100644 index 0000000..95d8a5b --- /dev/null +++ b/rector.php @@ -0,0 +1,26 @@ +withPaths( + array( + __DIR__ . '/includes', + __DIR__ . '/lib', + __DIR__ . '/tests', + __DIR__ . '/functions.php', + __DIR__ . '/widget.zone-posts.php', + __DIR__ . '/zoninator.php', + ) + ) + ->withSkip( + array( + LongArrayToShortArrayRector::class, + ) + ) + ->withPhpSets( php53: true ) + ->withTypeCoverageLevel( 0 ); diff --git a/tests/bootstrap.php b/tests/bootstrap.php index c94207e..819b4b9 100644 --- a/tests/bootstrap.php +++ b/tests/bootstrap.php @@ -12,7 +12,7 @@ require_once $_tests_dir . '/includes/functions.php'; function _manually_load_plugin() { - $thispath = dirname( __FILE__ ); + $thispath = __DIR__; $file = $thispath . '/../zoninator.php'; require_once realpath( $file ); } diff --git a/widget.zone-posts.php b/widget.zone-posts.php index 2bf1357..80cfb0d 100644 --- a/widget.zone-posts.php +++ b/widget.zone-posts.php @@ -38,7 +38,7 @@ function widget( $args, $instance ) { ob_start(); - $zone_id = $instance['zone_id'] ? $instance['zone_id'] : 0; + $zone_id = $instance['zone_id'] ?: 0; $show_description = $instance['show_description'] ? 1 : 0; if ( ! $zone_id ) { return; diff --git a/zoninator.php b/zoninator.php index 2935a2c..e661992 100644 --- a/zoninator.php +++ b/zoninator.php @@ -40,21 +40,21 @@ class Zoninator { - var $key = 'zoninator'; - var $zone_taxonomy = 'zoninator_zones'; - var $zone_term_prefix = 'zone-'; - var $zone_meta_prefix = '_zoninator_order_'; - var $zone_nonce_prefix = 'zone-nonce'; - var $zone_ajax_nonce_action = 'ajax-action'; - var $zone_lock_period = 30; // number of seconds a lock is valid for - var $zone_max_lock_period = 600; // max number of seconds for all locks in a session - var $post_types = null; - var $zone_detail_defaults = array( + public $key = 'zoninator'; + public $zone_taxonomy = 'zoninator_zones'; + public $zone_term_prefix = 'zone-'; + public $zone_meta_prefix = '_zoninator_order_'; + public $zone_nonce_prefix = 'zone-nonce'; + public $zone_ajax_nonce_action = 'ajax-action'; + public $zone_lock_period = 30; // number of seconds a lock is valid for + public $zone_max_lock_period = 600; // max number of seconds for all locks in a session + public $post_types = null; + public $zone_detail_defaults = array( 'description' => '', // Add additional properties here! ); - var $zone_messages = null; - var $posts_per_page = 10; + public $zone_messages = null; + public $posts_per_page = 10; /** * @var Zoninator_Api */ @@ -511,7 +511,7 @@ function admin_page_zone_edit( $zone = null ) {
- + Date: Sat, 10 Aug 2024 16:48:09 +0100 Subject: [PATCH 04/56] CS: Rector with PHP 5.5 set https://getrector.com/find-rule?rectorSet=php-php-55 --- lib/zoninator_rest/class-zoninator-rest-bootstrap.php | 2 +- rector.php | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/zoninator_rest/class-zoninator-rest-bootstrap.php b/lib/zoninator_rest/class-zoninator-rest-bootstrap.php index 29feb30..c9f9119 100644 --- a/lib/zoninator_rest/class-zoninator-rest-bootstrap.php +++ b/lib/zoninator_rest/class-zoninator-rest-bootstrap.php @@ -71,7 +71,7 @@ public static function create( $class_loader = null ) { if ( empty( $class_loader ) ) { include_once 'interfaces/class-zoninator-rest-interfaces-classloader.php'; include_once 'class-zoninator-rest-classloader.php'; - $prefix = str_replace( '_Bootstrap', '', __CLASS__ ); + $prefix = str_replace( '_Bootstrap', '', self::class ); $base_dir = self::get_base_dir(); $class_loader = new Zoninator_REST_Classloader( $prefix, $base_dir ); } diff --git a/rector.php b/rector.php index 95d8a5b..f8043c7 100644 --- a/rector.php +++ b/rector.php @@ -22,5 +22,5 @@ LongArrayToShortArrayRector::class, ) ) - ->withPhpSets( php53: true ) + ->withPhpSets( php55: true ) ->withTypeCoverageLevel( 0 ); From 3cee9b96778bd9111da5dd1ce2eaaea07a44ccdb Mon Sep 17 00:00:00 2001 From: Gary Jones Date: Sat, 10 Aug 2024 16:52:31 +0100 Subject: [PATCH 05/56] CS: Rector with PHP 7.0 set https://getrector.com/find-rule?rectorSet=php-php-70 --- lib/zoninator_rest/class-zoninator-rest-model.php | 5 +---- .../class-zoninator-rest-data-store-customposttype.php | 2 +- .../field/class-zoninator-rest-field-declaration.php | 4 ++-- .../model/class-zoninator-rest-model-settings.php | 8 ++++---- .../class-zoninator-rest-model-declaration-settings.php | 8 ++++---- rector.php | 2 +- tests/unit/class-zoninator-api-controller-test.php | 2 +- zoninator.php | 4 ++-- 8 files changed, 16 insertions(+), 19 deletions(-) diff --git a/lib/zoninator_rest/class-zoninator-rest-model.php b/lib/zoninator_rest/class-zoninator-rest-model.php index b6998cf..e05eb63 100644 --- a/lib/zoninator_rest/class-zoninator-rest-model.php +++ b/lib/zoninator_rest/class-zoninator-rest-model.php @@ -358,10 +358,7 @@ public function with_data_store( $data_store ) { */ public function get_environment() { $class_name = get_class( $this ); - if ( isset( self::$environments_by_class_name[ $class_name ] ) ) { - return self::$environments_by_class_name[ $class_name ]; - } - return null; + return self::$environments_by_class_name[ $class_name ] ?? null; } /** diff --git a/lib/zoninator_rest/data/store/class-zoninator-rest-data-store-customposttype.php b/lib/zoninator_rest/data/store/class-zoninator-rest-data-store-customposttype.php index 54ff78c..f6ed19d 100644 --- a/lib/zoninator_rest/data/store/class-zoninator-rest-data-store-customposttype.php +++ b/lib/zoninator_rest/data/store/class-zoninator-rest-data-store-customposttype.php @@ -27,7 +27,7 @@ class Zoninator_REST_Data_Store_CustomPostType extends Zoninator_REST_Data_Store * @param array $args Args. */ public function __construct( $model_prototype = null, $args = array() ) { - $this->post_type = isset( $args['post_type'] ) ? $args['post_type'] : 'post'; + $this->post_type = $args['post_type'] ?? 'post'; parent::__construct( $model_prototype, $args ); } diff --git a/lib/zoninator_rest/field/class-zoninator-rest-field-declaration.php b/lib/zoninator_rest/field/class-zoninator-rest-field-declaration.php index 0fd121a..ea23ba0 100644 --- a/lib/zoninator_rest/field/class-zoninator-rest-field-declaration.php +++ b/lib/zoninator_rest/field/class-zoninator-rest-field-declaration.php @@ -224,7 +224,7 @@ public function get_sanitizer() { * @return null */ private function value_or_default( $args, $name, $default = null ) { - return isset( $args[ $name ] ) ? $args[ $name ] : $default; + return $args[ $name ] ?? $default; } /** @@ -357,7 +357,7 @@ public function get_description() { * @return string */ public function get_data_transfer_name() { - return isset( $this->data_transfer_name ) ? $this->data_transfer_name : $this->get_name(); + return $this->data_transfer_name ?? $this->get_name(); } /** diff --git a/lib/zoninator_rest/model/class-zoninator-rest-model-settings.php b/lib/zoninator_rest/model/class-zoninator-rest-model-settings.php index 4d727f4..0609613 100644 --- a/lib/zoninator_rest/model/class-zoninator-rest-model-settings.php +++ b/lib/zoninator_rest/model/class-zoninator-rest-model-settings.php @@ -119,10 +119,10 @@ public function set_id( $new_id ) { private function field_declaration_builder_from_data( $env, $field_data ) { $field_name = $field_data['name']; $field_builder = $env->field( $field_name ); - $default_value = isset( $field_data['std'] ) ? $field_data['std'] : $this->default_for_attribute( $field_data, 'std' ); - $label = isset( $field_data['label'] ) ? $field_data['label'] : $field_name; - $description = isset( $field_data['desc'] ) ? $field_data['desc'] : $label; - $setting_type = isset( $field_data['type'] ) ? $field_data['type'] : null; + $default_value = $field_data['std'] ?? $this->default_for_attribute( $field_data, 'std' ); + $label = $field_data['label'] ?? $field_name; + $description = $field_data['desc'] ?? $label; + $setting_type = $field_data['type'] ?? null; $choices = isset( $field_data['options'] ) ? array_keys( $field_data['options'] ) : null; $field_type = 'string'; diff --git a/lib/zoninator_rest/model/declaration/class-zoninator-rest-model-declaration-settings.php b/lib/zoninator_rest/model/declaration/class-zoninator-rest-model-declaration-settings.php index 7e197d9..b134ad9 100644 --- a/lib/zoninator_rest/model/declaration/class-zoninator-rest-model-declaration-settings.php +++ b/lib/zoninator_rest/model/declaration/class-zoninator-rest-model-declaration-settings.php @@ -119,10 +119,10 @@ function set_id( $model, $new_id ) { private function field_declaration_builder_from_data( $env, $field_data ) { $field_name = $field_data['name']; $field_builder = $env->field( $field_name ); - $default_value = isset( $field_data['std'] ) ? $field_data['std'] : $this->default_for_attribute( $field_data, 'std' ); - $label = isset( $field_data['label'] ) ? $field_data['label'] : $field_name; - $description = isset( $field_data['desc'] ) ? $field_data['desc'] : $label; - $setting_type = isset( $field_data['type'] ) ? $field_data['type'] : null; + $default_value = $field_data['std'] ?? $this->default_for_attribute( $field_data, 'std' ); + $label = $field_data['label'] ?? $field_name; + $description = $field_data['desc'] ?? $label; + $setting_type = $field_data['type'] ?? null; $choices = isset( $field_data['options'] ) ? array_keys( $field_data['options'] ) : null; $field_type = 'string'; diff --git a/rector.php b/rector.php index f8043c7..18eb7b1 100644 --- a/rector.php +++ b/rector.php @@ -22,5 +22,5 @@ LongArrayToShortArrayRector::class, ) ) - ->withPhpSets( php55: true ) + ->withPhpSets( php70: true ) ->withTypeCoverageLevel( 0 ); diff --git a/tests/unit/class-zoninator-api-controller-test.php b/tests/unit/class-zoninator-api-controller-test.php index 357915e..b2bfa39 100644 --- a/tests/unit/class-zoninator-api-controller-test.php +++ b/tests/unit/class-zoninator-api-controller-test.php @@ -413,7 +413,7 @@ private function create_a_zone( $slug, $title ) { if ( is_wp_error( $result ) ) { return $result; } - return isset( $result['term_id'] ) ? $result['term_id'] : 0; + return $result['term_id'] ?? 0; } /** diff --git a/zoninator.php b/zoninator.php index e661992..d228de8 100644 --- a/zoninator.php +++ b/zoninator.php @@ -1516,7 +1516,7 @@ function do_zoninator_feeds() { $zone_slug = get_query_var( $this->zone_taxonomy ); $results = $this->get_zone_feed( $zone_slug ); if ( is_wp_error( $results ) ) { - $this->send_user_error( $results->get_error_message() ); + self::send_user_error($results->get_error_message()); } $this->json_return( $results, false ); } @@ -1581,7 +1581,7 @@ private static function status_header_with_message( $status, $message ) { global $wp_header_to_desc; $status = absint( $status ); - $official_message = isset( $wp_header_to_desc[ $status ] ) ? $wp_header_to_desc[ $status ] : ''; + $official_message = $wp_header_to_desc[ $status ] ?? ''; $wp_header_to_desc[ $status ] = $message; status_header( $status ); From 4b4c2a92ece71cec1baf5f4208a41dd982d5a743 Mon Sep 17 00:00:00 2001 From: Gary Jones Date: Sat, 10 Aug 2024 16:55:38 +0100 Subject: [PATCH 06/56] CS: Rector with PHP 7.1 set https://getrector.com/find-rule?rectorSet=php-php-71 --- includes/class-zoninator-api-controller.php | 30 +++++++++---------- .../class-zoninator-rest-bootstrap.php | 2 +- .../class-zoninator-rest-controller.php | 8 ++--- .../class-zoninator-rest-environment.php | 6 ++-- ...class-zoninator-rest-field-declaration.php | 6 ++-- rector.php | 2 +- zoninator.php | 4 +-- 7 files changed, 29 insertions(+), 29 deletions(-) diff --git a/includes/class-zoninator-api-controller.php b/includes/class-zoninator-api-controller.php index 208c7ca..ed7c2b2 100644 --- a/includes/class-zoninator-api-controller.php +++ b/includes/class-zoninator-api-controller.php @@ -7,21 +7,21 @@ * Class Zoninator_Api_Controller */ class Zoninator_Api_Controller extends Zoninator_REST_Controller { - const ZONE_ITEM_URL_REGEX = '/zones/(?P[\d]+)'; - const ZONE_ITEM_POSTS_URL_REGEX = '/zones/(?P[\d]+)/posts'; - const ZONE_ITEM_POSTS_POST_REGEX = '/zones/(?P[\d]+)/posts/(?P\d+)'; - - const INVALID_ZONE_ID = 'invalid-zone-id'; - const INVALID_POST_ID = 'invalid-post-id'; - const ZONE_ID_POST_ID_REQUIRED = 'zone-id-post-id-required'; - const ZONE_ID_POST_IDS_REQUIRED = 'zone-id-post-ids-required'; - const ZONE_ID_REQUIRED = 'zone-id-required'; - const ZONE_FEED_ERROR = 'zone-feed-error'; - const TERM_REQUIRED = 'term-required'; - const PERMISSION_DENIED = 'permission-denied'; - const ZONE_NOT_FOUND = 'zone-not-found'; - const POST_NOT_FOUND = 'post-not-found'; - const INVALID_ZONE_SETTINGS = 'invalid-zone-settings'; + public const ZONE_ITEM_URL_REGEX = '/zones/(?P[\d]+)'; + public const ZONE_ITEM_POSTS_URL_REGEX = '/zones/(?P[\d]+)/posts'; + public const ZONE_ITEM_POSTS_POST_REGEX = '/zones/(?P[\d]+)/posts/(?P\d+)'; + + public const INVALID_ZONE_ID = 'invalid-zone-id'; + public const INVALID_POST_ID = 'invalid-post-id'; + public const ZONE_ID_POST_ID_REQUIRED = 'zone-id-post-id-required'; + public const ZONE_ID_POST_IDS_REQUIRED = 'zone-id-post-ids-required'; + public const ZONE_ID_REQUIRED = 'zone-id-required'; + public const ZONE_FEED_ERROR = 'zone-feed-error'; + public const TERM_REQUIRED = 'term-required'; + public const PERMISSION_DENIED = 'permission-denied'; + public const ZONE_NOT_FOUND = 'zone-not-found'; + public const POST_NOT_FOUND = 'post-not-found'; + public const INVALID_ZONE_SETTINGS = 'invalid-zone-settings'; /** * Instance * diff --git a/lib/zoninator_rest/class-zoninator-rest-bootstrap.php b/lib/zoninator_rest/class-zoninator-rest-bootstrap.php index c9f9119..c0f382b 100644 --- a/lib/zoninator_rest/class-zoninator-rest-bootstrap.php +++ b/lib/zoninator_rest/class-zoninator-rest-bootstrap.php @@ -18,7 +18,7 @@ * This is the entry point for. */ class Zoninator_REST_Bootstrap { - const MINIMUM_PHP_VERSION = '5.2.0'; + public const MINIMUM_PHP_VERSION = '5.2.0'; /** * The Environment we will use diff --git a/lib/zoninator_rest/class-zoninator-rest-controller.php b/lib/zoninator_rest/class-zoninator-rest-controller.php index e9f8bd4..24ecdc7 100644 --- a/lib/zoninator_rest/class-zoninator-rest-controller.php +++ b/lib/zoninator_rest/class-zoninator-rest-controller.php @@ -13,10 +13,10 @@ * Class Zoninator_REST_Controller */ class Zoninator_REST_Controller extends WP_REST_Controller implements Zoninator_REST_Interfaces_Controller { - const HTTP_CREATED = 201; - const HTTP_OK = 200; - const HTTP_BAD_REQUEST = 400; - const HTTP_NOT_FOUND = 404; + public const HTTP_CREATED = 201; + public const HTTP_OK = 200; + public const HTTP_BAD_REQUEST = 400; + public const HTTP_NOT_FOUND = 404; /** * The bundle this belongs to. diff --git a/lib/zoninator_rest/class-zoninator-rest-environment.php b/lib/zoninator_rest/class-zoninator-rest-environment.php index 77847a1..6929179 100644 --- a/lib/zoninator_rest/class-zoninator-rest-environment.php +++ b/lib/zoninator_rest/class-zoninator-rest-environment.php @@ -19,9 +19,9 @@ * @package Mixtape */ class Zoninator_REST_Environment { - const REGISTRABLE = 'IRegistrable'; - const BUNDLES = 'Bundles'; - const MODELS = 'Models'; + public const REGISTRABLE = 'IRegistrable'; + public const BUNDLES = 'Bundles'; + public const MODELS = 'Models'; /** * This environment's registered REST bundles diff --git a/lib/zoninator_rest/field/class-zoninator-rest-field-declaration.php b/lib/zoninator_rest/field/class-zoninator-rest-field-declaration.php index ea23ba0..41afe99 100644 --- a/lib/zoninator_rest/field/class-zoninator-rest-field-declaration.php +++ b/lib/zoninator_rest/field/class-zoninator-rest-field-declaration.php @@ -17,18 +17,18 @@ class Zoninator_REST_Field_Declaration { /** * Field A field */ - const FIELD = 'field'; + public const FIELD = 'field'; /** * Meta a meta field */ - const META = 'meta'; + public const META = 'meta'; /** * Derived field kinds get their values from callables. It is also * possible to update their values from callables */ - const DERIVED = 'derived'; + public const DERIVED = 'derived'; /** * Map From * diff --git a/rector.php b/rector.php index 18eb7b1..fee0110 100644 --- a/rector.php +++ b/rector.php @@ -22,5 +22,5 @@ LongArrayToShortArrayRector::class, ) ) - ->withPhpSets( php70: true ) + ->withPhpSets( php71: true ) ->withTypeCoverageLevel( 0 ); diff --git a/zoninator.php b/zoninator.php index d228de8..2e73a86 100644 --- a/zoninator.php +++ b/zoninator.php @@ -485,7 +485,7 @@ function admin_page_zone_edit( $zone = null ) {
-
+

@@ -1518,7 +1518,7 @@ function do_zoninator_feeds() { if ( is_wp_error( $results ) ) { self::send_user_error($results->get_error_message()); } - $this->json_return( $results, false ); + $this->json_return( $results ); } return; From de2852fdc5dee2b2929bd898813e4c55b2eac3d0 Mon Sep 17 00:00:00 2001 From: Gary Jones Date: Sat, 10 Aug 2024 16:59:22 +0100 Subject: [PATCH 07/56] CS: Rector with PHP 7.3 set https://getrector.com/find-rule?rectorSet=php-php-73 --- rector.php | 2 +- zoninator.php | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/rector.php b/rector.php index fee0110..fb16233 100644 --- a/rector.php +++ b/rector.php @@ -22,5 +22,5 @@ LongArrayToShortArrayRector::class, ) ) - ->withPhpSets( php71: true ) + ->withPhpSets( php73: true ) ->withTypeCoverageLevel( 0 ); diff --git a/zoninator.php b/zoninator.php index 2e73a86..3c9aefc 100644 --- a/zoninator.php +++ b/zoninator.php @@ -748,7 +748,7 @@ function is_zoninator_page() { if ( empty( $screen ) ) { return ! empty( $_REQUEST['page'] ) && sanitize_key( $_REQUEST['page'] ) == $this->key; } else { - return ! empty( $screen->id ) && strstr( $screen->id, $this->key ); + return ! empty( $screen->id ) && strstr( $screen->id, (string) $this->key ); } } From ec14a43b882b3b3f02a1058481f84924569b577d Mon Sep 17 00:00:00 2001 From: Gary Jones Date: Sat, 10 Aug 2024 17:07:08 +0100 Subject: [PATCH 08/56] CS: Rector with PHP 7.4 set https://getrector.com/find-rule?rectorSet=php-php-74 --- rector.php | 3 +-- zoninator.php | 2 +- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/rector.php b/rector.php index fb16233..53e0b89 100644 --- a/rector.php +++ b/rector.php @@ -4,7 +4,6 @@ use Rector\Config\RectorConfig; use Rector\Php54\Rector\Array_\LongArrayToShortArrayRector; -use Rector\ValueObject\PhpVersion; return RectorConfig::configure() ->withPaths( @@ -22,5 +21,5 @@ LongArrayToShortArrayRector::class, ) ) - ->withPhpSets( php73: true ) + ->withPhpSets( php74: true ) ->withTypeCoverageLevel( 0 ); diff --git a/zoninator.php b/zoninator.php index 3c9aefc..56fd39b 100644 --- a/zoninator.php +++ b/zoninator.php @@ -1516,7 +1516,7 @@ function do_zoninator_feeds() { $zone_slug = get_query_var( $this->zone_taxonomy ); $results = $this->get_zone_feed( $zone_slug ); if ( is_wp_error( $results ) ) { - self::send_user_error($results->get_error_message()); + self::send_user_error( $results->get_error_message() ); } $this->json_return( $results ); } From 4f71221a6893bd883ae934a2d39cb49a497652a1 Mon Sep 17 00:00:00 2001 From: Gary Jones Date: Sat, 10 Aug 2024 18:02:11 +0100 Subject: [PATCH 09/56] CS: Rector with TypeCoverage level 1 --- rector.php | 2 +- tests/bootstrap.php | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/rector.php b/rector.php index 53e0b89..91b7ba6 100644 --- a/rector.php +++ b/rector.php @@ -22,4 +22,4 @@ ) ) ->withPhpSets( php74: true ) - ->withTypeCoverageLevel( 0 ); + ->withTypeCoverageLevel( 1 ); diff --git a/tests/bootstrap.php b/tests/bootstrap.php index 819b4b9..774ef5f 100644 --- a/tests/bootstrap.php +++ b/tests/bootstrap.php @@ -11,7 +11,7 @@ require_once $_tests_dir . '/includes/functions.php'; -function _manually_load_plugin() { +function _manually_load_plugin(): void { $thispath = __DIR__; $file = $thispath . '/../zoninator.php'; require_once realpath( $file ); From 9aaf2e207edaaee86458bbc7c205fbd43ea99b4c Mon Sep 17 00:00:00 2001 From: Gary Jones Date: Sat, 10 Aug 2024 18:15:42 +0100 Subject: [PATCH 10/56] CS: Rector with DeadCode level 1 RemoveUnusedForeachKeyRector --- lib/zoninator_rest/class-zoninator-rest-controller.php | 2 +- lib/zoninator_rest/class-zoninator-rest-environment.php | 2 +- lib/zoninator_rest/class-zoninator-rest-model.php | 4 ++-- .../controller/class-zoninator-rest-controller-route.php | 2 +- .../model/class-zoninator-rest-model-settings.php | 2 +- .../class-zoninator-rest-model-declaration-settings.php | 2 +- rector.php | 1 + 7 files changed, 8 insertions(+), 7 deletions(-) diff --git a/lib/zoninator_rest/class-zoninator-rest-controller.php b/lib/zoninator_rest/class-zoninator-rest-controller.php index 24ecdc7..8f8a290 100644 --- a/lib/zoninator_rest/class-zoninator-rest-controller.php +++ b/lib/zoninator_rest/class-zoninator-rest-controller.php @@ -89,7 +89,7 @@ public function register( $bundle, $environment ) { $this->setup(); Zoninator_REST_Expect::that( ! empty( $this->base ), 'Need to put a string with a backslash in $base' ); $prefix = $this->controller_bundle->get_prefix(); - foreach ( $this->routes as $pattern => $route ) { + foreach ( $this->routes as $route ) { /** * The route we want to register. * diff --git a/lib/zoninator_rest/class-zoninator-rest-environment.php b/lib/zoninator_rest/class-zoninator-rest-environment.php index 6929179..320df04 100644 --- a/lib/zoninator_rest/class-zoninator-rest-environment.php +++ b/lib/zoninator_rest/class-zoninator-rest-environment.php @@ -183,7 +183,7 @@ public function start() { */ $rest_apis = (array) apply_filters( 'mt_environment_get_rest_apis', $this->rest_apis, $this ); - foreach ( $rest_apis as $k => $bundle ) { + foreach ( $rest_apis as $bundle ) { /** * Register this bundle * diff --git a/lib/zoninator_rest/class-zoninator-rest-model.php b/lib/zoninator_rest/class-zoninator-rest-model.php index e05eb63..e4a4ca0 100644 --- a/lib/zoninator_rest/class-zoninator-rest-model.php +++ b/lib/zoninator_rest/class-zoninator-rest-model.php @@ -149,7 +149,7 @@ public function has( $field ) { public function validate() { $validation_errors = array(); $fields = self::get_fields(); - foreach ( $fields as $key => $field_declaration ) { + foreach ( $fields as $field_declaration ) { $is_valid = $this->run_field_validations( $field_declaration ); if ( is_wp_error( $is_valid ) ) { $validation_errors[] = $is_valid->get_error_data(); @@ -168,7 +168,7 @@ public function validate() { */ public function sanitize() { $fields = self::get_fields(); - foreach ( $fields as $key => $field_declaration ) { + foreach ( $fields as $field_declaration ) { /** * Field Declaration. * diff --git a/lib/zoninator_rest/controller/class-zoninator-rest-controller-route.php b/lib/zoninator_rest/controller/class-zoninator-rest-controller-route.php index 2e77fff..54e5b39 100644 --- a/lib/zoninator_rest/controller/class-zoninator-rest-controller-route.php +++ b/lib/zoninator_rest/controller/class-zoninator-rest-controller-route.php @@ -77,7 +77,7 @@ public function as_array() { $result = array(); $result['pattern'] = $this->pattern; $result['actions'] = array(); - foreach ( $this->actions as $action => $route_action ) { + foreach ( $this->actions as $route_action ) { /** * The route action. * diff --git a/lib/zoninator_rest/model/class-zoninator-rest-model-settings.php b/lib/zoninator_rest/model/class-zoninator-rest-model-settings.php index 0609613..372c988 100644 --- a/lib/zoninator_rest/model/class-zoninator-rest-model-settings.php +++ b/lib/zoninator_rest/model/class-zoninator-rest-model-settings.php @@ -59,7 +59,7 @@ public function declare_fields() { $settings_per_group = $this->get_settings(); $fields = array(); - foreach ( $settings_per_group as $group_name => $group_data ) { + foreach ( $settings_per_group as $group_data ) { $group_fields = $group_data[1]; foreach ( $group_fields as $field_data ) { diff --git a/lib/zoninator_rest/model/declaration/class-zoninator-rest-model-declaration-settings.php b/lib/zoninator_rest/model/declaration/class-zoninator-rest-model-declaration-settings.php index b134ad9..f5de2d0 100644 --- a/lib/zoninator_rest/model/declaration/class-zoninator-rest-model-declaration-settings.php +++ b/lib/zoninator_rest/model/declaration/class-zoninator-rest-model-declaration-settings.php @@ -57,7 +57,7 @@ function declare_fields( $env ) { $settings_per_group = $this->get_settings(); $fields = array(); - foreach ( $settings_per_group as $group_name => $group_data ) { + foreach ( $settings_per_group as $group_data ) { $group_fields = $group_data[1]; foreach ( $group_fields as $field_data ) { diff --git a/rector.php b/rector.php index 91b7ba6..ad620ac 100644 --- a/rector.php +++ b/rector.php @@ -22,4 +22,5 @@ ) ) ->withPhpSets( php74: true ) + ->withDeadCodeLevel( 1 ) ->withTypeCoverageLevel( 1 ); From 374da2278f0ba07eeacd4b50f409ceb6f3062091 Mon Sep 17 00:00:00 2001 From: Gary Jones Date: Sat, 10 Aug 2024 18:16:23 +0100 Subject: [PATCH 11/56] CS: Rector with DeadCode level 2 RecastingRemovalRector --- .../type/class-zoninator-rest-type-typedarray.php | 2 +- rector.php | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/zoninator_rest/type/class-zoninator-rest-type-typedarray.php b/lib/zoninator_rest/type/class-zoninator-rest-type-typedarray.php index 2c93b04..ced62e2 100644 --- a/lib/zoninator_rest/type/class-zoninator-rest-type-typedarray.php +++ b/lib/zoninator_rest/type/class-zoninator-rest-type-typedarray.php @@ -54,7 +54,7 @@ public function cast( $value ) { foreach ( $value as $v ) { $new_value[] = $this->item_type_definition->cast( $v ); } - return (array) $new_value; + return $new_value; } /** diff --git a/rector.php b/rector.php index ad620ac..099da3c 100644 --- a/rector.php +++ b/rector.php @@ -22,5 +22,5 @@ ) ) ->withPhpSets( php74: true ) - ->withDeadCodeLevel( 1 ) + ->withDeadCodeLevel( 2 ) ->withTypeCoverageLevel( 1 ); From 3f645635493fbd1835a0ba3017f0deca97868a54 Mon Sep 17 00:00:00 2001 From: Gary Jones Date: Sat, 10 Aug 2024 18:19:51 +0100 Subject: [PATCH 12/56] CS: Rector with DeadCode level 7 RemoveNullPropertyInitializationRector --- lib/zoninator_rest/class-zoninator-rest-bootstrap.php | 4 ++-- lib/zoninator_rest/class-zoninator-rest-controller.php | 4 ++-- .../class-zoninator-rest-controller-bundle-builder.php | 2 +- .../controller/class-zoninator-rest-controller-bundle.php | 2 +- .../type/class-zoninator-rest-type-registry.php | 2 +- rector.php | 2 +- tests/unit/class-zoninator-api-controller-test.php | 2 +- zoninator.php | 8 ++++---- 8 files changed, 13 insertions(+), 13 deletions(-) diff --git a/lib/zoninator_rest/class-zoninator-rest-bootstrap.php b/lib/zoninator_rest/class-zoninator-rest-bootstrap.php index c0f382b..d50991b 100644 --- a/lib/zoninator_rest/class-zoninator-rest-bootstrap.php +++ b/lib/zoninator_rest/class-zoninator-rest-bootstrap.php @@ -25,14 +25,14 @@ class Zoninator_REST_Bootstrap { * * @var null|object the Environment implementation. */ - private $environment = null; + private $environment; /** * The class loader we will use * * @var null|Zoninator_REST_Classloader */ - private $class_loader = null; + private $class_loader; /** * Construct a new Bootstrap diff --git a/lib/zoninator_rest/class-zoninator-rest-controller.php b/lib/zoninator_rest/class-zoninator-rest-controller.php index 8f8a290..efeb8de 100644 --- a/lib/zoninator_rest/class-zoninator-rest-controller.php +++ b/lib/zoninator_rest/class-zoninator-rest-controller.php @@ -30,7 +30,7 @@ class Zoninator_REST_Controller extends WP_REST_Controller implements Zoninator_ * * @var string */ - protected $base = null; + protected $base; /** * Our Handlers * @@ -43,7 +43,7 @@ class Zoninator_REST_Controller extends WP_REST_Controller implements Zoninator_ * * @var null|Zoninator_REST_Environment */ - protected $environment = null; + protected $environment; /** * Zoninator_REST_Rest_Api_Controller constructor. diff --git a/lib/zoninator_rest/controller/bundle/class-zoninator-rest-controller-bundle-builder.php b/lib/zoninator_rest/controller/bundle/class-zoninator-rest-controller-bundle-builder.php index f940050..421b9b0 100644 --- a/lib/zoninator_rest/controller/bundle/class-zoninator-rest-controller-bundle-builder.php +++ b/lib/zoninator_rest/controller/bundle/class-zoninator-rest-controller-bundle-builder.php @@ -37,7 +37,7 @@ class Zoninator_REST_Controller_Bundle_Builder implements Zoninator_REST_Interfa * * @var Zoninator_REST_Controller_Bundle|null */ - private $bundle = null; + private $bundle; /** * Zoninator_REST_Controller_Bundle_Builder constructor. diff --git a/lib/zoninator_rest/controller/class-zoninator-rest-controller-bundle.php b/lib/zoninator_rest/controller/class-zoninator-rest-controller-bundle.php index 28a03ec..6bd10c8 100644 --- a/lib/zoninator_rest/controller/class-zoninator-rest-controller-bundle.php +++ b/lib/zoninator_rest/controller/class-zoninator-rest-controller-bundle.php @@ -19,7 +19,7 @@ class Zoninator_REST_Controller_Bundle implements Zoninator_REST_Interfaces_Cont * * @var string|null */ - protected $prefix = null; + protected $prefix; /** * Collection of Mixtape_Rest_Api_Controller subclasses diff --git a/lib/zoninator_rest/type/class-zoninator-rest-type-registry.php b/lib/zoninator_rest/type/class-zoninator-rest-type-registry.php index f081045..42d0cf9 100644 --- a/lib/zoninator_rest/type/class-zoninator-rest-type-registry.php +++ b/lib/zoninator_rest/type/class-zoninator-rest-type-registry.php @@ -28,7 +28,7 @@ class Zoninator_REST_Type_Registry { * * @var null|array */ - private $types = null; + private $types; /** * Define a new type diff --git a/rector.php b/rector.php index 099da3c..aca1e12 100644 --- a/rector.php +++ b/rector.php @@ -22,5 +22,5 @@ ) ) ->withPhpSets( php74: true ) - ->withDeadCodeLevel( 2 ) + ->withDeadCodeLevel( 7 ) ->withTypeCoverageLevel( 1 ); diff --git a/tests/unit/class-zoninator-api-controller-test.php b/tests/unit/class-zoninator-api-controller-test.php index b2bfa39..e941378 100644 --- a/tests/unit/class-zoninator-api-controller-test.php +++ b/tests/unit/class-zoninator-api-controller-test.php @@ -7,7 +7,7 @@ class Zoninator_Api_Controller_Test extends WP_UnitTestCase { * * @var Zoninator */ - private $_zoninator = null; + private $_zoninator; /** * REST Server diff --git a/zoninator.php b/zoninator.php index 56fd39b..46dfd4d 100644 --- a/zoninator.php +++ b/zoninator.php @@ -48,17 +48,17 @@ class Zoninator { public $zone_ajax_nonce_action = 'ajax-action'; public $zone_lock_period = 30; // number of seconds a lock is valid for public $zone_max_lock_period = 600; // max number of seconds for all locks in a session - public $post_types = null; - public $zone_detail_defaults = array( + public $post_types; + public $zone_detail_defaults = array( 'description' => '', // Add additional properties here! ); - public $zone_messages = null; + public $zone_messages; public $posts_per_page = 10; /** * @var Zoninator_Api */ - public $rest_api = null; + public $rest_api; /** * @var array|string[] Default post types that support zones. */ From d21774ebc7b053dc7ace066d74ab6064fec56044 Mon Sep 17 00:00:00 2001 From: Gary Jones Date: Sat, 10 Aug 2024 18:22:38 +0100 Subject: [PATCH 13/56] CS: Rector with DeadCode level 14 SimplifyUselessVariableRector --- .../controller/class-zoninator-rest-controller-action.php | 4 +--- .../field/class-zoninator-rest-field-declaration.php | 3 +-- rector.php | 2 +- tests/unit/class-zoninator-api-controller-test.php | 3 +-- 4 files changed, 4 insertions(+), 8 deletions(-) diff --git a/lib/zoninator_rest/controller/class-zoninator-rest-controller-action.php b/lib/zoninator_rest/controller/class-zoninator-rest-controller-action.php index 948a5aa..ce1758c 100644 --- a/lib/zoninator_rest/controller/class-zoninator-rest-controller-action.php +++ b/lib/zoninator_rest/controller/class-zoninator-rest-controller-action.php @@ -136,14 +136,12 @@ public function as_array() { $args = $this->controller->get_endpoint_args_for_item_schema( $this->actions_to_http_methods[ $this->action_name ] ); } - $result = array( + return array( 'methods' => $this->actions_to_http_methods[ $this->action_name ], 'callback' => $callable_func, 'permission_callback' => $permission_callback, 'args' => $args, ); - - return $result; } /** diff --git a/lib/zoninator_rest/field/class-zoninator-rest-field-declaration.php b/lib/zoninator_rest/field/class-zoninator-rest-field-declaration.php index 41afe99..17f7e1d 100644 --- a/lib/zoninator_rest/field/class-zoninator-rest-field-declaration.php +++ b/lib/zoninator_rest/field/class-zoninator-rest-field-declaration.php @@ -347,8 +347,7 @@ public function get_description() { if ( isset( $this->description ) && ! empty( $this->description ) ) { return $this->description; } - $name = ucfirst( str_replace( '_', ' ', $this->get_name() ) ); - return $name; + return ucfirst( str_replace( '_', ' ', $this->get_name() ) ); } /** diff --git a/rector.php b/rector.php index aca1e12..23c3fcb 100644 --- a/rector.php +++ b/rector.php @@ -22,5 +22,5 @@ ) ) ->withPhpSets( php74: true ) - ->withDeadCodeLevel( 7 ) + ->withDeadCodeLevel( 14 ) ->withTypeCoverageLevel( 1 ); diff --git a/tests/unit/class-zoninator-api-controller-test.php b/tests/unit/class-zoninator-api-controller-test.php index e941378..60771a7 100644 --- a/tests/unit/class-zoninator-api-controller-test.php +++ b/tests/unit/class-zoninator-api-controller-test.php @@ -425,11 +425,10 @@ private function create_a_zone( $slug, $title ) { */ private function add_a_zone( $slug = 'zone-1' ) { $term_factory = new WP_UnitTest_Factory_For_Term(null, Zoninator()->zone_taxonomy); - $zone_id = $term_factory->create_object(array( + return $term_factory->create_object(array( 'name' => 'The Zone Add Post one ' . rand_str(), 'description' => 'Zone ' . rand_str(), 'slug' => $slug, )); - return $zone_id; } } From fee13099ee21bcfe617eb0d6ffb2adc4f8b1ad6d Mon Sep 17 00:00:00 2001 From: Gary Jones Date: Sat, 10 Aug 2024 18:27:53 +0100 Subject: [PATCH 14/56] CS: Rector with DeadCode level 19 RemoveNonExistingVarAnnotationRector --- lib/zoninator_rest/class-zoninator-rest-environment.php | 2 -- .../controller/class-zoninator-rest-controller-bundle.php | 2 -- rector.php | 2 +- 3 files changed, 1 insertion(+), 5 deletions(-) diff --git a/lib/zoninator_rest/class-zoninator-rest-environment.php b/lib/zoninator_rest/class-zoninator-rest-environment.php index 320df04..4305f0c 100644 --- a/lib/zoninator_rest/class-zoninator-rest-environment.php +++ b/lib/zoninator_rest/class-zoninator-rest-environment.php @@ -186,8 +186,6 @@ public function start() { foreach ( $rest_apis as $bundle ) { /** * Register this bundle - * - * @var Zoninator_REST_Interfaces_Controller_Bundle */ $bundle->register( $this ); } diff --git a/lib/zoninator_rest/controller/class-zoninator-rest-controller-bundle.php b/lib/zoninator_rest/controller/class-zoninator-rest-controller-bundle.php index 6bd10c8..f9ecbf3 100644 --- a/lib/zoninator_rest/controller/class-zoninator-rest-controller-bundle.php +++ b/lib/zoninator_rest/controller/class-zoninator-rest-controller-bundle.php @@ -78,8 +78,6 @@ function register( $environment ) { foreach ( $endpoints as $endpoint ) { /** * Controller - * - * @var Zoninator_REST_Interfaces_Controller */ $endpoint->register( $this, $this->environment ); } diff --git a/rector.php b/rector.php index 23c3fcb..ed43bad 100644 --- a/rector.php +++ b/rector.php @@ -22,5 +22,5 @@ ) ) ->withPhpSets( php74: true ) - ->withDeadCodeLevel( 14 ) + ->withDeadCodeLevel( 19 ) ->withTypeCoverageLevel( 1 ); From 04fccfd3102357c2afdbd1eec30647e3f06510e7 Mon Sep 17 00:00:00 2001 From: Gary Jones Date: Sat, 10 Aug 2024 18:48:48 +0100 Subject: [PATCH 15/56] CS: Rector with DeadCode level 21 RemoveNullTagValueNodeRector --- lib/zoninator_rest/class-zoninator-rest-type.php | 2 -- .../data/store/class-zoninator-rest-data-store-nil.php | 1 - .../field/class-zoninator-rest-field-declaration.php | 3 --- .../interfaces/class-zoninator-rest-interfaces-type.php | 2 -- .../type/class-zoninator-rest-type-nullable.php | 2 -- rector.php | 2 +- zoninator.php | 5 +++-- 7 files changed, 4 insertions(+), 13 deletions(-) diff --git a/lib/zoninator_rest/class-zoninator-rest-type.php b/lib/zoninator_rest/class-zoninator-rest-type.php index afe0b38..309363a 100644 --- a/lib/zoninator_rest/class-zoninator-rest-type.php +++ b/lib/zoninator_rest/class-zoninator-rest-type.php @@ -39,8 +39,6 @@ function name() { /** * The default value - * - * @return null */ function default_value() { return null; diff --git a/lib/zoninator_rest/data/store/class-zoninator-rest-data-store-nil.php b/lib/zoninator_rest/data/store/class-zoninator-rest-data-store-nil.php index d6fef95..2125fac 100644 --- a/lib/zoninator_rest/data/store/class-zoninator-rest-data-store-nil.php +++ b/lib/zoninator_rest/data/store/class-zoninator-rest-data-store-nil.php @@ -29,7 +29,6 @@ public function get_entities( $filter = null ) { * Get Entity * * @param int $id Id. - * @return null */ public function get_entity( $id ) { return null; diff --git a/lib/zoninator_rest/field/class-zoninator-rest-field-declaration.php b/lib/zoninator_rest/field/class-zoninator-rest-field-declaration.php index 17f7e1d..df5ad47 100644 --- a/lib/zoninator_rest/field/class-zoninator-rest-field-declaration.php +++ b/lib/zoninator_rest/field/class-zoninator-rest-field-declaration.php @@ -221,7 +221,6 @@ public function get_sanitizer() { * @param array $args Args. * @param string $name Name. * @param mixed $default Default. - * @return null */ private function value_or_default( $args, $name, $default = null ) { return $args[ $name ] ?? $default; @@ -291,8 +290,6 @@ public function as_item_schema_property() { /** * Get Map From - * - * @return null */ public function get_map_from() { if ( isset( $this->map_from ) && ! empty( $this->map_from ) ) { diff --git a/lib/zoninator_rest/interfaces/class-zoninator-rest-interfaces-type.php b/lib/zoninator_rest/interfaces/class-zoninator-rest-interfaces-type.php index 19512ef..1ba208c 100644 --- a/lib/zoninator_rest/interfaces/class-zoninator-rest-interfaces-type.php +++ b/lib/zoninator_rest/interfaces/class-zoninator-rest-interfaces-type.php @@ -23,8 +23,6 @@ interface Zoninator_REST_Interfaces_Type { public function cast( $value ); /** * The default value - * - * @return null */ public function default_value(); /** diff --git a/lib/zoninator_rest/type/class-zoninator-rest-type-nullable.php b/lib/zoninator_rest/type/class-zoninator-rest-type-nullable.php index 5dde989..1841719 100644 --- a/lib/zoninator_rest/type/class-zoninator-rest-type-nullable.php +++ b/lib/zoninator_rest/type/class-zoninator-rest-type-nullable.php @@ -32,8 +32,6 @@ function __construct( $item_type_definition ) { /** * Default value as always null. - * - * @return null */ public function default_value() { return null; diff --git a/rector.php b/rector.php index ed43bad..7297cf4 100644 --- a/rector.php +++ b/rector.php @@ -22,5 +22,5 @@ ) ) ->withPhpSets( php74: true ) - ->withDeadCodeLevel( 19 ) + ->withDeadCodeLevel( 21 ) ->withTypeCoverageLevel( 1 ); diff --git a/zoninator.php b/zoninator.php index 46dfd4d..7452393 100644 --- a/zoninator.php +++ b/zoninator.php @@ -1116,8 +1116,9 @@ function add_zone_posts( $zone, $posts, $append = false ) { } /** - * @param $zone - * @param null $posts + * @param mixed $zone + * @param mixed $posts + * * @return bool|WP_Error */ function remove_zone_posts( $zone, $posts = null ) { From 73a85b9fa1c6c5e8a818219d24a0433e18fa2b48 Mon Sep 17 00:00:00 2001 From: Gary Jones Date: Sat, 10 Aug 2024 19:51:57 +0100 Subject: [PATCH 16/56] CS: Rector with DeadCode level 26 RemoveUnusedPrivatePropertyRector --- ...ninator-rest-controller-bundle-builder.php | 7 ------- ...class-zoninator-rest-controller-bundle.php | 6 ------ .../class-zoninator-rest-controller-route.php | 20 ++----------------- ...ass-zoninator-rest-data-store-abstract.php | 10 +--------- rector.php | 2 +- .../class-zoninator-api-controller-test.php | 15 -------------- 6 files changed, 4 insertions(+), 56 deletions(-) diff --git a/lib/zoninator_rest/controller/bundle/class-zoninator-rest-controller-bundle-builder.php b/lib/zoninator_rest/controller/bundle/class-zoninator-rest-controller-bundle-builder.php index 421b9b0..b584046 100644 --- a/lib/zoninator_rest/controller/bundle/class-zoninator-rest-controller-bundle-builder.php +++ b/lib/zoninator_rest/controller/bundle/class-zoninator-rest-controller-bundle-builder.php @@ -20,12 +20,6 @@ class Zoninator_REST_Controller_Bundle_Builder implements Zoninator_REST_Interfa * @var string */ private $bundle_prefix; - /** - * Env. - * - * @var Zoninator_REST_Environment - */ - private $environment; /** * Endpoint Builders. * @@ -78,7 +72,6 @@ public function with_prefix( $bundle_prefix ) { * @return Zoninator_REST_Controller_Bundle_Builder $this */ public function with_environment( $env ) { - $this->environment = $env; return $this; } diff --git a/lib/zoninator_rest/controller/class-zoninator-rest-controller-bundle.php b/lib/zoninator_rest/controller/class-zoninator-rest-controller-bundle.php index f9ecbf3..0a18be6 100644 --- a/lib/zoninator_rest/controller/class-zoninator-rest-controller-bundle.php +++ b/lib/zoninator_rest/controller/class-zoninator-rest-controller-bundle.php @@ -27,12 +27,6 @@ class Zoninator_REST_Controller_Bundle implements Zoninator_REST_Interfaces_Cont * @var array */ protected $endpoints = array(); - /** - * Our Endpoint Builders - * - * @var array - */ - private $endpoint_builders; /** * Environment. * diff --git a/lib/zoninator_rest/controller/class-zoninator-rest-controller-route.php b/lib/zoninator_rest/controller/class-zoninator-rest-controller-route.php index 54e5b39..43491c4 100644 --- a/lib/zoninator_rest/controller/class-zoninator-rest-controller-route.php +++ b/lib/zoninator_rest/controller/class-zoninator-rest-controller-route.php @@ -28,20 +28,6 @@ class Zoninator_REST_Controller_Route { */ private $actions; - /** - * Our Controller - * - * @var Zoninator_REST_Controller - */ - private $controller; - - /** - * HTTP Methods - * - * @var array - */ - private $http_methods; - /** * Zoninator_REST_Controller_Route constructor. * @@ -49,10 +35,8 @@ class Zoninator_REST_Controller_Route { * @param string $pattern Pattern. */ public function __construct( $controller, $pattern ) { - $this->controller = $controller; - $this->pattern = $pattern; - $this->actions = array(); - $this->http_methods = explode( ', ', WP_REST_Server::ALLMETHODS ); + $this->pattern = $pattern; + $this->actions = array(); } /** diff --git a/lib/zoninator_rest/data/store/class-zoninator-rest-data-store-abstract.php b/lib/zoninator_rest/data/store/class-zoninator-rest-data-store-abstract.php index bf84d9d..6d14df5 100644 --- a/lib/zoninator_rest/data/store/class-zoninator-rest-data-store-abstract.php +++ b/lib/zoninator_rest/data/store/class-zoninator-rest-data-store-abstract.php @@ -22,13 +22,6 @@ abstract class Zoninator_REST_Data_Store_Abstract implements Zoninator_REST_Inte */ protected $model_prototype; - /** - * Type Serializers - * - * @var array - */ - private $type_serializers; - /** * Zoninator_REST_Data_Store_Abstract constructor. * @@ -36,8 +29,7 @@ abstract class Zoninator_REST_Data_Store_Abstract implements Zoninator_REST_Inte * @param array $args Args. */ public function __construct( $model_prototype = null, $args = array() ) { - $this->type_serializers = array(); - $this->args = $args; + $this->args = $args; Zoninator_REST_Expect::is_a( $model_prototype, 'Zoninator_REST_Interfaces_Model' ); $this->set_model_factory( $model_prototype ); } diff --git a/rector.php b/rector.php index 7297cf4..75db8f3 100644 --- a/rector.php +++ b/rector.php @@ -22,5 +22,5 @@ ) ) ->withPhpSets( php74: true ) - ->withDeadCodeLevel( 21 ) + ->withDeadCodeLevel( 26 ) ->withTypeCoverageLevel( 1 ); diff --git a/tests/unit/class-zoninator-api-controller-test.php b/tests/unit/class-zoninator-api-controller-test.php index 60771a7..798cc04 100644 --- a/tests/unit/class-zoninator-api-controller-test.php +++ b/tests/unit/class-zoninator-api-controller-test.php @@ -2,13 +2,6 @@ class Zoninator_Api_Controller_Test extends WP_UnitTestCase { - /** - * The Mighty Zoninator! - * - * @var Zoninator - */ - private $_zoninator; - /** * REST Server * @@ -16,13 +9,6 @@ class Zoninator_Api_Controller_Test extends WP_UnitTestCase { */ protected $rest_server; - /** - * Post ID - * - * @var int - */ - private $_post_id = 0; - /** * Admin ID * @@ -171,7 +157,6 @@ function setUp(): void { global $wp_rest_server; $this->rest_server = new Spy_REST_Server; $wp_rest_server = $this->rest_server; - $this->_zoninator = Zoninator(); $admin = get_user_by( 'email', 'rest_api_admin_user@test.com' ); if ( false === $admin ) { $this->admin_id = wp_create_user( From b51a88e3114871b524547fdf2d07b4622e4cf7a6 Mon Sep 17 00:00:00 2001 From: Gary Jones Date: Sat, 10 Aug 2024 20:30:13 +0100 Subject: [PATCH 17/56] CS: Rector with DeadCode level 40 RemoveUnreachableStatementRector --- rector.php | 2 +- zoninator.php | 18 +----------------- 2 files changed, 2 insertions(+), 18 deletions(-) diff --git a/rector.php b/rector.php index 75db8f3..9e4ba78 100644 --- a/rector.php +++ b/rector.php @@ -22,5 +22,5 @@ ) ) ->withPhpSets( php74: true ) - ->withDeadCodeLevel( 26 ) + ->withDeadCodeLevel( 40 ) ->withTypeCoverageLevel( 1 ); diff --git a/zoninator.php b/zoninator.php index 7452393..3b80c25 100644 --- a/zoninator.php +++ b/zoninator.php @@ -258,7 +258,6 @@ function admin_controller() { ); exit; } - break; case 'delete': $zone_id = $this->_get_request_var( 'zone_id', 0, 'absint' ); @@ -1593,29 +1592,14 @@ private static function status_header_with_message( $status, $message ) { // TODO: Caching needs to be testing properly before being implemented! function get_zone_cache_key( $zone, $args = array() ) { return ''; - - $meta_key = $this->get_zone_meta_key( $zone ); - $hash = md5( serialize( $args ) ); - return $meta_key . $hash; } function get_zone_posts_from_cache( $zone, $args = array() ) { - return false; // TODO: implement - - $meta_key = $this->get_zone_meta_key( $zone ); - $cache_key = $this->get_zone_cache_key( $zone, $args ); - if ( $posts = wp_cache_get( $cache_key, $meta_key ) ) { - return $posts; - } return false; } function add_zone_posts_to_cache( $posts, $zone, $args = array() ) { - return; // TODO: implement - - $meta_key = $this->get_zone_meta_key( $zone ); - $cache_key = $this->get_zone_cache_key( $zone, $args ); - wp_cache_set( $cache_key, $posts, $meta_key ); + return; } // Handle 4.2 term-splitting From adbc67b195103ff394da9fea51f87ca5abc8c97c Mon Sep 17 00:00:00 2001 From: Gary Jones Date: Sat, 10 Aug 2024 21:22:32 +0100 Subject: [PATCH 18/56] CS: Rector with DeadCode level 41 RemoveUnusedVariableAssignRector --- ...class-zoninator-rest-data-store-customposttype.php | 11 +++++------ rector.php | 2 +- tests/unit/class-zoninator-api-controller-test.php | 4 ++-- zoninator.php | 3 --- 4 files changed, 8 insertions(+), 12 deletions(-) diff --git a/lib/zoninator_rest/data/store/class-zoninator-rest-data-store-customposttype.php b/lib/zoninator_rest/data/store/class-zoninator-rest-data-store-customposttype.php index f6ed19d..e5b36ac 100644 --- a/lib/zoninator_rest/data/store/class-zoninator-rest-data-store-customposttype.php +++ b/lib/zoninator_rest/data/store/class-zoninator-rest-data-store-customposttype.php @@ -43,7 +43,7 @@ public function get_entities( $filter = null ) { array( 'post_type' => $this->post_type, 'post_status' => 'any', - ) + ) ); $posts = $query->get_posts(); $collection = array(); @@ -76,9 +76,8 @@ public function get_entity( $id ) { * @throws Zoninator_REST_Exception If something goes wrong. */ private function create_from_post( $post ) { - $field_declarations = $this->get_model_prototype()->get_fields(); - $raw_post_data = $post->to_array(); - $raw_meta_data = get_post_meta( $post->ID ); // assumes we are only ever adding one postmeta per key. + $raw_post_data = $post->to_array(); + $raw_meta_data = get_post_meta( $post->ID ); // assumes we are only ever adding one postmeta per key. $flattened_meta = array(); foreach ( $raw_meta_data as $key => $value_arr ) { @@ -90,7 +89,7 @@ private function create_from_post( $post ) { $merged_data, array( 'deserialize' => true, - ) + ) ); } @@ -108,7 +107,7 @@ public function delete( $model, $args = array() ) { $args, array( 'force_delete' => false, - ) + ) ); do_action( 'mixtape_data_store_delete_model_before', $model, $id ); diff --git a/rector.php b/rector.php index 9e4ba78..2a4e9f1 100644 --- a/rector.php +++ b/rector.php @@ -22,5 +22,5 @@ ) ) ->withPhpSets( php74: true ) - ->withDeadCodeLevel( 40 ) + ->withDeadCodeLevel( 41 ) ->withTypeCoverageLevel( 1 ); diff --git a/tests/unit/class-zoninator-api-controller-test.php b/tests/unit/class-zoninator-api-controller-test.php index 798cc04..2f42a5d 100644 --- a/tests/unit/class-zoninator-api-controller-test.php +++ b/tests/unit/class-zoninator-api-controller-test.php @@ -305,7 +305,7 @@ function test_update_zone_posts_responds_with_not_found_if_zone_not_exist() { */ function test_update_zone_posts_fails_if_invalid_data() { $this->login_as_admin(); - $post_id = $this->_insert_a_post(); + $this->_insert_a_post(); $zone_id = $this->create_a_zone( 'test-zone', 'Test Zone' ); $response = $this->put( '/zoninator/v1/zones/' . $zone_id . '/posts', array() ); $this->assertResponseStatus( $response, 400 ); @@ -318,7 +318,7 @@ function test_update_zone_posts_fails_if_invalid_data() { */ function test_update_zone_posts_fails_if_invalid_post_id() { $this->login_as_admin(); - $post_id = $this->_insert_a_post(); + $this->_insert_a_post(); $zone_id = $this->create_a_zone( 'test-zone', 'Test Zone' ); $response = $this->put( '/zoninator/v1/zones/' . $zone_id . '/posts', array( 'post_ids' => array( 123456789 ), diff --git a/zoninator.php b/zoninator.php index 3b80c25..356103e 100644 --- a/zoninator.php +++ b/zoninator.php @@ -284,8 +284,6 @@ function admin_controller() { function admin_page() { global $zoninator_admin_page; - $view = $this->_get_value_or_default( 'view', $zoninator_admin_page, 'edit.php' ); - $view = sprintf( '%s/views/%s', ZONINATOR_PATH, $view ); $title = __( 'Zones', 'zoninator' ); $zones = $this->get_zones( apply_filters( 'zoninator_admin_page_get_zones_args', array() ) ); @@ -345,7 +343,6 @@ function admin_page() { } function admin_page_zone_tabs( $zones, $active_zone_id = 0 ) { - $new_link = $this->_get_zone_page_url( array( 'action' => 'new' ) ); ?>
From 15d87ede23fc9604390d14c8d4ae3a18bab1c80a Mon Sep 17 00:00:00 2001 From: Gary Jones Date: Sat, 10 Aug 2024 21:27:02 +0100 Subject: [PATCH 19/56] CS: Rector with DeadCode level 44 RemoveDeadReturnRector --- rector.php | 2 +- zoninator.php | 3 --- 2 files changed, 1 insertion(+), 4 deletions(-) diff --git a/rector.php b/rector.php index 2a4e9f1..d04c791 100644 --- a/rector.php +++ b/rector.php @@ -22,5 +22,5 @@ ) ) ->withPhpSets( php74: true ) - ->withDeadCodeLevel( 41 ) + ->withDeadCodeLevel( 44 ) ->withTypeCoverageLevel( 1 ); diff --git a/zoninator.php b/zoninator.php index 356103e..8eb0c20 100644 --- a/zoninator.php +++ b/zoninator.php @@ -1517,8 +1517,6 @@ function do_zoninator_feeds() { } $this->json_return( $results ); } - - return; } private function filter_zone_feed_fields( $results ) { @@ -1596,7 +1594,6 @@ function get_zone_posts_from_cache( $zone, $args = array() ) { } function add_zone_posts_to_cache( $posts, $zone, $args = array() ) { - return; } // Handle 4.2 term-splitting From 72d1c9efeef48b514fd2a6687e2ca107272afffa Mon Sep 17 00:00:00 2001 From: Gary Jones Date: Sat, 10 Aug 2024 21:39:22 +0100 Subject: [PATCH 20/56] CS: Rector with CodeQuality level 11 SimplifyIfReturnBoolRector --- rector.php | 3 ++- zoninator.php | 7 +------ 2 files changed, 3 insertions(+), 7 deletions(-) diff --git a/rector.php b/rector.php index d04c791..8049dd4 100644 --- a/rector.php +++ b/rector.php @@ -22,5 +22,6 @@ ) ) ->withPhpSets( php74: true ) - ->withDeadCodeLevel( 44 ) + ->withPreparedSets( deadCode: true ) + ->withCodeQualityLevel( 11 ) ->withTypeCoverageLevel( 1 ); diff --git a/zoninator.php b/zoninator.php index 8eb0c20..db8d390 100644 --- a/zoninator.php +++ b/zoninator.php @@ -1381,12 +1381,7 @@ function is_zone_locked( $zone ) { function zone_exists( $zone ) { $zone_id = $this->get_zone_id( $zone ); - - if ( term_exists( $zone_id, $this->zone_taxonomy ) ) { - return true; - } - - return false; + return (bool) term_exists( $zone_id, $this->zone_taxonomy ); } function get_zone_id( $zone ) { From 4f72927042161ff1a4b1410046601ea3ff6add6f Mon Sep 17 00:00:00 2001 From: Gary Jones Date: Sat, 10 Aug 2024 21:56:25 +0100 Subject: [PATCH 21/56] CS: Rector with CodeQuality level 13 UnnecessaryTernaryExpressionRector --- .../model/class-zoninator-rest-model-settings.php | 2 +- .../class-zoninator-rest-model-declaration-settings.php | 2 +- rector.php | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/zoninator_rest/model/class-zoninator-rest-model-settings.php b/lib/zoninator_rest/model/class-zoninator-rest-model-settings.php index 372c988..d208628 100644 --- a/lib/zoninator_rest/model/class-zoninator-rest-model-settings.php +++ b/lib/zoninator_rest/model/class-zoninator-rest-model-settings.php @@ -87,7 +87,7 @@ public function bool_to_bit( $value ) { * @return bool */ public function bit_to_bool( $value ) { - return ( ! empty( $value ) && '0' !== $value ) ? true : false; + return ! empty( $value ) && '0' !== $value; } /** diff --git a/lib/zoninator_rest/model/declaration/class-zoninator-rest-model-declaration-settings.php b/lib/zoninator_rest/model/declaration/class-zoninator-rest-model-declaration-settings.php index f5de2d0..ed3f69d 100644 --- a/lib/zoninator_rest/model/declaration/class-zoninator-rest-model-declaration-settings.php +++ b/lib/zoninator_rest/model/declaration/class-zoninator-rest-model-declaration-settings.php @@ -85,7 +85,7 @@ function bool_to_bit( $value ) { * @return bool */ function bit_to_bool( $value ) { - return ( ! empty( $value ) && '0' !== $value ) ? true : false; + return ! empty( $value ) && '0' !== $value; } /** diff --git a/rector.php b/rector.php index 8049dd4..e25b1cb 100644 --- a/rector.php +++ b/rector.php @@ -23,5 +23,5 @@ ) ->withPhpSets( php74: true ) ->withPreparedSets( deadCode: true ) - ->withCodeQualityLevel( 11 ) + ->withCodeQualityLevel( 13 ) ->withTypeCoverageLevel( 1 ); From ad29cae90a30b9ce4ef78c8c1e07a7033b89c608 Mon Sep 17 00:00:00 2001 From: Gary Jones Date: Sat, 10 Aug 2024 22:02:28 +0100 Subject: [PATCH 22/56] CS: Rector with CodeQuality level 18 SimplifyIfElseToTernaryRector --- rector.php | 2 +- zoninator.php | 12 ++---------- 2 files changed, 3 insertions(+), 11 deletions(-) diff --git a/rector.php b/rector.php index e25b1cb..eb052ba 100644 --- a/rector.php +++ b/rector.php @@ -23,5 +23,5 @@ ) ->withPhpSets( php74: true ) ->withPreparedSets( deadCode: true ) - ->withCodeQualityLevel( 13 ) + ->withCodeQualityLevel( 18 ) ->withTypeCoverageLevel( 1 ); diff --git a/zoninator.php b/zoninator.php index db8d390..2afe128 100644 --- a/zoninator.php +++ b/zoninator.php @@ -1085,11 +1085,7 @@ function add_zone_posts( $zone, $posts, $append = false ) { if ( $append ) { // Order should be the highest post order $last_post = $this->get_last_post_in_zone( $zone ); - if ( $last_post ) { - $order = $this->get_post_order( $last_post, $zone ); - } else { - $order = 0; - } + $order = $last_post ? $this->get_post_order( $last_post, $zone ) : 0; } else { $order = 0; $this->remove_zone_posts( $zone ); @@ -1686,11 +1682,7 @@ function _get_value_or_default( $var, $object, $default = '', $sanitize_callback } if ( is_callable( $sanitize_callback ) ) { - if ( is_array( $value ) ) { - $value = array_map( $sanitize_callback, $value ); - } else { - $value = call_user_func( $sanitize_callback, $value ); - } + $value = is_array( $value ) ? array_map( $sanitize_callback, $value ) : call_user_func( $sanitize_callback, $value ); } return $value; From fcfc8898b9fa96d35bdb36fbce3e893554a392ca Mon Sep 17 00:00:00 2001 From: Gary Jones Date: Sat, 10 Aug 2024 22:54:05 +0100 Subject: [PATCH 23/56] CS: Rector with CodeQuality level 22 CombineIfRector --- rector.php | 2 +- zoninator.php | 6 ++---- 2 files changed, 3 insertions(+), 5 deletions(-) diff --git a/rector.php b/rector.php index eb052ba..fea4ca6 100644 --- a/rector.php +++ b/rector.php @@ -23,5 +23,5 @@ ) ->withPhpSets( php74: true ) ->withPreparedSets( deadCode: true ) - ->withCodeQualityLevel( 18 ) + ->withCodeQualityLevel( 22 ) ->withTypeCoverageLevel( 1 ); diff --git a/zoninator.php b/zoninator.php index 2afe128..1dc988e 100644 --- a/zoninator.php +++ b/zoninator.php @@ -289,10 +289,8 @@ function admin_page() { $zones = $this->get_zones( apply_filters( 'zoninator_admin_page_get_zones_args', array() ) ); $default_active_zone = 0; - if ( ! $this->_current_user_can_add_zones() ) { - if ( ! empty( $zones ) ) { - $default_active_zone = $zones[0]->term_id; - } + if ( ! $this->_current_user_can_add_zones() && ! empty( $zones ) ) { + $default_active_zone = $zones[0]->term_id; } $active_zone_id = $this->_get_request_var( 'zone_id', $default_active_zone, 'absint' ); From 5950cdaa0998b505663f597de267637293e7d4cb Mon Sep 17 00:00:00 2001 From: Gary Jones Date: Sat, 10 Aug 2024 22:55:19 +0100 Subject: [PATCH 24/56] CS: Rector with CodeQuality level 24 SimplifyBoolIdenticalTrueRector --- rector.php | 2 +- zoninator.php | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/rector.php b/rector.php index fea4ca6..77e262e 100644 --- a/rector.php +++ b/rector.php @@ -23,5 +23,5 @@ ) ->withPhpSets( php74: true ) ->withPreparedSets( deadCode: true ) - ->withCodeQualityLevel( 22 ) + ->withCodeQualityLevel( 24 ) ->withTypeCoverageLevel( 1 ); diff --git a/zoninator.php b/zoninator.php index 1dc988e..828dcdb 100644 --- a/zoninator.php +++ b/zoninator.php @@ -602,7 +602,7 @@ function zone_advanced_search_date_filter() { Date: Sat, 10 Aug 2024 22:59:23 +0100 Subject: [PATCH 25/56] CS: Rector with CodeQuality level 25 SimplifyRegexPatternRector --- rector.php | 2 +- zoninator.php | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/rector.php b/rector.php index 77e262e..ea196e7 100644 --- a/rector.php +++ b/rector.php @@ -23,5 +23,5 @@ ) ->withPhpSets( php74: true ) ->withPreparedSets( deadCode: true ) - ->withCodeQualityLevel( 24 ) + ->withCodeQualityLevel( 25 ) ->withTypeCoverageLevel( 1 ); diff --git a/zoninator.php b/zoninator.php index 828dcdb..287905c 100644 --- a/zoninator.php +++ b/zoninator.php @@ -1659,7 +1659,7 @@ function _get_zone_page_url( $args = array() ) { } function _validate_date_filter( $date ) { - return preg_match( '/([0-9]{4})-([0-9]{2})-([0-9]{2})/', $date ); + return preg_match( '/(\d{4})-(\d{2})-(\d{2})/', $date ); } function _validate_category_filter( $cat ) { From 49b49da7b9c3c1beeab42916ce0f1c001c795ad3 Mon Sep 17 00:00:00 2001 From: Gary Jones Date: Sat, 10 Aug 2024 23:06:19 +0100 Subject: [PATCH 26/56] CS: Rector with CodeQuality level 29 CompleteDynamicPropertiesRector --- .../controller/class-zoninator-rest-controller-action.php | 2 ++ .../data/store/class-zoninator-rest-data-store-abstract.php | 5 +++++ .../class-zoninator-rest-field-declaration-builder.php | 2 ++ rector.php | 2 +- 4 files changed, 10 insertions(+), 1 deletion(-) diff --git a/lib/zoninator_rest/controller/class-zoninator-rest-controller-action.php b/lib/zoninator_rest/controller/class-zoninator-rest-controller-action.php index ce1758c..494ae63 100644 --- a/lib/zoninator_rest/controller/class-zoninator-rest-controller-action.php +++ b/lib/zoninator_rest/controller/class-zoninator-rest-controller-action.php @@ -13,6 +13,8 @@ * Class Zoninator_REST_Controller_Action */ class Zoninator_REST_Controller_Action { + public $controller; + /** * Permitted actions * diff --git a/lib/zoninator_rest/data/store/class-zoninator-rest-data-store-abstract.php b/lib/zoninator_rest/data/store/class-zoninator-rest-data-store-abstract.php index 6d14df5..c0ee0cb 100644 --- a/lib/zoninator_rest/data/store/class-zoninator-rest-data-store-abstract.php +++ b/lib/zoninator_rest/data/store/class-zoninator-rest-data-store-abstract.php @@ -15,6 +15,11 @@ */ abstract class Zoninator_REST_Data_Store_Abstract implements Zoninator_REST_Interfaces_Data_Store { + /** + * @var mixed[] + */ + public $args; + /** * Definition * diff --git a/lib/zoninator_rest/field/declaration/class-zoninator-rest-field-declaration-builder.php b/lib/zoninator_rest/field/declaration/class-zoninator-rest-field-declaration-builder.php index 1f70ea0..53b4c4c 100644 --- a/lib/zoninator_rest/field/declaration/class-zoninator-rest-field-declaration-builder.php +++ b/lib/zoninator_rest/field/declaration/class-zoninator-rest-field-declaration-builder.php @@ -15,6 +15,8 @@ */ class Zoninator_REST_Field_Declaration_Builder { + public $args; + /** * Constructor. */ diff --git a/rector.php b/rector.php index ea196e7..e13147b 100644 --- a/rector.php +++ b/rector.php @@ -23,5 +23,5 @@ ) ->withPhpSets( php74: true ) ->withPreparedSets( deadCode: true ) - ->withCodeQualityLevel( 25 ) + ->withCodeQualityLevel( 29 ) ->withTypeCoverageLevel( 1 ); From 38676ddb68dbb258fd6f6dc3495e98a94084cd42 Mon Sep 17 00:00:00 2001 From: Gary Jones Date: Sat, 10 Aug 2024 23:10:56 +0100 Subject: [PATCH 27/56] CS: Rector with CodeQuality level 34 ShortenElseIfRector --- .../model/class-zoninator-rest-model-settings.php | 6 ++---- .../class-zoninator-rest-model-declaration-settings.php | 6 ++---- rector.php | 2 +- 3 files changed, 5 insertions(+), 9 deletions(-) diff --git a/lib/zoninator_rest/model/class-zoninator-rest-model-settings.php b/lib/zoninator_rest/model/class-zoninator-rest-model-settings.php index d208628..797442b 100644 --- a/lib/zoninator_rest/model/class-zoninator-rest-model-settings.php +++ b/lib/zoninator_rest/model/class-zoninator-rest-model-settings.php @@ -137,11 +137,9 @@ private function field_declaration_builder_from_data( $env, $field_data ) { ->with_deserializer( array( $this, 'bit_to_bool' ) ); } elseif ( 'select' === $setting_type ) { $field_type = 'string'; - } else { + } elseif ( is_numeric( $default_value ) ) { // try to guess numeric fields, although this is not perfect. - if ( is_numeric( $default_value ) ) { - $field_type = is_float( $default_value ) ? 'float' : 'integer'; - } + $field_type = is_float( $default_value ) ? 'float' : 'integer'; } if ( $default_value ) { diff --git a/lib/zoninator_rest/model/declaration/class-zoninator-rest-model-declaration-settings.php b/lib/zoninator_rest/model/declaration/class-zoninator-rest-model-declaration-settings.php index ed3f69d..f1fcfc3 100644 --- a/lib/zoninator_rest/model/declaration/class-zoninator-rest-model-declaration-settings.php +++ b/lib/zoninator_rest/model/declaration/class-zoninator-rest-model-declaration-settings.php @@ -137,11 +137,9 @@ private function field_declaration_builder_from_data( $env, $field_data ) { ->with_deserializer( array( $this, 'bit_to_bool' ) ); } elseif ( 'select' === $setting_type ) { $field_type = 'string'; - } else { + } elseif ( is_numeric( $default_value ) ) { // try to guess numeric fields, although this is not perfect. - if ( is_numeric( $default_value ) ) { - $field_type = is_float( $default_value ) ? 'float' : 'integer'; - } + $field_type = is_float( $default_value ) ? 'float' : 'integer'; } if ( $default_value ) { diff --git a/rector.php b/rector.php index e13147b..6ee3e51 100644 --- a/rector.php +++ b/rector.php @@ -23,5 +23,5 @@ ) ->withPhpSets( php74: true ) ->withPreparedSets( deadCode: true ) - ->withCodeQualityLevel( 29 ) + ->withCodeQualityLevel( 34 ) ->withTypeCoverageLevel( 1 ); From c1340e75ea031f865b8faf16ed73e19b6cc92d44 Mon Sep 17 00:00:00 2001 From: Gary Jones Date: Sat, 10 Aug 2024 23:17:37 +0100 Subject: [PATCH 28/56] CS: Rector with CodeQuality level 35 ExplicitReturnNullRector --- rector.php | 2 +- zoninator.php | 3 +++ 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/rector.php b/rector.php index 6ee3e51..35378d8 100644 --- a/rector.php +++ b/rector.php @@ -23,5 +23,5 @@ ) ->withPhpSets( php74: true ) ->withPreparedSets( deadCode: true ) - ->withCodeQualityLevel( 34 ) + ->withCodeQualityLevel( 35 ) ->withTypeCoverageLevel( 1 ); diff --git a/zoninator.php b/zoninator.php index 287905c..60ebd54 100644 --- a/zoninator.php +++ b/zoninator.php @@ -88,6 +88,7 @@ public function maybe_add_rest_api() { include_once 'includes/class-zoninator-api.php'; $this->rest_api = new Zoninator_Api( $this ); + return null; } function add_zone_feed() { @@ -1339,6 +1340,7 @@ function lock_zone( $zone, $user_id = 0 ) { set_transient( $lock_key, $user->ID, $expiry ); // Possible alternative: set zone lock as property with time and user + return null; } // Not really needed with transients... @@ -1352,6 +1354,7 @@ function unlock_zone( $zone ) { $lock_key = $this->get_zone_meta_key( $zone ); delete_transient( $lock_key ); + return null; } function is_zone_locked( $zone ) { From 4098dfdad432e8225d4ad427038a608215c9af11 Mon Sep 17 00:00:00 2001 From: Gary Jones Date: Sat, 10 Aug 2024 23:19:42 +0100 Subject: [PATCH 29/56] CS: Rector with CodeQuality level 38 AbsolutizeRequireAndIncludePathRector --- includes/class-zoninator-api.php | 6 +++--- lib/zoninator_rest/class-zoninator-rest-bootstrap.php | 4 ++-- rector.php | 2 +- zoninator.php | 2 +- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/includes/class-zoninator-api.php b/includes/class-zoninator-api.php index 02b1d34..1d0a756 100644 --- a/includes/class-zoninator-api.php +++ b/includes/class-zoninator-api.php @@ -30,9 +30,9 @@ public function __construct( $instance ) { function rest_api() { include_once ZONINATOR_PATH . '/lib/zoninator_rest/class-zoninator-rest-bootstrap.php'; $this->bootstrap = Zoninator_REST_Bootstrap::create()->load(); - include_once 'class-zoninator-api-schema-converter.php'; - include_once 'class-zoninator-api-filter-search.php'; - include_once 'class-zoninator-api-controller.php'; + include_once __DIR__ . '/class-zoninator-api-schema-converter.php'; + include_once __DIR__ . '/class-zoninator-api-filter-search.php'; + include_once __DIR__ . '/class-zoninator-api-controller.php'; $env = $this->bootstrap->environment(); $env->define_model( 'Zoninator_Api_Filter_Search' ); diff --git a/lib/zoninator_rest/class-zoninator-rest-bootstrap.php b/lib/zoninator_rest/class-zoninator-rest-bootstrap.php index d50991b..8a1bf17 100644 --- a/lib/zoninator_rest/class-zoninator-rest-bootstrap.php +++ b/lib/zoninator_rest/class-zoninator-rest-bootstrap.php @@ -69,8 +69,8 @@ public static function get_base_dir() { */ public static function create( $class_loader = null ) { if ( empty( $class_loader ) ) { - include_once 'interfaces/class-zoninator-rest-interfaces-classloader.php'; - include_once 'class-zoninator-rest-classloader.php'; + include_once __DIR__ . '/interfaces/class-zoninator-rest-interfaces-classloader.php'; + include_once __DIR__ . '/class-zoninator-rest-classloader.php'; $prefix = str_replace( '_Bootstrap', '', self::class ); $base_dir = self::get_base_dir(); $class_loader = new Zoninator_REST_Classloader( $prefix, $base_dir ); diff --git a/rector.php b/rector.php index 35378d8..62e97ad 100644 --- a/rector.php +++ b/rector.php @@ -23,5 +23,5 @@ ) ->withPhpSets( php74: true ) ->withPreparedSets( deadCode: true ) - ->withCodeQualityLevel( 35 ) + ->withCodeQualityLevel( 38 ) ->withTypeCoverageLevel( 1 ); diff --git a/zoninator.php b/zoninator.php index 60ebd54..aae09f9 100644 --- a/zoninator.php +++ b/zoninator.php @@ -86,7 +86,7 @@ public function maybe_add_rest_api() { return false; } - include_once 'includes/class-zoninator-api.php'; + include_once __DIR__ . '/includes/class-zoninator-api.php'; $this->rest_api = new Zoninator_Api( $this ); return null; } From 41769bc007c84805ed5a3ee4f2f23c688bce5539 Mon Sep 17 00:00:00 2001 From: Gary Jones Date: Sat, 10 Aug 2024 23:24:26 +0100 Subject: [PATCH 30/56] CS: Rector with CodeQuality level 39 ChangeArrayPushToArrayAssignRector --- rector.php | 2 +- zoninator.php | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/rector.php b/rector.php index 62e97ad..f10ac88 100644 --- a/rector.php +++ b/rector.php @@ -23,5 +23,5 @@ ) ->withPhpSets( php74: true ) ->withPreparedSets( deadCode: true ) - ->withCodeQualityLevel( 38 ) + ->withCodeQualityLevel( 39 ) ->withTypeCoverageLevel( 1 ); diff --git a/zoninator.php b/zoninator.php index aae09f9..c18868e 100644 --- a/zoninator.php +++ b/zoninator.php @@ -955,7 +955,7 @@ function get_supported_post_types() { foreach ( get_post_types() as $post_type ) { if ( post_type_supports( $post_type, $this->zone_taxonomy ) ) { - array_push( $this->post_types, $post_type ); + $this->post_types[] = $post_type; } } From 5c7b9bc2d89a9a294c09cf2e2832c5731dc3a02d Mon Sep 17 00:00:00 2001 From: Gary Jones Date: Sat, 10 Aug 2024 23:31:39 +0100 Subject: [PATCH 31/56] CS: Rector with CodeQuality level 48 IssetOnPropertyObjectToPropertyExistsRector --- .../field/class-zoninator-rest-field-declaration.php | 6 +++--- rector.php | 2 +- zoninator.php | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/lib/zoninator_rest/field/class-zoninator-rest-field-declaration.php b/lib/zoninator_rest/field/class-zoninator-rest-field-declaration.php index df5ad47..d2f5aaf 100644 --- a/lib/zoninator_rest/field/class-zoninator-rest-field-declaration.php +++ b/lib/zoninator_rest/field/class-zoninator-rest-field-declaration.php @@ -245,7 +245,7 @@ public function is_kind( $kind ) { * @return mixed */ public function get_default_value() { - if ( isset( $this->default_value ) && ! empty( $this->default_value ) ) { + if ( $this->default_value !== null && ! empty( $this->default_value ) ) { return ( is_array( $this->default_value ) && is_callable( $this->default_value ) ) ? call_user_func( $this->default_value ) : $this->default_value; } @@ -292,7 +292,7 @@ public function as_item_schema_property() { * Get Map From */ public function get_map_from() { - if ( isset( $this->map_from ) && ! empty( $this->map_from ) ) { + if ( $this->map_from !== null && ! empty( $this->map_from ) ) { return $this->map_from; } @@ -341,7 +341,7 @@ public function is_required() { * @return string */ public function get_description() { - if ( isset( $this->description ) && ! empty( $this->description ) ) { + if ( $this->description !== null && ! empty( $this->description ) ) { return $this->description; } return ucfirst( str_replace( '_', ' ', $this->get_name() ) ); diff --git a/rector.php b/rector.php index f10ac88..63641a6 100644 --- a/rector.php +++ b/rector.php @@ -23,5 +23,5 @@ ) ->withPhpSets( php74: true ) ->withPreparedSets( deadCode: true ) - ->withCodeQualityLevel( 39 ) + ->withCodeQualityLevel( 48 ) ->withTypeCoverageLevel( 1 ); diff --git a/zoninator.php b/zoninator.php index c18868e..e2c7bdb 100644 --- a/zoninator.php +++ b/zoninator.php @@ -947,7 +947,7 @@ function ajax_update_lock() { } function get_supported_post_types() { - if ( isset( $this->post_types ) ) { + if ( $this->post_types !== null ) { return $this->post_types; } From a731820a430f9ae3250b3e44e54483e6f2f837e3 Mon Sep 17 00:00:00 2001 From: Gary Jones Date: Sat, 10 Aug 2024 23:33:13 +0100 Subject: [PATCH 32/56] CS: Rector with CodeQuality level 51 SwitchNegatedTernaryRector --- rector.php | 2 +- zoninator.php | 12 ++++++------ 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/rector.php b/rector.php index 63641a6..a08b9b7 100644 --- a/rector.php +++ b/rector.php @@ -23,5 +23,5 @@ ) ->withPhpSets( php74: true ) ->withPreparedSets( deadCode: true ) - ->withCodeQualityLevel( 48 ) + ->withCodeQualityLevel( 51 ) ->withTypeCoverageLevel( 1 ); diff --git a/zoninator.php b/zoninator.php index e2c7bdb..edc8de8 100644 --- a/zoninator.php +++ b/zoninator.php @@ -295,7 +295,7 @@ function admin_page() { } $active_zone_id = $this->_get_request_var( 'zone_id', $default_active_zone, 'absint' ); - $active_zone = ! empty( $active_zone_id ) ? $this->get_zone( $active_zone_id ) : array(); + $active_zone = empty( $active_zone_id ) ? array() : $this->get_zone( $active_zone_id ); if ( ! empty( $active_zone ) ) { $title = __( 'Edit Zone', 'zoninator' ); } @@ -748,7 +748,7 @@ function is_zoninator_page() { } function ajax_return( $status, $content = '', $action = '' ) { - $action = ! empty( $action ) ? $action : $this->zone_ajax_nonce_action; + $action = empty( $action ) ? $this->zone_ajax_nonce_action : $action; $nonce = wp_create_nonce( $this->_get_nonce_key( $action ) ); echo json_encode( @@ -915,7 +915,7 @@ function ajax_search_posts() { $stripped_posts[] = apply_filters( 'zoninator_search_results_post', array( - 'title' => ! empty( $post->post_title ) ? $post->post_title : __( '(no title)', 'zoninator' ), + 'title' => empty( $post->post_title ) ? __( '(no title)', 'zoninator' ) : $post->post_title, 'post_id' => $post->ID, 'date' => get_the_time( get_option( 'date_format' ), $post ), 'post_type' => $post->post_type, @@ -1001,7 +1001,7 @@ function insert_zone( $slug, $name = '', $details = array() ) { } $slug = $this->get_formatted_zone_slug( $slug ); - $name = ! empty( $name ) ? $name : $slug; + $name = empty( $name ) ? $slug : $name; $details = wp_parse_args( $details, $this->zone_detail_defaults ); $details = maybe_serialize( stripslashes_deep( $details ) ); @@ -1675,9 +1675,9 @@ function _sanitize_value( $var ) { function _get_value_or_default( $var, $object, $default = '', $sanitize_callback = '' ) { if ( is_object( $object ) ) { - $value = ! empty( $object->$var ) ? $object->$var : $default; + $value = empty( $object->$var ) ? $default : $object->$var; } elseif ( is_array( $object ) ) { - $value = ! empty( $object[ $var ] ) ? $object[ $var ] : $default; + $value = empty( $object[ $var ] ) ? $default : $object[ $var ]; } else { $value = $default; } From 0c958deeee2c0b5203e75418d627937eb43870fe Mon Sep 17 00:00:00 2001 From: Gary Jones Date: Sat, 10 Aug 2024 23:35:23 +0100 Subject: [PATCH 33/56] CS: Rector with CodeQuality level 57 CountArrayToEmptyArrayComparisonRector --- lib/zoninator_rest/class-zoninator-rest-model.php | 2 +- rector.php | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/zoninator_rest/class-zoninator-rest-model.php b/lib/zoninator_rest/class-zoninator-rest-model.php index e4a4ca0..70b2415 100644 --- a/lib/zoninator_rest/class-zoninator-rest-model.php +++ b/lib/zoninator_rest/class-zoninator-rest-model.php @@ -155,7 +155,7 @@ public function validate() { $validation_errors[] = $is_valid->get_error_data(); } } - if ( count( $validation_errors ) > 0 ) { + if ( $validation_errors !== array() ) { return $this->validation_error( $validation_errors ); } return true; diff --git a/rector.php b/rector.php index a08b9b7..8456a8f 100644 --- a/rector.php +++ b/rector.php @@ -23,5 +23,5 @@ ) ->withPhpSets( php74: true ) ->withPreparedSets( deadCode: true ) - ->withCodeQualityLevel( 51 ) + ->withCodeQualityLevel( 57 ) ->withTypeCoverageLevel( 1 ); From 1e46ade3bc0a5848dc8eb2ad390172e711673a69 Mon Sep 17 00:00:00 2001 From: Gary Jones Date: Mon, 12 Aug 2024 21:18:58 +0100 Subject: [PATCH 34/56] CS: Rector with CodeQuality level 65 SimplifyEmptyCheckOnEmptyArrayRector --- includes/class-zoninator-api-schema-converter.php | 2 +- .../controller/class-zoninator-rest-controller-model.php | 2 +- rector.php | 2 +- zoninator.php | 4 ++-- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/includes/class-zoninator-api-schema-converter.php b/includes/class-zoninator-api-schema-converter.php index 6b23284..2100d08 100644 --- a/includes/class-zoninator-api-schema-converter.php +++ b/includes/class-zoninator-api-schema-converter.php @@ -29,7 +29,7 @@ public function as_schema( $model_definition ) { 'properties' => (array) apply_filters( 'rest_api_schema_properties', $properties, $model_definition ), ); - if ( ! empty( $required ) ) { + if ( $required !== array() ) { $schema['required'] = $required; } diff --git a/lib/zoninator_rest/controller/class-zoninator-rest-controller-model.php b/lib/zoninator_rest/controller/class-zoninator-rest-controller-model.php index a38caa3..84e2f62 100644 --- a/lib/zoninator_rest/controller/class-zoninator-rest-controller-model.php +++ b/lib/zoninator_rest/controller/class-zoninator-rest-controller-model.php @@ -104,7 +104,7 @@ public function get_item_schema() { 'properties' => (array) apply_filters( 'mixtape_rest_api_schema_properties', $properties, $this->get_model_prototype() ), ); - if ( ! empty( $required ) ) { + if ( $required !== array() ) { $schema['required'] = $required; } diff --git a/rector.php b/rector.php index 8456a8f..0ad2e09 100644 --- a/rector.php +++ b/rector.php @@ -23,5 +23,5 @@ ) ->withPhpSets( php74: true ) ->withPreparedSets( deadCode: true ) - ->withCodeQualityLevel( 57 ) + ->withCodeQualityLevel( 65 ) ->withTypeCoverageLevel( 1 ); diff --git a/zoninator.php b/zoninator.php index edc8de8..984ee5e 100644 --- a/zoninator.php +++ b/zoninator.php @@ -829,7 +829,7 @@ function ajax_reorder_posts() { $this->verify_access( '', $zone_id ); // validate - if ( ! $zone_id || empty( $post_ids ) ) { + if ( ! $zone_id || $post_ids === array() ) { $this->ajax_return( 0 ); } @@ -1242,7 +1242,7 @@ function get_single_post_in_zone( $zone, $args = array() ) { $post = $this->get_zone_posts( $zone, $args ); - if ( is_array( $post ) && ! empty( $post ) ) { + if ( is_array( $post ) && $post !== array() ) { return array_pop( $post ); } From ca9225801af7a0f1ebe3901973aea41301ffb4a8 Mon Sep 17 00:00:00 2001 From: Gary Jones Date: Mon, 12 Aug 2024 21:37:39 +0100 Subject: [PATCH 35/56] CS: Rector with CodeQuality level 70 LocallyCalledStaticMethodToNonStaticRector --- lib/zoninator_rest/class-zoninator-rest-model.php | 4 ++-- rector.php | 7 ++++++- zoninator.php | 8 ++++---- 3 files changed, 12 insertions(+), 7 deletions(-) diff --git a/lib/zoninator_rest/class-zoninator-rest-model.php b/lib/zoninator_rest/class-zoninator-rest-model.php index 70b2415..b1b867e 100644 --- a/lib/zoninator_rest/class-zoninator-rest-model.php +++ b/lib/zoninator_rest/class-zoninator-rest-model.php @@ -282,7 +282,7 @@ public function get_fields( $filter_by_type = null ) { $instance = new $class_name(); if ( ! isset( self::$fields_by_class_name[ $class_name ] ) ) { $fields = $instance->declare_fields(); - self::$fields_by_class_name[ $class_name ] = self::initialize_field_map( $fields ); + self::$fields_by_class_name[ $class_name ] = $this->initialize_field_map( $fields ); } if ( null === $filter_by_type ) { @@ -311,7 +311,7 @@ public function get_fields( $filter_by_type = null ) { * * @return array */ - private static function initialize_field_map( $declared_field_builders ) { + private function initialize_field_map( $declared_field_builders ) { $fields = array(); foreach ( $declared_field_builders as $field_builder ) { /** diff --git a/rector.php b/rector.php index 0ad2e09..647b34b 100644 --- a/rector.php +++ b/rector.php @@ -4,6 +4,7 @@ use Rector\Config\RectorConfig; use Rector\Php54\Rector\Array_\LongArrayToShortArrayRector; +use Rector\Strict\Rector\Empty_\DisallowedEmptyRuleFixerRector; return RectorConfig::configure() ->withPaths( @@ -19,9 +20,13 @@ ->withSkip( array( LongArrayToShortArrayRector::class, + // Need a better understanding of intent in this file before switching out the use of empty(). + DisallowedEmptyRuleFixerRector::class => array( + __DIR__ . '/lib/zoninator_rest/type/class-zoninator-rest-type-registry.php', + ), ) ) ->withPhpSets( php74: true ) ->withPreparedSets( deadCode: true ) - ->withCodeQualityLevel( 65 ) + ->withCodeQualityLevel( 70 ) ->withTypeCoverageLevel( 1 ); diff --git a/zoninator.php b/zoninator.php index 984ee5e..de9edab 100644 --- a/zoninator.php +++ b/zoninator.php @@ -1505,7 +1505,7 @@ function do_zoninator_feeds() { $zone_slug = get_query_var( $this->zone_taxonomy ); $results = $this->get_zone_feed( $zone_slug ); if ( is_wp_error( $results ) ) { - self::send_user_error( $results->get_error_message() ); + $this->send_user_error( $results->get_error_message() ); } $this->json_return( $results ); } @@ -1552,8 +1552,8 @@ private function json_return( $data ) { exit(); } - private static function send_user_error( $message ) { - self::status_header_with_message( 406, $message ); + private function send_user_error( $message ) { + $this->status_header_with_message( 406, $message ); exit(); } @@ -1564,7 +1564,7 @@ private static function send_user_error( $message ) { * @param int $status * @param string $message */ - private static function status_header_with_message( $status, $message ) { + private function status_header_with_message( $status, $message ) { global $wp_header_to_desc; $status = absint( $status ); From 2ca2c1dadeffa352d6f428d366f29cb32732d284 Mon Sep 17 00:00:00 2001 From: Gary Jones Date: Wed, 14 Aug 2024 11:23:51 +0100 Subject: [PATCH 36/56] CS: Rector with CodingStyle EncapsedStringsToSprintfRector --- rector.php | 11 +++++++++-- tests/bootstrap.php | 2 +- 2 files changed, 10 insertions(+), 3 deletions(-) diff --git a/rector.php b/rector.php index 647b34b..11651d7 100644 --- a/rector.php +++ b/rector.php @@ -2,9 +2,13 @@ declare(strict_types=1); +use Rector\CodingStyle\Rector\ClassMethod\MakeInheritedMethodVisibilitySameAsParentRector; +use Rector\CodingStyle\Rector\Stmt\NewlineAfterStatementRector; +use Rector\CodingStyle\Rector\String_\SymplifyQuoteEscapeRector; use Rector\Config\RectorConfig; use Rector\Php54\Rector\Array_\LongArrayToShortArrayRector; use Rector\Strict\Rector\Empty_\DisallowedEmptyRuleFixerRector; +use Rector\Visibility\Rector\ClassMethod\ExplicitPublicClassMethodRector; return RectorConfig::configure() ->withPaths( @@ -24,9 +28,12 @@ DisallowedEmptyRuleFixerRector::class => array( __DIR__ . '/lib/zoninator_rest/type/class-zoninator-rest-type-registry.php', ), + MakeInheritedMethodVisibilitySameAsParentRector::class, + NewlineAfterStatementRector::class, + SymplifyQuoteEscapeRector::class, + ExplicitPublicClassMethodRector::class, ) ) ->withPhpSets( php74: true ) - ->withPreparedSets( deadCode: true ) - ->withCodeQualityLevel( 70 ) + ->withPreparedSets( deadCode: true, codeQuality: true, instanceOf: true, codingStyle: true ) ->withTypeCoverageLevel( 1 ); diff --git a/tests/bootstrap.php b/tests/bootstrap.php index 774ef5f..69c2bc9 100644 --- a/tests/bootstrap.php +++ b/tests/bootstrap.php @@ -5,7 +5,7 @@ $_tests_dir = rtrim( sys_get_temp_dir(), '/\\' ) . '/wordpress-tests-lib'; } if ( ! file_exists( $_tests_dir . '/includes/functions.php' ) ) { - echo "Could not find $_tests_dir/includes/functions.php, have you run bin/install-wp-tests.sh ?" . PHP_EOL; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped + echo sprintf('Could not find %s/includes/functions.php, have you run bin/install-wp-tests.sh ?', $_tests_dir) . PHP_EOL; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped exit( 1 ); } From 97a353e492e7292f5c13eeb8a9b54d2c42eacf9b Mon Sep 17 00:00:00 2001 From: Gary Jones Date: Wed, 14 Aug 2024 11:26:09 +0100 Subject: [PATCH 37/56] CS: Rector with CodingStyle ExplicitPublicClassMethodRector --- includes/class-zoninator-api-controller.php | 16 +- .../class-zoninator-api-filter-search.php | 2 +- includes/class-zoninator-api.php | 2 +- .../class-zoninator-rest-bootstrap.php | 8 +- .../class-zoninator-rest-controller.php | 6 +- .../class-zoninator-rest-environment.php | 2 +- .../class-zoninator-rest-expect.php | 8 +- .../class-zoninator-rest-model.php | 12 +- .../class-zoninator-rest-type.php | 14 +- ...ninator-rest-controller-bundle-builder.php | 2 +- ...class-zoninator-rest-controller-bundle.php | 6 +- ...ss-zoninator-rest-controller-extension.php | 4 +- .../data/class-zoninator-rest-data-mapper.php | 6 +- .../class-zoninator-rest-data-serializer.php | 6 +- ...lass-zoninator-rest-data-store-builder.php | 6 +- ...class-zoninator-rest-field-declaration.php | 2 +- ...ninator-rest-field-declaration-builder.php | 2 +- ...lass-zoninator-rest-interfaces-builder.php | 2 +- ...-zoninator-rest-interfaces-classloader.php | 2 +- ...s-zoninator-rest-interfaces-controller.php | 2 +- .../class-zoninator-rest-interfaces-model.php | 18 +- ...-zoninator-rest-interfaces-registrable.php | 2 +- ...nator-rest-interfaces-model-collection.php | 2 +- ...ator-rest-interfaces-model-declaration.php | 14 +- ...class-zoninator-rest-model-declaration.php | 14 +- .../class-zoninator-rest-model-definition.php | 20 +-- ...inator-rest-model-declaration-settings.php | 12 +- ...oninator-rest-model-definition-builder.php | 12 +- .../class-zoninator-rest-type-integer.php | 2 +- .../class-zoninator-rest-type-nullable.php | 4 +- .../type/class-zoninator-rest-type-number.php | 8 +- .../class-zoninator-rest-type-registry.php | 2 +- .../type/class-zoninator-rest-type-string.php | 8 +- .../class-zoninator-rest-type-typedarray.php | 4 +- rector.php | 1 - .../class-zoninator-api-controller-test.php | 54 +++--- widget.zone-posts.php | 10 +- zoninator.php | 170 +++++++++--------- 38 files changed, 233 insertions(+), 234 deletions(-) diff --git a/includes/class-zoninator-api-controller.php b/includes/class-zoninator-api-controller.php index ed7c2b2..f0c3923 100644 --- a/includes/class-zoninator-api-controller.php +++ b/includes/class-zoninator-api-controller.php @@ -41,7 +41,7 @@ class Zoninator_Api_Controller extends Zoninator_REST_Controller { * @param string $base Base. * @param Zoninator $instance Instance. */ - function __construct( $instance ) { + public function __construct( $instance ) { $this->instance = $instance; $this->base = '/'; } @@ -49,7 +49,7 @@ function __construct( $instance ) { /** * Set up this controller */ - function setup() { + public function setup() { $this->translations = array( self::ZONE_NOT_FOUND => __( 'Zone not found', 'zoninator' ), self::INVALID_POST_ID => __( 'Invalid post id', 'zoninator' ), @@ -105,7 +105,7 @@ function setup() { * @param WP_REST_Request $request Full data about the request. * @return WP_Error|WP_REST_Response */ - function get_zones( $request ) { + public function get_zones( $request ) { $results = $this->instance->get_zones(); if ( is_wp_error( $results ) ) { @@ -127,7 +127,7 @@ function get_zones( $request ) { * @param WP_REST_Request $request Full data about the request. * @return WP_Error|WP_REST_Response */ - function create_zone( $request ) { + public function create_zone( $request ) { $name = $this->_get_param( $request, 'name', '' ); $slug = $this->_get_param( $request, 'slug', $name ); $description = $this->_get_param( $request, 'description', '' ); @@ -159,7 +159,7 @@ function create_zone( $request ) { * @param WP_REST_Request $request Full data about the request. * @return WP_Error|WP_REST_Response */ - function update_zone( $request ) { + public function update_zone( $request ) { $zone_id = $this->_get_param( $request, 'zone_id', 0, 'absint' ); $name = $this->_get_param( $request, 'name', '' ); $slug = $this->_get_param( $request, 'slug', '' ); @@ -203,7 +203,7 @@ function update_zone( $request ) { * @param WP_REST_Request $request Full data about the request. * @return WP_Error|WP_REST_Response */ - function delete_zone( $request ) { + public function delete_zone( $request ) { $zone_id = $this->_get_param( $request, 'zone_id', 0, 'absint' ); $zone = $this->instance->get_zone( $zone_id ); @@ -253,7 +253,7 @@ public function get_zone_posts( $request ) { * @param WP_REST_Request $request Full data about the request.] * @return WP_Error|WP_REST_Response */ - function update_zone_posts( $request ) { + public function update_zone_posts( $request ) { $zone_id = $this->_get_param( $request, 'zone_id', 0, 'absint' ); $post_ids = $this->_get_param( $request, 'post_ids', array() ); @@ -286,7 +286,7 @@ function update_zone_posts( $request ) { * @param WP_REST_Request $request Full data about the request. * @return WP_Error|WP_REST_Response */ - function zone_update_lock( $request ) { + public function zone_update_lock( $request ) { $zone_id = $this->_get_param( $request, 'zone_id', 0, 'absint' ); if ( ! $zone_id ) { return $this->_bad_request( self::ZONE_ID_REQUIRED, __( 'zone id required', 'zoninator' ) ); diff --git a/includes/class-zoninator-api-filter-search.php b/includes/class-zoninator-api-filter-search.php index 2da3039..54d1b8c 100644 --- a/includes/class-zoninator-api-filter-search.php +++ b/includes/class-zoninator-api-filter-search.php @@ -71,7 +71,7 @@ public function strip_tags( $item ) { return strip_tags( $item ); } - function date_before_set( $model, $item ) { + public function date_before_set( $model, $item ) { return $this->strip_tags( $this->strip_slashes( $item ) ); } } diff --git a/includes/class-zoninator-api.php b/includes/class-zoninator-api.php index 1d0a756..1ed8510 100644 --- a/includes/class-zoninator-api.php +++ b/includes/class-zoninator-api.php @@ -27,7 +27,7 @@ public function __construct( $instance ) { /** * Rest Api. */ - function rest_api() { + public function rest_api() { include_once ZONINATOR_PATH . '/lib/zoninator_rest/class-zoninator-rest-bootstrap.php'; $this->bootstrap = Zoninator_REST_Bootstrap::create()->load(); include_once __DIR__ . '/class-zoninator-api-schema-converter.php'; diff --git a/lib/zoninator_rest/class-zoninator-rest-bootstrap.php b/lib/zoninator_rest/class-zoninator-rest-bootstrap.php index 8a1bf17..003556a 100644 --- a/lib/zoninator_rest/class-zoninator-rest-bootstrap.php +++ b/lib/zoninator_rest/class-zoninator-rest-bootstrap.php @@ -98,7 +98,7 @@ public function run() { * * @return Zoninator_REST_Bootstrap $this */ - function register_autoload() { + public function register_autoload() { if ( function_exists( 'spl_autoload_register' ) ) { spl_autoload_register( array( $this->class_loader(), 'load_class' ), true ); } @@ -111,7 +111,7 @@ function register_autoload() { * @return Zoninator_REST_Bootstrap $this * @throws Exception In case a class/file is not found. */ - function load() { + public function load() { $this->class_loader() ->load_class( 'Interfaces_Data_Store' ) ->load_class( 'Interfaces_Registrable' ) @@ -162,7 +162,7 @@ function load() { * * @return Zoninator_REST_Bootstrap $this */ - function load_testing_classes() { + public function load_testing_classes() { $this->class_loader() ->load_class( 'Testing_TestCase' ) ->load_class( 'Testing_Model_TestCase' ) @@ -175,7 +175,7 @@ function load_testing_classes() { * * @return Zoninator_REST_Classloader */ - function class_loader() { + public function class_loader() { return $this->class_loader; } diff --git a/lib/zoninator_rest/class-zoninator-rest-controller.php b/lib/zoninator_rest/class-zoninator-rest-controller.php index efeb8de..b539716 100644 --- a/lib/zoninator_rest/class-zoninator-rest-controller.php +++ b/lib/zoninator_rest/class-zoninator-rest-controller.php @@ -252,7 +252,7 @@ public function delete_permissions_check( $request ) { * @param string $action One of (index, show, create, update, delete, any). * @return bool */ - function permissions_check( $request, $action = 'any' ) { + public function permissions_check( $request, $action = 'any' ) { return true; } @@ -262,7 +262,7 @@ function permissions_check( $request, $action = 'any' ) { * @param string $pattern The route pattern (e.g. '/'). * @return Zoninator_REST_Controller_Route */ - function add_route( $pattern = '' ) { + public function add_route( $pattern = '' ) { $route = new Zoninator_REST_Controller_Route( $this, $pattern ); $this->routes[ $pattern ] = $route; return $this->routes[ $pattern ]; @@ -282,7 +282,7 @@ protected function environment() { * * @return string */ - function get_base() { + public function get_base() { return rest_url( $this->controller_bundle->get_prefix() . $this->base ); } } diff --git a/lib/zoninator_rest/class-zoninator-rest-environment.php b/lib/zoninator_rest/class-zoninator-rest-environment.php index 4305f0c..22f1bd8 100644 --- a/lib/zoninator_rest/class-zoninator-rest-environment.php +++ b/lib/zoninator_rest/class-zoninator-rest-environment.php @@ -373,7 +373,7 @@ public function rest_api( $maybe_bundle_or_prefix = null ) { * * @return Zoninator_REST_Model */ - function define_model( $declaration ) { + public function define_model( $declaration ) { Zoninator_REST_Expect::that( class_exists( $declaration ), '$declaration string should be an existing class' ); Zoninator_REST_Expect::that( in_array( 'Zoninator_REST_Interfaces_Model', class_implements( $declaration ), true ), '$declaration does not implement Zoninator_REST_Interfaces_Model' ); diff --git a/lib/zoninator_rest/class-zoninator-rest-expect.php b/lib/zoninator_rest/class-zoninator-rest-expect.php index 265bd67..b6db20d 100644 --- a/lib/zoninator_rest/class-zoninator-rest-expect.php +++ b/lib/zoninator_rest/class-zoninator-rest-expect.php @@ -23,7 +23,7 @@ class Zoninator_REST_Expect { * * @throws Zoninator_REST_Exception Fail if we got an unexpected class. */ - static function is_a( $thing, $class_name ) { + public static function is_a( $thing, $class_name ) { self::is_object( $thing ); self::that( is_a( $thing, $class_name ), 'Expected ' . $class_name . ', got ' . get_class( $thing ) ); } @@ -34,7 +34,7 @@ static function is_a( $thing, $class_name ) { * @param mixed $thing The thing. * @throws Zoninator_REST_Exception Throw if not an object. */ - static function is_object( $thing ) { + public static function is_object( $thing ) { self::that( is_object( $thing ), 'Variable is is not an Object' ); } @@ -46,7 +46,7 @@ static function is_object( $thing ) { * * @throws Zoninator_REST_Exception Fail if condition doesn't hold. */ - static function that( $cond, $fail_message ) { + public static function that( $cond, $fail_message ) { if ( ! $cond ) { throw new Zoninator_REST_Exception( $fail_message ); } @@ -59,7 +59,7 @@ static function that( $cond, $fail_message ) { * * @throws Zoninator_REST_Exception To Override this. */ - static function should_override( $method ) { + public static function should_override( $method ) { throw new Zoninator_REST_Exception( $method . ' should be overridden' ); } } diff --git a/lib/zoninator_rest/class-zoninator-rest-model.php b/lib/zoninator_rest/class-zoninator-rest-model.php index b1b867e..89f5bc1 100644 --- a/lib/zoninator_rest/class-zoninator-rest-model.php +++ b/lib/zoninator_rest/class-zoninator-rest-model.php @@ -66,7 +66,7 @@ class Zoninator_REST_Model implements * * @throws Zoninator_REST_Exception Throws when data is not an array. */ - function __construct( $data = array(), $args = array() ) { + public function __construct( $data = array(), $args = array() ) { Zoninator_REST_Expect::that( is_array( $data ), '$data should be an array' ); $this->data = array(); @@ -403,7 +403,7 @@ public function create( $data, $args = array() ) { * @return Zoninator_REST_Interfaces_Model|WP_Error * @throws Zoninator_REST_Exception Throws. */ - function update_from_array( $data, $updating = false ) { + public function update_from_array( $data, $updating = false ) { $mapped_data = self::map_data( $data, $updating ); foreach ( $mapped_data as $name => $value ) { $this->set( $name, $value ); @@ -449,7 +449,7 @@ public function get_dto_field_mappings() { * * @return array */ - function to_dto() { + public function to_dto() { $result = array(); foreach ( $this->get_dto_field_mappings() as $mapping_name => $field_name ) { $value = $this->get( $field_name ); @@ -529,7 +529,7 @@ public function declare_fields() { * * @return mixed|null */ - function get_id() { + public function get_id() { return $this->get( 'id' ); } @@ -540,7 +540,7 @@ function get_id() { * * @return mixed|null */ - function set_id( $new_id ) { + public function set_id( $new_id ) { return $this->set( 'id', $new_id ); } @@ -610,7 +610,7 @@ public function deserialize( $data ) { * * @return array */ - function serialize( $field_type = null ) { + public function serialize( $field_type = null ) { $field_values_to_insert = array(); foreach ( $this->get_fields( $field_type ) as $field_declaration ) { /** diff --git a/lib/zoninator_rest/class-zoninator-rest-type.php b/lib/zoninator_rest/class-zoninator-rest-type.php index 309363a..163f80f 100644 --- a/lib/zoninator_rest/class-zoninator-rest-type.php +++ b/lib/zoninator_rest/class-zoninator-rest-type.php @@ -24,7 +24,7 @@ class Zoninator_REST_Type implements Zoninator_REST_Interfaces_Type { * * @param string $identifier The identifier. */ - function __construct( $identifier ) { + public function __construct( $identifier ) { $this->identifier = $identifier; } @@ -33,14 +33,14 @@ function __construct( $identifier ) { * * @return string */ - function name() { + public function name() { return $this->identifier; } /** * The default value */ - function default_value() { + public function default_value() { return null; } @@ -51,7 +51,7 @@ function default_value() { * * @return mixed */ - function cast( $value ) { + public function cast( $value ) { return $value; } @@ -62,7 +62,7 @@ function cast( $value ) { * * @return mixed */ - function sanitize( $value ) { + public function sanitize( $value ) { return $value; } @@ -71,7 +71,7 @@ function sanitize( $value ) { * * @return array */ - function schema() { + public function schema() { return array( 'type' => $this->name(), ); @@ -82,7 +82,7 @@ function schema() { * * @return Zoninator_REST_Type */ - static function any() { + public static function any() { return new self( 'any' ); } } diff --git a/lib/zoninator_rest/controller/bundle/class-zoninator-rest-controller-bundle-builder.php b/lib/zoninator_rest/controller/bundle/class-zoninator-rest-controller-bundle-builder.php index b584046..c6385b1 100644 --- a/lib/zoninator_rest/controller/bundle/class-zoninator-rest-controller-bundle-builder.php +++ b/lib/zoninator_rest/controller/bundle/class-zoninator-rest-controller-bundle-builder.php @@ -38,7 +38,7 @@ class Zoninator_REST_Controller_Bundle_Builder implements Zoninator_REST_Interfa * * @param Zoninator_REST_Interfaces_Controller_Bundle|null $bundle Bundle. */ - function __construct( $bundle = null ) { + public function __construct( $bundle = null ) { $this->bundle = $bundle; } diff --git a/lib/zoninator_rest/controller/class-zoninator-rest-controller-bundle.php b/lib/zoninator_rest/controller/class-zoninator-rest-controller-bundle.php index 0a18be6..9fe0c04 100644 --- a/lib/zoninator_rest/controller/class-zoninator-rest-controller-bundle.php +++ b/lib/zoninator_rest/controller/class-zoninator-rest-controller-bundle.php @@ -40,7 +40,7 @@ class Zoninator_REST_Controller_Bundle implements Zoninator_REST_Interfaces_Cont * @param string $bundle_prefix Prefix. * @param array $endpoints Builders. */ - function __construct( $bundle_prefix, $endpoints ) { + public function __construct( $bundle_prefix, $endpoints ) { $this->prefix = $bundle_prefix; $this->endpoints = $endpoints; } @@ -52,7 +52,7 @@ function __construct( $bundle_prefix, $endpoints ) { * @return Zoninator_REST_Controller_Bundle $this * @throws Zoninator_REST_Exception When no prefix is defined. */ - function register( $environment ) { + public function register( $environment ) { Zoninator_REST_Expect::that( null !== $this->prefix, 'prefix should be defined' ); $this->environment = $environment; /** @@ -84,7 +84,7 @@ function register( $environment ) { * * @return string */ - function get_prefix() { + public function get_prefix() { return $this->prefix; } } diff --git a/lib/zoninator_rest/controller/class-zoninator-rest-controller-extension.php b/lib/zoninator_rest/controller/class-zoninator-rest-controller-extension.php index f996c6f..f8a7bcb 100644 --- a/lib/zoninator_rest/controller/class-zoninator-rest-controller-extension.php +++ b/lib/zoninator_rest/controller/class-zoninator-rest-controller-extension.php @@ -41,7 +41,7 @@ class Zoninator_REST_Controller_Extension implements Zoninator_REST_Interfaces_R * @param string $object_to_extend Post type. * @param string $model_definition_name Model Definition name. */ - function __construct( $object_to_extend, $model_definition_name ) { + public function __construct( $object_to_extend, $model_definition_name ) { $this->model_definition_name = $model_definition_name; $this->object_to_extend = $object_to_extend; } @@ -54,7 +54,7 @@ function __construct( $object_to_extend, $model_definition_name ) { * * @return bool|WP_Error true if valid otherwise error. */ - function register( $environment ) { + public function register( $environment ) { $this->environment = $environment; $this->model_definition = $this->environment->model( $this->model_definition_name ); if ( ! $this->model_definition ) { diff --git a/lib/zoninator_rest/data/class-zoninator-rest-data-mapper.php b/lib/zoninator_rest/data/class-zoninator-rest-data-mapper.php index ba932dd..929aff2 100644 --- a/lib/zoninator_rest/data/class-zoninator-rest-data-mapper.php +++ b/lib/zoninator_rest/data/class-zoninator-rest-data-mapper.php @@ -32,7 +32,7 @@ class Zoninator_REST_Data_Mapper { * @param Zoninator_REST_Model_Definition $definition Def. * @param Zoninator_REST_Data_Serializer $serializer Serializer. */ - function __construct( $definition, $serializer ) { + public function __construct( $definition, $serializer ) { $this->definition = $definition; $this->serializer = $serializer; } @@ -44,7 +44,7 @@ function __construct( $definition, $serializer ) { * @param array $field_declarations Declarations. * @return array */ - function raw_data_to_model_data( $data, $field_declarations ) { + public function raw_data_to_model_data( $data, $field_declarations ) { $raw_data = array(); $post_array_keys = array_keys( $data ); foreach ( $field_declarations as $declaration ) { @@ -76,7 +76,7 @@ function raw_data_to_model_data( $data, $field_declarations ) { * @param null|string $field_type Type. * @return array */ - function model_to_data( $model, $field_type = null ) { + public function model_to_data( $model, $field_type = null ) { $field_values_to_insert = array(); foreach ( $this->definition->get_field_declarations( $field_type ) as $field_declaration ) { /** diff --git a/lib/zoninator_rest/data/class-zoninator-rest-data-serializer.php b/lib/zoninator_rest/data/class-zoninator-rest-data-serializer.php index 4fa3f38..320155b 100644 --- a/lib/zoninator_rest/data/class-zoninator-rest-data-serializer.php +++ b/lib/zoninator_rest/data/class-zoninator-rest-data-serializer.php @@ -25,7 +25,7 @@ class Zoninator_REST_Data_Serializer { * * @param Zoninator_REST_Model_Definition $model_definition MD. */ - function __construct( $model_definition ) { + public function __construct( $model_definition ) { $this->model_declaration = $model_definition->get_model_declaration(); } @@ -36,7 +36,7 @@ function __construct( $model_definition ) { * @param mixed $value Value. * @return mixed the deserialized value */ - function deserialize( $field_declaration, $value ) { + public function deserialize( $field_declaration, $value ) { $deserializer = $field_declaration->get_deserializer(); return $deserializer ? $this->model_declaration->call( $deserializer, array( $value ) ) : $value; } @@ -49,7 +49,7 @@ function deserialize( $field_declaration, $value ) { * @return mixed * @throws Zoninator_REST_Exception If call fails. */ - function serialize( $field_declaration, $value ) { + public function serialize( $field_declaration, $value ) { $serializer = $field_declaration->get_serializer(); if ( isset( $serializer ) && ! empty( $serializer ) ) { return $this->model_declaration->call( $serializer, array( $value ) ); diff --git a/lib/zoninator_rest/data/store/class-zoninator-rest-data-store-builder.php b/lib/zoninator_rest/data/store/class-zoninator-rest-data-store-builder.php index dc6fc89..d0423d2 100644 --- a/lib/zoninator_rest/data/store/class-zoninator-rest-data-store-builder.php +++ b/lib/zoninator_rest/data/store/class-zoninator-rest-data-store-builder.php @@ -57,7 +57,7 @@ public function with_class( $data_store_class ) { * @param array $args Args. * @return Zoninator_REST_Data_Store_Builder $this */ - function with_args( $args ) { + public function with_args( $args ) { $this->args = $args; return $this; } @@ -68,7 +68,7 @@ function with_args( $args ) { * @param string|Zoninator_REST_Model_Definition $model_definition Def. * @return Zoninator_REST_Data_Store_Builder $this */ - function with_model_definition( $model_definition ) { + public function with_model_definition( $model_definition ) { $this->model_definition = $model_definition; return $this; } @@ -78,7 +78,7 @@ function with_model_definition( $model_definition ) { * * @return Zoninator_REST_Interfaces_Data_Store */ - function build() { + public function build() { $store_class = $this->store_class; return new $store_class( $this->model_definition, $this->args ); } diff --git a/lib/zoninator_rest/field/class-zoninator-rest-field-declaration.php b/lib/zoninator_rest/field/class-zoninator-rest-field-declaration.php index d2f5aaf..d70ca00 100644 --- a/lib/zoninator_rest/field/class-zoninator-rest-field-declaration.php +++ b/lib/zoninator_rest/field/class-zoninator-rest-field-declaration.php @@ -397,7 +397,7 @@ public function get_deserializer() { * * @return Zoninator_REST_Interfaces_Type */ - function get_type() { + public function get_type() { return $this->type; } diff --git a/lib/zoninator_rest/field/declaration/class-zoninator-rest-field-declaration-builder.php b/lib/zoninator_rest/field/declaration/class-zoninator-rest-field-declaration-builder.php index 53b4c4c..be1f932 100644 --- a/lib/zoninator_rest/field/declaration/class-zoninator-rest-field-declaration-builder.php +++ b/lib/zoninator_rest/field/declaration/class-zoninator-rest-field-declaration-builder.php @@ -20,7 +20,7 @@ class Zoninator_REST_Field_Declaration_Builder { /** * Constructor. */ - function __construct() { + public function __construct() { $this->args = array( 'name' => '', 'kind' => Zoninator_REST_Field_Declaration::FIELD, diff --git a/lib/zoninator_rest/interfaces/class-zoninator-rest-interfaces-builder.php b/lib/zoninator_rest/interfaces/class-zoninator-rest-interfaces-builder.php index 192f04c..3a664e4 100644 --- a/lib/zoninator_rest/interfaces/class-zoninator-rest-interfaces-builder.php +++ b/lib/zoninator_rest/interfaces/class-zoninator-rest-interfaces-builder.php @@ -18,5 +18,5 @@ interface Zoninator_REST_Interfaces_Builder { * * @return mixed */ - function build(); + public function build(); } diff --git a/lib/zoninator_rest/interfaces/class-zoninator-rest-interfaces-classloader.php b/lib/zoninator_rest/interfaces/class-zoninator-rest-interfaces-classloader.php index 055f81c..69272a4 100644 --- a/lib/zoninator_rest/interfaces/class-zoninator-rest-interfaces-classloader.php +++ b/lib/zoninator_rest/interfaces/class-zoninator-rest-interfaces-classloader.php @@ -21,5 +21,5 @@ interface Zoninator_REST_Interfaces_Classloader { * @param string $name The class to load. * @return Zoninator_REST_Interfaces_Classloader */ - function load_class( $name ); + public function load_class( $name ); } diff --git a/lib/zoninator_rest/interfaces/class-zoninator-rest-interfaces-controller.php b/lib/zoninator_rest/interfaces/class-zoninator-rest-interfaces-controller.php index b703f64..1104eec 100644 --- a/lib/zoninator_rest/interfaces/class-zoninator-rest-interfaces-controller.php +++ b/lib/zoninator_rest/interfaces/class-zoninator-rest-interfaces-controller.php @@ -22,5 +22,5 @@ interface Zoninator_REST_Interfaces_Controller { * * @return bool|WP_Error true if valid otherwise error. */ - function register( $bundle, $environment ); + public function register( $bundle, $environment ); } diff --git a/lib/zoninator_rest/interfaces/class-zoninator-rest-interfaces-model.php b/lib/zoninator_rest/interfaces/class-zoninator-rest-interfaces-model.php index a331269..0c4bbcd 100644 --- a/lib/zoninator_rest/interfaces/class-zoninator-rest-interfaces-model.php +++ b/lib/zoninator_rest/interfaces/class-zoninator-rest-interfaces-model.php @@ -20,7 +20,7 @@ interface Zoninator_REST_Interfaces_Model { * * @return mixed a unique identifier */ - function get_id(); + public function get_id(); /** * Set this model's unique identifier @@ -28,7 +28,7 @@ function get_id(); * @param mixed $new_id The new Id. * @return Zoninator_REST_Interfaces_Model $model This model. */ - function set_id( $new_id ); + public function set_id( $new_id ); /** * Get a field for this model @@ -38,7 +38,7 @@ function set_id( $new_id ); * * @return mixed|null */ - function get( $field_name, $args = array() ); + public function get( $field_name, $args = array() ); /** * Set a field for this model @@ -48,7 +48,7 @@ function get( $field_name, $args = array() ); * * @return Zoninator_REST_Interfaces_Model $this; */ - function set( $field, $value ); + public function set( $field, $value ); /** * Check if this model has a field @@ -57,7 +57,7 @@ function set( $field, $value ); * * @return bool */ - function has( $field ); + public function has( $field ); /** * Validate this Model instance. @@ -66,7 +66,7 @@ function has( $field ); * * @return bool|WP_Error true if valid otherwise error. */ - function validate(); + public function validate(); /** * Sanitize this Model's field values @@ -75,7 +75,7 @@ function validate(); * * @return Zoninator_REST_Interfaces_Model */ - function sanitize(); + public function sanitize(); /** * Get this model class fields @@ -137,7 +137,7 @@ public function to_dto(); * * @return mixed */ - function update_from_array( $data, $updating = false ); + public function update_from_array( $data, $updating = false ); /** * Transform Model to raw data array @@ -146,5 +146,5 @@ function update_from_array( $data, $updating = false ); * * @return array */ - function serialize( $field_type = null ); + public function serialize( $field_type = null ); } diff --git a/lib/zoninator_rest/interfaces/class-zoninator-rest-interfaces-registrable.php b/lib/zoninator_rest/interfaces/class-zoninator-rest-interfaces-registrable.php index 2d42d8a..a9666e8 100644 --- a/lib/zoninator_rest/interfaces/class-zoninator-rest-interfaces-registrable.php +++ b/lib/zoninator_rest/interfaces/class-zoninator-rest-interfaces-registrable.php @@ -20,5 +20,5 @@ interface Zoninator_REST_Interfaces_Registrable { * @param Zoninator_REST_Environment $environment The Environment to use. * @return void */ - function register( $environment ); + public function register( $environment ); } diff --git a/lib/zoninator_rest/interfaces/model/class-zoninator-rest-interfaces-model-collection.php b/lib/zoninator_rest/interfaces/model/class-zoninator-rest-interfaces-model-collection.php index f6bd910..97f15c5 100644 --- a/lib/zoninator_rest/interfaces/model/class-zoninator-rest-interfaces-model-collection.php +++ b/lib/zoninator_rest/interfaces/model/class-zoninator-rest-interfaces-model-collection.php @@ -18,5 +18,5 @@ interface Zoninator_REST_Interfaces_Model_Collection { * * @return Iterator */ - function get_items(); + public function get_items(); } diff --git a/lib/zoninator_rest/interfaces/model/class-zoninator-rest-interfaces-model-declaration.php b/lib/zoninator_rest/interfaces/model/class-zoninator-rest-interfaces-model-declaration.php index c5b4917..8e5acb8 100644 --- a/lib/zoninator_rest/interfaces/model/class-zoninator-rest-interfaces-model-declaration.php +++ b/lib/zoninator_rest/interfaces/model/class-zoninator-rest-interfaces-model-declaration.php @@ -25,14 +25,14 @@ interface Zoninator_REST_Interfaces_Model_Declaration { * @param Zoninator_REST_Model_Definition $def The definition. * @return mixed */ - function set_definition( $def ); + public function set_definition( $def ); /** * Get this Declaration's Definition * * @return Zoninator_REST_Model_Definition */ - function definition(); + public function definition(); /** * Declare the fields of our Model. @@ -40,7 +40,7 @@ function definition(); * @param Zoninator_REST_Environment $environment The Environment. * @return array list of Mixtape_Model_Field_Declaration */ - function declare_fields( $environment ); + public function declare_fields( $environment ); /** * Call a method @@ -49,7 +49,7 @@ function declare_fields( $environment ); * @param array $args The args. * @return mixed */ - function call( $method, $args = array() ); + public function call( $method, $args = array() ); /** * Get this model's unique identifier @@ -57,7 +57,7 @@ function call( $method, $args = array() ); * @param Zoninator_REST_Interfaces_Model $model The model. * @return mixed */ - function get_id( $model ); + public function get_id( $model ); /** * Set this model's unique identifier @@ -67,12 +67,12 @@ function get_id( $model ); * * @return Zoninator_REST_Interfaces_Model The model. */ - function set_id( $model, $id ); + public function set_id( $model, $id ); /** * Get the name * * @return string This declaration's name. */ - function get_name(); + public function get_name(); } diff --git a/lib/zoninator_rest/model/class-zoninator-rest-model-declaration.php b/lib/zoninator_rest/model/class-zoninator-rest-model-declaration.php index 6393073..efbebbd 100644 --- a/lib/zoninator_rest/model/class-zoninator-rest-model-declaration.php +++ b/lib/zoninator_rest/model/class-zoninator-rest-model-declaration.php @@ -27,7 +27,7 @@ class Zoninator_REST_Model_Declaration implements Zoninator_REST_Interfaces_Mode * * @return Zoninator_REST_Interfaces_Model_Declaration $this */ - function set_definition( $def ) { + public function set_definition( $def ) { $this->model_definition = $def; return $this; } @@ -37,7 +37,7 @@ function set_definition( $def ) { * * @return Zoninator_REST_Model_Definition */ - function definition() { + public function definition() { return $this->model_definition; } @@ -49,7 +49,7 @@ function definition() { * @return void * @throws Zoninator_REST_Exception Override this. */ - function declare_fields( $env ) { + public function declare_fields( $env ) { throw new Zoninator_REST_Exception( 'Override me: ' . __FUNCTION__ ); } @@ -60,7 +60,7 @@ function declare_fields( $env ) { * * @return mixed|null */ - function get_id( $model ) { + public function get_id( $model ) { return $model->get( 'id' ); } @@ -72,7 +72,7 @@ function get_id( $model ) { * * @return mixed|null */ - function set_id( $model, $new_id ) { + public function set_id( $model, $new_id ) { return $model->set( 'id', $new_id ); } @@ -85,7 +85,7 @@ function set_id( $model, $new_id ) { * @return mixed * @throws Zoninator_REST_Exception Throw if method nonexistent. */ - function call( $method, $args = array() ) { + public function call( $method, $args = array() ) { if ( is_callable( $method ) ) { return $this->perform_call( $method, $args ); } @@ -98,7 +98,7 @@ function call( $method, $args = array() ) { * * @return string */ - function get_name() { + public function get_name() { return strtolower( get_class( $this ) ); } diff --git a/lib/zoninator_rest/model/class-zoninator-rest-model-definition.php b/lib/zoninator_rest/model/class-zoninator-rest-model-definition.php index d2065f2..682b18e 100644 --- a/lib/zoninator_rest/model/class-zoninator-rest-model-definition.php +++ b/lib/zoninator_rest/model/class-zoninator-rest-model-definition.php @@ -70,7 +70,7 @@ class Zoninator_REST_Model_Definition implements Zoninator_REST_Interfaces_Permi * * @throws Zoninator_REST_Exception Throws if wrong types or null args provided. */ - function __construct( $environment, $model_declaration, $data_store, $permissions_provider ) { + public function __construct( $environment, $model_declaration, $data_store, $permissions_provider ) { Zoninator_REST_Expect::that( null !== $environment, '$environment cannot be null' ); Zoninator_REST_Expect::that( null !== $model_declaration, '$model_declaration cannot be null' ); Zoninator_REST_Expect::that( null !== $data_store, '$data_store cannot be null' ); @@ -95,7 +95,7 @@ function __construct( $environment, $model_declaration, $data_store, $permission * * @return string */ - function get_model_class() { + public function get_model_class() { return $this->model_class; } @@ -104,7 +104,7 @@ function get_model_class() { * * @return Zoninator_REST_Interfaces_Data_Store */ - function get_data_store() { + public function get_data_store() { return $this->data_store; } @@ -115,7 +115,7 @@ function get_data_store() { * @return $this * @throws Zoninator_REST_Exception Throws when Data Store Invalid. */ - function set_data_store( $data_store ) { + public function set_data_store( $data_store ) { if ( is_a( $data_store, 'Zoninator_REST_Data_Store_Builder' ) ) { $this->data_store = $data_store ->with_model_definition( $this ) @@ -134,7 +134,7 @@ function set_data_store( $data_store ) { * * @return Zoninator_REST_Environment */ - function environment() { + public function environment() { return $this->environment; } @@ -145,7 +145,7 @@ function environment() { * * @return array|null */ - function get_field_declarations( $filter_by_type = null ) { + public function get_field_declarations( $filter_by_type = null ) { $model_declaration = $this->get_model_declaration()->set_definition( $this ); Zoninator_REST_Expect::is_a( $model_declaration, 'Zoninator_REST_Interfaces_Model_Declaration' ); @@ -183,7 +183,7 @@ function get_field_declarations( $filter_by_type = null ) { * @return Zoninator_REST_Model * @throws Zoninator_REST_Exception Throws if data not an array. */ - function create_instance( $data ) { + public function create_instance( $data ) { if ( is_array( $data ) ) { return new Zoninator_REST_Model( $this, $data ); } @@ -201,7 +201,7 @@ function create_instance( $data ) { * @return Zoninator_REST_Interfaces_Model|WP_Error * @throws Zoninator_REST_Exception Throws. */ - function update_model_from_array( $model, $data, $updating = false ) { + public function update_model_from_array( $model, $data, $updating = false ) { $mapped_data = $this->map_data( $data, $updating ); foreach ( $mapped_data as $name => $value ) { $model->set( $name, $value ); @@ -234,7 +234,7 @@ public function new_from_array( $data ) { * * @return array */ - function get_dto_field_mappings() { + public function get_dto_field_mappings() { $mappings = array(); foreach ( $this->get_field_declarations() as $field_declaration ) { /** @@ -257,7 +257,7 @@ function get_dto_field_mappings() { * * @return array */ - function model_to_dto( $model ) { + public function model_to_dto( $model ) { $result = array(); foreach ( $this->get_dto_field_mappings() as $mapping_name => $field_name ) { $value = $model->get( $field_name ); diff --git a/lib/zoninator_rest/model/declaration/class-zoninator-rest-model-declaration-settings.php b/lib/zoninator_rest/model/declaration/class-zoninator-rest-model-declaration-settings.php index f1fcfc3..10f5d12 100644 --- a/lib/zoninator_rest/model/declaration/class-zoninator-rest-model-declaration-settings.php +++ b/lib/zoninator_rest/model/declaration/class-zoninator-rest-model-declaration-settings.php @@ -20,7 +20,7 @@ class Zoninator_REST_Model_Declaration_Settings extends Zoninator_REST_Model_Dec * * @throws Zoninator_REST_Exception Override this. */ - function get_settings() { + public function get_settings() { Zoninator_REST_Expect::that( false, 'Override this' ); } @@ -53,7 +53,7 @@ protected function on_field_setup( $field_name, $field_builder, $field_data, $en * @param Zoninator_REST_Environment $env Def. * @return array */ - function declare_fields( $env ) { + public function declare_fields( $env ) { $settings_per_group = $this->get_settings(); $fields = array(); @@ -74,7 +74,7 @@ function declare_fields( $env ) { * @param mixed $value Val. * @return string */ - function bool_to_bit( $value ) { + public function bool_to_bit( $value ) { return ( ! empty( $value ) && 'false' !== $value ) ? '1' : ''; } @@ -84,7 +84,7 @@ function bool_to_bit( $value ) { * @param mixed $value Val. * @return bool */ - function bit_to_bool( $value ) { + public function bit_to_bool( $value ) { return ! empty( $value ) && '0' !== $value; } @@ -94,7 +94,7 @@ function bit_to_bool( $value ) { * @param Zoninator_REST_Interfaces_Model $model Model. * @return string */ - function get_id( $model ) { + public function get_id( $model ) { return strtolower( get_class( $this ) ); } @@ -105,7 +105,7 @@ function get_id( $model ) { * @param mixed $new_id New ID. * @return Zoninator_REST_Interfaces_Model $this */ - function set_id( $model, $new_id ) { + public function set_id( $model, $new_id ) { return $this; } diff --git a/lib/zoninator_rest/model/definition/class-zoninator-rest-model-definition-builder.php b/lib/zoninator_rest/model/definition/class-zoninator-rest-model-definition-builder.php index fda5116..855945d 100644 --- a/lib/zoninator_rest/model/definition/class-zoninator-rest-model-definition-builder.php +++ b/lib/zoninator_rest/model/definition/class-zoninator-rest-model-definition-builder.php @@ -41,7 +41,7 @@ class Zoninator_REST_Model_Definition_Builder implements Zoninator_REST_Interfac /** * Zoninator_REST_Model_Definition_Builder constructor. */ - function __construct() { + public function __construct() { $this->with_data_store( new Zoninator_REST_Data_Store_Nil() ) ->with_permissions_provider( new Zoninator_REST_Permissions_Any() ); } @@ -52,7 +52,7 @@ function __construct() { * @param Zoninator_REST_Interfaces_Model_Declaration|Zoninator_REST_Interfaces_Permissions_Provider $declaration D. * @return Zoninator_REST_Model_Definition_Builder */ - function with_declaration( $declaration ) { + public function with_declaration( $declaration ) { if ( is_string( $declaration ) && class_exists( $declaration ) ) { $declaration = new $declaration(); } @@ -71,7 +71,7 @@ function with_declaration( $declaration ) { * * @return Zoninator_REST_Model_Definition_Builder $this */ - function with_data_store( $data_store = null ) { + public function with_data_store( $data_store = null ) { $this->data_store = $data_store; return $this; } @@ -81,7 +81,7 @@ function with_data_store( $data_store = null ) { * * @param Zoninator_REST_Interfaces_Permissions_Provider $permissions_provider Provider. */ - function with_permissions_provider( $permissions_provider ) { + public function with_permissions_provider( $permissions_provider ) { $this->permissions_provider = $permissions_provider; } @@ -92,7 +92,7 @@ function with_permissions_provider( $permissions_provider ) { * * @return Zoninator_REST_Model_Definition_Builder $this */ - function with_environment( $environment ) { + public function with_environment( $environment ) { $this->environment = $environment; return $this; } @@ -102,7 +102,7 @@ function with_environment( $environment ) { * * @return Zoninator_REST_Model_Definition */ - function build() { + public function build() { return new Zoninator_REST_Model_Definition( $this->environment, $this->declaration, $this->data_store, $this->permissions_provider ); } } diff --git a/lib/zoninator_rest/type/class-zoninator-rest-type-integer.php b/lib/zoninator_rest/type/class-zoninator-rest-type-integer.php index 440a098..238f825 100644 --- a/lib/zoninator_rest/type/class-zoninator-rest-type-integer.php +++ b/lib/zoninator_rest/type/class-zoninator-rest-type-integer.php @@ -59,7 +59,7 @@ public function cast( $value ) { * @param mixed $value Val. * @return int */ - function sanitize( $value ) { + public function sanitize( $value ) { return $this->cast( $value ); } } diff --git a/lib/zoninator_rest/type/class-zoninator-rest-type-nullable.php b/lib/zoninator_rest/type/class-zoninator-rest-type-nullable.php index 1841719..f5fc232 100644 --- a/lib/zoninator_rest/type/class-zoninator-rest-type-nullable.php +++ b/lib/zoninator_rest/type/class-zoninator-rest-type-nullable.php @@ -25,7 +25,7 @@ class Zoninator_REST_Type_Nullable extends Zoninator_REST_Type { * * @param Zoninator_REST_Interfaces_Type $item_type_definition Def. */ - function __construct( $item_type_definition ) { + public function __construct( $item_type_definition ) { parent::__construct( 'nullable:' . $item_type_definition->name() ); $this->item_type_definition = $item_type_definition; } @@ -66,7 +66,7 @@ public function sanitize( $value ) { /** * Schema */ - function schema() { + public function schema() { $schema = parent::schema(); $schema['type'] = array_unique( array_merge( $schema['type'], array( 'null' ) ) ); } diff --git a/lib/zoninator_rest/type/class-zoninator-rest-type-number.php b/lib/zoninator_rest/type/class-zoninator-rest-type-number.php index 0cdb773..b3663c8 100644 --- a/lib/zoninator_rest/type/class-zoninator-rest-type-number.php +++ b/lib/zoninator_rest/type/class-zoninator-rest-type-number.php @@ -17,7 +17,7 @@ class Zoninator_REST_Type_Number extends Zoninator_REST_Type { /** * Zoninator_REST_Type_Number constructor. */ - function __construct() { + public function __construct() { parent::__construct( 'number' ); } @@ -26,7 +26,7 @@ function __construct() { * * @return float */ - function default_value() { + public function default_value() { return 0.0; } @@ -36,7 +36,7 @@ function default_value() { * @param mixed $value The thing to cast. * @return float */ - function cast( $value ) { + public function cast( $value ) { if ( ! is_numeric( $value ) ) { return $this->default_value(); } @@ -49,7 +49,7 @@ function cast( $value ) { * @param mixed $value The value to sanitize. * @return float */ - function sanitize( $value ) { + public function sanitize( $value ) { return $this->cast( $value ); } } diff --git a/lib/zoninator_rest/type/class-zoninator-rest-type-registry.php b/lib/zoninator_rest/type/class-zoninator-rest-type-registry.php index 42d0cf9..98a54f1 100644 --- a/lib/zoninator_rest/type/class-zoninator-rest-type-registry.php +++ b/lib/zoninator_rest/type/class-zoninator-rest-type-registry.php @@ -54,7 +54,7 @@ public function define( $identifier, $instance ) { * * @throws Zoninator_REST_Exception In case of type name not confirming to syntax. */ - function definition( $type ) { + public function definition( $type ) { $types = $this->get_types(); if ( ! isset( $types[ $type ] ) ) { diff --git a/lib/zoninator_rest/type/class-zoninator-rest-type-string.php b/lib/zoninator_rest/type/class-zoninator-rest-type-string.php index 40ba8ac..040d06c 100644 --- a/lib/zoninator_rest/type/class-zoninator-rest-type-string.php +++ b/lib/zoninator_rest/type/class-zoninator-rest-type-string.php @@ -16,7 +16,7 @@ class Zoninator_REST_Type_String extends Zoninator_REST_Type { /** * Zoninator_REST_Type_String constructor. */ - function __construct() { + public function __construct() { parent::__construct( 'string' ); } @@ -26,7 +26,7 @@ function __construct() { * @param mixed $value Val. * @return string */ - function sanitize( $value ) { + public function sanitize( $value ) { return sanitize_text_field( $value ); } @@ -35,7 +35,7 @@ function sanitize( $value ) { * * @return string */ - function default_value() { + public function default_value() { return ''; } @@ -45,7 +45,7 @@ function default_value() { * @param mixed $value Val. * @return string */ - function cast( $value ) { + public function cast( $value ) { if ( is_array( $value ) ) { $cast_ones = array(); foreach ( $value as $v ) { diff --git a/lib/zoninator_rest/type/class-zoninator-rest-type-typedarray.php b/lib/zoninator_rest/type/class-zoninator-rest-type-typedarray.php index ced62e2..573c28a 100644 --- a/lib/zoninator_rest/type/class-zoninator-rest-type-typedarray.php +++ b/lib/zoninator_rest/type/class-zoninator-rest-type-typedarray.php @@ -28,7 +28,7 @@ class Zoninator_REST_Type_TypedArray extends Zoninator_REST_Type { * * @param Zoninator_REST_Interfaces_Type $item_type_definition The type. */ - function __construct( $item_type_definition ) { + public function __construct( $item_type_definition ) { parent::__construct( 'array:' . $item_type_definition->name() ); $this->item_type_definition = $item_type_definition; } @@ -62,7 +62,7 @@ public function cast( $value ) { * * @return array */ - function schema() { + public function schema() { $schema = parent::schema(); $schema['type'] = 'array'; $schema['items'] = $this->item_type_definition->schema(); diff --git a/rector.php b/rector.php index 11651d7..fc12e3f 100644 --- a/rector.php +++ b/rector.php @@ -31,7 +31,6 @@ MakeInheritedMethodVisibilitySameAsParentRector::class, NewlineAfterStatementRector::class, SymplifyQuoteEscapeRector::class, - ExplicitPublicClassMethodRector::class, ) ) ->withPhpSets( php74: true ) diff --git a/tests/unit/class-zoninator-api-controller-test.php b/tests/unit/class-zoninator-api-controller-test.php index 2f42a5d..5cf927d 100644 --- a/tests/unit/class-zoninator-api-controller-test.php +++ b/tests/unit/class-zoninator-api-controller-test.php @@ -22,7 +22,7 @@ class Zoninator_Api_Controller_Test extends WP_UnitTestCase { * @param WP_REST_Response $response Response. * @param int $status_code Code. */ - function assert_response_status( $response, $status_code ) { + public function assert_response_status( $response, $status_code ) { $this->assertEquals( $status_code, $response->get_status() ); } @@ -31,7 +31,7 @@ function assert_response_status( $response, $status_code ) { * * @return Zoninator_Api_Controller_Test */ - function login_as_admin() { + public function login_as_admin() { return $this->login_as( $this->admin_id ); } @@ -41,7 +41,7 @@ function login_as_admin() { * @param int $user_id U. * @return Zoninator_Api_Controller_Test $this */ - function login_as( $user_id ) { + public function login_as( $user_id ) { wp_set_current_user( $user_id ); return $this; } @@ -51,7 +51,7 @@ function login_as( $user_id ) { * * @param WP_REST_Response $response Response. */ - function assert_http_response_status_success( $response ) { + public function assert_http_response_status_success( $response ) { $this->assert_response_status( $response, MT_Controller::HTTP_OK ); } @@ -60,7 +60,7 @@ function assert_http_response_status_success( $response ) { * * @param WP_REST_Response $response Response. */ - function assert_http_response_status_created( $response ) { + public function assert_http_response_status_created( $response ) { $this->assert_response_status( $response, MT_Controller::HTTP_CREATED ); } @@ -69,7 +69,7 @@ function assert_http_response_status_created( $response ) { * * @param WP_REST_Response $response Response. */ - function assert_http_response_status_not_found( $response ) { + public function assert_http_response_status_not_found( $response ) { $this->assert_response_status( $response, MT_Controller::HTTP_NOT_FOUND ); } @@ -79,7 +79,7 @@ function assert_http_response_status_not_found( $response ) { * @param WP_REST_Response $response The Response. * @param int $status_code Expected status code. */ - function assertResponseStatus( $response, $status_code ) { + public function assertResponseStatus( $response, $status_code ) { $this->assertInstanceOf( 'WP_REST_Response', $response ); $this->assertEquals( $status_code, $response->get_status() ); } @@ -92,7 +92,7 @@ function assertResponseStatus( $response, $status_code ) { * @param array $args Any Data/Args. * @return WP_REST_Response */ - function request( $endpoint, $method, $args = array() ) { + public function request( $endpoint, $method, $args = array() ) { $request = new WP_REST_Request( $method, $endpoint ); foreach ( $args as $key => $value ) { $request->set_param( $key, $value ); @@ -107,7 +107,7 @@ function request( $endpoint, $method, $args = array() ) { * @param array $args Any Data/Args. * @return WP_REST_Response */ - function get( $endpoint, $args = array() ) { + public function get( $endpoint, $args = array() ) { return $this->request( $endpoint, 'GET', $args ); } @@ -118,7 +118,7 @@ function get( $endpoint, $args = array() ) { * @param array $args Any Data/Args. * @return WP_REST_Response */ - function post( $endpoint, $args = array() ) { + public function post( $endpoint, $args = array() ) { return $this->request( $endpoint, 'POST', $args ); } @@ -129,7 +129,7 @@ function post( $endpoint, $args = array() ) { * @param array $args Any Data/Args. * @return WP_REST_Response */ - function put( $endpoint, $args = array() ) { + public function put( $endpoint, $args = array() ) { return $this->request( $endpoint, 'PUT', $args ); } @@ -140,14 +140,14 @@ function put( $endpoint, $args = array() ) { * @param array $args Any Data/Args. * @return WP_REST_Response */ - function delete( $endpoint, $args = array() ) { + public function delete( $endpoint, $args = array() ) { return $this->request( $endpoint, 'DELETE', $args ); } /** * Setup */ - function setUp(): void { + public function setUp(): void { parent::setUp(); /** *The global @@ -180,7 +180,7 @@ function setUp(): void { * * @throws Exception E. */ - function test_create_zone_responds_with_created_when_method_post() { + public function test_create_zone_responds_with_created_when_method_post() { $this->login_as_admin(); $response = $this->post( '/zoninator/v1/zones', array( 'slug' => 'test-zone', @@ -193,7 +193,7 @@ function test_create_zone_responds_with_created_when_method_post() { * * @throws Exception E. */ - function test_create_zone_fail_if_invalid_data() { + public function test_create_zone_fail_if_invalid_data() { $this->login_as_admin(); $response = $this->post( '/zoninator/v1/zones', array( 'description' => 'No slug provided.' @@ -206,7 +206,7 @@ function test_create_zone_fail_if_invalid_data() { * * @throws Exception E */ - function test_create_zone_with_special_chars() { + public function test_create_zone_with_special_chars() { $this->login_as_admin(); $response = $this->post( '/zoninator/v1/zones', array( 'name' => '&<>!@#(', @@ -224,7 +224,7 @@ function test_create_zone_with_special_chars() { * * @throws Exception E. */ - function test_update_zone_responds_with_success_when_method_put() { + public function test_update_zone_responds_with_success_when_method_put() { $this->login_as_admin(); $zone_id = $this->create_a_zone( 'test-update-zone', 'Test Zone' ); $response = $this->put( '/zoninator/v1/zones/' . $zone_id, array( @@ -238,7 +238,7 @@ function test_update_zone_responds_with_success_when_method_put() { * * @throws Exception E. */ - function test_update_zone_responds_with_not_found_if_zone_not_exist() { + public function test_update_zone_responds_with_not_found_if_zone_not_exist() { $this->login_as_admin(); $response = $this->put( '/zoninator/v1/zones/666666', array( 'name' => 'Other test zone', @@ -251,7 +251,7 @@ function test_update_zone_responds_with_not_found_if_zone_not_exist() { * * @throws Exception E. */ - function test_delete_zone_responds_with_success_when_method_delete() { + public function test_delete_zone_responds_with_success_when_method_delete() { $this->login_as_admin(); $zone_id = $this->create_a_zone( 'test-update-zone', 'Test Zone' ); $response = $this->delete( '/zoninator/v1/zones/' . $zone_id ); @@ -263,7 +263,7 @@ function test_delete_zone_responds_with_success_when_method_delete() { * * @throws Exception E. */ - function test_delete_zone_responds_with_not_found_if_zone_not_exist() { + public function test_delete_zone_responds_with_not_found_if_zone_not_exist() { $this->login_as_admin(); $response = $this->delete( '/zoninator/v1/zones/666666' ); $this->assertResponseStatus( $response, 404 ); @@ -274,7 +274,7 @@ function test_delete_zone_responds_with_not_found_if_zone_not_exist() { * * @throws Exception E. */ - function test_update_zone_posts_responds_with_success_when_method_put() { + public function test_update_zone_posts_responds_with_success_when_method_put() { $this->login_as_admin(); $post_id = $this->_insert_a_post(); $zone_id = $this->create_a_zone( 'test-zone', 'Test Zone' ); @@ -289,7 +289,7 @@ function test_update_zone_posts_responds_with_success_when_method_put() { * * @throws Exception E. */ - function test_update_zone_posts_responds_with_not_found_if_zone_not_exist() { + public function test_update_zone_posts_responds_with_not_found_if_zone_not_exist() { $this->login_as_admin(); $post_id = $this->_insert_a_post(); $response = $this->put( '/zoninator/v1/zones/666666/posts', array( @@ -303,7 +303,7 @@ function test_update_zone_posts_responds_with_not_found_if_zone_not_exist() { * * @throws Exception E. */ - function test_update_zone_posts_fails_if_invalid_data() { + public function test_update_zone_posts_fails_if_invalid_data() { $this->login_as_admin(); $this->_insert_a_post(); $zone_id = $this->create_a_zone( 'test-zone', 'Test Zone' ); @@ -316,7 +316,7 @@ function test_update_zone_posts_fails_if_invalid_data() { * * @throws Exception E. */ - function test_update_zone_posts_fails_if_invalid_post_id() { + public function test_update_zone_posts_fails_if_invalid_post_id() { $this->login_as_admin(); $this->_insert_a_post(); $zone_id = $this->create_a_zone( 'test-zone', 'Test Zone' ); @@ -331,7 +331,7 @@ function test_update_zone_posts_fails_if_invalid_post_id() { * * @throws Exception E. */ - function test_get_zone_posts_success_when_valid_zone_and_posts() { + public function test_get_zone_posts_success_when_valid_zone_and_posts() { $this->login_as_admin(); self::factory()->post->create_many( 5 ); $query = new WP_Query(); @@ -349,7 +349,7 @@ function test_get_zone_posts_success_when_valid_zone_and_posts() { /** * Test test_get_zone_posts_success_when_no_posts_in_zone */ - function test_get_zone_posts_success_when_no_posts_in_zone() { + public function test_get_zone_posts_success_when_no_posts_in_zone() { $term_factory = new WP_UnitTest_Factory_For_Term( null, Zoninator()->zone_taxonomy ); $zone_id = $term_factory->create_object( array( 'name' => 'The Zone Add Post one', @@ -364,7 +364,7 @@ function test_get_zone_posts_success_when_no_posts_in_zone() { /** * Test test_get_zone_posts_not_found_when_invalid_zone */ - function test_get_zone_posts_not_found_when_invalid_zone() { + public function test_get_zone_posts_not_found_when_invalid_zone() { $term_factory = new WP_UnitTest_Factory_For_Term( null, Zoninator()->zone_taxonomy ); $zone_id = $term_factory->create_object( array( 'name' => 'The Zone Add Post one', diff --git a/widget.zone-posts.php b/widget.zone-posts.php index 80cfb0d..71a2ff0 100644 --- a/widget.zone-posts.php +++ b/widget.zone-posts.php @@ -5,7 +5,7 @@ */ class Zoninator_ZonePosts_Widget extends WP_Widget { - function __construct() { + public function __construct() { $widget_ops = array( 'classname' => 'widget-zone-posts', 'description' => __( 'Use this widget to display a list of posts from any zone.', 'zoninator' ), @@ -23,7 +23,7 @@ function __construct() { ); } - function widget( $args, $instance ) { + public function widget( $args, $instance ) { $cache_key = 'widget-zone-posts'; $cache = wp_cache_get( $cache_key, 'widget' ); @@ -85,7 +85,7 @@ function widget( $args, $instance ) { wp_cache_set( 'widget-zone-posts', $cache, 'widget' ); } - function update( $new_instance, $old_instance ) { + public function update( $new_instance, $old_instance ) { $instance = $old_instance; $new_instance = wp_parse_args( (array) $new_instance, @@ -105,7 +105,7 @@ function update( $new_instance, $old_instance ) { return $instance; } - function flush_widget_cache() { + public function flush_widget_cache() { $cache_key = 'widget-zone-posts'; $block_save_cache_seconds = absint( apply_filters( 'zone_posts_widget_block_save_cache_seconds', 5 ) ); @@ -117,7 +117,7 @@ function flush_widget_cache() { wp_cache_delete( $cache_key, 'widget' ); } - function form( $instance ) { + public function form( $instance ) { // select - zone // checkbox - show description $zones = z_get_zones(); diff --git a/zoninator.php b/zoninator.php index de9edab..ec776cc 100644 --- a/zoninator.php +++ b/zoninator.php @@ -64,7 +64,7 @@ class Zoninator { */ public $default_post_types = array( 'post' ); - function __construct() { + public function __construct() { add_action( 'init', array( $this, 'init' ), 99 ); // init later after other post types have been registered add_action( 'plugins_loaded', array( $this, 'load_textdomain' ) ); @@ -91,12 +91,12 @@ public function maybe_add_rest_api() { return null; } - function add_zone_feed() { + public function add_zone_feed() { add_rewrite_tag( '%' . $this->zone_taxonomy . '%', '([^&]+)' ); add_rewrite_rule( '^zones/([^/]+)/feed.json/?$', 'index.php?' . $this->zone_taxonomy . '=$matches[1]', 'top' ); } - function init() { + public function init() { $this->zone_messages = array( 'insert-success' => __( 'The zone was successfully created.', 'zoninator' ), 'update-success' => __( 'The zone was successfully updated.', 'zoninator' ), @@ -149,12 +149,12 @@ public function load_textdomain() { load_plugin_textdomain( 'zoninator', false, basename( ZONINATOR_PATH ) . '/language' ); } - function widgets_init() { + public function widgets_init() { register_widget( 'Zoninator_ZonePosts_Widget' ); } // Add necessary AJAX actions - function admin_ajax_init() { + public function admin_ajax_init() { add_action( 'wp_ajax_zoninator_reorder_posts', array( $this, 'ajax_reorder_posts' ) ); add_action( 'wp_ajax_zoninator_add_post', array( $this, 'ajax_add_post' ) ); add_action( 'wp_ajax_zoninator_remove_post', array( $this, 'ajax_remove_post' ) ); @@ -163,7 +163,7 @@ function admin_ajax_init() { add_action( 'wp_ajax_zoninator_update_recent', array( $this, 'ajax_recent_posts' ) ); } - function admin_init() { + public function admin_init() { $this->admin_ajax_init(); @@ -172,12 +172,12 @@ function admin_init() { add_action( 'admin_enqueue_scripts', array( $this, 'admin_enqueue_styles' ) ); } - function admin_page_init() { + public function admin_page_init() { // Set up page add_menu_page( __( 'Zoninator', 'zoninator' ), __( 'Zones', 'zoninator' ), $this->_get_manage_zones_cap(), $this->key, array( $this, 'admin_page' ), '', 11 ); } - function admin_enqueue_scripts() { + public function admin_enqueue_scripts() { if ( $this->is_zoninator_page() ) { wp_enqueue_script( 'zoninator-js', ZONINATOR_URL . 'js/zoninator.js', array( 'jquery', 'jquery-ui-core', 'jquery-ui-widget', 'jquery-ui-mouse', 'jquery-ui-position', 'jquery-ui-sortable', 'jquery-ui-autocomplete' ), ZONINATOR_VERSION, true ); @@ -199,14 +199,14 @@ function admin_enqueue_scripts() { } } - function admin_enqueue_styles() { + public function admin_enqueue_styles() { if ( $this->is_zoninator_page() ) { wp_enqueue_style( 'zoninator-jquery-ui', ZONINATOR_URL . 'css/jquery-ui/smoothness/jquery-ui-zoninator.css', false, ZONINATOR_VERSION, 'all' ); wp_enqueue_style( 'zoninator-styles', ZONINATOR_URL . 'css/zoninator.css', false, ZONINATOR_VERSION, 'all' ); } } - function admin_controller() { + public function admin_controller() { if ( $this->is_zoninator_page() ) { $action = $this->_get_request_var( 'action' ); @@ -282,7 +282,7 @@ function admin_controller() { } } - function admin_page() { + public function admin_page() { global $zoninator_admin_page; $title = __( 'Zones', 'zoninator' ); @@ -341,7 +341,7 @@ function admin_page() {
@@ -371,7 +371,7 @@ function admin_page_zone_tabs( $zones, $active_zone_id = 0 ) { _get_value_or_default( 'term_id', $zone, 0, 'absint' ); $zone_name = $this->_get_value_or_default( 'name', $zone ); $zone_slug = $this->_get_value_or_default( 'slug', $zone, '', array( $this, 'get_unformatted_zone_slug' ) ); @@ -512,7 +512,7 @@ function admin_page_zone_edit( $zone = null ) { get_post_order( $post->ID, $zone ); ?> @@ -548,7 +548,7 @@ function admin_page_zone_post_col_position( $post, $zone ) { %s', get_edit_post_link( $post->ID ), __( 'Opens in new window', 'zoninator' ), __( 'Edit', 'zoninator' ) ), sprintf( '%s', __( 'Remove this item from the zone', 'zoninator' ), __( 'Remove', 'zoninator' ) ), @@ -565,7 +565,7 @@ function admin_page_zone_post_col_info( $post, $zone ) {
@@ -576,7 +576,7 @@ function zone_advanced_search_filters() { _get_post_var( 'zone_advanced_filter_taxonomy', '', 'absint' ); ?> @@ -595,7 +595,7 @@ function zone_advanced_search_cat_filter() { ); } - function zone_advanced_search_date_filter() { + public function zone_advanced_search_date_filter() { $current_date = $this->_get_post_var( 'zone_advanced_filter_date', apply_filters( 'zoninator_advanced_filter_date_default', '' ), 'striptags' ); $date_filters = apply_filters( 'zoninator_advanced_filter_date', array( 'all', 'today', 'yesterday' ) ); ?> @@ -618,7 +618,7 @@ function zone_advanced_search_date_filter() { _get_post_var( 'cat', '', 'absint' ); $date = $this->_get_post_var( 'date', '', 'striptags' ); @@ -685,7 +685,7 @@ function ajax_recent_posts() { $this->ajax_return( $status, $content ); } - function zone_admin_recent_posts_dropdown( $zone_id ) { + public function zone_admin_recent_posts_dropdown( $zone_id ) { $limit = $this->posts_per_page; $post_types = $this->get_supported_post_types(); @@ -723,7 +723,7 @@ function zone_admin_recent_posts_dropdown( $zone_id ) {
@@ -733,7 +733,7 @@ function zone_admin_search_form() { zone_ajax_nonce_action : $action; $nonce = wp_create_nonce( $this->_get_nonce_key( $action ) ); @@ -761,7 +761,7 @@ function ajax_return( $status, $content = '', $action = '' ) { exit; } - function ajax_add_post() { + public function ajax_add_post() { $zone_id = $this->_get_post_var( 'zone_id', 0, 'absint' ); $post_id = $this->_get_post_var( 'post_id', 0, 'absint' ); @@ -794,7 +794,7 @@ function ajax_add_post() { $this->ajax_return( $status, $content ); } - function ajax_remove_post() { + public function ajax_remove_post() { $zone_id = $this->_get_post_var( 'zone_id', 0, 'absint' ); $post_id = $this->_get_post_var( 'post_id', 0, 'absint' ); @@ -820,7 +820,7 @@ function ajax_remove_post() { $this->ajax_return( $status, $content ); } - function ajax_reorder_posts() { + public function ajax_reorder_posts() { $zone_id = $this->_get_post_var( 'zone_id', 0, 'absint' ); $post_ids = (array) $this->_get_post_var( 'posts', array(), 'absint' ); @@ -847,7 +847,7 @@ function ajax_reorder_posts() { } // TODO: implement in front-end - function ajax_move_zone_post( $from_zone, $to_zone, $post_id ) { + public function ajax_move_zone_post( $from_zone, $to_zone, $post_id ) { $from_zone_id = $this->_get_post_var( 'from_zone_id', 0, 'absint' ); $to_zone_id = $this->_get_post_var( 'to_zone_id', 0, 'absint' ); @@ -862,7 +862,7 @@ function ajax_move_zone_post( $from_zone, $to_zone, $post_id ) { $this->remove_zone_posts( $from_zone_id, $post_id ); } - function ajax_search_posts() { + public function ajax_search_posts() { $q = $this->_get_request_var( 'term', '', 'stripslashes' ); @@ -930,7 +930,7 @@ function ajax_search_posts() { } } - function ajax_update_lock() { + public function ajax_update_lock() { $zone_id = $this->_get_post_var( 'zone_id', 0, 'absint' ); $this->verify_nonce( $this->zone_ajax_nonce_action ); @@ -946,7 +946,7 @@ function ajax_update_lock() { } } - function get_supported_post_types() { + public function get_supported_post_types() { if ( $this->post_types !== null ) { return $this->post_types; } @@ -968,7 +968,7 @@ function get_supported_post_types() { * @param string|array $post_types A post type string or array of post type strings to register. * @return bool True if any post types were added, false if not. */ - function register_zone_post_type( $post_types = '' ) { + public function register_zone_post_type( $post_types = '' ) { $did_register_post_types = false; @@ -993,7 +993,7 @@ function register_zone_post_type( $post_types = '' ) { return $did_register_post_types; } - function insert_zone( $slug, $name = '', $details = array() ) { + public function insert_zone( $slug, $name = '', $details = array() ) { // slug cannot be empty if ( empty( $slug ) ) { @@ -1017,7 +1017,7 @@ function insert_zone( $slug, $name = '', $details = array() ) { return wp_insert_term( $name, $this->zone_taxonomy, $args ); } - function update_zone( $zone, $data = array() ) { + public function update_zone( $zone, $data = array() ) { $zone_id = $this->get_zone_id( $zone ); if ( $this->zone_exists( $zone_id ) ) { @@ -1046,7 +1046,7 @@ function update_zone( $zone, $data = array() ) { return new WP_Error( 'invalid-zone', __( 'Sorry, that zone doesn\'t exist.', 'zoninator' ) ); } - function delete_zone( $zone ) { + public function delete_zone( $zone ) { $zone_id = $this->get_zone_id( $zone ); $meta_key = $this->get_zone_meta_key( $zone ); @@ -1075,7 +1075,7 @@ function delete_zone( $zone ) { * @param bool $append * @return bool|WP_Error */ - function add_zone_posts( $zone, $posts, $append = false ) { + public function add_zone_posts( $zone, $posts, $append = false ) { $zone = $this->get_zone( $zone ); $meta_key = $this->get_zone_meta_key( $zone ); @@ -1112,7 +1112,7 @@ function add_zone_posts( $zone, $posts, $append = false ) { * * @return bool|WP_Error */ - function remove_zone_posts( $zone, $posts = null ) { + public function remove_zone_posts( $zone, $posts = null ) { $zone = $this->get_zone( $zone ); $meta_key = $this->get_zone_meta_key( $zone ); @@ -1135,7 +1135,7 @@ function remove_zone_posts( $zone, $posts = null ) { do_action( 'zoninator_remove_zone_posts', $posts, $zone ); } - function get_zone_posts( $zone, $args = array() ) { + public function get_zone_posts( $zone, $args = array() ) { // Check cache first if ( $posts = $this->get_zone_posts_from_cache( $zone, $args ) ) { return $posts; @@ -1150,7 +1150,7 @@ function get_zone_posts( $zone, $args = array() ) { return $posts; } - function get_zone_query( $zone, $args = array() ) { + public function get_zone_query( $zone, $args = array() ) { $meta_key = $this->get_zone_meta_key( $zone ); $defaults = array( @@ -1191,7 +1191,7 @@ function get_zone_query( $zone, $args = array() ) { return new WP_Query( $args ); } - function get_last_post_in_zone( $zone ) { + public function get_last_post_in_zone( $zone ) { return $this->get_single_post_in_zone( $zone, array( @@ -1200,11 +1200,11 @@ function get_last_post_in_zone( $zone ) { ); } - function get_first_post_in_zone( $zone ) { + public function get_first_post_in_zone( $zone ) { return $this->get_single_post_in_zone( $zone ); } - function get_prev_post_in_zone( $zone, $post_id ) { + public function get_prev_post_in_zone( $zone, $post_id ) { // TODO: test this works $order = $this->get_post_order_in_zone( $zone, $post_id ); @@ -1217,7 +1217,7 @@ function get_prev_post_in_zone( $zone, $post_id ) { ); } - function get_next_post_in_zone( $zone, $post_id ) { + public function get_next_post_in_zone( $zone, $post_id ) { // TODO: test this works $order = $this->get_post_order_in_zone( $zone, $post_id ); @@ -1230,7 +1230,7 @@ function get_next_post_in_zone( $zone, $post_id ) { ); } - function get_single_post_in_zone( $zone, $args = array() ) { + public function get_single_post_in_zone( $zone, $args = array() ) { $args = wp_parse_args( $args, @@ -1249,7 +1249,7 @@ function get_single_post_in_zone( $zone, $args = array() ) { return false; } - function get_zones_for_post( $post_id ) { + public function get_zones_for_post( $post_id ) { // TODO: build this out // get_object_terms @@ -1273,7 +1273,7 @@ function get_zones_for_post( $post_id ) { // return $zones; } - function get_zones( $args = array() ) { + public function get_zones( $args = array() ) { $args = wp_parse_args( $args, @@ -1298,7 +1298,7 @@ function get_zones( $args = array() ) { return false; } - function get_zone( $zone ) { + public function get_zone( $zone ) { if ( is_int( $zone ) ) { $field = 'id'; } elseif ( is_string( $zone ) ) { @@ -1323,7 +1323,7 @@ function get_zone( $zone ) { return $this->_fill_zone_details( $zone ); } - function lock_zone( $zone, $user_id = 0 ) { + public function lock_zone( $zone, $user_id = 0 ) { $zone_id = $this->get_zone_id( $zone ); if ( ! $zone_id ) { @@ -1344,7 +1344,7 @@ function lock_zone( $zone, $user_id = 0 ) { } // Not really needed with transients... - function unlock_zone( $zone ) { + public function unlock_zone( $zone ) { $zone_id = $this->get_zone_id( $zone ); if ( ! $zone_id ) { @@ -1357,7 +1357,7 @@ function unlock_zone( $zone ) { return null; } - function is_zone_locked( $zone ) { + public function is_zone_locked( $zone ) { $zone_id = $this->get_zone_id( $zone ); if ( ! $zone_id ) { return false; @@ -1376,12 +1376,12 @@ function is_zone_locked( $zone ) { } } - function zone_exists( $zone ) { + public function zone_exists( $zone ) { $zone_id = $this->get_zone_id( $zone ); return (bool) term_exists( $zone_id, $this->zone_taxonomy ); } - function get_zone_id( $zone ) { + public function get_zone_id( $zone ) { if ( is_int( $zone ) ) { return $zone; } @@ -1394,12 +1394,12 @@ function get_zone_id( $zone ) { return (int) $zone; } - function get_zone_meta_key( $zone ) { + public function get_zone_meta_key( $zone ) { $zone_id = $this->get_zone_id( $zone ); return $this->zone_meta_prefix . $zone_id; } - function get_zone_slug( $zone ) { + public function get_zone_slug( $zone ) { if ( is_int( $zone ) ) { $zone = $this->get_zone( $zone ); } @@ -1411,14 +1411,14 @@ function get_zone_slug( $zone ) { return $this->get_formatted_zone_slug( $zone ); } - function get_formatted_zone_slug( $slug ) { + public function get_formatted_zone_slug( $slug ) { return $slug; // legacy function -- slugs can no longer be changed } - function get_unformatted_zone_slug( $slug ) { + public function get_unformatted_zone_slug( $slug ) { return $slug; // legacy function -- slugs can no longer be changed } - function get_post_id( $post ) { + public function get_post_id( $post ) { if ( is_int( $post ) ) { return $post; } elseif ( is_array( $post ) ) { @@ -1430,14 +1430,14 @@ function get_post_id( $post ) { return false; } - function get_post_order( $post, $zone ) { + public function get_post_order( $post, $zone ) { $post_id = $this->get_post_id( $post ); $meta_key = $this->get_zone_meta_key( $zone ); return get_metadata( 'post', $post_id, $meta_key, true ); } - function verify_nonce( $action ) { + public function verify_nonce( $action ) { $action = $this->_get_nonce_key( $action ); $nonce = $this->_get_request_var( $action ); @@ -1450,7 +1450,7 @@ function verify_nonce( $action ) { } } - function verify_access( $action = '', $zone_id = null ) { + public function verify_access( $action = '', $zone_id = null ) { // TODO: should check if zone locked $verify_function = ''; @@ -1472,11 +1472,11 @@ function verify_access( $action = '', $zone_id = null ) { } } - function _unauthorized_access() { + public function _unauthorized_access() { wp_die( __( 'Sorry, you\'re not supposed to do that...', 'zoninator' ) ); } - function _fill_zone_details( $zone ) { + public function _fill_zone_details( $zone ) { if ( ! empty( $zone->zoninator_parsed ) && $zone->zoninator_parsed ) { return $zone; } @@ -1498,7 +1498,7 @@ function _fill_zone_details( $zone ) { return $zone; } - function do_zoninator_feeds() { + public function do_zoninator_feeds() { $query_var = get_query_var( $this->zone_taxonomy ); if ( ! empty( $query_var ) ) { @@ -1577,19 +1577,19 @@ private function status_header_with_message( $status, $message ) { } // TODO: Caching needs to be testing properly before being implemented! - function get_zone_cache_key( $zone, $args = array() ) { + public function get_zone_cache_key( $zone, $args = array() ) { return ''; } - function get_zone_posts_from_cache( $zone, $args = array() ) { + public function get_zone_posts_from_cache( $zone, $args = array() ) { return false; } - function add_zone_posts_to_cache( $posts, $zone, $args = array() ) { + public function add_zone_posts_to_cache( $posts, $zone, $args = array() ) { } // Handle 4.2 term-splitting - function split_shared_term( $old_term_id, $new_term_id, $term_taxonomy_id, $taxonomy ) { + public function split_shared_term( $old_term_id, $new_term_id, $term_taxonomy_id, $taxonomy ) { if ( $this->zone_taxonomy === $taxonomy ) { do_action( 'zoninator_split_shared_term', $old_term_id, $new_term_id, $term_taxonomy_id ); @@ -1604,11 +1604,11 @@ function split_shared_term( $old_term_id, $new_term_id, $term_taxonomy_id, $taxo } } - function _empty_zone_posts_cache( $meta_key ) { + public function _empty_zone_posts_cache( $meta_key ) { return; // TODO: implement } - function _get_message( $message_id, $encode = false ) { + public function _get_message( $message_id, $encode = false ) { $message = ''; if ( ! empty( $this->zone_messages[ $message_id ] ) ) { @@ -1622,36 +1622,36 @@ function _get_message( $message_id, $encode = false ) { return $message; } - function _get_nonce_key( $action ) { + public function _get_nonce_key( $action ) { return sprintf( '%s-%s', $this->zone_nonce_prefix, $action ); } - function _current_user_can_add_zones() { + public function _current_user_can_add_zones() { return current_user_can( $this->_get_add_zones_cap() ); } - function _current_user_can_edit_zones( $zone_id ) { + public function _current_user_can_edit_zones( $zone_id ) { $has_cap = current_user_can( $this->_get_edit_zones_cap() ); return apply_filters( 'zoninator_current_user_can_edit_zone', $has_cap, $zone_id ); } - function _current_user_can_manage_zones() { + public function _current_user_can_manage_zones() { return current_user_can( $this->_get_manage_zones_cap() ); } - function _get_add_zones_cap() { + public function _get_add_zones_cap() { return apply_filters( 'zoninator_add_zone_cap', 'edit_others_posts' ); } - function _get_edit_zones_cap() { + public function _get_edit_zones_cap() { return apply_filters( 'zoninator_edit_zone_cap', 'edit_others_posts' ); } - function _get_manage_zones_cap() { + public function _get_manage_zones_cap() { return apply_filters( 'zoninator_manage_zone_cap', 'edit_others_posts' ); } - function _get_zone_page_url( $args = array() ) { + public function _get_zone_page_url( $args = array() ) { $url = menu_page_url( $this->key, false ); foreach ( $args as $arg_key => $arg_value ) { @@ -1661,19 +1661,19 @@ function _get_zone_page_url( $args = array() ) { return $url; } - function _validate_date_filter( $date ) { + public function _validate_date_filter( $date ) { return preg_match( '/(\d{4})-(\d{2})-(\d{2})/', $date ); } - function _validate_category_filter( $cat ) { + public function _validate_category_filter( $cat ) { return $cat && get_term_by( 'id', $cat, 'category' ); } - function _sanitize_value( $var ) { + public function _sanitize_value( $var ) { return htmlentities( stripslashes( $var ) ); } - function _get_value_or_default( $var, $object, $default = '', $sanitize_callback = '' ) { + public function _get_value_or_default( $var, $object, $default = '', $sanitize_callback = '' ) { if ( is_object( $object ) ) { $value = empty( $object->$var ) ? $default : $object->$var; } elseif ( is_array( $object ) ) { @@ -1689,14 +1689,14 @@ function _get_value_or_default( $var, $object, $default = '', $sanitize_callback return $value; } - function _get_request_var( $var, $default = '', $sanitize_callback = '' ) { + public function _get_request_var( $var, $default = '', $sanitize_callback = '' ) { return $this->_get_value_or_default( $var, $_REQUEST, $default, $sanitize_callback ); } - function _get_get_var( $var, $default = '', $sanitize_callback = '' ) { + public function _get_get_var( $var, $default = '', $sanitize_callback = '' ) { return $this->_get_value_or_default( $var, $_GET, $default, $sanitize_callback ); } - function _get_post_var( $var, $default = '', $sanitize_callback = '' ) { + public function _get_post_var( $var, $default = '', $sanitize_callback = '' ) { return $this->_get_value_or_default( $var, $_POST, $default, $sanitize_callback ); } @@ -1761,7 +1761,7 @@ public function get_admin_zone_posts( $zone_or_id ) { * @param $zone_slug_or_id * @return array|WP_Error */ - function get_zone_feed( $zone_slug_or_id ) { + public function get_zone_feed( $zone_slug_or_id ) { $zone_id = $this->get_zone( $zone_slug_or_id ); if ( empty( $zone_id ) ) { From 91fdd5dfb40310af820a65737893f9ebc06a2538 Mon Sep 17 00:00:00 2001 From: Gary Jones Date: Wed, 14 Aug 2024 11:27:23 +0100 Subject: [PATCH 38/56] CS: Rector with CodingStyle SymplifyQuoteEscapeRector --- includes/class-zoninator-api-controller.php | 2 +- rector.php | 1 - zoninator.php | 8 ++++---- 3 files changed, 5 insertions(+), 6 deletions(-) diff --git a/includes/class-zoninator-api-controller.php b/includes/class-zoninator-api-controller.php index f0c3923..d156752 100644 --- a/includes/class-zoninator-api-controller.php +++ b/includes/class-zoninator-api-controller.php @@ -482,7 +482,7 @@ private function _bad_request( $code, $message ) { */ private function _permissions_check( $action, $zone_id = null ) { if ( ! $this->instance->check( $action, $zone_id ) ) { - return new WP_Error( self::PERMISSION_DENIED, __( 'Sorry, you\'re not supposed to do that...', 'zoninator' ) ); + return new WP_Error( self::PERMISSION_DENIED, __( "Sorry, you're not supposed to do that...", 'zoninator' ) ); } return true; } diff --git a/rector.php b/rector.php index fc12e3f..33d39cb 100644 --- a/rector.php +++ b/rector.php @@ -30,7 +30,6 @@ ), MakeInheritedMethodVisibilitySameAsParentRector::class, NewlineAfterStatementRector::class, - SymplifyQuoteEscapeRector::class, ) ) ->withPhpSets( php74: true ) diff --git a/zoninator.php b/zoninator.php index ec776cc..b278535 100644 --- a/zoninator.php +++ b/zoninator.php @@ -1043,7 +1043,7 @@ public function update_zone( $zone, $data = array() ) { return wp_update_term( $zone_id, $this->zone_taxonomy, $args ); } - return new WP_Error( 'invalid-zone', __( 'Sorry, that zone doesn\'t exist.', 'zoninator' ) ); + return new WP_Error( 'invalid-zone', __( "Sorry, that zone doesn't exist.", 'zoninator' ) ); } public function delete_zone( $zone ) { @@ -1060,13 +1060,13 @@ public function delete_zone( $zone ) { $delete = wp_delete_term( $zone_id, $this->zone_taxonomy ); if ( ! $delete ) { - return new WP_Error( 'delete-zone', __( 'Sorry, we couldn\'t delete the zone.', 'zoninator' ) ); + return new WP_Error( 'delete-zone', __( "Sorry, we couldn't delete the zone.", 'zoninator' ) ); } else { do_action( 'zoninator_delete_zone', $zone_id ); return $delete; } } - return new WP_Error( 'invalid-zone', __( 'Sorry, that zone doesn\'t exist.', 'zoninator' ) ); + return new WP_Error( 'invalid-zone', __( "Sorry, that zone doesn't exist.", 'zoninator' ) ); } /** @@ -1473,7 +1473,7 @@ public function verify_access( $action = '', $zone_id = null ) { } public function _unauthorized_access() { - wp_die( __( 'Sorry, you\'re not supposed to do that...', 'zoninator' ) ); + wp_die( __( "Sorry, you're not supposed to do that...", 'zoninator' ) ); } public function _fill_zone_details( $zone ) { From a8d4a300a2d3743f354f7d2f46ae7254fcf5edcd Mon Sep 17 00:00:00 2001 From: Gary Jones Date: Wed, 14 Aug 2024 11:48:08 +0100 Subject: [PATCH 39/56] CS: Rector with CodingStyle NewlineAfterStatementRector --- functions.php | 1 + includes/class-zoninator-api-controller.php | 39 +++++-- .../class-zoninator-api-schema-converter.php | 2 + includes/class-zoninator-api.php | 1 + .../class-zoninator-rest-bootstrap.php | 4 + .../class-zoninator-rest-classloader.php | 9 +- .../class-zoninator-rest-controller.php | 10 +- .../class-zoninator-rest-environment.php | 11 +- .../class-zoninator-rest-model.php | 24 ++++ .../class-zoninator-rest-type.php | 1 + ...ninator-rest-controller-bundle-builder.php | 3 + ...class-zoninator-rest-controller-action.php | 2 + ...class-zoninator-rest-controller-bundle.php | 1 + .../class-zoninator-rest-controller-crud.php | 4 + ...ss-zoninator-rest-controller-extension.php | 4 + .../class-zoninator-rest-controller-model.php | 2 + .../class-zoninator-rest-controller-route.php | 1 + .../data/class-zoninator-rest-data-mapper.php | 3 + .../class-zoninator-rest-data-serializer.php | 1 + ...ninator-rest-data-store-customposttype.php | 5 + ...class-zoninator-rest-data-store-option.php | 2 + ...class-zoninator-rest-field-declaration.php | 24 ++++ ...ninator-rest-field-declaration-builder.php | 4 + .../class-zoninator-rest-interfaces-type.php | 4 + ...class-zoninator-rest-model-declaration.php | 1 + .../class-zoninator-rest-model-definition.php | 12 ++ .../class-zoninator-rest-model-settings.php | 3 + ...ss-zoninator-rest-model-validationdata.php | 2 + ...inator-rest-model-declaration-settings.php | 3 + ...oninator-rest-model-definition-builder.php | 5 + .../class-zoninator-rest-type-boolean.php | 1 + .../class-zoninator-rest-type-integer.php | 1 + .../class-zoninator-rest-type-nullable.php | 2 + .../type/class-zoninator-rest-type-number.php | 1 + .../class-zoninator-rest-type-registry.php | 2 + .../type/class-zoninator-rest-type-string.php | 2 + .../class-zoninator-rest-type-typedarray.php | 1 + rector.php | 7 +- tests/bootstrap.php | 2 + .../class-zoninator-api-controller-test.php | 3 + widget.zone-posts.php | 13 ++- zoninator.php | 104 +++++++++++++----- 42 files changed, 274 insertions(+), 53 deletions(-) diff --git a/functions.php b/functions.php index 74ad95c..43d6e68 100644 --- a/functions.php +++ b/functions.php @@ -75,6 +75,7 @@ function z_get_loop_post_id_or_default( $post_id = 0 ) { $post_id = $post->ID; } } + return $post_id; } diff --git a/includes/class-zoninator-api-controller.php b/includes/class-zoninator-api-controller.php index d156752..4bccc49 100644 --- a/includes/class-zoninator-api-controller.php +++ b/includes/class-zoninator-api-controller.php @@ -7,27 +7,41 @@ * Class Zoninator_Api_Controller */ class Zoninator_Api_Controller extends Zoninator_REST_Controller { - public const ZONE_ITEM_URL_REGEX = '/zones/(?P[\d]+)'; - public const ZONE_ITEM_POSTS_URL_REGEX = '/zones/(?P[\d]+)/posts'; + public const ZONE_ITEM_URL_REGEX = '/zones/(?P[\d]+)'; + + public const ZONE_ITEM_POSTS_URL_REGEX = '/zones/(?P[\d]+)/posts'; + public const ZONE_ITEM_POSTS_POST_REGEX = '/zones/(?P[\d]+)/posts/(?P\d+)'; - public const INVALID_ZONE_ID = 'invalid-zone-id'; - public const INVALID_POST_ID = 'invalid-post-id'; - public const ZONE_ID_POST_ID_REQUIRED = 'zone-id-post-id-required'; + public const INVALID_ZONE_ID = 'invalid-zone-id'; + + public const INVALID_POST_ID = 'invalid-post-id'; + + public const ZONE_ID_POST_ID_REQUIRED = 'zone-id-post-id-required'; + public const ZONE_ID_POST_IDS_REQUIRED = 'zone-id-post-ids-required'; - public const ZONE_ID_REQUIRED = 'zone-id-required'; - public const ZONE_FEED_ERROR = 'zone-feed-error'; - public const TERM_REQUIRED = 'term-required'; - public const PERMISSION_DENIED = 'permission-denied'; - public const ZONE_NOT_FOUND = 'zone-not-found'; - public const POST_NOT_FOUND = 'post-not-found'; - public const INVALID_ZONE_SETTINGS = 'invalid-zone-settings'; + + public const ZONE_ID_REQUIRED = 'zone-id-required'; + + public const ZONE_FEED_ERROR = 'zone-feed-error'; + + public const TERM_REQUIRED = 'term-required'; + + public const PERMISSION_DENIED = 'permission-denied'; + + public const ZONE_NOT_FOUND = 'zone-not-found'; + + public const POST_NOT_FOUND = 'post-not-found'; + + public const INVALID_ZONE_SETTINGS = 'invalid-zone-settings'; + /** * Instance * * @var Zoninator */ private $instance; + /** * Key Value Translation array * @@ -484,6 +498,7 @@ private function _permissions_check( $action, $zone_id = null ) { if ( ! $this->instance->check( $action, $zone_id ) ) { return new WP_Error( self::PERMISSION_DENIED, __( "Sorry, you're not supposed to do that...", 'zoninator' ) ); } + return true; } } diff --git a/includes/class-zoninator-api-schema-converter.php b/includes/class-zoninator-api-schema-converter.php index 2100d08..e0db40d 100644 --- a/includes/class-zoninator-api-schema-converter.php +++ b/includes/class-zoninator-api-schema-converter.php @@ -22,6 +22,7 @@ public function as_schema( $model_definition ) { $required[] = $field_declaration->get_data_transfer_name(); } } + $schema = array( '$schema' => 'http://json-schema.org/schema#', 'title' => $model_definition->get_name(), @@ -64,6 +65,7 @@ public function as_args( $model_definition ) { $result[ $field_declaration->get_data_transfer_name() ] = $arg; } + return $result; } } diff --git a/includes/class-zoninator-api.php b/includes/class-zoninator-api.php index 1ed8510..d1ecf0f 100644 --- a/includes/class-zoninator-api.php +++ b/includes/class-zoninator-api.php @@ -7,6 +7,7 @@ class Zoninator_Api { * @var Zoninator */ private $instance; + /** * Bootstrap * diff --git a/lib/zoninator_rest/class-zoninator-rest-bootstrap.php b/lib/zoninator_rest/class-zoninator-rest-bootstrap.php index 003556a..3930365 100644 --- a/lib/zoninator_rest/class-zoninator-rest-bootstrap.php +++ b/lib/zoninator_rest/class-zoninator-rest-bootstrap.php @@ -75,6 +75,7 @@ public static function create( $class_loader = null ) { $base_dir = self::get_base_dir(); $class_loader = new Zoninator_REST_Classloader( $prefix, $base_dir ); } + return new self( $class_loader ); } @@ -87,6 +88,7 @@ public function run() { if ( ! self::is_compatible() ) { return false; } + $this->load() ->environment()->start(); return true; @@ -102,6 +104,7 @@ public function register_autoload() { if ( function_exists( 'spl_autoload_register' ) ) { spl_autoload_register( array( $this->class_loader(), 'load_class' ), true ); } + return $this; } @@ -188,6 +191,7 @@ public function environment() { if ( null === $this->environment ) { $this->environment = new Zoninator_REST_Environment( $this ); } + return $this->environment; } } diff --git a/lib/zoninator_rest/class-zoninator-rest-classloader.php b/lib/zoninator_rest/class-zoninator-rest-classloader.php index 2bf45a2..c1eba3d 100644 --- a/lib/zoninator_rest/class-zoninator-rest-classloader.php +++ b/lib/zoninator_rest/class-zoninator-rest-classloader.php @@ -20,13 +20,15 @@ class Zoninator_REST_Classloader implements Zoninator_REST_Interfaces_Classloade * * @var array The loaded class map. */ - private $loaded_classes; + private $loaded_classes = array(); + /** * The prefix to use (e.g. Mixtape) * * @var string */ private $prefix; + /** * The directory the loader looks for classes. * @@ -43,9 +45,8 @@ class Zoninator_REST_Classloader implements Zoninator_REST_Interfaces_Classloade * @throws Exception Throws if an invalid directory is provided. */ public function __construct( $prefix, $base_dir ) { - $this->loaded_classes = array(); - $this->prefix = $prefix; - $this->base_dir = $base_dir; + $this->prefix = $prefix; + $this->base_dir = $base_dir; if ( ! is_dir( $this->base_dir ) ) { throw new Exception( 'base_dir does not exist: ' . $this->base_dir ); } diff --git a/lib/zoninator_rest/class-zoninator-rest-controller.php b/lib/zoninator_rest/class-zoninator-rest-controller.php index b539716..4704b15 100644 --- a/lib/zoninator_rest/class-zoninator-rest-controller.php +++ b/lib/zoninator_rest/class-zoninator-rest-controller.php @@ -13,10 +13,13 @@ * Class Zoninator_REST_Controller */ class Zoninator_REST_Controller extends WP_REST_Controller implements Zoninator_REST_Interfaces_Controller { - public const HTTP_CREATED = 201; - public const HTTP_OK = 200; + public const HTTP_CREATED = 201; + + public const HTTP_OK = 200; + public const HTTP_BAD_REQUEST = 400; - public const HTTP_NOT_FOUND = 404; + + public const HTTP_NOT_FOUND = 404; /** * The bundle this belongs to. @@ -31,6 +34,7 @@ class Zoninator_REST_Controller extends WP_REST_Controller implements Zoninator_ * @var string */ protected $base; + /** * Our Handlers * diff --git a/lib/zoninator_rest/class-zoninator-rest-environment.php b/lib/zoninator_rest/class-zoninator-rest-environment.php index 22f1bd8..73ed772 100644 --- a/lib/zoninator_rest/class-zoninator-rest-environment.php +++ b/lib/zoninator_rest/class-zoninator-rest-environment.php @@ -20,8 +20,10 @@ */ class Zoninator_REST_Environment { public const REGISTRABLE = 'IRegistrable'; - public const BUNDLES = 'Bundles'; - public const MODELS = 'Models'; + + public const BUNDLES = 'Bundles'; + + public const MODELS = 'Models'; /** * This environment's registered REST bundles @@ -116,6 +118,7 @@ public function model( $class ) { if ( ! class_exists( $class ) ) { throw new Zoninator_REST_Exception( $class . ' does not exist' ); } + Zoninator_REST_Expect::that( isset( $this->model_definitions[ $class ] ), $class . ' definition does not exist' ); return $this->model_definitions[ $class ]; } @@ -189,6 +192,7 @@ public function start() { */ $bundle->register( $this ); } + $this->has_started = true; do_action( 'mt_environment_after_start', $this ); } @@ -269,6 +273,7 @@ public function define_var( $name, $thing = null, $append = false ) { if ( $append && ! $this->has_variable( $name ) ) { $this->variables[ $name ] = array(); } + if ( null !== $thing ) { if ( $append ) { $this->variables[ $name ][] = $thing; @@ -276,6 +281,7 @@ public function define_var( $name, $thing = null, $append = false ) { $this->variables[ $name ] = $thing; } } + return $this; } @@ -359,6 +365,7 @@ public function rest_api( $maybe_bundle_or_prefix = null ) { if ( is_string( $maybe_bundle_or_prefix ) ) { $builder->with_prefix( $maybe_bundle_or_prefix ); } + $builder->with_environment( $this ); } diff --git a/lib/zoninator_rest/class-zoninator-rest-model.php b/lib/zoninator_rest/class-zoninator-rest-model.php index 89f5bc1..66b8900 100644 --- a/lib/zoninator_rest/class-zoninator-rest-model.php +++ b/lib/zoninator_rest/class-zoninator-rest-model.php @@ -74,6 +74,7 @@ public function __construct( $data = array(), $args = array() ) { unset( $args['deserialize'] ); $data = $this->deserialize( $data ); } + $this->raw_data = $data; $data_keys = array_keys( $data ); @@ -121,11 +122,13 @@ public function set( $field, $value ) { if ( isset( $args['deserializing'] ) && $args['deserializing'] ) { $value = $this->deserialize_field( $field_declaration, $value ); } + if ( null !== $field_declaration->before_set() ) { $val = $this->call( $field_declaration->before_set(), array( $value, $field_declaration->get_name() ) ); } else { $val = $field_declaration->cast_value( $value ); } + $this->data[ $field_declaration->get_name() ] = $val; return $this; } @@ -155,9 +158,11 @@ public function validate() { $validation_errors[] = $is_valid->get_error_data(); } } + if ( $validation_errors !== array() ) { return $this->validation_error( $validation_errors ); } + return true; } @@ -182,8 +187,10 @@ public function sanitize() { } else { $value = $field_declaration->get_type()->sanitize( $value ); } + $this->set( $field_name, $value ); } + return $this; } @@ -208,6 +215,7 @@ protected function run_field_validations( $field_declaration ) { if ( $field_declaration->is_kind( Zoninator_REST_Field_Declaration::DERIVED ) ) { return true; } + $value = $this->get( $field_declaration->get_name() ); if ( $field_declaration->is_required() && empty( $value ) ) { // translators: %s is usually a field name. @@ -228,6 +236,7 @@ protected function run_field_validations( $field_declaration ) { } } } + return true; } @@ -301,6 +310,7 @@ public function get_fields( $filter_by_type = null ) { $filtered[] = $field_declaration; } } + return $filtered; } @@ -322,6 +332,7 @@ private function initialize_field_map( $declared_field_builders ) { $field = $field_builder->build(); $fields[ $field->get_name() ] = $field; } + return $fields; } @@ -335,6 +346,7 @@ public function get_data_store() { if ( ! isset( self::$data_stores_by_class_name[ $class_name ] ) ) { self::$data_stores_by_class_name[ $class_name ] = new Zoninator_REST_Data_Store_Nil(); } + return self::$data_stores_by_class_name[ $class_name ]; } @@ -408,6 +420,7 @@ public function update_from_array( $data, $updating = false ) { foreach ( $mapped_data as $name => $value ) { $this->set( $name, $value ); } + return $this->sanitize(); } @@ -439,8 +452,10 @@ public function get_dto_field_mappings() { if ( ! $field_declaration->supports_output_type( 'json' ) ) { continue; } + $mappings[ $field_declaration->get_data_transfer_name() ] = $field_declaration->get_name(); } + return $mappings; } @@ -478,6 +493,7 @@ private function map_data( $data, $updating = false ) { if ( $field->is_kind( Zoninator_REST_Field_Declaration::DERIVED ) ) { continue; } + $dto_name = $field->get_data_transfer_name(); $field_name = $field->get_name(); if ( isset( $data[ $dto_name ] ) && ! ( $updating && $field->is_primary() ) ) { @@ -485,6 +501,7 @@ private function map_data( $data, $updating = false ) { $request_data[ $field_name ] = $value; } } + return $request_data; } @@ -501,6 +518,7 @@ private function call( $method, $args = array() ) { if ( is_callable( $method ) ) { return call_user_func_array( $method, $args ); } + Zoninator_REST_Expect::that( method_exists( $this, $method ), $method . ' does not exist' ); return call_user_func_array( array( $this, $method ), $args ); } @@ -559,6 +577,7 @@ public static function from_raw_data( $post ) { foreach ( $raw_meta_data as $key => $value_arr ) { $flattened_meta[ $key ] = $value_arr[0]; } + $merged_data = array_merge( $raw_post_data, $flattened_meta ); return self::create( @@ -598,8 +617,10 @@ public function deserialize( $data ) { // just provide a default. $value = $declaration->get_default_value(); } + $raw_data[ $key ] = $declaration->cast_value( $value ); } + return $raw_data; } @@ -638,6 +659,7 @@ private function deserialize_field( $field_declaration, $value ) { if ( isset( $deserializer ) && ! empty( $deserializer ) ) { return $this->call( $deserializer, array( $value ) ); } + return $value; } @@ -654,6 +676,7 @@ private function serialize_field( $field_declaration, $value ) { if ( isset( $serializer ) && ! empty( $serializer ) ) { return $this->call( $serializer, array( $value ) ); } + return $value; } @@ -670,6 +693,7 @@ public function permissions_check( $request, $action ) { $permissions_provider = self::$permissions_providers_by_class_name[ $class_name ]; return call_user_func_array( array( $permissions_provider, 'permissions_check' ), array( $request, $action ) ); } + return true; } diff --git a/lib/zoninator_rest/class-zoninator-rest-type.php b/lib/zoninator_rest/class-zoninator-rest-type.php index 163f80f..e41f5d8 100644 --- a/lib/zoninator_rest/class-zoninator-rest-type.php +++ b/lib/zoninator_rest/class-zoninator-rest-type.php @@ -19,6 +19,7 @@ class Zoninator_REST_Type implements Zoninator_REST_Interfaces_Type { * @var string */ protected $identifier; + /** * Mixtape_Type constructor. * diff --git a/lib/zoninator_rest/controller/bundle/class-zoninator-rest-controller-bundle-builder.php b/lib/zoninator_rest/controller/bundle/class-zoninator-rest-controller-bundle-builder.php index c6385b1..e9188de 100644 --- a/lib/zoninator_rest/controller/bundle/class-zoninator-rest-controller-bundle-builder.php +++ b/lib/zoninator_rest/controller/bundle/class-zoninator-rest-controller-bundle-builder.php @@ -20,12 +20,14 @@ class Zoninator_REST_Controller_Bundle_Builder implements Zoninator_REST_Interfa * @var string */ private $bundle_prefix; + /** * Endpoint Builders. * * @var array */ private $endpoint_builders = array(); + /** * Bundle. * @@ -51,6 +53,7 @@ public function build() { if ( is_a( $this->bundle, 'Zoninator_REST_Interfaces_Controller_Bundle' ) ) { return $this->bundle; } + return new Zoninator_REST_Controller_Bundle( $this->bundle_prefix, $this->endpoint_builders ); } diff --git a/lib/zoninator_rest/controller/class-zoninator-rest-controller-action.php b/lib/zoninator_rest/controller/class-zoninator-rest-controller-action.php index 494ae63..00ed599 100644 --- a/lib/zoninator_rest/controller/class-zoninator-rest-controller-action.php +++ b/lib/zoninator_rest/controller/class-zoninator-rest-controller-action.php @@ -159,8 +159,10 @@ private function expect_callable( $callable_func ) { if ( is_string( $callable_func ) && method_exists( $this->controller, $callable_func ) ) { return array( $this->controller, $callable_func ); } + Zoninator_REST_Expect::that( is_callable( $callable_func ), 'Callable Expected: $callable_func' ); } + return $callable_func; } } diff --git a/lib/zoninator_rest/controller/class-zoninator-rest-controller-bundle.php b/lib/zoninator_rest/controller/class-zoninator-rest-controller-bundle.php index 9fe0c04..16a712c 100644 --- a/lib/zoninator_rest/controller/class-zoninator-rest-controller-bundle.php +++ b/lib/zoninator_rest/controller/class-zoninator-rest-controller-bundle.php @@ -27,6 +27,7 @@ class Zoninator_REST_Controller_Bundle implements Zoninator_REST_Interfaces_Cont * @var array */ protected $endpoints = array(); + /** * Environment. * diff --git a/lib/zoninator_rest/controller/class-zoninator-rest-controller-crud.php b/lib/zoninator_rest/controller/class-zoninator-rest-controller-crud.php index af73b72..9d5567d 100644 --- a/lib/zoninator_rest/controller/class-zoninator-rest-controller-crud.php +++ b/lib/zoninator_rest/controller/class-zoninator-rest-controller-crud.php @@ -145,10 +145,12 @@ public function delete_item( $request ) { if ( empty( $id ) ) { return $this->bad_request( 'No Model ID provided' ); } + $model = $this->model_prototype->get_data_store()->get_entity( $id ); if ( null === $model ) { return $this->not_found( 'Model does not exist' ); } + $result = $this->model_data_store->delete( $model ); return $this->ok( $result ); } @@ -188,6 +190,7 @@ protected function add_links( $model ) { ), ); } + if ( $model->has( 'author' ) ) { $result['author'] = array( array( @@ -195,6 +198,7 @@ protected function add_links( $model ) { ), ); } + return $result; } } diff --git a/lib/zoninator_rest/controller/class-zoninator-rest-controller-extension.php b/lib/zoninator_rest/controller/class-zoninator-rest-controller-extension.php index f8a7bcb..366cedc 100644 --- a/lib/zoninator_rest/controller/class-zoninator-rest-controller-extension.php +++ b/lib/zoninator_rest/controller/class-zoninator-rest-controller-extension.php @@ -16,18 +16,21 @@ class Zoninator_REST_Controller_Extension implements Zoninator_REST_Interfaces_R * @var Zoninator_REST_Environment */ private $environment; + /** * Object to extend * * @var string */ private $object_to_extend; + /** * Model def. * * @var Zoninator_REST_Model_Definition */ private $model_definition; + /** * Model Definition name, This should be a valid Model definition at registration time, otherwise register will throw * @@ -60,6 +63,7 @@ public function register( $environment ) { if ( ! $this->model_definition ) { return new WP_Error( 'model-not-found' ); } + $fields = $this->model_definition->get_fields(); foreach ( $fields as $field ) { $this->register_field( $field ); diff --git a/lib/zoninator_rest/controller/class-zoninator-rest-controller-model.php b/lib/zoninator_rest/controller/class-zoninator-rest-controller-model.php index 84e2f62..888b2fa 100644 --- a/lib/zoninator_rest/controller/class-zoninator-rest-controller-model.php +++ b/lib/zoninator_rest/controller/class-zoninator-rest-controller-model.php @@ -97,6 +97,7 @@ public function get_item_schema() { $required[] = $field_declaration->get_data_transfer_name(); } } + $schema = array( '$schema' => 'http://json-schema.org/schema#', 'title' => $model_definition->get_name(), @@ -143,6 +144,7 @@ protected function prepare_dto( $entity ) { foreach ( $entity->get_items() as $model ) { $results[] = $this->model_to_dto( $model ); } + return $results; } diff --git a/lib/zoninator_rest/controller/class-zoninator-rest-controller-route.php b/lib/zoninator_rest/controller/class-zoninator-rest-controller-route.php index 43491c4..a7432f5 100644 --- a/lib/zoninator_rest/controller/class-zoninator-rest-controller-route.php +++ b/lib/zoninator_rest/controller/class-zoninator-rest-controller-route.php @@ -69,6 +69,7 @@ public function as_array() { */ $result['actions'][] = $route_action->as_array(); } + return $result; } } diff --git a/lib/zoninator_rest/data/class-zoninator-rest-data-mapper.php b/lib/zoninator_rest/data/class-zoninator-rest-data-mapper.php index 929aff2..3c39113 100644 --- a/lib/zoninator_rest/data/class-zoninator-rest-data-mapper.php +++ b/lib/zoninator_rest/data/class-zoninator-rest-data-mapper.php @@ -19,6 +19,7 @@ class Zoninator_REST_Data_Mapper { * @var Zoninator_REST_Data_Serializer */ private $serializer; + /** * Definition * @@ -64,8 +65,10 @@ public function raw_data_to_model_data( $data, $field_declarations ) { } else { $value = $declaration->get_default_value(); } + $raw_data[ $key ] = $declaration->cast_value( $value ); } + return $raw_data; } diff --git a/lib/zoninator_rest/data/class-zoninator-rest-data-serializer.php b/lib/zoninator_rest/data/class-zoninator-rest-data-serializer.php index 320155b..8c06716 100644 --- a/lib/zoninator_rest/data/class-zoninator-rest-data-serializer.php +++ b/lib/zoninator_rest/data/class-zoninator-rest-data-serializer.php @@ -54,6 +54,7 @@ public function serialize( $field_declaration, $value ) { if ( isset( $serializer ) && ! empty( $serializer ) ) { return $this->model_declaration->call( $serializer, array( $value ) ); } + return $value; } } diff --git a/lib/zoninator_rest/data/store/class-zoninator-rest-data-store-customposttype.php b/lib/zoninator_rest/data/store/class-zoninator-rest-data-store-customposttype.php index e5b36ac..e7887c5 100644 --- a/lib/zoninator_rest/data/store/class-zoninator-rest-data-store-customposttype.php +++ b/lib/zoninator_rest/data/store/class-zoninator-rest-data-store-customposttype.php @@ -50,6 +50,7 @@ public function get_entities( $filter = null ) { foreach ( $posts as $post ) { $collection[] = $this->create_from_post( $post ); } + return new Zoninator_REST_Model_Collection( $collection ); } @@ -83,6 +84,7 @@ private function create_from_post( $post ) { foreach ( $raw_meta_data as $key => $value_arr ) { $flattened_meta[ $key ] = $value_arr[0]; } + $merged_data = array_merge( $raw_post_data, $flattened_meta ); return $this->get_model_prototype()->create( @@ -126,6 +128,7 @@ public function delete( $model, $args = array() ) { do_action( 'mixtape_data_store_delete_model_fail', $model, $id ); return new WP_Error( 'delete-failed', 'delete-failed' ); } + return $result; } @@ -144,6 +147,7 @@ public function upsert( $model ) { if ( ! isset( $fields['post_type'] ) ) { $fields['post_type'] = $this->post_type; } + if ( isset( $fields['ID'] ) && empty( $fields['ID'] ) ) { // ID of 0 is not acceptable on CPTs, so remove it. unset( $fields['ID'] ); @@ -156,6 +160,7 @@ public function upsert( $model ) { do_action( 'mixtape_data_store_model_upsert_error', $model ); return $id_or_error; } + $model->set( 'id', absint( $id_or_error ) ); foreach ( $meta_fields as $meta_key => $meta_value ) { if ( $updating ) { diff --git a/lib/zoninator_rest/data/store/class-zoninator-rest-data-store-option.php b/lib/zoninator_rest/data/store/class-zoninator-rest-data-store-option.php index de3c80a..cfe905a 100644 --- a/lib/zoninator_rest/data/store/class-zoninator-rest-data-store-option.php +++ b/lib/zoninator_rest/data/store/class-zoninator-rest-data-store-option.php @@ -89,6 +89,7 @@ public function delete( $model, $args = array() ) { } } } + return true; } @@ -108,6 +109,7 @@ public function upsert( $model ) { add_option( $option_name, $option_value ); } } + return true; } } diff --git a/lib/zoninator_rest/field/class-zoninator-rest-field-declaration.php b/lib/zoninator_rest/field/class-zoninator-rest-field-declaration.php index d70ca00..f55e149 100644 --- a/lib/zoninator_rest/field/class-zoninator-rest-field-declaration.php +++ b/lib/zoninator_rest/field/class-zoninator-rest-field-declaration.php @@ -29,78 +29,91 @@ class Zoninator_REST_Field_Declaration { * possible to update their values from callables */ public const DERIVED = 'derived'; + /** * Map From * * @var null|string */ private $map_from; + /** * The field kind * * @var string */ private $kind; + /** * Field name * * @var string */ private $name; + /** * Is this a primary field? * * @var bool */ private $primary; + /** * Is this a required field? * * @var bool */ private $required; + /** * Outputs * * @var array */ private $supported_outputs; + /** * Description * * @var string */ private $description; + /** * Data Transfer Name * * @var null|string */ private $data_transfer_name; + /** * Validations * * @var null|array */ private $validations; + /** * Default Value * * @var null|mixed */ private $default_value; + /** * Field Choices * * @var null|array */ private $choices; + /** * Type * * @var null|Zoninator_REST_Interfaces_Type */ private $type; + /** * Acceptable field kinds * @@ -111,18 +124,21 @@ class Zoninator_REST_Field_Declaration { self::META, self::DERIVED, ); + /** * A custom function to call before serialization * * @var null|callable */ private $serializer; + /** * A custom function to call before deserialization * * @var null|callable */ private $deserializer; + /** * A custom function to use for sanitizing the field value before setting it. * Used when receiving values from untrusted sources (e.g. a web form of a REST API request) @@ -130,24 +146,28 @@ class Zoninator_REST_Field_Declaration { * @var null|callable */ private $sanitizer; + /** * A custom filtering callable triggered before setting the field with the value * * @var null|callable */ private $before_set; + /** * A custom filtering callable triggered before returning the field value * * @var null|callable */ private $before_get; + /** * Used by derived fields: The function to use to get the field value * * @var null|callable */ private $reader; + /** * Used by derived fields: The function to use to update the field value * @@ -165,6 +185,7 @@ public function __construct( $args ) { if ( ! isset( $args['name'] ) || empty( $args['name'] ) || ! is_string( $args['name'] ) ) { throw new Zoninator_REST_Exception( 'every field declaration should have a (non-empty) name string' ); } + if ( ! isset( $args['kind'] ) || ! in_array( $args['kind'], $this->field_kinds, true ) ) { throw new Zoninator_REST_Exception( 'every field should have a kind (one of ' . implode( ',', $this->field_kinds ) . ')' ); } @@ -236,6 +257,7 @@ public function is_kind( $kind ) { if ( ! in_array( $kind, $this->field_kinds, true ) ) { return false; } + return $this->kind === $kind; } @@ -285,6 +307,7 @@ public function as_item_schema_property() { if ( $this->get_choices() ) { $schema['enum'] = (array) $this->get_choices(); } + return $schema; } @@ -344,6 +367,7 @@ public function get_description() { if ( $this->description !== null && ! empty( $this->description ) ) { return $this->description; } + return ucfirst( str_replace( '_', ' ', $this->get_name() ) ); } diff --git a/lib/zoninator_rest/field/declaration/class-zoninator-rest-field-declaration-builder.php b/lib/zoninator_rest/field/declaration/class-zoninator-rest-field-declaration-builder.php index be1f932..b5117d2 100644 --- a/lib/zoninator_rest/field/declaration/class-zoninator-rest-field-declaration-builder.php +++ b/lib/zoninator_rest/field/declaration/class-zoninator-rest-field-declaration-builder.php @@ -159,6 +159,7 @@ public function with_type( $value_type ) { if ( ! is_a( $value_type, 'Zoninator_REST_Interfaces_Type' ) ) { throw new Zoninator_REST_Exception( get_class( $value_type ) . ' is not a Mixtape_Interfaces_Type' ); } + return $this->with( 'type', $value_type ); } @@ -192,6 +193,7 @@ public function with_validations( $validations ) { if ( is_callable( $validations ) || ! is_array( $validations ) ) { $validations = array( $validations ); } + return $this->with( 'validations', $validations ); } @@ -226,6 +228,7 @@ public function with_choices( $choices ) { if ( empty( $choices ) ) { return $this; } + return $this->with( 'choices', is_array( $choices ) ? $choices : array( $choices ) ); } @@ -252,6 +255,7 @@ public function derived( $func = null ) { if ( $func ) { $this->with_map_from( $func ); } + return $this->with_kind( Zoninator_REST_Field_Declaration::DERIVED ); } diff --git a/lib/zoninator_rest/interfaces/class-zoninator-rest-interfaces-type.php b/lib/zoninator_rest/interfaces/class-zoninator-rest-interfaces-type.php index 1ba208c..78cc4f5 100644 --- a/lib/zoninator_rest/interfaces/class-zoninator-rest-interfaces-type.php +++ b/lib/zoninator_rest/interfaces/class-zoninator-rest-interfaces-type.php @@ -21,16 +21,19 @@ interface Zoninator_REST_Interfaces_Type { * @return mixed */ public function cast( $value ); + /** * The default value */ public function default_value(); + /** * The type's name * * @return string */ public function name(); + /** * Sanitize this value * @@ -39,6 +42,7 @@ public function name(); * @return mixed */ public function sanitize( $value ); + /** * Get this type's JSON Schema. * diff --git a/lib/zoninator_rest/model/class-zoninator-rest-model-declaration.php b/lib/zoninator_rest/model/class-zoninator-rest-model-declaration.php index efbebbd..cc3ff54 100644 --- a/lib/zoninator_rest/model/class-zoninator-rest-model-declaration.php +++ b/lib/zoninator_rest/model/class-zoninator-rest-model-declaration.php @@ -89,6 +89,7 @@ public function call( $method, $args = array() ) { if ( is_callable( $method ) ) { return $this->perform_call( $method, $args ); } + Zoninator_REST_Expect::that( method_exists( $this, $method ), $method . ' does not exist' ); return $this->perform_call( array( $this, $method ), $args ); } diff --git a/lib/zoninator_rest/model/class-zoninator-rest-model-definition.php b/lib/zoninator_rest/model/class-zoninator-rest-model-definition.php index 682b18e..cb08871 100644 --- a/lib/zoninator_rest/model/class-zoninator-rest-model-definition.php +++ b/lib/zoninator_rest/model/class-zoninator-rest-model-definition.php @@ -20,18 +20,21 @@ class Zoninator_REST_Model_Definition implements Zoninator_REST_Interfaces_Permi * @var Zoninator_REST_Environment */ private $environment; + /** * Field Declarations * * @var array */ private $field_declarations; + /** * Model class * * @var string */ private $model_class; + /** * Data Store * @@ -123,6 +126,7 @@ public function set_data_store( $data_store ) { } else { $this->data_store = $data_store; } + // at this point we should have a data store. Zoninator_REST_Expect::is_a( $this->data_store, 'Zoninator_REST_Interfaces_Data_Store' ); @@ -172,6 +176,7 @@ public function get_field_declarations( $filter_by_type = null ) { $filtered[] = $field_declaration; } } + return $filtered; } @@ -187,6 +192,7 @@ public function create_instance( $data ) { if ( is_array( $data ) ) { return new Zoninator_REST_Model( $this, $data ); } + throw new Zoninator_REST_Exception( 'does not understand entity' ); } @@ -206,6 +212,7 @@ public function update_model_from_array( $model, $data, $updating = false ) { foreach ( $mapped_data as $name => $value ) { $model->set( $name, $value ); } + return $model->sanitize(); } @@ -245,8 +252,10 @@ public function get_dto_field_mappings() { if ( ! $field_declaration->supports_output_type( 'json' ) ) { continue; } + $mappings[ $field_declaration->get_data_transfer_name() ] = $field_declaration->get_name(); } + return $mappings; } @@ -306,6 +315,7 @@ private function map_data( $data, $updating = false ) { if ( $field->is_kind( Zoninator_REST_Field_Declaration::DERIVED ) ) { continue; } + $dto_name = $field->get_data_transfer_name(); $field_name = $field->get_name(); if ( isset( $data[ $dto_name ] ) && ! ( $updating && $field->is_primary() ) ) { @@ -313,6 +323,7 @@ private function map_data( $data, $updating = false ) { $request_data[ $field_name ] = $value; } } + return $request_data; } @@ -334,6 +345,7 @@ private function initialize_field_map( $declared_field_builders ) { $field = $field_builder->build(); $fields[ $field->get_name() ] = $field; } + return $fields; } } diff --git a/lib/zoninator_rest/model/class-zoninator-rest-model-settings.php b/lib/zoninator_rest/model/class-zoninator-rest-model-settings.php index 797442b..c158831 100644 --- a/lib/zoninator_rest/model/class-zoninator-rest-model-settings.php +++ b/lib/zoninator_rest/model/class-zoninator-rest-model-settings.php @@ -67,6 +67,7 @@ public function declare_fields() { $fields[] = $field_builder; } } + return $fields; } @@ -132,6 +133,7 @@ private function field_declaration_builder_from_data( $env, $field_data ) { // convert our default value as well. $default_value = $this->bit_to_bool( $default_value ); } + $field_builder ->with_serializer( array( $this, 'bool_to_bit' ) ) ->with_deserializer( array( $this, 'bit_to_bool' ) ); @@ -145,6 +147,7 @@ private function field_declaration_builder_from_data( $env, $field_data ) { if ( $default_value ) { $field_builder->with_default( $default_value ); } + $field_builder ->with_description( $description ) ->with_dto_name( $field_name ) diff --git a/lib/zoninator_rest/model/class-zoninator-rest-model-validationdata.php b/lib/zoninator_rest/model/class-zoninator-rest-model-validationdata.php index afa83a7..10fde3c 100644 --- a/lib/zoninator_rest/model/class-zoninator-rest-model-validationdata.php +++ b/lib/zoninator_rest/model/class-zoninator-rest-model-validationdata.php @@ -19,12 +19,14 @@ class Zoninator_REST_Model_ValidationData { * @var mixed */ private $value; + /** * The model * * @var Zoninator_REST_Interfaces_Model */ private $model; + /** * The field * diff --git a/lib/zoninator_rest/model/declaration/class-zoninator-rest-model-declaration-settings.php b/lib/zoninator_rest/model/declaration/class-zoninator-rest-model-declaration-settings.php index 10f5d12..9ed8af3 100644 --- a/lib/zoninator_rest/model/declaration/class-zoninator-rest-model-declaration-settings.php +++ b/lib/zoninator_rest/model/declaration/class-zoninator-rest-model-declaration-settings.php @@ -65,6 +65,7 @@ public function declare_fields( $env ) { $fields[] = $field_builder; } } + return $fields; } @@ -132,6 +133,7 @@ private function field_declaration_builder_from_data( $env, $field_data ) { // convert our default value as well. $default_value = $this->bit_to_bool( $default_value ); } + $field_builder ->with_serializer( array( $this, 'bool_to_bit' ) ) ->with_deserializer( array( $this, 'bit_to_bool' ) ); @@ -145,6 +147,7 @@ private function field_declaration_builder_from_data( $env, $field_data ) { if ( $default_value ) { $field_builder->with_default( $default_value ); } + $field_builder ->with_description( $description ) ->with_dto_name( $field_name ) diff --git a/lib/zoninator_rest/model/definition/class-zoninator-rest-model-definition-builder.php b/lib/zoninator_rest/model/definition/class-zoninator-rest-model-definition-builder.php index 855945d..6abf95c 100644 --- a/lib/zoninator_rest/model/definition/class-zoninator-rest-model-definition-builder.php +++ b/lib/zoninator_rest/model/definition/class-zoninator-rest-model-definition-builder.php @@ -19,18 +19,21 @@ class Zoninator_REST_Model_Definition_Builder implements Zoninator_REST_Interfac * @var Zoninator_REST_Interfaces_Model_Declaration */ private $declaration; + /** * Data Store * * @var Zoninator_REST_Interfaces_Data_Store */ private $data_store; + /** * Environment * * @var Zoninator_REST_Environment */ private $environment; + /** * Permissions Provider * @@ -56,11 +59,13 @@ public function with_declaration( $declaration ) { if ( is_string( $declaration ) && class_exists( $declaration ) ) { $declaration = new $declaration(); } + Zoninator_REST_Expect::is_a( $declaration, 'Zoninator_REST_Interfaces_Model_Declaration' ); $this->declaration = $declaration; if ( is_a( $declaration, 'Zoninator_REST_Interfaces_Permissions_Provider' ) ) { $this->with_permissions_provider( $declaration ); } + return $this; } diff --git a/lib/zoninator_rest/type/class-zoninator-rest-type-boolean.php b/lib/zoninator_rest/type/class-zoninator-rest-type-boolean.php index a093ff3..a5ec9d1 100644 --- a/lib/zoninator_rest/type/class-zoninator-rest-type-boolean.php +++ b/lib/zoninator_rest/type/class-zoninator-rest-type-boolean.php @@ -40,6 +40,7 @@ public function cast( $value ) { if ( 'false' === $value ) { return false; } + return (bool) $value; } } diff --git a/lib/zoninator_rest/type/class-zoninator-rest-type-integer.php b/lib/zoninator_rest/type/class-zoninator-rest-type-integer.php index 238f825..6359ac9 100644 --- a/lib/zoninator_rest/type/class-zoninator-rest-type-integer.php +++ b/lib/zoninator_rest/type/class-zoninator-rest-type-integer.php @@ -50,6 +50,7 @@ public function cast( $value ) { if ( ! is_numeric( $value ) ) { return $this->default_value(); } + return $this->unsigned ? absint( $value ) : intval( $value, 10 ); } diff --git a/lib/zoninator_rest/type/class-zoninator-rest-type-nullable.php b/lib/zoninator_rest/type/class-zoninator-rest-type-nullable.php index f5fc232..badcefb 100644 --- a/lib/zoninator_rest/type/class-zoninator-rest-type-nullable.php +++ b/lib/zoninator_rest/type/class-zoninator-rest-type-nullable.php @@ -47,6 +47,7 @@ public function cast( $value ) { if ( null === $value ) { return null; } + return $this->item_type_definition->cast( $value ); } @@ -60,6 +61,7 @@ public function sanitize( $value ) { if ( null === $value ) { return null; } + return $this->item_type_definition->sanitize( $value ); } diff --git a/lib/zoninator_rest/type/class-zoninator-rest-type-number.php b/lib/zoninator_rest/type/class-zoninator-rest-type-number.php index b3663c8..d9b4b6e 100644 --- a/lib/zoninator_rest/type/class-zoninator-rest-type-number.php +++ b/lib/zoninator_rest/type/class-zoninator-rest-type-number.php @@ -40,6 +40,7 @@ public function cast( $value ) { if ( ! is_numeric( $value ) ) { return $this->default_value(); } + return floatval( $value ); } diff --git a/lib/zoninator_rest/type/class-zoninator-rest-type-registry.php b/lib/zoninator_rest/type/class-zoninator-rest-type-registry.php index 98a54f1..a92681d 100644 --- a/lib/zoninator_rest/type/class-zoninator-rest-type-registry.php +++ b/lib/zoninator_rest/type/class-zoninator-rest-type-registry.php @@ -70,6 +70,7 @@ public function definition( $type ) { if ( empty( $item_type ) ) { throw new Zoninator_REST_Exception( $type . ': invalid syntax' ); } + $item_type_definition = $this->definition( $item_type ); if ( 'array' === $container_type ) { @@ -87,6 +88,7 @@ public function definition( $type ) { if ( ! isset( $types[ $type ] ) ) { throw new Zoninator_REST_Exception(); } + return $types[ $type ]; } diff --git a/lib/zoninator_rest/type/class-zoninator-rest-type-string.php b/lib/zoninator_rest/type/class-zoninator-rest-type-string.php index 040d06c..41b7ae5 100644 --- a/lib/zoninator_rest/type/class-zoninator-rest-type-string.php +++ b/lib/zoninator_rest/type/class-zoninator-rest-type-string.php @@ -51,8 +51,10 @@ public function cast( $value ) { foreach ( $value as $v ) { $cast_ones[] = $this->cast( $v ); } + return '(' . implode( ',', $cast_ones ) . ')'; } + return (string) $value; } } diff --git a/lib/zoninator_rest/type/class-zoninator-rest-type-typedarray.php b/lib/zoninator_rest/type/class-zoninator-rest-type-typedarray.php index 573c28a..ec64bcd 100644 --- a/lib/zoninator_rest/type/class-zoninator-rest-type-typedarray.php +++ b/lib/zoninator_rest/type/class-zoninator-rest-type-typedarray.php @@ -54,6 +54,7 @@ public function cast( $value ) { foreach ( $value as $v ) { $new_value[] = $this->item_type_definition->cast( $v ); } + return $new_value; } diff --git a/rector.php b/rector.php index 33d39cb..5749366 100644 --- a/rector.php +++ b/rector.php @@ -3,12 +3,9 @@ declare(strict_types=1); use Rector\CodingStyle\Rector\ClassMethod\MakeInheritedMethodVisibilitySameAsParentRector; -use Rector\CodingStyle\Rector\Stmt\NewlineAfterStatementRector; -use Rector\CodingStyle\Rector\String_\SymplifyQuoteEscapeRector; use Rector\Config\RectorConfig; use Rector\Php54\Rector\Array_\LongArrayToShortArrayRector; use Rector\Strict\Rector\Empty_\DisallowedEmptyRuleFixerRector; -use Rector\Visibility\Rector\ClassMethod\ExplicitPublicClassMethodRector; return RectorConfig::configure() ->withPaths( @@ -28,8 +25,10 @@ DisallowedEmptyRuleFixerRector::class => array( __DIR__ . '/lib/zoninator_rest/type/class-zoninator-rest-type-registry.php', ), + // Child classes can legitimately relax the visibility of a method, so while this + // might not be desirable, changing them from public to the original parent-defined + // protected would count as a breaking change. MakeInheritedMethodVisibilitySameAsParentRector::class, - NewlineAfterStatementRector::class, ) ) ->withPhpSets( php74: true ) diff --git a/tests/bootstrap.php b/tests/bootstrap.php index 69c2bc9..8804db1 100644 --- a/tests/bootstrap.php +++ b/tests/bootstrap.php @@ -4,6 +4,7 @@ if ( ! $_tests_dir ) { $_tests_dir = rtrim( sys_get_temp_dir(), '/\\' ) . '/wordpress-tests-lib'; } + if ( ! file_exists( $_tests_dir . '/includes/functions.php' ) ) { echo sprintf('Could not find %s/includes/functions.php, have you run bin/install-wp-tests.sh ?', $_tests_dir) . PHP_EOL; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped exit( 1 ); @@ -16,6 +17,7 @@ function _manually_load_plugin(): void { $file = $thispath . '/../zoninator.php'; require_once realpath( $file ); } + tests_add_filter( 'muplugins_loaded', '_manually_load_plugin' ); require $_tests_dir . '/includes/bootstrap.php'; diff --git a/tests/unit/class-zoninator-api-controller-test.php b/tests/unit/class-zoninator-api-controller-test.php index 5cf927d..11b4f4e 100644 --- a/tests/unit/class-zoninator-api-controller-test.php +++ b/tests/unit/class-zoninator-api-controller-test.php @@ -97,6 +97,7 @@ public function request( $endpoint, $method, $args = array() ) { foreach ( $args as $key => $value ) { $request->set_param( $key, $value ); } + return $this->rest_server->dispatch( $request ); } @@ -390,6 +391,7 @@ private function _insert_a_post() { if ( is_wp_error( $insert ) ) { throw new Exception( 'Error' ); } + return $insert; } @@ -398,6 +400,7 @@ private function create_a_zone( $slug, $title ) { if ( is_wp_error( $result ) ) { return $result; } + return $result['term_id'] ?? 0; } diff --git a/widget.zone-posts.php b/widget.zone-posts.php index 71a2ff0..c7d6ce9 100644 --- a/widget.zone-posts.php +++ b/widget.zone-posts.php @@ -61,7 +61,9 @@ public function widget( $args, $instance ) { description ) && $show_description ) : ?>

description ); ?>

- +
    @@ -70,7 +72,9 @@ public function widget( $args, $instance ) { ID ) ); ?> - +
@@ -82,6 +86,7 @@ public function widget( $args, $instance ) { // Save is blocked while the cache flush is in progress. return; } + wp_cache_set( 'widget-zone-posts', $cache, 'widget' ); } @@ -141,7 +146,9 @@ public function form( $instance ) { - +

diff --git a/zoninator.php b/zoninator.php index b278535..7a91015 100644 --- a/zoninator.php +++ b/zoninator.php @@ -40,25 +40,39 @@ class Zoninator { - public $key = 'zoninator'; - public $zone_taxonomy = 'zoninator_zones'; - public $zone_term_prefix = 'zone-'; - public $zone_meta_prefix = '_zoninator_order_'; - public $zone_nonce_prefix = 'zone-nonce'; + public $key = 'zoninator'; + + public $zone_taxonomy = 'zoninator_zones'; + + public $zone_term_prefix = 'zone-'; + + public $zone_meta_prefix = '_zoninator_order_'; + + public $zone_nonce_prefix = 'zone-nonce'; + public $zone_ajax_nonce_action = 'ajax-action'; - public $zone_lock_period = 30; // number of seconds a lock is valid for - public $zone_max_lock_period = 600; // max number of seconds for all locks in a session + + // Number of seconds a lock is valid for. + public $zone_lock_period = 30; + + // Max number of seconds for all locks in a session. + public $zone_max_lock_period = 600; public $post_types; + public $zone_detail_defaults = array( 'description' => '', - // Add additional properties here! + // Add additional properties here! ); + public $zone_messages; + public $posts_per_page = 10; + /** * @var Zoninator_Api */ public $rest_api; + /** * @var array|string[] Default post types that support zones. */ @@ -316,20 +330,26 @@ public function admin_page() { - - +

- +

- +
@@ -362,8 +382,10 @@ public function admin_page_zone_tabs( $zones, $active_zone_id = 0 ) { name ); ?> name ); ?> - - +
@@ -397,7 +419,9 @@ public function admin_page_zone_edit( $zone = null ) {

_get_message( 'error-zone-lock' ), sprintf( '%s', esc_attr( $locking_user->user_email ), esc_html( $locking_user->display_name ) ) ); ?>

- +
@@ -418,7 +442,9 @@ public function admin_page_zone_edit( $zone = null ) {
- +
@@ -432,14 +458,18 @@ public function admin_page_zone_edit( $zone = null ) { _get_nonce_key( 'update' ) ); ?> _get_nonce_key( 'insert' ) ); ?> - +
- +
@@ -471,7 +501,9 @@ public function admin_page_zone_edit( $zone = null ) {
- + _get_nonce_key( $this->zone_ajax_nonce_action ), $this->_get_nonce_key( $this->zone_ajax_nonce_action ), false ); ?> @@ -498,17 +530,22 @@ public function admin_page_zone_edit( $zone = null ) {
admin_page_zone_post( $post, $zone ); ?> - +

- +
- +
- "> - - + @@ -548,6 +587,7 @@ public function admin_page_zone_post_col_position( $post, $zone ) { %s', get_edit_post_link( $post->ID ), __( 'Opens in new window', 'zoninator' ), __( 'Edit', 'zoninator' ) ), @@ -611,6 +651,7 @@ public function zone_advanced_search_date_filter() { $output = ( $timestamp ) ? date( 'Y-m-d', $timestamp ) : 0; $label = $date; } + printf( '', esc_attr( $output ), selected( $output, $current_date, false ), esc_html( $label ) ); endforeach; ?> @@ -667,6 +708,7 @@ public function ajax_recent_posts() { foreach ( $recent_posts as $post ) : $content .= sprintf( '', $post->ID, get_the_title( $post->ID ) . ' (' . $post->post_status . ')' ); endforeach; + wp_reset_postdata(); $status = 1; } @@ -716,6 +758,7 @@ public function zone_admin_recent_posts_dropdown( $zone_id ) { foreach ( $recent_posts as $post ) : printf( '', $post->ID, esc_html( get_the_title( $post->ID ) . ' (' . $post->post_status . ')' ) ); endforeach; + wp_reset_postdata(); ?> @@ -875,6 +918,7 @@ public function ajax_search_posts() { if ( $limit <= 0 ) { $limit = $this->posts_per_page; } + $exclude = (array) $this->_get_request_var( 'exclude', array(), 'absint' ); $args = apply_filters( @@ -1043,6 +1087,7 @@ public function update_zone( $zone, $data = array() ) { return wp_update_term( $zone_id, $this->zone_taxonomy, $args ); } + return new WP_Error( 'invalid-zone', __( "Sorry, that zone doesn't exist.", 'zoninator' ) ); } @@ -1066,6 +1111,7 @@ public function delete_zone( $zone ) { return $delete; } } + return new WP_Error( 'invalid-zone', __( "Sorry, that zone doesn't exist.", 'zoninator' ) ); } @@ -1096,6 +1142,7 @@ public function add_zone_posts( $zone, $posts, $append = false ) { ++$order; update_metadata( 'post', $post_id, $meta_key, $order, true ); } + // TODO: remove_object_terms -- but need remove object terms function :( } @@ -1414,6 +1461,7 @@ public function get_zone_slug( $zone ) { public function get_formatted_zone_slug( $slug ) { return $slug; // legacy function -- slugs can no longer be changed } + public function get_unformatted_zone_slug( $slug ) { return $slug; // legacy function -- slugs can no longer be changed } @@ -1507,6 +1555,7 @@ public function do_zoninator_feeds() { if ( is_wp_error( $results ) ) { $this->send_user_error( $results->get_error_message() ); } + $this->json_return( $results ); } } @@ -1524,12 +1573,15 @@ private function filter_zone_feed_fields( $results ) { if ( ! isset( $filtered_results[ $i ] ) ) { $filtered_results[ $i ] = new stdClass(); } + foreach ( $whitelisted_fields as $field ) { if ( ! isset( $filtered_results[ $i ] ) ) { $filtered_results[ $i ] = new stdClass(); } + $filtered_results[ $i ]->$field = $result->$field; } + ++$i; } @@ -1696,6 +1748,7 @@ public function _get_request_var( $var, $default = '', $sanitize_callback = '' ) public function _get_get_var( $var, $default = '', $sanitize_callback = '' ) { return $this->_get_value_or_default( $var, $_GET, $default, $sanitize_callback ); } + public function _get_post_var( $var, $default = '', $sanitize_callback = '' ) { return $this->_get_value_or_default( $var, $_POST, $default, $sanitize_callback ); } @@ -1793,6 +1846,7 @@ function Zoninator() { if ( ! isset( $zoninator ) || null === $zoninator ) { $zoninator = new Zoninator(); } + return $zoninator; } From b479dec1e39ae93dce9d9161afddf3eb49771157 Mon Sep 17 00:00:00 2001 From: Gary Jones Date: Wed, 14 Aug 2024 12:21:38 +0100 Subject: [PATCH 40/56] CS: Rector with back-compat later PHP rules --- rector.php | 35 +++++++++++++++++++++++++++++++++++ zoninator.php | 1 + 2 files changed, 36 insertions(+) diff --git a/rector.php b/rector.php index 5749366..c5b0d92 100644 --- a/rector.php +++ b/rector.php @@ -2,9 +2,19 @@ declare(strict_types=1); +use Rector\CodeQuality\Rector\ClassMethod\OptionalParametersAfterRequiredRector; use Rector\CodingStyle\Rector\ClassMethod\MakeInheritedMethodVisibilitySameAsParentRector; +use Rector\CodingStyle\Rector\FuncCall\ConsistentImplodeRector; use Rector\Config\RectorConfig; +use Rector\DeadCode\Rector\StaticCall\RemoveParentCallWithoutParentRector; use Rector\Php54\Rector\Array_\LongArrayToShortArrayRector; +use Rector\Php80\Rector\Identical\StrEndsWithRector; +use Rector\Php80\Rector\Identical\StrStartsWithRector; +use Rector\Php80\Rector\NotIdentical\StrContainsRector; +use Rector\Php81\Rector\FuncCall\NullToStrictStringFuncCallArgRector; +use Rector\Php82\Rector\Encapsed\VariableInStringInterpolationFixerRector; +use Rector\Php83\Rector\ClassMethod\AddOverrideAttributeToOverriddenMethodsRector; +use Rector\Php84\Rector\Param\ExplicitNullableParamTypeRector; use Rector\Strict\Rector\Empty_\DisallowedEmptyRuleFixerRector; return RectorConfig::configure() @@ -32,5 +42,30 @@ ) ) ->withPhpSets( php74: true ) + // Changes from later PHP Sets that are backwards compatible: + ->withRules( + array( + // 8.0 + ConsistentImplodeRector::class, + OptionalParametersAfterRequiredRector::class, + RemoveParentCallWithoutParentRector::class, + // Backfilled from PHP 8.0 into WP 5.9, so these can be used. + StrContainsRector::class, + StrEndsWithRector::class, + StrStartsWithRector::class, + + // 8.1 + NullToStrictStringFuncCallArgRector::class, + + // 8.2 + VariableInStringInterpolationFixerRector::class, + + // 8.3 + AddOverrideAttributeToOverriddenMethodsRector::class, + + // 8.4 + ExplicitNullableParamTypeRector::class, + ) + ) ->withPreparedSets( deadCode: true, codeQuality: true, instanceOf: true, codingStyle: true ) ->withTypeCoverageLevel( 1 ); diff --git a/zoninator.php b/zoninator.php index 7a91015..d909481 100644 --- a/zoninator.php +++ b/zoninator.php @@ -57,6 +57,7 @@ class Zoninator { // Max number of seconds for all locks in a session. public $zone_max_lock_period = 600; + public $post_types; public $zone_detail_defaults = array( From 32e2d8d3016dfc28c320558155dc92fdd3a9c8b4 Mon Sep 17 00:00:00 2001 From: Gary Jones Date: Wed, 14 Aug 2024 18:37:02 +0100 Subject: [PATCH 41/56] CS: Rector changes from merge conflict resolution These changes were missed during the merge conflict resolution. --- .../class-zoninator-rest-classloader.php | 4 ++++ .../class-zoninator-rest-environment.php | 12 ++++-------- lib/zoninator_rest/class-zoninator-rest-model.php | 3 +-- .../class-zoninator-rest-controller-action.php | 3 --- .../class-zoninator-rest-controller-route.php | 3 +-- .../model/class-zoninator-rest-model-definition.php | 2 -- 6 files changed, 10 insertions(+), 17 deletions(-) diff --git a/lib/zoninator_rest/class-zoninator-rest-classloader.php b/lib/zoninator_rest/class-zoninator-rest-classloader.php index c1eba3d..62339f5 100644 --- a/lib/zoninator_rest/class-zoninator-rest-classloader.php +++ b/lib/zoninator_rest/class-zoninator-rest-classloader.php @@ -105,6 +105,7 @@ public function prefixed_class_name( $class_name, $prefix = null ) { if ( empty( $prefix ) ) { $prefix = $this->prefix; } + return $prefix . '_' . $this->strip_prefix( $class_name, $prefix ); } @@ -120,6 +121,7 @@ private function strip_prefix( $class_name, $prefix = null ) { if ( empty( $prefix ) ) { $prefix = $this->prefix; } + return str_replace( $prefix, '', $class_name ); } @@ -135,9 +137,11 @@ private function include_class_file( $path_to_the_class ) { if ( isset( $this->loaded_classes[ $path_to_the_class ] ) ) { return $this; } + if ( ! file_exists( $path_to_the_class ) ) { throw new Exception( $path_to_the_class . ' not found' ); } + $included = include_once $path_to_the_class; $this->loaded_classes[ $path_to_the_class ] = $included; diff --git a/lib/zoninator_rest/class-zoninator-rest-environment.php b/lib/zoninator_rest/class-zoninator-rest-environment.php index 73ed772..39fde39 100644 --- a/lib/zoninator_rest/class-zoninator-rest-environment.php +++ b/lib/zoninator_rest/class-zoninator-rest-environment.php @@ -32,14 +32,14 @@ class Zoninator_REST_Environment { * * @var array */ - protected $rest_apis; + protected $rest_apis = array(); /** * This environment's model definitions * * @var array */ - protected $model_definitions; + protected $model_definitions = array(); /** * The Environment Variables @@ -48,14 +48,14 @@ class Zoninator_REST_Environment { * * @var array */ - protected $variables; + protected $variables = array(); /** * Did this Environment start? * * @var bool */ - private $has_started; + private $has_started = false; /** * Our Bootstrap @@ -78,10 +78,6 @@ class Zoninator_REST_Environment { */ public function __construct( $bootstrap ) { $this->bootstrap = $bootstrap; - $this->has_started = false; - $this->rest_apis = array(); - $this->variables = array(); - $this->model_definitions = array(); $this->type_registry = new Zoninator_REST_Type_Registry(); $this->type_registry->initialize( $this ); // initialize our array vars. diff --git a/lib/zoninator_rest/class-zoninator-rest-model.php b/lib/zoninator_rest/class-zoninator-rest-model.php index 66b8900..670da01 100644 --- a/lib/zoninator_rest/class-zoninator-rest-model.php +++ b/lib/zoninator_rest/class-zoninator-rest-model.php @@ -49,7 +49,7 @@ class Zoninator_REST_Model implements * * @var array */ - private $data; + private $data = array(); /** * Our raw data @@ -68,7 +68,6 @@ class Zoninator_REST_Model implements */ public function __construct( $data = array(), $args = array() ) { Zoninator_REST_Expect::that( is_array( $data ), '$data should be an array' ); - $this->data = array(); if ( isset( $args['deserialize'] ) && true === $args['deserialize'] ) { unset( $args['deserialize'] ); diff --git a/lib/zoninator_rest/controller/class-zoninator-rest-controller-action.php b/lib/zoninator_rest/controller/class-zoninator-rest-controller-action.php index 00ed599..46a04aa 100644 --- a/lib/zoninator_rest/controller/class-zoninator-rest-controller-action.php +++ b/lib/zoninator_rest/controller/class-zoninator-rest-controller-action.php @@ -69,9 +69,6 @@ public function __construct( $controller, $action_name ) { $this->controller = $controller; $this->action_name = $action_name; - $this->handler = null; - $this->args = null; - $this->permission_callback = null; } /** diff --git a/lib/zoninator_rest/controller/class-zoninator-rest-controller-route.php b/lib/zoninator_rest/controller/class-zoninator-rest-controller-route.php index a7432f5..a8a27b1 100644 --- a/lib/zoninator_rest/controller/class-zoninator-rest-controller-route.php +++ b/lib/zoninator_rest/controller/class-zoninator-rest-controller-route.php @@ -26,7 +26,7 @@ class Zoninator_REST_Controller_Route { * * @var array */ - private $actions; + private $actions = array(); /** * Zoninator_REST_Controller_Route constructor. @@ -36,7 +36,6 @@ class Zoninator_REST_Controller_Route { */ public function __construct( $controller, $pattern ) { $this->pattern = $pattern; - $this->actions = array(); } /** diff --git a/lib/zoninator_rest/model/class-zoninator-rest-model-definition.php b/lib/zoninator_rest/model/class-zoninator-rest-model-definition.php index cb08871..a291914 100644 --- a/lib/zoninator_rest/model/class-zoninator-rest-model-definition.php +++ b/lib/zoninator_rest/model/class-zoninator-rest-model-definition.php @@ -82,8 +82,6 @@ public function __construct( $environment, $model_declaration, $data_store, $per Zoninator_REST_Expect::is_a( $environment, 'Zoninator_REST_Environment' ); Zoninator_REST_Expect::is_a( $model_declaration, 'Zoninator_REST_Interfaces_Model_Declaration' ); Zoninator_REST_Expect::is_a( $permissions_provider, 'Zoninator_REST_Interfaces_Permissions_Provider' ); - - $this->field_declarations = null; $this->environment = $environment; $this->model_declaration = $model_declaration; $this->model_class = get_class( $model_declaration ); From 9879b9176f6cc6ab67af9c3e15a9a888748b2be4 Mon Sep 17 00:00:00 2001 From: Gary Jones Date: Fri, 16 Aug 2024 18:49:50 +0100 Subject: [PATCH 42/56] CS: Fix or ignore coding standards issues Some of these will need to be addressed, but for the moment, CI runs of testing coding standards should now pass. --- .phpcs.xml.dist | 14 +- functions.php | 1 + includes/class-zoninator-api-controller.php | 69 ++++---- .../class-zoninator-api-filter-search.php | 2 +- .../class-zoninator-api-schema-converter.php | 3 +- .../class-zoninator-rest-classloader.php | 4 +- .../class-zoninator-rest-environment.php | 24 +-- .../class-zoninator-rest-expect.php | 4 +- .../class-zoninator-rest-model.php | 8 +- ...class-zoninator-rest-controller-action.php | 22 +-- ...class-zoninator-rest-controller-bundle.php | 2 +- .../class-zoninator-rest-controller-crud.php | 6 +- .../class-zoninator-rest-controller-model.php | 3 +- ...ass-zoninator-rest-controller-settings.php | 2 +- ...ninator-rest-data-store-customposttype.php | 8 + ...class-zoninator-rest-field-declaration.php | 16 +- ...ninator-rest-field-declaration-builder.php | 4 +- ...s-zoninator-rest-interfaces-data-store.php | 2 +- ...class-zoninator-rest-model-declaration.php | 6 +- .../class-zoninator-rest-type-registry.php | 9 +- widget.zone-posts.php | 9 +- zoninator.php | 159 ++++++++---------- 22 files changed, 197 insertions(+), 180 deletions(-) diff --git a/.phpcs.xml.dist b/.phpcs.xml.dist index 6cdf13e..a0f9d5a 100644 --- a/.phpcs.xml.dist +++ b/.phpcs.xml.dist @@ -9,6 +9,7 @@ . + /node_modules/ /vendor/ /tests/ @@ -36,8 +37,17 @@ - - + + + + + widget.zone-posts.php + zoninator.php + + + widget.zone-posts.php + + diff --git a/functions.php b/functions.php index 43d6e68..0287374 100644 --- a/functions.php +++ b/functions.php @@ -1,4 +1,5 @@ bad_request( array( 'message' => $results->get_error_message(), - ) + ) ); } @@ -142,23 +142,23 @@ public function get_zones( $request ) { * @return WP_Error|WP_REST_Response */ public function create_zone( $request ) { - $name = $this->_get_param( $request, 'name', '' ); - $slug = $this->_get_param( $request, 'slug', $name ); - $description = $this->_get_param( $request, 'description', '' ); + $name = $this->get_param( $request, 'name', '' ); + $slug = $this->get_param( $request, 'slug', $name ); + $description = $this->get_param( $request, 'description', '' ); $result = $this->instance->insert_zone( $slug, $name, array( 'description' => $description, - ) + ) ); if ( is_wp_error( $result ) ) { return $this->bad_request( array( 'message' => $result->get_error_message(), - ) + ) ); } @@ -174,10 +174,10 @@ public function create_zone( $request ) { * @return WP_Error|WP_REST_Response */ public function update_zone( $request ) { - $zone_id = $this->_get_param( $request, 'zone_id', 0, 'absint' ); - $name = $this->_get_param( $request, 'name', '' ); - $slug = $this->_get_param( $request, 'slug', '' ); - $description = $this->_get_param( $request, 'description', '', 'strip_tags' ); + $zone_id = $this->get_param( $request, 'zone_id', 0, 'absint' ); + $name = $this->get_param( $request, 'name', '' ); + $slug = $this->get_param( $request, 'slug', '' ); + $description = $this->get_param( $request, 'description', '', 'strip_tags' ); $zone = $this->instance->get_zone( $zone_id ); $update_params = array(); @@ -204,7 +204,7 @@ public function update_zone( $request ) { return $this->bad_request( array( 'message' => $result->get_error_message(), - ) + ) ); } @@ -218,7 +218,7 @@ public function update_zone( $request ) { * @return WP_Error|WP_REST_Response */ public function delete_zone( $request ) { - $zone_id = $this->_get_param( $request, 'zone_id', 0, 'absint' ); + $zone_id = $this->get_param( $request, 'zone_id', 0, 'absint' ); $zone = $this->instance->get_zone( $zone_id ); @@ -232,7 +232,7 @@ public function delete_zone( $request ) { return $this->bad_request( array( 'message' => $result->get_error_message(), - ) + ) ); } @@ -246,7 +246,7 @@ public function delete_zone( $request ) { * @return WP_Error|WP_REST_Response */ public function get_zone_posts( $request ) { - $zone_id = $this->_get_param( $request, 'zone_id', 0, 'absint' ); + $zone_id = $this->get_param( $request, 'zone_id', 0, 'absint' ); if ( empty( $zone_id ) || false === $this->instance->get_zone( $zone_id ) ) { return $this->not_found( $this->translations[ self::INVALID_ZONE_ID ] ); @@ -268,8 +268,8 @@ public function get_zone_posts( $request ) { * @return WP_Error|WP_REST_Response */ public function update_zone_posts( $request ) { - $zone_id = $this->_get_param( $request, 'zone_id', 0, 'absint' ); - $post_ids = $this->_get_param( $request, 'post_ids', array() ); + $zone_id = $this->get_param( $request, 'zone_id', 0, 'absint' ); + $post_ids = $this->get_param( $request, 'post_ids', array() ); if ( ! $this->instance->get_zone( $zone_id ) ) { return $this->not_found( $this->translations[ self::INVALID_ZONE_ID ] ); @@ -281,7 +281,7 @@ public function update_zone_posts( $request ) { return $this->bad_request( array( 'message' => $this->translations[ self::INVALID_POST_ID ], - ) + ) ); } @@ -301,7 +301,7 @@ public function update_zone_posts( $request ) { * @return WP_Error|WP_REST_Response */ public function zone_update_lock( $request ) { - $zone_id = $this->_get_param( $request, 'zone_id', 0, 'absint' ); + $zone_id = $this->get_param( $request, 'zone_id', 0, 'absint' ); if ( ! $zone_id ) { return $this->_bad_request( self::ZONE_ID_REQUIRED, __( 'zone id required', 'zoninator' ) ); } @@ -330,7 +330,7 @@ public function zone_update_lock( $request ) { 'timeout' => $this->instance->zone_lock_period, 'max_lock_period' => $this->instance->zone_max_lock_period, ), - 200 + 200 ); } @@ -371,7 +371,7 @@ public function get_zone_posts_permissions_check( $request ) { * @return WP_Error|bool */ public function update_zone_permissions_check( $request ) { - $zone_id = $this->_get_param( $request, 'zone_id', 0, 'absint' ); + $zone_id = $this->get_param( $request, 'zone_id', 0, 'absint' ); return $this->_permissions_check( 'update', $zone_id ); } @@ -389,15 +389,16 @@ public function sanitize_string( $item ) { } /** - * @param WP_REST_Request $object - * @param $var - * @param string $default + * @param WP_REST_Request $rest_request + * @param string $key Parameter name. + * @param string $default_value * @param string $sanitize_callback + * * @return array|mixed|null|string */ - private function _get_param( $object, $var, $default = '', $sanitize_callback = '' ) { - $value = $object->get_param( $var ); - $value = empty( $value ) ? $default : $value; + private function get_param( $rest_request, $key, $default_value = '', $sanitize_callback = '' ) { + $value = $rest_request->get_param( $key ); + $value = empty( $value ) ? $default_value : $value; if ( is_callable( $sanitize_callback ) ) { $value = ( is_array( $value ) ) ? array_map( $sanitize_callback, $value ) : call_user_func( $sanitize_callback, $value ); @@ -406,7 +407,7 @@ private function _get_param( $object, $var, $default = '', $sanitize_callback = return $value; } - public function _params_for_create_zone() { + public function _params_for_create_zone() { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore return array( 'name' => array( 'type' => 'string', @@ -429,7 +430,7 @@ public function _params_for_create_zone() { ); } - public function _params_for_update_zone() { + public function _params_for_update_zone() { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore return array( 'name' => array( 'type' => 'string', @@ -449,7 +450,7 @@ public function _params_for_update_zone() { ); } - public function _get_zone_id_param() { + public function _get_zone_id_param() { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore return array( 'zone_id' => array( 'type' => 'integer', @@ -460,7 +461,7 @@ public function _get_zone_id_param() { ); } - public function _get_zone_post_rest_route_params() { + public function _get_zone_post_rest_route_params() { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore $zone_params = $this->_get_zone_id_param(); return array_merge( array( @@ -471,11 +472,11 @@ public function _get_zone_post_rest_route_params() { 'items' => array( 'type' => 'integer' ), ), ), - $zone_params + $zone_params ); } - public function _filter_zone_properties( $zone ) { + public function _filter_zone_properties( $zone ) { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore $data = $zone->to_array(); return array( @@ -486,7 +487,7 @@ public function _filter_zone_properties( $zone ) { ); } - private function _bad_request( $code, $message ) { + private function _bad_request( $code, $message ) { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore return new WP_Error( $code, $message, array( 'status' => 400 ) ); } @@ -494,7 +495,7 @@ private function _bad_request( $code, $message ) { * @param $zone_id * @return bool|WP_Error */ - private function _permissions_check( $action, $zone_id = null ) { + private function _permissions_check( $action, $zone_id = null ) { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore if ( ! $this->instance->check( $action, $zone_id ) ) { return new WP_Error( self::PERMISSION_DENIED, __( "Sorry, you're not supposed to do that...", 'zoninator' ) ); } diff --git a/includes/class-zoninator-api-filter-search.php b/includes/class-zoninator-api-filter-search.php index 54d1b8c..8e394fc 100644 --- a/includes/class-zoninator-api-filter-search.php +++ b/includes/class-zoninator-api-filter-search.php @@ -68,7 +68,7 @@ public function strip_slashes( $item ) { } public function strip_tags( $item ) { - return strip_tags( $item ); + return wp_strip_all_tags( $item ); } public function date_before_set( $model, $item ) { diff --git a/includes/class-zoninator-api-schema-converter.php b/includes/class-zoninator-api-schema-converter.php index e0db40d..9f6dd38 100644 --- a/includes/class-zoninator-api-schema-converter.php +++ b/includes/class-zoninator-api-schema-converter.php @@ -27,10 +27,11 @@ public function as_schema( $model_definition ) { '$schema' => 'http://json-schema.org/schema#', 'title' => $model_definition->get_name(), 'type' => 'object', + // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedHooknameFound -- applying a core filter. 'properties' => (array) apply_filters( 'rest_api_schema_properties', $properties, $model_definition ), ); - if ( $required !== array() ) { + if ( array() !== $required ) { $schema['required'] = $required; } diff --git a/lib/zoninator_rest/class-zoninator-rest-classloader.php b/lib/zoninator_rest/class-zoninator-rest-classloader.php index 62339f5..b593177 100644 --- a/lib/zoninator_rest/class-zoninator-rest-classloader.php +++ b/lib/zoninator_rest/class-zoninator-rest-classloader.php @@ -48,7 +48,7 @@ public function __construct( $prefix, $base_dir ) { $this->prefix = $prefix; $this->base_dir = $base_dir; if ( ! is_dir( $this->base_dir ) ) { - throw new Exception( 'base_dir does not exist: ' . $this->base_dir ); + throw new Exception( esc_html( 'base_dir does not exist: ' . $this->base_dir ) ); } } @@ -139,7 +139,7 @@ private function include_class_file( $path_to_the_class ) { } if ( ! file_exists( $path_to_the_class ) ) { - throw new Exception( $path_to_the_class . ' not found' ); + throw new Exception( esc_html( $path_to_the_class . ' not found' ) ); } $included = include_once $path_to_the_class; diff --git a/lib/zoninator_rest/class-zoninator-rest-environment.php b/lib/zoninator_rest/class-zoninator-rest-environment.php index 39fde39..ee40ab9 100644 --- a/lib/zoninator_rest/class-zoninator-rest-environment.php +++ b/lib/zoninator_rest/class-zoninator-rest-environment.php @@ -77,8 +77,8 @@ class Zoninator_REST_Environment { * @param Zoninator_REST_Bootstrap $bootstrap The bootstrap. */ public function __construct( $bootstrap ) { - $this->bootstrap = $bootstrap; - $this->type_registry = new Zoninator_REST_Type_Registry(); + $this->bootstrap = $bootstrap; + $this->type_registry = new Zoninator_REST_Type_Registry(); $this->type_registry->initialize( $this ); // initialize our array vars. $this->array_var( self::MODELS ) @@ -106,17 +106,18 @@ public function push_builder( $where, $builder ) { /** * Retrieve a previously defined Zoninator_REST_Model * - * @param string $class the class name. + * @param string $class_name the class name. + * * @return Zoninator_REST_Model the definition. * @throws Zoninator_REST_Exception Throws in case the model is not registered. */ - public function model( $class ) { - if ( ! class_exists( $class ) ) { - throw new Zoninator_REST_Exception( $class . ' does not exist' ); + public function model( $class_name ) { + if ( ! class_exists( $class_name ) ) { + throw new Zoninator_REST_Exception( esc_html( $class_name . ' does not exist' ) ); } - Zoninator_REST_Expect::that( isset( $this->model_definitions[ $class ] ), $class . ' definition does not exist' ); - return $this->model_definitions[ $class ]; + Zoninator_REST_Expect::that( isset( $this->model_definitions[ $class_name ] ), $class_name . ' definition does not exist' ); + return $this->model_definitions[ $class_name ]; } /** @@ -161,6 +162,7 @@ public function start() { } if ( false === $this->has_started ) { + // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedHooknameFound do_action( 'mt_environment_before_start', $this, get_class( $this ) ); $this->load_pending_builders( self::MODELS ); $this->load_pending_builders( self::BUNDLES ); @@ -180,7 +182,7 @@ public function start() { * @param array $rest_apis The existing rest apis. * @param Zoninator_REST_Environment $this The Environment. */ - $rest_apis = (array) apply_filters( 'mt_environment_get_rest_apis', $this->rest_apis, $this ); + $rest_apis = (array) apply_filters( 'mt_environment_get_rest_apis', $this->rest_apis, $this ); // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedHooknameFound foreach ( $rest_apis as $bundle ) { /** @@ -190,7 +192,7 @@ public function start() { } $this->has_started = true; - do_action( 'mt_environment_after_start', $this ); + do_action( 'mt_environment_after_start', $this ); // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedHooknameFound } return $this; @@ -250,7 +252,7 @@ public function get( $name ) { * * @return mixed */ - return apply_filters( 'mt_variable_get', $value, $this, $name ); + return apply_filters( 'mt_variable_get', $value, $this, $name ); // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedHooknameFound } /** diff --git a/lib/zoninator_rest/class-zoninator-rest-expect.php b/lib/zoninator_rest/class-zoninator-rest-expect.php index b6db20d..a1a8e4f 100644 --- a/lib/zoninator_rest/class-zoninator-rest-expect.php +++ b/lib/zoninator_rest/class-zoninator-rest-expect.php @@ -48,7 +48,7 @@ public static function is_object( $thing ) { */ public static function that( $cond, $fail_message ) { if ( ! $cond ) { - throw new Zoninator_REST_Exception( $fail_message ); + throw new Zoninator_REST_Exception( esc_html( $fail_message ) ); } } @@ -60,6 +60,6 @@ public static function that( $cond, $fail_message ) { * @throws Zoninator_REST_Exception To Override this. */ public static function should_override( $method ) { - throw new Zoninator_REST_Exception( $method . ' should be overridden' ); + throw new Zoninator_REST_Exception( esc_html( $method . ' should be overridden' ) ); } } diff --git a/lib/zoninator_rest/class-zoninator-rest-model.php b/lib/zoninator_rest/class-zoninator-rest-model.php index 670da01..3c68817 100644 --- a/lib/zoninator_rest/class-zoninator-rest-model.php +++ b/lib/zoninator_rest/class-zoninator-rest-model.php @@ -158,7 +158,7 @@ public function validate() { } } - if ( $validation_errors !== array() ) { + if ( array() !== $validation_errors ) { return $this->validation_error( $validation_errors ); } @@ -218,7 +218,7 @@ protected function run_field_validations( $field_declaration ) { $value = $this->get( $field_declaration->get_name() ); if ( $field_declaration->is_required() && empty( $value ) ) { // translators: %s is usually a field name. - $message = sprintf( __( '%s cannot be empty', 'mixtape' ), $field_declaration->get_name() ); + $message = sprintf( __( '%s cannot be empty', 'zoninator' ), $field_declaration->get_name() ); return new WP_Error( 'required-field-empty', $message ); } elseif ( ! $field_declaration->is_required() && ! empty( $value ) ) { foreach ( $field_declaration->get_validations() as $validation ) { @@ -229,7 +229,7 @@ protected function run_field_validations( $field_declaration ) { 'reason' => $result->get_error_messages(), 'field' => $field_declaration->get_data_transfer_name(), 'value' => $value, - ) + ) ); return $result; } @@ -583,7 +583,7 @@ public static function from_raw_data( $post ) { $merged_data, array( 'deserialize' => true, - ) + ) ); } diff --git a/lib/zoninator_rest/controller/class-zoninator-rest-controller-action.php b/lib/zoninator_rest/controller/class-zoninator-rest-controller-action.php index 46a04aa..e7b2583 100644 --- a/lib/zoninator_rest/controller/class-zoninator-rest-controller-action.php +++ b/lib/zoninator_rest/controller/class-zoninator-rest-controller-action.php @@ -67,8 +67,8 @@ public function __construct( $controller, $action_name ) { $is_known_action = in_array( $action_name, array_keys( $this->actions_to_http_methods ), true ); Zoninator_REST_Expect::that( $is_known_action, 'Unknown method: ' . $action_name ); - $this->controller = $controller; - $this->action_name = $action_name; + $this->controller = $controller; + $this->action_name = $action_name; } /** @@ -83,36 +83,36 @@ public function name() { /** * Set Permissions * - * @param mixed $callable A Callable. + * @param mixed $a_callable A Callable. * * @return Zoninator_REST_Controller_Action */ - public function permissions( $callable ) { - $this->permission_callback = $callable; + public function permissions( $a_callable ) { + $this->permission_callback = $a_callable; return $this; } /** * Set Handler * - * @param mixed $callable A Callable. + * @param mixed $a_callable A Callable. * * @return Zoninator_REST_Controller_Action */ - public function callback( $callable ) { - $this->handler = $callable; + public function callback( $a_callable ) { + $this->handler = $a_callable; return $this; } /** * Set Handler * - * @param mixed $callable A Callable. + * @param mixed $a_callable A Callable. * * @return Zoninator_REST_Controller_Action */ - public function args( $callable ) { - $this->args = $callable; + public function args( $a_callable ) { + $this->args = $a_callable; return $this; } diff --git a/lib/zoninator_rest/controller/class-zoninator-rest-controller-bundle.php b/lib/zoninator_rest/controller/class-zoninator-rest-controller-bundle.php index 16a712c..2475990 100644 --- a/lib/zoninator_rest/controller/class-zoninator-rest-controller-bundle.php +++ b/lib/zoninator_rest/controller/class-zoninator-rest-controller-bundle.php @@ -65,7 +65,7 @@ public function register( $environment ) { * @return array */ $endpoints = (array) apply_filters( - 'mt_rest_api_controller_bundle_get_endpoints', + 'mt_rest_api_controller_bundle_get_endpoints', // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedHooknameFound $this->endpoints, $this ); diff --git a/lib/zoninator_rest/controller/class-zoninator-rest-controller-crud.php b/lib/zoninator_rest/controller/class-zoninator-rest-controller-crud.php index 9d5567d..aa8436a 100644 --- a/lib/zoninator_rest/controller/class-zoninator-rest-controller-crud.php +++ b/lib/zoninator_rest/controller/class-zoninator-rest-controller-crud.php @@ -7,7 +7,7 @@ if ( ! defined( 'ABSPATH' ) ) { exit; -} // End if(). +} /** * Class Zoninator_REST_Controller_CRUD @@ -45,7 +45,7 @@ public function get_items( $request ) { $model = $this->model_prototype->get_data_store()->get_entity( $item_id ); if ( empty( $model ) ) { - return $this->not_found( __( 'Model not found' ) ); + return $this->not_found( __( 'Model not found', 'zoninator' ) ); } return $this->ok( $this->prepare_dto( $model ) ); @@ -128,7 +128,7 @@ protected function create_or_update( $request, $is_update = false ) { $dto = $this->prepare_dto( array( 'id' => absint( $id_or_error ), - ) + ) ); return $is_update ? $this->ok( $dto ) : $this->created( $dto ); diff --git a/lib/zoninator_rest/controller/class-zoninator-rest-controller-model.php b/lib/zoninator_rest/controller/class-zoninator-rest-controller-model.php index 888b2fa..b5879a0 100644 --- a/lib/zoninator_rest/controller/class-zoninator-rest-controller-model.php +++ b/lib/zoninator_rest/controller/class-zoninator-rest-controller-model.php @@ -102,10 +102,11 @@ public function get_item_schema() { '$schema' => 'http://json-schema.org/schema#', 'title' => $model_definition->get_name(), 'type' => 'object', + // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedHooknameFound -- breaking change to fix prefix. 'properties' => (array) apply_filters( 'mixtape_rest_api_schema_properties', $properties, $this->get_model_prototype() ), ); - if ( $required !== array() ) { + if ( array() !== $required ) { $schema['required'] = $required; } diff --git a/lib/zoninator_rest/controller/class-zoninator-rest-controller-settings.php b/lib/zoninator_rest/controller/class-zoninator-rest-controller-settings.php index 05ea322..fd77185 100644 --- a/lib/zoninator_rest/controller/class-zoninator-rest-controller-settings.php +++ b/lib/zoninator_rest/controller/class-zoninator-rest-controller-settings.php @@ -32,7 +32,7 @@ public function setup() { public function get_items( $request ) { $model = $this->model_prototype->get_data_store()->get_entity( null ); if ( empty( $model ) ) { - return $this->not_found( __( 'Settings not found' ) ); + return $this->not_found( __( 'Settings not found', 'zoninator' ) ); } return $this->ok( $this->prepare_dto( $model ) ); diff --git a/lib/zoninator_rest/data/store/class-zoninator-rest-data-store-customposttype.php b/lib/zoninator_rest/data/store/class-zoninator-rest-data-store-customposttype.php index e7887c5..0ea0100 100644 --- a/lib/zoninator_rest/data/store/class-zoninator-rest-data-store-customposttype.php +++ b/lib/zoninator_rest/data/store/class-zoninator-rest-data-store-customposttype.php @@ -112,19 +112,23 @@ public function delete( $model, $args = array() ) { ) ); + // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedHooknameFound do_action( 'mixtape_data_store_delete_model_before', $model, $id ); if ( $args['force_delete'] ) { $result = wp_delete_post( $model->get_id() ); $model->set( 'id', 0 ); + // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedHooknameFound do_action( 'mixtape_data_store_delete_model', $model, $id ); } else { $result = wp_trash_post( $model->get_id() ); $model->set( 'status', 'trash' ); + // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedHooknameFound do_action( 'mixtape_data_store_trash_model', $model, $id ); } if ( false === $result ) { + // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedHooknameFound do_action( 'mixtape_data_store_delete_model_fail', $model, $id ); return new WP_Error( 'delete-failed', 'delete-failed' ); } @@ -153,10 +157,12 @@ public function upsert( $model ) { unset( $fields['ID'] ); } + // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedHooknameFound do_action( 'mixtape_data_store_model_upsert_before', $model ); $id_or_error = wp_insert_post( $fields, true ); if ( is_wp_error( $id_or_error ) ) { + // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedHooknameFound do_action( 'mixtape_data_store_model_upsert_error', $model ); return $id_or_error; } @@ -170,6 +176,7 @@ public function upsert( $model ) { } if ( false === $id_or_bool ) { + // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedHooknameFound do_action( 'mixtape_data_store_model_upsert_error', $model ); // Something was wrong with this update/create. TODO: Should we stop mid create/update? return new WP_Error( @@ -183,6 +190,7 @@ public function upsert( $model ) { } } + // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedHooknameFound do_action( 'mixtape_data_store_model_upsert_after', $model ); return absint( $id_or_error ); diff --git a/lib/zoninator_rest/field/class-zoninator-rest-field-declaration.php b/lib/zoninator_rest/field/class-zoninator-rest-field-declaration.php index f55e149..a34627e 100644 --- a/lib/zoninator_rest/field/class-zoninator-rest-field-declaration.php +++ b/lib/zoninator_rest/field/class-zoninator-rest-field-declaration.php @@ -7,7 +7,7 @@ if ( ! defined( 'ABSPATH' ) ) { exit; -} // End if(). +} /** * Class Zoninator_REST_Field_Declaration @@ -187,7 +187,7 @@ public function __construct( $args ) { } if ( ! isset( $args['kind'] ) || ! in_array( $args['kind'], $this->field_kinds, true ) ) { - throw new Zoninator_REST_Exception( 'every field should have a kind (one of ' . implode( ',', $this->field_kinds ) . ')' ); + throw new Zoninator_REST_Exception( esc_html( 'every field should have a kind (one of ' . implode( ',', $this->field_kinds ) . ')' ) ); } $this->name = $args['name']; @@ -241,10 +241,10 @@ public function get_sanitizer() { * * @param array $args Args. * @param string $name Name. - * @param mixed $default Default. + * @param mixed $default_value Default. */ - private function value_or_default( $args, $name, $default = null ) { - return $args[ $name ] ?? $default; + private function value_or_default( $args, $name, $default_value = null ) { + return $args[ $name ] ?? $default_value; } /** @@ -267,7 +267,7 @@ public function is_kind( $kind ) { * @return mixed */ public function get_default_value() { - if ( $this->default_value !== null && ! empty( $this->default_value ) ) { + if ( null !== $this->default_value && ! empty( $this->default_value ) ) { return ( is_array( $this->default_value ) && is_callable( $this->default_value ) ) ? call_user_func( $this->default_value ) : $this->default_value; } @@ -315,7 +315,7 @@ public function as_item_schema_property() { * Get Map From */ public function get_map_from() { - if ( $this->map_from !== null && ! empty( $this->map_from ) ) { + if ( null !== $this->map_from && ! empty( $this->map_from ) ) { return $this->map_from; } @@ -364,7 +364,7 @@ public function is_required() { * @return string */ public function get_description() { - if ( $this->description !== null && ! empty( $this->description ) ) { + if ( null !== $this->description && ! empty( $this->description ) ) { return $this->description; } diff --git a/lib/zoninator_rest/field/declaration/class-zoninator-rest-field-declaration-builder.php b/lib/zoninator_rest/field/declaration/class-zoninator-rest-field-declaration-builder.php index b5117d2..eab8bfb 100644 --- a/lib/zoninator_rest/field/declaration/class-zoninator-rest-field-declaration-builder.php +++ b/lib/zoninator_rest/field/declaration/class-zoninator-rest-field-declaration-builder.php @@ -7,7 +7,7 @@ if ( ! defined( 'ABSPATH' ) ) { exit; -} // End if(). +} /** * Class Mixtape_Model_Field_Declaration_Builder @@ -157,7 +157,7 @@ public function with_supported_outputs( $supported_outputs = array() ) { */ public function with_type( $value_type ) { if ( ! is_a( $value_type, 'Zoninator_REST_Interfaces_Type' ) ) { - throw new Zoninator_REST_Exception( get_class( $value_type ) . ' is not a Mixtape_Interfaces_Type' ); + throw new Zoninator_REST_Exception( esc_html( get_class( $value_type ) . ' is not a Mixtape_Interfaces_Type' ) ); } return $this->with( 'type', $value_type ); diff --git a/lib/zoninator_rest/interfaces/data/class-zoninator-rest-interfaces-data-store.php b/lib/zoninator_rest/interfaces/data/class-zoninator-rest-interfaces-data-store.php index a6b4601..a1223cd 100644 --- a/lib/zoninator_rest/interfaces/data/class-zoninator-rest-interfaces-data-store.php +++ b/lib/zoninator_rest/interfaces/data/class-zoninator-rest-interfaces-data-store.php @@ -9,7 +9,7 @@ if ( ! defined( 'ABSPATH' ) ) { exit; -} // End if(). +} /** * Interface Zoninator_REST_Interfaces_Data_Store diff --git a/lib/zoninator_rest/model/class-zoninator-rest-model-declaration.php b/lib/zoninator_rest/model/class-zoninator-rest-model-declaration.php index cc3ff54..cee1128 100644 --- a/lib/zoninator_rest/model/class-zoninator-rest-model-declaration.php +++ b/lib/zoninator_rest/model/class-zoninator-rest-model-declaration.php @@ -106,12 +106,12 @@ public function get_name() { /** * Perform call * - * @param mixed $callable A Callable. + * @param mixed $a_callable A Callable. * @param array $args The args. * * @return mixed */ - private function perform_call( $callable, $args ) { - return call_user_func_array( $callable, $args ); + private function perform_call( $a_callable, $args ) { + return call_user_func_array( $a_callable, $args ); } } diff --git a/lib/zoninator_rest/type/class-zoninator-rest-type-registry.php b/lib/zoninator_rest/type/class-zoninator-rest-type-registry.php index a92681d..4135705 100644 --- a/lib/zoninator_rest/type/class-zoninator-rest-type-registry.php +++ b/lib/zoninator_rest/type/class-zoninator-rest-type-registry.php @@ -63,12 +63,12 @@ public function definition( $type ) { if ( count( $parts ) > 1 ) { $container_type = $parts[0]; if ( ! in_array( $container_type, $this->container_types, true ) ) { - throw new Zoninator_REST_Exception( $container_type . ' is not a known container type' ); + throw new Zoninator_REST_Exception( esc_html( $container_type . ' is not a known container type' ) ); } $item_type = $parts[1]; if ( empty( $item_type ) ) { - throw new Zoninator_REST_Exception( $type . ': invalid syntax' ); + throw new Zoninator_REST_Exception( esc_html( $type . ': invalid syntax' ) ); } $item_type_definition = $this->definition( $item_type ); @@ -98,6 +98,7 @@ public function definition( $type ) { * @return array */ private function get_types() { + // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedHooknameFound return (array) apply_filters( 'mixtape_type_registry_get_types', $this->types, $this ); } @@ -112,7 +113,7 @@ public function initialize( $environment ) { } $this->types = apply_filters( - 'mixtape_type_registry_register_types', + 'mixtape_type_registry_register_types', // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedHooknameFound array( 'any' => new Zoninator_REST_Type( 'any' ), 'string' => new Zoninator_REST_Type_String(), @@ -125,7 +126,7 @@ public function initialize( $environment ) { 'array' => new Zoninator_REST_Type_Array(), ), $this, - $environment + $environment ); } } diff --git a/widget.zone-posts.php b/widget.zone-posts.php index c7d6ce9..c5f57f8 100644 --- a/widget.zone-posts.php +++ b/widget.zone-posts.php @@ -1,4 +1,5 @@ 0, 'show_description' => 0, - ) + ) ); $instance['zone_id'] = absint( $new_instance['zone_id'] ); $instance['show_description'] = $new_instance['show_description'] ? 1 : 0; @@ -113,9 +114,11 @@ public function update( $new_instance, $old_instance ) { public function flush_widget_cache() { $cache_key = 'widget-zone-posts'; + // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedHooknameFound -- breaking change to rename this filter with the correct prefix. $block_save_cache_seconds = absint( apply_filters( 'zone_posts_widget_block_save_cache_seconds', 5 ) ); if ( $block_save_cache_seconds > 0 ) { // This key will block updating the cache for n seconds so the following cache delete can propagate + // phpcs:ignore -- WordPressVIPMinimum.Performance.LowExpiryCacheTime.CacheTimeUndetermined -- not changing behavior now. wp_cache_set( $cache_key . '-save_blocked', 1, 'widget', $block_save_cache_seconds ); } @@ -143,7 +146,7 @@ public function form( $instance ) { - __( 'The zone was successfully updated.', 'zoninator' ), 'delete-success' => __( 'The zone was successfully deleted.', 'zoninator' ), 'error-general' => __( 'Sorry, something went wrong! Please try again?', 'zoninator' ), + /* translators: User's display name, or "another user" */ 'error-zone-lock' => __( 'Sorry, this zone is in use by %s and is currently locked. Please try again later.', 'zoninator' ), 'error-zone-lock-max' => __( 'Sorry, you have reached the maximum idle limit and will now be redirected to the Dashboard.', 'zoninator' ), ); @@ -208,8 +209,8 @@ public function admin_enqueue_scripts() { ); wp_localize_script( 'zoninator-js', 'zoninatorOptions', $options ); - // For mobile support - // http://github.com/furf/jquery-ui-touch-punch + // For mobile support: https://github.com/furf/jquery-ui-touch-punch + // phpcs:ignore WordPress.WP.EnqueuedResourceParameters.NotInFooter, WordPress.WP.EnqueuedResourceParameters.MissingVersion wp_enqueue_script( 'jquery-ui-touch-punch', ZONINATOR_URL . 'js/jquery.ui.touch-punch.min.js', array( 'jquery-ui-core', 'jquery-ui-widget', 'jquery-ui-mouse' ) ); } } @@ -254,6 +255,7 @@ public function admin_controller() { } if ( is_wp_error( $result ) ) { + // phpcs:ignore WordPress.Security.SafeRedirect.wp_redirect_wp_redirect wp_redirect( add_query_arg( 'message', 'error-general' ) ); exit; } else { @@ -263,6 +265,7 @@ public function admin_controller() { // Redirect with success message $message = sprintf( '%s-success', $action ); + // phpcs:ignore WordPress.Security.SafeRedirect.wp_redirect_wp_redirect wp_redirect( $this->_get_zone_page_url( array( @@ -291,6 +294,7 @@ public function admin_controller() { $redirect_args = array( 'message' => 'delete-success' ); } + // phpcs:ignore WordPress.Security.SafeRedirect.wp_redirect_wp_redirect wp_redirect( $this->_get_zone_page_url( $redirect_args ) ); exit; } @@ -413,11 +417,11 @@ public function admin_page_zone_edit( $zone = null ) { $delete_link = wp_nonce_url( $delete_link, $this->_get_nonce_key( 'delete' ) ); ?>
- _current_user_can_add_zones() ) || ( $zone_id != 0 && $this->_current_user_can_manage_zones() ) ) : ?> + _current_user_can_add_zones() ) || ( 0 != $zone_id && $this->_current_user_can_manage_zones() ) ) : ?>
-

_get_message( 'error-zone-lock' ), sprintf( '%s', esc_attr( $locking_user->user_email ), esc_html( $locking_user->display_name ) ) ); ?>

+

_get_message( 'error-zone-lock' ) ), sprintf( '%s', esc_attr( $locking_user->user_email ), esc_html( $locking_user->display_name ) ) ); ?>

- +
" name="submit" class="button" /> - +
- + @@ -483,13 +487,13 @@ public function admin_page_zone_edit( $zone = null ) {
- +
@@ -561,12 +565,12 @@ public function admin_page_zone_post( $post, $zone ) { $zone ); ?> -
+
$column_callback ) : ?> -
+
- +
%s', get_edit_post_link( $post->ID ), __( 'Opens in new window', 'zoninator' ), __( 'Edit', 'zoninator' ) ), sprintf( '%s', __( 'Remove this item from the zone', 'zoninator' ), __( 'Remove', 'zoninator' ) ), @@ -601,7 +605,7 @@ public function admin_page_zone_post_col_info( $post, $zone ) { (%s)', esc_html( $post->post_title ), esc_html( $post->post_status ) ); ?>
- +
%s', esc_attr( $output ), selected( $output, $current_date, false ), esc_html( $label ) ); @@ -688,6 +693,7 @@ public function ajax_recent_posts() { 'post_type' => $post_types, 'ignore_sticky_posts' => true, 'post_status' => array( 'publish', 'future' ), + // phpcs:ignore WordPressVIPMinimum.Performance.WPQueryParams.PostNotIn_post__not_in 'post__not_in' => $zone_post_ids, 'suppress_filters' => false, ) @@ -718,6 +724,7 @@ public function ajax_recent_posts() { if ( ! $content ) { $empty_label = __( 'No results found', 'zoninator' ); } elseif ( $cat ) { + /* translators: Category name */ $empty_label = sprintf( __( 'Choose post from %s', 'zoninator' ), get_the_category_by_ID( $cat ) ); } else { $empty_label = __( 'Choose a post', 'zoninator' ); @@ -744,6 +751,7 @@ public function zone_admin_recent_posts_dropdown( $zone_id ) { 'post_type' => $post_types, 'ignore_sticky_posts' => true, 'post_status' => array( 'publish', 'future' ), + // phpcs:ignore WordPressVIPMinimum.Performance.WPQueryParams.PostNotIn_post__not_in 'post__not_in' => $zone_post_ids, 'suppress_filters' => false, ) @@ -757,7 +765,7 @@ public function zone_admin_recent_posts_dropdown( $zone_id ) { %s', $post->ID, esc_html( get_the_title( $post->ID ) . ' (' . $post->post_status . ')' ) ); + printf( '', esc_attr( $post->ID ), esc_html( get_the_title( $post->ID ) . ' (' . $post->post_status . ')' ) ); endforeach; wp_reset_postdata(); @@ -785,6 +793,7 @@ public function is_zoninator_page() { } if ( empty( $screen ) ) { + // phpcs:ignore WordPress.Security.NonceVerification.Recommended return ! empty( $_REQUEST['page'] ) && sanitize_key( $_REQUEST['page'] ) == $this->key; } else { return ! empty( $screen->id ) && strstr( $screen->id, (string) $this->key ); @@ -795,7 +804,7 @@ public function ajax_return( $status, $content = '', $action = '' ) { $action = empty( $action ) ? $this->zone_ajax_nonce_action : $action; $nonce = wp_create_nonce( $this->_get_nonce_key( $action ) ); - echo json_encode( + echo wp_json_encode( array( 'status' => $status, 'content' => $content, @@ -873,7 +882,7 @@ public function ajax_reorder_posts() { $this->verify_access( '', $zone_id ); // validate - if ( ! $zone_id || $post_ids === array() ) { + if ( ! $zone_id || array() === $post_ids ) { $this->ajax_return( 0 ); } @@ -926,12 +935,14 @@ public function ajax_search_posts() { 'zoninator_search_args', array( 's' => $q, + // phpcs:ignore WordPressVIPMinimum.Performance.WPQueryParams.PostNotIn_post__not_in 'post__not_in' => $exclude, 'posts_per_page' => $limit, 'post_type' => $post_types, 'post_status' => array( 'publish', 'future' ), 'order' => 'DESC', 'orderby' => 'post_date', + // phpcs:ignore WordPressVIPMinimum.Performance.WPQueryParams.SuppressFilters_suppress_filters 'suppress_filters' => true, 'no_found_rows' => true, ) @@ -952,7 +963,7 @@ public function ajax_search_posts() { $stripped_posts = array(); if ( ! $query->have_posts() ) { - echo json_encode( array() ); + echo wp_json_encode( array() ); exit; } @@ -970,7 +981,7 @@ public function ajax_search_posts() { ); } - echo json_encode( $stripped_posts ); + echo wp_json_encode( $stripped_posts ); exit; } } @@ -992,7 +1003,7 @@ public function ajax_update_lock() { } public function get_supported_post_types() { - if ( $this->post_types !== null ) { + if ( null !== $this->post_types ) { return $this->post_types; } @@ -1185,7 +1196,8 @@ public function remove_zone_posts( $zone, $posts = null ) { public function get_zone_posts( $zone, $args = array() ) { // Check cache first - if ( $posts = $this->get_zone_posts_from_cache( $zone, $args ) ) { + $posts = $this->get_zone_posts_from_cache( $zone, $args ); + if ( $posts ) { return $posts; } @@ -1214,6 +1226,7 @@ public function get_zone_query( $zone, $args = array() ) { } if ( is_admin() ) { // skip APC in the admin + // phpcs:ignore WordPressVIPMinimum.Performance.WPQueryParams.SuppressFilters_suppress_filters $defaults['suppress_filters'] = true; } @@ -1223,19 +1236,6 @@ public function get_zone_query( $zone, $args = array() ) { $args['orderby'] = 'meta_value_num'; $args['meta_key'] = $meta_key; - /* - // 3.1-friendly, though missing sort support which is why we're using the old way - if( function_exists( 'get_post_format' ) ) { - $args['meta_query'] = array( - array( - 'key' => $meta_key, - 'type' => 'NUMERIC' - ) - ); - } else { - $args['meta_key'] = $meta_key; - } - */ return new WP_Query( $args ); } @@ -1259,6 +1259,7 @@ public function get_prev_post_in_zone( $zone, $post_id ) { return $this->get_single_post_in_zone( $zone, array( + // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_value 'meta_value' => $order, 'meta_compare' => '<=', ) @@ -1272,6 +1273,7 @@ public function get_next_post_in_zone( $zone, $post_id ) { return $this->get_single_post_in_zone( $zone, array( + // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_value 'meta_value' => $order, 'meta_compare' => '>=', ) @@ -1290,7 +1292,7 @@ public function get_single_post_in_zone( $zone, $args = array() ) { $post = $this->get_zone_posts( $zone, $args ); - if ( is_array( $post ) && $post !== array() ) { + if ( is_array( $post ) && array() !== $post ) { return array_pop( $post ); } @@ -1298,27 +1300,7 @@ public function get_single_post_in_zone( $zone, $args = array() ) { } public function get_zones_for_post( $post_id ) { - // TODO: build this out - - // get_object_terms - // get_terms - - // OR - - // get all meta_keys that match the prefix - // strip the prefix - - // OR - - // get all zones and see if there's a matching meta entry - // strip the prefix from keys - - // array_map( 'absint', $zone_ids ) - // $zones = array(); - // foreach( $zone_ids as $zone_id ) { - // $zones[] = get_zone( $zone_id ); - // } - // return $zones; + // TODO: build this out - see https://github.com/Automattic/zoninator/pull/19 } public function get_zones( $args = array() ) { @@ -1332,6 +1314,7 @@ public function get_zones( $args = array() ) { ) ); + // phpcs:ignore WordPress.WP.DeprecatedParameters.Get_termsParam2Found -- See https://github.com/Automattic/zoninator/issues/111 $zones = get_terms( $this->zone_taxonomy, $args ); if ( ! is_wp_error( $zones ) ) { @@ -1359,6 +1342,7 @@ public function get_zone( $zone ) { } if ( function_exists( 'wpcom_vip_get_term_by' ) ) { + // phpcs:ignore WordPressVIPMinimum.Functions.RestrictedFunctions.wpcom_vip_get_term_by_wpcom_vip_get_term_by -- See https://github.com/Automattic/zoninator/issues/110 $zone = wpcom_vip_get_term_by( $field, $zone, $this->zone_taxonomy ); } else { $zone = get_term_by( $field, $zone, $this->zone_taxonomy ); @@ -1521,11 +1505,11 @@ public function verify_access( $action = '', $zone_id = null ) { } } - public function _unauthorized_access() { - wp_die( __( "Sorry, you're not supposed to do that...", 'zoninator' ) ); + public function _unauthorized_access() { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore -- breaking change + wp_die( esc_html__( "Sorry, you're not supposed to do that...", 'zoninator' ) ); } - public function _fill_zone_details( $zone ) { + public function _fill_zone_details( $zone ) { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore -- breaking change if ( ! empty( $zone->zoninator_parsed ) && $zone->zoninator_parsed ) { return $zone; } @@ -1580,6 +1564,7 @@ private function filter_zone_feed_fields( $results ) { $filtered_results[ $i ] = new stdClass(); } + // phpcs:ignore Squiz.PHP.DisallowMultipleAssignments.Found -- see https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/598 $filtered_results[ $i ]->$field = $result->$field; } @@ -1596,12 +1581,12 @@ private function filter_zone_feed_fields( $results ) { */ private function json_return( $data ) { - if ( $data == null ) { + if ( null == $data ) { return false; } header( 'Content-Type: application/json' ); - echo json_encode( $data ); + echo wp_json_encode( $data ); exit(); } @@ -1622,19 +1607,20 @@ private function status_header_with_message( $status, $message ) { $status = absint( $status ); $official_message = $wp_header_to_desc[ $status ] ?? ''; - $wp_header_to_desc[ $status ] = $message; + $wp_header_to_desc[ $status ] = $message; // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited status_header( $status ); + // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited $wp_header_to_desc[ $status ] = $official_message; } // TODO: Caching needs to be testing properly before being implemented! - public function get_zone_cache_key( $zone, $args = array() ) { + public function get_zone_cache_key( $zone, $args = array() ) { // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.FoundAfterLastUsed -- potentially breaking change/ return ''; } - public function get_zone_posts_from_cache( $zone, $args = array() ) { + public function get_zone_posts_from_cache( $zone, $args = array() ) { // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.FoundAfterLastUsed -- potentially breaking change/ return false; } @@ -1657,11 +1643,11 @@ public function split_shared_term( $old_term_id, $new_term_id, $term_taxonomy_id } } - public function _empty_zone_posts_cache( $meta_key ) { - return; // TODO: implement + public function _empty_zone_posts_cache( $meta_key ) { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore -- breaking change + // TODO: implement } - public function _get_message( $message_id, $encode = false ) { + public function _get_message( $message_id, $encode = false ) { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore -- breaking change $message = ''; if ( ! empty( $this->zone_messages[ $message_id ] ) ) { @@ -1675,36 +1661,36 @@ public function _get_message( $message_id, $encode = false ) { return $message; } - public function _get_nonce_key( $action ) { + public function _get_nonce_key( $action ) { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore -- breaking change return sprintf( '%s-%s', $this->zone_nonce_prefix, $action ); } - public function _current_user_can_add_zones() { + public function _current_user_can_add_zones() { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore -- breaking change return current_user_can( $this->_get_add_zones_cap() ); } - public function _current_user_can_edit_zones( $zone_id ) { + public function _current_user_can_edit_zones( $zone_id ) { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore -- breaking change $has_cap = current_user_can( $this->_get_edit_zones_cap() ); return apply_filters( 'zoninator_current_user_can_edit_zone', $has_cap, $zone_id ); } - public function _current_user_can_manage_zones() { + public function _current_user_can_manage_zones() { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore -- breaking change return current_user_can( $this->_get_manage_zones_cap() ); } - public function _get_add_zones_cap() { + public function _get_add_zones_cap() { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore -- breaking change return apply_filters( 'zoninator_add_zone_cap', 'edit_others_posts' ); } - public function _get_edit_zones_cap() { + public function _get_edit_zones_cap() { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore -- breaking change return apply_filters( 'zoninator_edit_zone_cap', 'edit_others_posts' ); } - public function _get_manage_zones_cap() { + public function _get_manage_zones_cap() { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore -- breaking change return apply_filters( 'zoninator_manage_zone_cap', 'edit_others_posts' ); } - public function _get_zone_page_url( $args = array() ) { + public function _get_zone_page_url( $args = array() ) { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore -- breaking change $url = menu_page_url( $this->key, false ); foreach ( $args as $arg_key => $arg_value ) { @@ -1714,19 +1700,19 @@ public function _get_zone_page_url( $args = array() ) { return $url; } - public function _validate_date_filter( $date ) { + public function _validate_date_filter( $date ) { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore -- breaking change return preg_match( '/(\d{4})-(\d{2})-(\d{2})/', $date ); } - public function _validate_category_filter( $cat ) { + public function _validate_category_filter( $cat ) { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore -- breaking change return $cat && get_term_by( 'id', $cat, 'category' ); } - public function _sanitize_value( $var ) { + public function _sanitize_value( $var ) { // phpcs:ignore Universal.NamingConventions.NoReservedKeywordParameterNames.varFound, PSR2.Methods.MethodDeclaration.Underscore -- breaking change return htmlentities( stripslashes( $var ) ); } - public function _get_value_or_default( $var, $object, $default = '', $sanitize_callback = '' ) { + public function _get_value_or_default( $var, $object, $default = '', $sanitize_callback = '' ) { // phpcs:ignore Universal.NamingConventions.NoReservedKeywordParameterNames.defaultFound, Universal.NamingConventions.NoReservedKeywordParameterNames.objectFound, Universal.NamingConventions.NoReservedKeywordParameterNames.varFound, PSR2.Methods.MethodDeclaration.Underscore -- breaking change if ( is_object( $object ) ) { $value = empty( $object->$var ) ? $default : $object->$var; } elseif ( is_array( $object ) ) { @@ -1742,15 +1728,18 @@ public function _get_value_or_default( $var, $object, $default = '', $sanitize_c return $value; } - public function _get_request_var( $var, $default = '', $sanitize_callback = '' ) { + public function _get_request_var( $var, $default = '', $sanitize_callback = '' ) { // phpcs:ignore Universal.NamingConventions.NoReservedKeywordParameterNames.defaultFound, Universal.NamingConventions.NoReservedKeywordParameterNames.varFound, PSR2.Methods.MethodDeclaration.Underscore -- breaking change + // phpcs:ignore WordPress.Security.NonceVerification.Recommended return $this->_get_value_or_default( $var, $_REQUEST, $default, $sanitize_callback ); } - public function _get_get_var( $var, $default = '', $sanitize_callback = '' ) { + public function _get_get_var( $var, $default = '', $sanitize_callback = '' ) { // phpcs:ignore Universal.NamingConventions.NoReservedKeywordParameterNames.defaultFound, Universal.NamingConventions.NoReservedKeywordParameterNames.varFound, PSR2.Methods.MethodDeclaration.Underscore -- breaking change + // phpcs:ignore WordPress.Security.NonceVerification.Recommended return $this->_get_value_or_default( $var, $_GET, $default, $sanitize_callback ); } - public function _get_post_var( $var, $default = '', $sanitize_callback = '' ) { + public function _get_post_var( $var, $default = '', $sanitize_callback = '' ) { // phpcs:ignore Universal.NamingConventions.NoReservedKeywordParameterNames.defaultFound, Universal.NamingConventions.NoReservedKeywordParameterNames.varFound, PSR2.Methods.MethodDeclaration.Underscore -- breaking change + // phpcs:ignore WordPress.Security.NonceVerification.Missing return $this->_get_value_or_default( $var, $_POST, $default, $sanitize_callback ); } @@ -1842,7 +1831,7 @@ public function check( $action = '', $zone_id = null ) { } } - function Zoninator() { + function Zoninator() { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid, Universal.Files.SeparateFunctionsFromOO.Mixed -- Windows is case-sensitive, so changing this is a breaking change. global $zoninator; if ( ! isset( $zoninator ) || null === $zoninator ) { $zoninator = new Zoninator(); From 38f779293739789b6adda98a8c020c3cee766a1b Mon Sep 17 00:00:00 2001 From: Gary Jones Date: Fri, 16 Aug 2024 18:51:28 +0100 Subject: [PATCH 43/56] CI: Enable Coding Standards checks --- .github/workflows/cs-lint.yml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/workflows/cs-lint.yml b/.github/workflows/cs-lint.yml index 8dd2b7c..0acc966 100644 --- a/.github/workflows/cs-lint.yml +++ b/.github/workflows/cs-lint.yml @@ -62,9 +62,9 @@ jobs: xml-schema-file: ./vendor/phpunit/phpunit/phpunit.xsd # Check the code-style consistency of the PHP files. -# - name: Check PHP code style -# continue-on-error: true -# run: vendor/bin/phpcs --report-full --report-checkstyle=./phpcs-report.xml + - name: Check PHP code style + continue-on-error: true + run: vendor/bin/phpcs --report-full --report-checkstyle=./phpcs-report.xml -# - name: Show PHPCS results in PR -# run: cs2pr ./phpcs-report.xml + - name: Show PHPCS results in PR + run: cs2pr ./phpcs-report.xml From e4826f2de25f9fba306a950fb20da2b7fd45512f Mon Sep 17 00:00:00 2001 From: Gary Jones Date: Sat, 23 Nov 2024 13:14:14 +0000 Subject: [PATCH 44/56] Consolidate includes and lib directories Closes #114. --- {includes => src}/class-zoninator-api-controller.php | 0 {includes => src}/class-zoninator-api-filter-search.php | 0 {includes => src}/class-zoninator-api-schema-converter.php | 0 {includes => src}/class-zoninator-api.php | 2 +- {lib => src}/zoninator_rest/class-zoninator-rest-bootstrap.php | 0 .../zoninator_rest/class-zoninator-rest-classloader.php | 0 {lib => src}/zoninator_rest/class-zoninator-rest-controller.php | 0 .../zoninator_rest/class-zoninator-rest-environment.php | 0 {lib => src}/zoninator_rest/class-zoninator-rest-exception.php | 0 {lib => src}/zoninator_rest/class-zoninator-rest-expect.php | 0 {lib => src}/zoninator_rest/class-zoninator-rest-model.php | 0 {lib => src}/zoninator_rest/class-zoninator-rest-type.php | 0 .../bundle/class-zoninator-rest-controller-bundle-builder.php | 0 .../controller/class-zoninator-rest-controller-action.php | 0 .../controller/class-zoninator-rest-controller-bundle.php | 0 .../controller/class-zoninator-rest-controller-crud.php | 0 .../controller/class-zoninator-rest-controller-extension.php | 0 .../controller/class-zoninator-rest-controller-model.php | 0 .../controller/class-zoninator-rest-controller-route.php | 0 .../controller/class-zoninator-rest-controller-settings.php | 0 .../zoninator_rest/data/class-zoninator-rest-data-mapper.php | 0 .../data/class-zoninator-rest-data-serializer.php | 0 .../data/store/class-zoninator-rest-data-store-abstract.php | 0 .../data/store/class-zoninator-rest-data-store-builder.php | 0 .../store/class-zoninator-rest-data-store-customposttype.php | 0 .../data/store/class-zoninator-rest-data-store-nil.php | 0 .../data/store/class-zoninator-rest-data-store-option.php | 0 .../field/class-zoninator-rest-field-declaration.php | 0 .../class-zoninator-rest-field-declaration-builder.php | 0 .../interfaces/class-zoninator-rest-interfaces-builder.php | 0 .../interfaces/class-zoninator-rest-interfaces-classloader.php | 0 .../interfaces/class-zoninator-rest-interfaces-controller.php | 0 .../interfaces/class-zoninator-rest-interfaces-model.php | 0 .../interfaces/class-zoninator-rest-interfaces-registrable.php | 0 .../interfaces/class-zoninator-rest-interfaces-type.php | 0 .../class-zoninator-rest-interfaces-controller-bundle.php | 0 .../data/class-zoninator-rest-interfaces-data-store.php | 0 .../model/class-zoninator-rest-interfaces-model-collection.php | 0 .../model/class-zoninator-rest-interfaces-model-declaration.php | 0 .../class-zoninator-rest-interfaces-permissions-provider.php | 0 .../model/class-zoninator-rest-model-collection.php | 0 .../model/class-zoninator-rest-model-declaration.php | 0 .../model/class-zoninator-rest-model-definition.php | 0 .../model/class-zoninator-rest-model-settings.php | 0 .../model/class-zoninator-rest-model-validationdata.php | 0 .../class-zoninator-rest-model-declaration-settings.php | 0 .../class-zoninator-rest-model-definition-builder.php | 0 .../permissions/class-zoninator-rest-permissions-any.php | 0 .../zoninator_rest/type/class-zoninator-rest-type-array.php | 0 .../zoninator_rest/type/class-zoninator-rest-type-boolean.php | 0 .../zoninator_rest/type/class-zoninator-rest-type-integer.php | 0 .../zoninator_rest/type/class-zoninator-rest-type-nullable.php | 0 .../zoninator_rest/type/class-zoninator-rest-type-number.php | 0 .../zoninator_rest/type/class-zoninator-rest-type-registry.php | 0 .../zoninator_rest/type/class-zoninator-rest-type-string.php | 0 .../type/class-zoninator-rest-type-typedarray.php | 0 zoninator.php | 2 +- 57 files changed, 2 insertions(+), 2 deletions(-) rename {includes => src}/class-zoninator-api-controller.php (100%) rename {includes => src}/class-zoninator-api-filter-search.php (100%) rename {includes => src}/class-zoninator-api-schema-converter.php (100%) rename {includes => src}/class-zoninator-api.php (93%) rename {lib => src}/zoninator_rest/class-zoninator-rest-bootstrap.php (100%) rename {lib => src}/zoninator_rest/class-zoninator-rest-classloader.php (100%) rename {lib => src}/zoninator_rest/class-zoninator-rest-controller.php (100%) rename {lib => src}/zoninator_rest/class-zoninator-rest-environment.php (100%) rename {lib => src}/zoninator_rest/class-zoninator-rest-exception.php (100%) rename {lib => src}/zoninator_rest/class-zoninator-rest-expect.php (100%) rename {lib => src}/zoninator_rest/class-zoninator-rest-model.php (100%) rename {lib => src}/zoninator_rest/class-zoninator-rest-type.php (100%) rename {lib => src}/zoninator_rest/controller/bundle/class-zoninator-rest-controller-bundle-builder.php (100%) rename {lib => src}/zoninator_rest/controller/class-zoninator-rest-controller-action.php (100%) rename {lib => src}/zoninator_rest/controller/class-zoninator-rest-controller-bundle.php (100%) rename {lib => src}/zoninator_rest/controller/class-zoninator-rest-controller-crud.php (100%) rename {lib => src}/zoninator_rest/controller/class-zoninator-rest-controller-extension.php (100%) rename {lib => src}/zoninator_rest/controller/class-zoninator-rest-controller-model.php (100%) rename {lib => src}/zoninator_rest/controller/class-zoninator-rest-controller-route.php (100%) rename {lib => src}/zoninator_rest/controller/class-zoninator-rest-controller-settings.php (100%) rename {lib => src}/zoninator_rest/data/class-zoninator-rest-data-mapper.php (100%) rename {lib => src}/zoninator_rest/data/class-zoninator-rest-data-serializer.php (100%) rename {lib => src}/zoninator_rest/data/store/class-zoninator-rest-data-store-abstract.php (100%) rename {lib => src}/zoninator_rest/data/store/class-zoninator-rest-data-store-builder.php (100%) rename {lib => src}/zoninator_rest/data/store/class-zoninator-rest-data-store-customposttype.php (100%) rename {lib => src}/zoninator_rest/data/store/class-zoninator-rest-data-store-nil.php (100%) rename {lib => src}/zoninator_rest/data/store/class-zoninator-rest-data-store-option.php (100%) rename {lib => src}/zoninator_rest/field/class-zoninator-rest-field-declaration.php (100%) rename {lib => src}/zoninator_rest/field/declaration/class-zoninator-rest-field-declaration-builder.php (100%) rename {lib => src}/zoninator_rest/interfaces/class-zoninator-rest-interfaces-builder.php (100%) rename {lib => src}/zoninator_rest/interfaces/class-zoninator-rest-interfaces-classloader.php (100%) rename {lib => src}/zoninator_rest/interfaces/class-zoninator-rest-interfaces-controller.php (100%) rename {lib => src}/zoninator_rest/interfaces/class-zoninator-rest-interfaces-model.php (100%) rename {lib => src}/zoninator_rest/interfaces/class-zoninator-rest-interfaces-registrable.php (100%) rename {lib => src}/zoninator_rest/interfaces/class-zoninator-rest-interfaces-type.php (100%) rename {lib => src}/zoninator_rest/interfaces/controller/class-zoninator-rest-interfaces-controller-bundle.php (100%) rename {lib => src}/zoninator_rest/interfaces/data/class-zoninator-rest-interfaces-data-store.php (100%) rename {lib => src}/zoninator_rest/interfaces/model/class-zoninator-rest-interfaces-model-collection.php (100%) rename {lib => src}/zoninator_rest/interfaces/model/class-zoninator-rest-interfaces-model-declaration.php (100%) rename {lib => src}/zoninator_rest/interfaces/permissions/class-zoninator-rest-interfaces-permissions-provider.php (100%) rename {lib => src}/zoninator_rest/model/class-zoninator-rest-model-collection.php (100%) rename {lib => src}/zoninator_rest/model/class-zoninator-rest-model-declaration.php (100%) rename {lib => src}/zoninator_rest/model/class-zoninator-rest-model-definition.php (100%) rename {lib => src}/zoninator_rest/model/class-zoninator-rest-model-settings.php (100%) rename {lib => src}/zoninator_rest/model/class-zoninator-rest-model-validationdata.php (100%) rename {lib => src}/zoninator_rest/model/declaration/class-zoninator-rest-model-declaration-settings.php (100%) rename {lib => src}/zoninator_rest/model/definition/class-zoninator-rest-model-definition-builder.php (100%) rename {lib => src}/zoninator_rest/permissions/class-zoninator-rest-permissions-any.php (100%) rename {lib => src}/zoninator_rest/type/class-zoninator-rest-type-array.php (100%) rename {lib => src}/zoninator_rest/type/class-zoninator-rest-type-boolean.php (100%) rename {lib => src}/zoninator_rest/type/class-zoninator-rest-type-integer.php (100%) rename {lib => src}/zoninator_rest/type/class-zoninator-rest-type-nullable.php (100%) rename {lib => src}/zoninator_rest/type/class-zoninator-rest-type-number.php (100%) rename {lib => src}/zoninator_rest/type/class-zoninator-rest-type-registry.php (100%) rename {lib => src}/zoninator_rest/type/class-zoninator-rest-type-string.php (100%) rename {lib => src}/zoninator_rest/type/class-zoninator-rest-type-typedarray.php (100%) diff --git a/includes/class-zoninator-api-controller.php b/src/class-zoninator-api-controller.php similarity index 100% rename from includes/class-zoninator-api-controller.php rename to src/class-zoninator-api-controller.php diff --git a/includes/class-zoninator-api-filter-search.php b/src/class-zoninator-api-filter-search.php similarity index 100% rename from includes/class-zoninator-api-filter-search.php rename to src/class-zoninator-api-filter-search.php diff --git a/includes/class-zoninator-api-schema-converter.php b/src/class-zoninator-api-schema-converter.php similarity index 100% rename from includes/class-zoninator-api-schema-converter.php rename to src/class-zoninator-api-schema-converter.php diff --git a/includes/class-zoninator-api.php b/src/class-zoninator-api.php similarity index 93% rename from includes/class-zoninator-api.php rename to src/class-zoninator-api.php index d1ecf0f..d07e1ef 100644 --- a/includes/class-zoninator-api.php +++ b/src/class-zoninator-api.php @@ -29,7 +29,7 @@ public function __construct( $instance ) { * Rest Api. */ public function rest_api() { - include_once ZONINATOR_PATH . '/lib/zoninator_rest/class-zoninator-rest-bootstrap.php'; + include_once ZONINATOR_PATH . '/src/zoninator_rest/class-zoninator-rest-bootstrap.php'; $this->bootstrap = Zoninator_REST_Bootstrap::create()->load(); include_once __DIR__ . '/class-zoninator-api-schema-converter.php'; include_once __DIR__ . '/class-zoninator-api-filter-search.php'; diff --git a/lib/zoninator_rest/class-zoninator-rest-bootstrap.php b/src/zoninator_rest/class-zoninator-rest-bootstrap.php similarity index 100% rename from lib/zoninator_rest/class-zoninator-rest-bootstrap.php rename to src/zoninator_rest/class-zoninator-rest-bootstrap.php diff --git a/lib/zoninator_rest/class-zoninator-rest-classloader.php b/src/zoninator_rest/class-zoninator-rest-classloader.php similarity index 100% rename from lib/zoninator_rest/class-zoninator-rest-classloader.php rename to src/zoninator_rest/class-zoninator-rest-classloader.php diff --git a/lib/zoninator_rest/class-zoninator-rest-controller.php b/src/zoninator_rest/class-zoninator-rest-controller.php similarity index 100% rename from lib/zoninator_rest/class-zoninator-rest-controller.php rename to src/zoninator_rest/class-zoninator-rest-controller.php diff --git a/lib/zoninator_rest/class-zoninator-rest-environment.php b/src/zoninator_rest/class-zoninator-rest-environment.php similarity index 100% rename from lib/zoninator_rest/class-zoninator-rest-environment.php rename to src/zoninator_rest/class-zoninator-rest-environment.php diff --git a/lib/zoninator_rest/class-zoninator-rest-exception.php b/src/zoninator_rest/class-zoninator-rest-exception.php similarity index 100% rename from lib/zoninator_rest/class-zoninator-rest-exception.php rename to src/zoninator_rest/class-zoninator-rest-exception.php diff --git a/lib/zoninator_rest/class-zoninator-rest-expect.php b/src/zoninator_rest/class-zoninator-rest-expect.php similarity index 100% rename from lib/zoninator_rest/class-zoninator-rest-expect.php rename to src/zoninator_rest/class-zoninator-rest-expect.php diff --git a/lib/zoninator_rest/class-zoninator-rest-model.php b/src/zoninator_rest/class-zoninator-rest-model.php similarity index 100% rename from lib/zoninator_rest/class-zoninator-rest-model.php rename to src/zoninator_rest/class-zoninator-rest-model.php diff --git a/lib/zoninator_rest/class-zoninator-rest-type.php b/src/zoninator_rest/class-zoninator-rest-type.php similarity index 100% rename from lib/zoninator_rest/class-zoninator-rest-type.php rename to src/zoninator_rest/class-zoninator-rest-type.php diff --git a/lib/zoninator_rest/controller/bundle/class-zoninator-rest-controller-bundle-builder.php b/src/zoninator_rest/controller/bundle/class-zoninator-rest-controller-bundle-builder.php similarity index 100% rename from lib/zoninator_rest/controller/bundle/class-zoninator-rest-controller-bundle-builder.php rename to src/zoninator_rest/controller/bundle/class-zoninator-rest-controller-bundle-builder.php diff --git a/lib/zoninator_rest/controller/class-zoninator-rest-controller-action.php b/src/zoninator_rest/controller/class-zoninator-rest-controller-action.php similarity index 100% rename from lib/zoninator_rest/controller/class-zoninator-rest-controller-action.php rename to src/zoninator_rest/controller/class-zoninator-rest-controller-action.php diff --git a/lib/zoninator_rest/controller/class-zoninator-rest-controller-bundle.php b/src/zoninator_rest/controller/class-zoninator-rest-controller-bundle.php similarity index 100% rename from lib/zoninator_rest/controller/class-zoninator-rest-controller-bundle.php rename to src/zoninator_rest/controller/class-zoninator-rest-controller-bundle.php diff --git a/lib/zoninator_rest/controller/class-zoninator-rest-controller-crud.php b/src/zoninator_rest/controller/class-zoninator-rest-controller-crud.php similarity index 100% rename from lib/zoninator_rest/controller/class-zoninator-rest-controller-crud.php rename to src/zoninator_rest/controller/class-zoninator-rest-controller-crud.php diff --git a/lib/zoninator_rest/controller/class-zoninator-rest-controller-extension.php b/src/zoninator_rest/controller/class-zoninator-rest-controller-extension.php similarity index 100% rename from lib/zoninator_rest/controller/class-zoninator-rest-controller-extension.php rename to src/zoninator_rest/controller/class-zoninator-rest-controller-extension.php diff --git a/lib/zoninator_rest/controller/class-zoninator-rest-controller-model.php b/src/zoninator_rest/controller/class-zoninator-rest-controller-model.php similarity index 100% rename from lib/zoninator_rest/controller/class-zoninator-rest-controller-model.php rename to src/zoninator_rest/controller/class-zoninator-rest-controller-model.php diff --git a/lib/zoninator_rest/controller/class-zoninator-rest-controller-route.php b/src/zoninator_rest/controller/class-zoninator-rest-controller-route.php similarity index 100% rename from lib/zoninator_rest/controller/class-zoninator-rest-controller-route.php rename to src/zoninator_rest/controller/class-zoninator-rest-controller-route.php diff --git a/lib/zoninator_rest/controller/class-zoninator-rest-controller-settings.php b/src/zoninator_rest/controller/class-zoninator-rest-controller-settings.php similarity index 100% rename from lib/zoninator_rest/controller/class-zoninator-rest-controller-settings.php rename to src/zoninator_rest/controller/class-zoninator-rest-controller-settings.php diff --git a/lib/zoninator_rest/data/class-zoninator-rest-data-mapper.php b/src/zoninator_rest/data/class-zoninator-rest-data-mapper.php similarity index 100% rename from lib/zoninator_rest/data/class-zoninator-rest-data-mapper.php rename to src/zoninator_rest/data/class-zoninator-rest-data-mapper.php diff --git a/lib/zoninator_rest/data/class-zoninator-rest-data-serializer.php b/src/zoninator_rest/data/class-zoninator-rest-data-serializer.php similarity index 100% rename from lib/zoninator_rest/data/class-zoninator-rest-data-serializer.php rename to src/zoninator_rest/data/class-zoninator-rest-data-serializer.php diff --git a/lib/zoninator_rest/data/store/class-zoninator-rest-data-store-abstract.php b/src/zoninator_rest/data/store/class-zoninator-rest-data-store-abstract.php similarity index 100% rename from lib/zoninator_rest/data/store/class-zoninator-rest-data-store-abstract.php rename to src/zoninator_rest/data/store/class-zoninator-rest-data-store-abstract.php diff --git a/lib/zoninator_rest/data/store/class-zoninator-rest-data-store-builder.php b/src/zoninator_rest/data/store/class-zoninator-rest-data-store-builder.php similarity index 100% rename from lib/zoninator_rest/data/store/class-zoninator-rest-data-store-builder.php rename to src/zoninator_rest/data/store/class-zoninator-rest-data-store-builder.php diff --git a/lib/zoninator_rest/data/store/class-zoninator-rest-data-store-customposttype.php b/src/zoninator_rest/data/store/class-zoninator-rest-data-store-customposttype.php similarity index 100% rename from lib/zoninator_rest/data/store/class-zoninator-rest-data-store-customposttype.php rename to src/zoninator_rest/data/store/class-zoninator-rest-data-store-customposttype.php diff --git a/lib/zoninator_rest/data/store/class-zoninator-rest-data-store-nil.php b/src/zoninator_rest/data/store/class-zoninator-rest-data-store-nil.php similarity index 100% rename from lib/zoninator_rest/data/store/class-zoninator-rest-data-store-nil.php rename to src/zoninator_rest/data/store/class-zoninator-rest-data-store-nil.php diff --git a/lib/zoninator_rest/data/store/class-zoninator-rest-data-store-option.php b/src/zoninator_rest/data/store/class-zoninator-rest-data-store-option.php similarity index 100% rename from lib/zoninator_rest/data/store/class-zoninator-rest-data-store-option.php rename to src/zoninator_rest/data/store/class-zoninator-rest-data-store-option.php diff --git a/lib/zoninator_rest/field/class-zoninator-rest-field-declaration.php b/src/zoninator_rest/field/class-zoninator-rest-field-declaration.php similarity index 100% rename from lib/zoninator_rest/field/class-zoninator-rest-field-declaration.php rename to src/zoninator_rest/field/class-zoninator-rest-field-declaration.php diff --git a/lib/zoninator_rest/field/declaration/class-zoninator-rest-field-declaration-builder.php b/src/zoninator_rest/field/declaration/class-zoninator-rest-field-declaration-builder.php similarity index 100% rename from lib/zoninator_rest/field/declaration/class-zoninator-rest-field-declaration-builder.php rename to src/zoninator_rest/field/declaration/class-zoninator-rest-field-declaration-builder.php diff --git a/lib/zoninator_rest/interfaces/class-zoninator-rest-interfaces-builder.php b/src/zoninator_rest/interfaces/class-zoninator-rest-interfaces-builder.php similarity index 100% rename from lib/zoninator_rest/interfaces/class-zoninator-rest-interfaces-builder.php rename to src/zoninator_rest/interfaces/class-zoninator-rest-interfaces-builder.php diff --git a/lib/zoninator_rest/interfaces/class-zoninator-rest-interfaces-classloader.php b/src/zoninator_rest/interfaces/class-zoninator-rest-interfaces-classloader.php similarity index 100% rename from lib/zoninator_rest/interfaces/class-zoninator-rest-interfaces-classloader.php rename to src/zoninator_rest/interfaces/class-zoninator-rest-interfaces-classloader.php diff --git a/lib/zoninator_rest/interfaces/class-zoninator-rest-interfaces-controller.php b/src/zoninator_rest/interfaces/class-zoninator-rest-interfaces-controller.php similarity index 100% rename from lib/zoninator_rest/interfaces/class-zoninator-rest-interfaces-controller.php rename to src/zoninator_rest/interfaces/class-zoninator-rest-interfaces-controller.php diff --git a/lib/zoninator_rest/interfaces/class-zoninator-rest-interfaces-model.php b/src/zoninator_rest/interfaces/class-zoninator-rest-interfaces-model.php similarity index 100% rename from lib/zoninator_rest/interfaces/class-zoninator-rest-interfaces-model.php rename to src/zoninator_rest/interfaces/class-zoninator-rest-interfaces-model.php diff --git a/lib/zoninator_rest/interfaces/class-zoninator-rest-interfaces-registrable.php b/src/zoninator_rest/interfaces/class-zoninator-rest-interfaces-registrable.php similarity index 100% rename from lib/zoninator_rest/interfaces/class-zoninator-rest-interfaces-registrable.php rename to src/zoninator_rest/interfaces/class-zoninator-rest-interfaces-registrable.php diff --git a/lib/zoninator_rest/interfaces/class-zoninator-rest-interfaces-type.php b/src/zoninator_rest/interfaces/class-zoninator-rest-interfaces-type.php similarity index 100% rename from lib/zoninator_rest/interfaces/class-zoninator-rest-interfaces-type.php rename to src/zoninator_rest/interfaces/class-zoninator-rest-interfaces-type.php diff --git a/lib/zoninator_rest/interfaces/controller/class-zoninator-rest-interfaces-controller-bundle.php b/src/zoninator_rest/interfaces/controller/class-zoninator-rest-interfaces-controller-bundle.php similarity index 100% rename from lib/zoninator_rest/interfaces/controller/class-zoninator-rest-interfaces-controller-bundle.php rename to src/zoninator_rest/interfaces/controller/class-zoninator-rest-interfaces-controller-bundle.php diff --git a/lib/zoninator_rest/interfaces/data/class-zoninator-rest-interfaces-data-store.php b/src/zoninator_rest/interfaces/data/class-zoninator-rest-interfaces-data-store.php similarity index 100% rename from lib/zoninator_rest/interfaces/data/class-zoninator-rest-interfaces-data-store.php rename to src/zoninator_rest/interfaces/data/class-zoninator-rest-interfaces-data-store.php diff --git a/lib/zoninator_rest/interfaces/model/class-zoninator-rest-interfaces-model-collection.php b/src/zoninator_rest/interfaces/model/class-zoninator-rest-interfaces-model-collection.php similarity index 100% rename from lib/zoninator_rest/interfaces/model/class-zoninator-rest-interfaces-model-collection.php rename to src/zoninator_rest/interfaces/model/class-zoninator-rest-interfaces-model-collection.php diff --git a/lib/zoninator_rest/interfaces/model/class-zoninator-rest-interfaces-model-declaration.php b/src/zoninator_rest/interfaces/model/class-zoninator-rest-interfaces-model-declaration.php similarity index 100% rename from lib/zoninator_rest/interfaces/model/class-zoninator-rest-interfaces-model-declaration.php rename to src/zoninator_rest/interfaces/model/class-zoninator-rest-interfaces-model-declaration.php diff --git a/lib/zoninator_rest/interfaces/permissions/class-zoninator-rest-interfaces-permissions-provider.php b/src/zoninator_rest/interfaces/permissions/class-zoninator-rest-interfaces-permissions-provider.php similarity index 100% rename from lib/zoninator_rest/interfaces/permissions/class-zoninator-rest-interfaces-permissions-provider.php rename to src/zoninator_rest/interfaces/permissions/class-zoninator-rest-interfaces-permissions-provider.php diff --git a/lib/zoninator_rest/model/class-zoninator-rest-model-collection.php b/src/zoninator_rest/model/class-zoninator-rest-model-collection.php similarity index 100% rename from lib/zoninator_rest/model/class-zoninator-rest-model-collection.php rename to src/zoninator_rest/model/class-zoninator-rest-model-collection.php diff --git a/lib/zoninator_rest/model/class-zoninator-rest-model-declaration.php b/src/zoninator_rest/model/class-zoninator-rest-model-declaration.php similarity index 100% rename from lib/zoninator_rest/model/class-zoninator-rest-model-declaration.php rename to src/zoninator_rest/model/class-zoninator-rest-model-declaration.php diff --git a/lib/zoninator_rest/model/class-zoninator-rest-model-definition.php b/src/zoninator_rest/model/class-zoninator-rest-model-definition.php similarity index 100% rename from lib/zoninator_rest/model/class-zoninator-rest-model-definition.php rename to src/zoninator_rest/model/class-zoninator-rest-model-definition.php diff --git a/lib/zoninator_rest/model/class-zoninator-rest-model-settings.php b/src/zoninator_rest/model/class-zoninator-rest-model-settings.php similarity index 100% rename from lib/zoninator_rest/model/class-zoninator-rest-model-settings.php rename to src/zoninator_rest/model/class-zoninator-rest-model-settings.php diff --git a/lib/zoninator_rest/model/class-zoninator-rest-model-validationdata.php b/src/zoninator_rest/model/class-zoninator-rest-model-validationdata.php similarity index 100% rename from lib/zoninator_rest/model/class-zoninator-rest-model-validationdata.php rename to src/zoninator_rest/model/class-zoninator-rest-model-validationdata.php diff --git a/lib/zoninator_rest/model/declaration/class-zoninator-rest-model-declaration-settings.php b/src/zoninator_rest/model/declaration/class-zoninator-rest-model-declaration-settings.php similarity index 100% rename from lib/zoninator_rest/model/declaration/class-zoninator-rest-model-declaration-settings.php rename to src/zoninator_rest/model/declaration/class-zoninator-rest-model-declaration-settings.php diff --git a/lib/zoninator_rest/model/definition/class-zoninator-rest-model-definition-builder.php b/src/zoninator_rest/model/definition/class-zoninator-rest-model-definition-builder.php similarity index 100% rename from lib/zoninator_rest/model/definition/class-zoninator-rest-model-definition-builder.php rename to src/zoninator_rest/model/definition/class-zoninator-rest-model-definition-builder.php diff --git a/lib/zoninator_rest/permissions/class-zoninator-rest-permissions-any.php b/src/zoninator_rest/permissions/class-zoninator-rest-permissions-any.php similarity index 100% rename from lib/zoninator_rest/permissions/class-zoninator-rest-permissions-any.php rename to src/zoninator_rest/permissions/class-zoninator-rest-permissions-any.php diff --git a/lib/zoninator_rest/type/class-zoninator-rest-type-array.php b/src/zoninator_rest/type/class-zoninator-rest-type-array.php similarity index 100% rename from lib/zoninator_rest/type/class-zoninator-rest-type-array.php rename to src/zoninator_rest/type/class-zoninator-rest-type-array.php diff --git a/lib/zoninator_rest/type/class-zoninator-rest-type-boolean.php b/src/zoninator_rest/type/class-zoninator-rest-type-boolean.php similarity index 100% rename from lib/zoninator_rest/type/class-zoninator-rest-type-boolean.php rename to src/zoninator_rest/type/class-zoninator-rest-type-boolean.php diff --git a/lib/zoninator_rest/type/class-zoninator-rest-type-integer.php b/src/zoninator_rest/type/class-zoninator-rest-type-integer.php similarity index 100% rename from lib/zoninator_rest/type/class-zoninator-rest-type-integer.php rename to src/zoninator_rest/type/class-zoninator-rest-type-integer.php diff --git a/lib/zoninator_rest/type/class-zoninator-rest-type-nullable.php b/src/zoninator_rest/type/class-zoninator-rest-type-nullable.php similarity index 100% rename from lib/zoninator_rest/type/class-zoninator-rest-type-nullable.php rename to src/zoninator_rest/type/class-zoninator-rest-type-nullable.php diff --git a/lib/zoninator_rest/type/class-zoninator-rest-type-number.php b/src/zoninator_rest/type/class-zoninator-rest-type-number.php similarity index 100% rename from lib/zoninator_rest/type/class-zoninator-rest-type-number.php rename to src/zoninator_rest/type/class-zoninator-rest-type-number.php diff --git a/lib/zoninator_rest/type/class-zoninator-rest-type-registry.php b/src/zoninator_rest/type/class-zoninator-rest-type-registry.php similarity index 100% rename from lib/zoninator_rest/type/class-zoninator-rest-type-registry.php rename to src/zoninator_rest/type/class-zoninator-rest-type-registry.php diff --git a/lib/zoninator_rest/type/class-zoninator-rest-type-string.php b/src/zoninator_rest/type/class-zoninator-rest-type-string.php similarity index 100% rename from lib/zoninator_rest/type/class-zoninator-rest-type-string.php rename to src/zoninator_rest/type/class-zoninator-rest-type-string.php diff --git a/lib/zoninator_rest/type/class-zoninator-rest-type-typedarray.php b/src/zoninator_rest/type/class-zoninator-rest-type-typedarray.php similarity index 100% rename from lib/zoninator_rest/type/class-zoninator-rest-type-typedarray.php rename to src/zoninator_rest/type/class-zoninator-rest-type-typedarray.php diff --git a/zoninator.php b/zoninator.php index 52775a0..63cf0b3 100644 --- a/zoninator.php +++ b/zoninator.php @@ -101,7 +101,7 @@ public function maybe_add_rest_api() { return false; } - include_once __DIR__ . '/includes/class-zoninator-api.php'; + include_once ZONINATOR_PATH . '/src/class-zoninator-api.php'; $this->rest_api = new Zoninator_Api( $this ); return null; } From 7574b06a26335489063c1c4e9238494d5abde03b Mon Sep 17 00:00:00 2001 From: Gary Jones Date: Sat, 23 Nov 2024 13:21:07 +0000 Subject: [PATCH 45/56] Extract Zoninator class Closes #113. --- src/class-zoninator.php | 1800 +++++++++++++++++++++++++++++++++++++++ zoninator.php | 1794 +------------------------------------- 2 files changed, 1801 insertions(+), 1793 deletions(-) create mode 100644 src/class-zoninator.php diff --git a/src/class-zoninator.php b/src/class-zoninator.php new file mode 100644 index 0000000..25e64dd --- /dev/null +++ b/src/class-zoninator.php @@ -0,0 +1,1800 @@ + '', + // Add additional properties here! + ); + + public $zone_messages; + + public $posts_per_page = 10; + + /** + * @var Zoninator_Api + */ + public $rest_api; + + /** + * @var array|string[] Default post types that support zones. + */ + public $default_post_types = array( 'post' ); + + public function __construct() { + add_action( 'init', array( $this, 'init' ), 99 ); // init later after other post types have been registered + + add_action( 'plugins_loaded', array( $this, 'load_textdomain' ) ); + + add_action( 'widgets_init', array( $this, 'widgets_init' ) ); + + add_action( 'init', array( $this, 'add_zone_feed' ) ); + + add_action( 'template_redirect', array( $this, 'do_zoninator_feeds' ) ); + + add_action( 'split_shared_term', array( $this, 'split_shared_term' ), 10, 4 ); + + $this->maybe_add_rest_api(); + } + + public function maybe_add_rest_api() { + global $wp_version; + if ( version_compare( $wp_version, '4.7', '<' ) ) { + return false; + } + + include_once ZONINATOR_PATH . '/src/class-zoninator-api.php'; + $this->rest_api = new Zoninator_Api( $this ); + return null; + } + + public function add_zone_feed() { + add_rewrite_tag( '%' . $this->zone_taxonomy . '%', '([^&]+)' ); + add_rewrite_rule( '^zones/([^/]+)/feed.json/?$', 'index.php?' . $this->zone_taxonomy . '=$matches[1]', 'top' ); + } + + public function init() { + $this->zone_messages = array( + 'insert-success' => __( 'The zone was successfully created.', 'zoninator' ), + 'update-success' => __( 'The zone was successfully updated.', 'zoninator' ), + 'delete-success' => __( 'The zone was successfully deleted.', 'zoninator' ), + 'error-general' => __( 'Sorry, something went wrong! Please try again?', 'zoninator' ), + /* translators: User's display name, or "another user" */ + 'error-zone-lock' => __( 'Sorry, this zone is in use by %s and is currently locked. Please try again later.', 'zoninator' ), + 'error-zone-lock-max' => __( 'Sorry, you have reached the maximum idle limit and will now be redirected to the Dashboard.', 'zoninator' ), + ); + + $this->zone_lock_period = apply_filters( 'zoninator_zone_lock_period', $this->zone_lock_period ); + $this->zone_max_lock_period = apply_filters( 'zoninator_zone_max_lock_period', $this->zone_max_lock_period ); + $this->posts_per_page = apply_filters( 'zoninator_posts_per_page', $this->posts_per_page ); + + do_action( 'zoninator_pre_init' ); + + // Default post type support + foreach ( $this->default_post_types as $post_type ) { + add_post_type_support( $post_type, $this->zone_taxonomy ); + } + + // Register taxonomy + if ( ! taxonomy_exists( $this->zone_taxonomy ) ) { + register_taxonomy( + $this->zone_taxonomy, + $this->get_supported_post_types(), + array( + 'label' => __( 'Zones', 'zoninator' ), + 'hierarchical' => false, + 'query_var' => false, + 'rewrite' => false, + 'public' => false, + + ) + ); + } + + add_action( 'admin_init', array( $this, 'admin_controller' ) ); + add_action( 'admin_init', array( $this, 'admin_init' ) ); + + add_action( 'admin_menu', array( $this, 'admin_page_init' ) ); + + // Add default advanced search fields + add_action( 'zoninator_advanced_search_fields', array( $this, 'zone_advanced_search_cat_filter' ) ); + add_action( 'zoninator_advanced_search_fields', array( $this, 'zone_advanced_search_date_filter' ), 20 ); + + do_action( 'zoninator_post_init' ); + } + + public function load_textdomain() { + load_plugin_textdomain( 'zoninator', false, basename( ZONINATOR_PATH ) . '/language' ); + } + + public function widgets_init() { + register_widget( 'Zoninator_ZonePosts_Widget' ); + } + + // Add necessary AJAX actions + public function admin_ajax_init() { + add_action( 'wp_ajax_zoninator_reorder_posts', array( $this, 'ajax_reorder_posts' ) ); + add_action( 'wp_ajax_zoninator_add_post', array( $this, 'ajax_add_post' ) ); + add_action( 'wp_ajax_zoninator_remove_post', array( $this, 'ajax_remove_post' ) ); + add_action( 'wp_ajax_zoninator_search_posts', array( $this, 'ajax_search_posts' ) ); + add_action( 'wp_ajax_zoninator_update_lock', array( $this, 'ajax_update_lock' ) ); + add_action( 'wp_ajax_zoninator_update_recent', array( $this, 'ajax_recent_posts' ) ); + } + + public function admin_init() { + + $this->admin_ajax_init(); + + // Enqueue Scripts and Styles + add_action( 'admin_enqueue_scripts', array( $this, 'admin_enqueue_scripts' ) ); + add_action( 'admin_enqueue_scripts', array( $this, 'admin_enqueue_styles' ) ); + } + + public function admin_page_init() { + // Set up page + add_menu_page( __( 'Zoninator', 'zoninator' ), __( 'Zones', 'zoninator' ), $this->_get_manage_zones_cap(), $this->key, array( $this, 'admin_page' ), '', 11 ); + } + + public function admin_enqueue_scripts() { + if ( $this->is_zoninator_page() ) { + wp_enqueue_script( 'zoninator-js', ZONINATOR_URL . 'js/zoninator.js', array( 'jquery', 'jquery-ui-core', 'jquery-ui-widget', 'jquery-ui-mouse', 'jquery-ui-position', 'jquery-ui-sortable', 'jquery-ui-autocomplete' ), ZONINATOR_VERSION, true ); + + $options = array( + 'baseUrl' => $this->_get_zone_page_url(), + 'adminUrl' => admin_url(), + 'ajaxNonceAction' => $this->_get_nonce_key( $this->zone_ajax_nonce_action ), + 'errorGeneral' => $this->_get_message( 'error-general' ), + 'errorZoneLock' => sprintf( $this->_get_message( 'error-zone-lock' ), __( 'another user', 'zoninator' ) ), + 'errorZoneLockMax' => $this->_get_message( 'error-zone-lock-max' ), + 'zoneLockPeriod' => $this->zone_lock_period, + 'zoneLockPeriodMax' => $this->zone_max_lock_period, + ); + wp_localize_script( 'zoninator-js', 'zoninatorOptions', $options ); + + // For mobile support: https://github.com/furf/jquery-ui-touch-punch + // phpcs:ignore WordPress.WP.EnqueuedResourceParameters.NotInFooter, WordPress.WP.EnqueuedResourceParameters.MissingVersion + wp_enqueue_script( 'jquery-ui-touch-punch', ZONINATOR_URL . 'js/jquery.ui.touch-punch.min.js', array( 'jquery-ui-core', 'jquery-ui-widget', 'jquery-ui-mouse' ) ); + } + } + + public function admin_enqueue_styles() { + if ( $this->is_zoninator_page() ) { + wp_enqueue_style( 'zoninator-jquery-ui', ZONINATOR_URL . 'css/jquery-ui/smoothness/jquery-ui-zoninator.css', false, ZONINATOR_VERSION, 'all' ); + wp_enqueue_style( 'zoninator-styles', ZONINATOR_URL . 'css/zoninator.css', false, ZONINATOR_VERSION, 'all' ); + } + } + + public function admin_controller() { + if ( $this->is_zoninator_page() ) { + $action = $this->_get_request_var( 'action' ); + + switch ( $action ) { + case 'insert': + case 'update': + $zone_id = $this->_get_post_var( 'zone_id', 0, 'absint' ); + + $this->verify_nonce( $action ); + $this->verify_access( $action, $zone_id ); + + $name = $this->_get_post_var( 'name', '', array( $this, '_sanitize_value' ) ); + $slug = $this->_get_post_var( 'slug', sanitize_title( $name ) ); + $details = array( + 'description' => $this->_get_post_var( 'description', '', array( $this, '_sanitize_value' ) ), + ); + + // TODO: handle additional properties + if ( $zone_id ) { + $result = $this->update_zone( + $zone_id, + array( + 'name' => $name, + 'slug' => $slug, + 'details' => $details, + ) + ); + } else { + $result = $this->insert_zone( $slug, $name, $details ); + } + + if ( is_wp_error( $result ) ) { + // phpcs:ignore WordPress.Security.SafeRedirect.wp_redirect_wp_redirect + wp_redirect( add_query_arg( 'message', 'error-general' ) ); + exit; + } else { + if ( ! $zone_id && isset( $result['term_id'] ) ) { + $zone_id = $result['term_id']; + } + + // Redirect with success message + $message = sprintf( '%s-success', $action ); + // phpcs:ignore WordPress.Security.SafeRedirect.wp_redirect_wp_redirect + wp_redirect( + $this->_get_zone_page_url( + array( + 'action' => 'edit', + 'zone_id' => $zone_id, + 'message' => $message, + ) + ) + ); + exit; + } + + case 'delete': + $zone_id = $this->_get_request_var( 'zone_id', 0, 'absint' ); + + $this->verify_nonce( $action ); + $this->verify_access( $action, $zone_id ); + + if ( $zone_id ) { + $result = $this->delete_zone( $zone_id ); + } + + if ( is_wp_error( $result ) ) { + $redirect_args = array( 'error' => $result->get_error_messages() ); + } else { + $redirect_args = array( 'message' => 'delete-success' ); + } + + // phpcs:ignore WordPress.Security.SafeRedirect.wp_redirect_wp_redirect + wp_redirect( $this->_get_zone_page_url( $redirect_args ) ); + exit; + } + } + } + + public function admin_page() { + global $zoninator_admin_page; + + $title = __( 'Zones', 'zoninator' ); + + $zones = $this->get_zones( apply_filters( 'zoninator_admin_page_get_zones_args', array() ) ); + + $default_active_zone = 0; + if ( ! $this->_current_user_can_add_zones() && ! empty( $zones ) ) { + $default_active_zone = $zones[0]->term_id; + } + + $active_zone_id = $this->_get_request_var( 'zone_id', $default_active_zone, 'absint' ); + $active_zone = empty( $active_zone_id ) ? array() : $this->get_zone( $active_zone_id ); + if ( ! empty( $active_zone ) ) { + $title = __( 'Edit Zone', 'zoninator' ); + } + + $message = $this->_get_message( $this->_get_get_var( 'message', '', 'urldecode' ) ); + $error = $this->_get_get_var( 'error', '', 'urldecode' ); + + ?> +
+

+

+ + _current_user_can_add_zones() ) : + $new_link = $this->_get_zone_page_url( array( 'action' => 'new' ) ); + ?> + + + + + +

+ + +
+

+
+ + +
+

+
+ + +
+ + admin_page_zone_tabs( $zones, $active_zone_id ); ?> + admin_page_zone_edit( $active_zone ); ?> + +
+
+ +
+
+
+
+ + get_zone_id( $zone ); ?> + _get_zone_page_url( + array( + 'action' => 'edit', + 'zone_id' => $zone_id, + ) + ); + ?> + + + name ); ?> + + name ); ?> + +
+
+
+
+ _get_value_or_default( 'term_id', $zone, 0, 'absint' ); + $zone_name = $this->_get_value_or_default( 'name', $zone ); + $zone_slug = $this->_get_value_or_default( 'slug', $zone, '', array( $this, 'get_unformatted_zone_slug' ) ); + $zone_description = $this->_get_value_or_default( 'description', $zone ); + + $zone_posts = $zone_id ? $this->get_zone_posts( $zone ) : array(); + + $zone_locked = $this->is_zone_locked( $zone_id ); + + $delete_link = $this->_get_zone_page_url( + array( + 'action' => 'delete', + 'zone_id' => $zone_id, + ) + ); + $delete_link = wp_nonce_url( $delete_link, $this->_get_nonce_key( 'delete' ) ); + ?> +
+ _current_user_can_add_zones() ) || ( 0 != $zone_id && $this->_current_user_can_manage_zones() ) ) : ?> + + +
+

_get_message( 'error-zone-lock' ) ), sprintf( '%s', esc_attr( $locking_user->user_email ), esc_html( $locking_user->display_name ) ) ); ?>

+
+ + +
+
+ + _current_user_can_edit_zones( $zone_id ) && ! $zone_locked ) : ?> + +
+ + + +
+ + +
+ + +
+ + + +
+ + +
+ + +
+ + + + + + _get_nonce_key( 'update' ) ); ?> + + _get_nonce_key( 'insert' ) ); ?> + + +
+ + + + + +
+ + + + +
+ +
+ + +
+ + +
+ + + +
+ + +
+ + + + +
+ + + + _get_nonce_key( $this->zone_ajax_nonce_action ), $this->_get_nonce_key( $this->zone_ajax_nonce_action ), false ); ?> +
+ +
+ +
+
+ +

+ + zone_advanced_search_filters(); ?> + + zone_admin_recent_posts_dropdown( $zone_id ); ?> + + zone_admin_search_form(); ?> + +
+ +

+
+ +
+ + admin_page_zone_post( $post, $zone ); ?> + +
+ + +

+ +
+
+ +
+ array( $this, 'admin_page_zone_post_col_position' ), + 'info' => array( $this, 'admin_page_zone_post_col_info' ), + ), + $post, + $zone + ); + ?> +
+ + + $column_callback ) : ?> + + + + +
+ +
+ +
+ get_post_order( $post->ID, $zone ); + ?> + + + + %s', get_edit_post_link( $post->ID ), __( 'Opens in new window', 'zoninator' ), __( 'Edit', 'zoninator' ) ), + sprintf( '%s', __( 'Remove this item from the zone', 'zoninator' ), __( 'Remove', 'zoninator' ) ), + sprintf( '%s', get_permalink( $post->ID ), __( 'Opens in new window', 'zoninator' ), __( 'View', 'zoninator' ) ), + // Move To + // Copy To + ); + ?> + (%s)', esc_html( $post->post_title ), esc_html( $post->post_status ) ); ?> + +
+ +
+ +
+ +
+
+ +
+ _get_post_var( 'zone_advanced_filter_taxonomy', '', 'absint' ); + ?> + + __( 'Show all Categories', 'zoninator' ), + 'selected' => $current_cat, + 'name' => 'zone_advanced_filter_taxonomy', + 'id' => 'zone_advanced_filter_taxonomy', + 'hide_if_empty' => true, + ) + ) + ); + } + + public function zone_advanced_search_date_filter() { + $current_date = $this->_get_post_var( 'zone_advanced_filter_date', apply_filters( 'zoninator_advanced_filter_date_default', '' ), 'striptags' ); + $date_filters = apply_filters( 'zoninator_advanced_filter_date', array( 'all', 'today', 'yesterday' ) ); + ?> + + _get_post_var( 'cat', '', 'absint' ); + $date = $this->_get_post_var( 'date', '', 'striptags' ); + $zone_id = $this->_get_post_var( 'zone_id', 0, 'absint' ); + + $limit = $this->posts_per_page; + $post_types = $this->get_supported_post_types(); + $zone_posts = $this->get_zone_posts( $zone_id ); + $zone_post_ids = wp_list_pluck( $zone_posts, 'ID' ); + + // Verify nonce + $this->verify_nonce( $this->zone_ajax_nonce_action ); + $this->verify_access( '', $zone_id ); + + if ( is_wp_error( $zone_posts ) ) { + $status = 0; + $content = $zone_posts->get_error_message(); + } else { + $args = apply_filters( + 'zoninator_recent_posts_args', + array( + 'posts_per_page' => $limit, + 'order' => 'DESC', + 'orderby' => 'post_date', + 'post_type' => $post_types, + 'ignore_sticky_posts' => true, + 'post_status' => array( 'publish', 'future' ), + // phpcs:ignore WordPressVIPMinimum.Performance.WPQueryParams.PostNotIn_post__not_in + 'post__not_in' => $zone_post_ids, + 'suppress_filters' => false, + ) + ); + + if ( $this->_validate_category_filter( $cat ) ) { + $args['cat'] = $cat; + } + + if ( $this->_validate_date_filter( $date ) ) { + $filter_date_parts = explode( '-', $date ); + $args['year'] = $filter_date_parts[0]; + $args['monthnum'] = $filter_date_parts[1]; + $args['day'] = $filter_date_parts[2]; + } + + $content = ''; + $recent_posts = get_posts( $args ); + foreach ( $recent_posts as $post ) : + $content .= sprintf( '', $post->ID, get_the_title( $post->ID ) . ' (' . $post->post_status . ')' ); + endforeach; + + wp_reset_postdata(); + $status = 1; + } + + $empty_label = ''; + if ( ! $content ) { + $empty_label = __( 'No results found', 'zoninator' ); + } elseif ( $cat ) { + /* translators: Category name */ + $empty_label = sprintf( __( 'Choose post from %s', 'zoninator' ), get_the_category_by_ID( $cat ) ); + } else { + $empty_label = __( 'Choose a post', 'zoninator' ); + } + + $content = '' . $content; + + $this->ajax_return( $status, $content ); + } + + public function zone_admin_recent_posts_dropdown( $zone_id ) { + + $limit = $this->posts_per_page; + $post_types = $this->get_supported_post_types(); + $zone_posts = $this->get_zone_posts( $zone_id ); + $zone_post_ids = wp_list_pluck( $zone_posts, 'ID' ); + + $args = apply_filters( + 'zoninator_recent_posts_args', + array( + 'posts_per_page' => $limit, + 'order' => 'DESC', + 'orderby' => 'post_date', + 'post_type' => $post_types, + 'ignore_sticky_posts' => true, + 'post_status' => array( 'publish', 'future' ), + // phpcs:ignore WordPressVIPMinimum.Performance.WPQueryParams.PostNotIn_post__not_in + 'post__not_in' => $zone_post_ids, + 'suppress_filters' => false, + ) + ); + + $recent_posts = get_posts( $args ); + ?> +
+
+ +
+ +
+ + +

+
+ key; + } else { + return ! empty( $screen->id ) && strstr( $screen->id, (string) $this->key ); + } + } + + public function ajax_return( $status, $content = '', $action = '' ) { + $action = empty( $action ) ? $this->zone_ajax_nonce_action : $action; + $nonce = wp_create_nonce( $this->_get_nonce_key( $action ) ); + + echo wp_json_encode( + array( + 'status' => $status, + 'content' => $content, + 'nonce' => $nonce, + ) + ); + exit; + } + + public function ajax_add_post() { + $zone_id = $this->_get_post_var( 'zone_id', 0, 'absint' ); + $post_id = $this->_get_post_var( 'post_id', 0, 'absint' ); + + // Verify nonce + $this->verify_nonce( $this->zone_ajax_nonce_action ); + $this->verify_access( '', $zone_id ); + + // Validate + if ( ! $zone_id || ! $post_id ) { + $this->ajax_return( 0 ); + } + + $result = $this->add_zone_posts( $zone_id, $post_id, true ); + + if ( is_wp_error( $result ) ) { + $status = 0; + $content = $result->get_error_message(); + } else { + $post = get_post( $post_id ); + $zone = $this->get_zone( $zone_id ); + + ob_start(); + $this->admin_page_zone_post( $post, $zone ); + $content = ob_get_contents(); + ob_end_clean(); + + $status = 1; + } + + $this->ajax_return( $status, $content ); + } + + public function ajax_remove_post() { + $zone_id = $this->_get_post_var( 'zone_id', 0, 'absint' ); + $post_id = $this->_get_post_var( 'post_id', 0, 'absint' ); + + // Verify nonce + $this->verify_nonce( $this->zone_ajax_nonce_action ); + $this->verify_access( '', $zone_id ); + + // Validate + if ( ! $zone_id || ! $post_id ) { + $this->ajax_return( 0 ); + } + + $result = $this->remove_zone_posts( $zone_id, $post_id ); + + if ( is_wp_error( $result ) ) { + $status = 0; + $content = $result->get_error_message(); + } else { + $status = 1; + $content = ''; + } + + $this->ajax_return( $status, $content ); + } + + public function ajax_reorder_posts() { + $zone_id = $this->_get_post_var( 'zone_id', 0, 'absint' ); + $post_ids = (array) $this->_get_post_var( 'posts', array(), 'absint' ); + + // Verify nonce + $this->verify_nonce( $this->zone_ajax_nonce_action ); + $this->verify_access( '', $zone_id ); + + // validate + if ( ! $zone_id || array() === $post_ids ) { + $this->ajax_return( 0 ); + } + + $result = $this->add_zone_posts( $zone_id, $post_ids, false ); + + if ( is_wp_error( $result ) ) { + $status = 0; + $content = $result->get_error_message(); + } else { + $status = 1; + $content = ''; + } + + $this->ajax_return( $status, $content ); + } + + // TODO: implement in front-end + public function ajax_move_zone_post( $from_zone, $to_zone, $post_id ) { + $from_zone_id = $this->_get_post_var( 'from_zone_id', 0, 'absint' ); + $to_zone_id = $this->_get_post_var( 'to_zone_id', 0, 'absint' ); + + $this->verify_nonce( $this->zone_ajax_nonce_action ); + + // TODO: validate both zones exist, post exists + + // Add to new zone + $this->add_zone_posts( $to_zone_id, $post_id, true ); + + // Remove from old zone + $this->remove_zone_posts( $from_zone_id, $post_id ); + } + + public function ajax_search_posts() { + + $q = $this->_get_request_var( 'term', '', 'stripslashes' ); + + if ( ! empty( $q ) ) { + $filter_cat = $this->_get_request_var( 'cat', '', 'absint' ); + $filter_date = $this->_get_request_var( 'date', '', 'striptags' ); + + $post_types = $this->get_supported_post_types(); + $limit = $this->_get_request_var( 'limit', $this->posts_per_page ); + if ( $limit <= 0 ) { + $limit = $this->posts_per_page; + } + + $exclude = (array) $this->_get_request_var( 'exclude', array(), 'absint' ); + + $args = apply_filters( + 'zoninator_search_args', + array( + 's' => $q, + // phpcs:ignore WordPressVIPMinimum.Performance.WPQueryParams.PostNotIn_post__not_in + 'post__not_in' => $exclude, + 'posts_per_page' => $limit, + 'post_type' => $post_types, + 'post_status' => array( 'publish', 'future' ), + 'order' => 'DESC', + 'orderby' => 'post_date', + // phpcs:ignore WordPressVIPMinimum.Performance.WPQueryParams.SuppressFilters_suppress_filters + 'suppress_filters' => true, + 'no_found_rows' => true, + ) + ); + + if ( $this->_validate_category_filter( $filter_cat ) ) { + $args['cat'] = $filter_cat; + } + + if ( $this->_validate_date_filter( $filter_date ) ) { + $filter_date_parts = explode( '-', $filter_date ); + $args['year'] = $filter_date_parts[0]; + $args['monthnum'] = $filter_date_parts[1]; + $args['day'] = $filter_date_parts[2]; + } + + $query = new WP_Query( $args ); + $stripped_posts = array(); + + if ( ! $query->have_posts() ) { + echo wp_json_encode( array() ); + exit; + } + + foreach ( $query->posts as $post ) { + $stripped_posts[] = apply_filters( + 'zoninator_search_results_post', + array( + 'title' => empty( $post->post_title ) ? __( '(no title)', 'zoninator' ) : $post->post_title, + 'post_id' => $post->ID, + 'date' => get_the_time( get_option( 'date_format' ), $post ), + 'post_type' => $post->post_type, + 'post_status' => $post->post_status, + ), + $post + ); + } + + echo wp_json_encode( $stripped_posts ); + exit; + } + } + + public function ajax_update_lock() { + $zone_id = $this->_get_post_var( 'zone_id', 0, 'absint' ); + + $this->verify_nonce( $this->zone_ajax_nonce_action ); + $this->verify_access( '', $zone_id ); + + if ( ! $zone_id ) { + exit; + } + + if ( ! $this->is_zone_locked( $zone_id ) ) { + $this->lock_zone( $zone_id ); + $this->ajax_return( 1, '' ); + } + } + + public function get_supported_post_types() { + if ( null !== $this->post_types ) { + return $this->post_types; + } + + $this->post_types = array(); + + foreach ( get_post_types() as $post_type ) { + if ( post_type_supports( $post_type, $this->zone_taxonomy ) ) { + $this->post_types[] = $post_type; + } + } + + return $this->post_types; + } + + /** + * Registers a post type to be available for zones + * + * @param string|array $post_types A post type string or array of post type strings to register. + * @return bool True if any post types were added, false if not. + */ + public function register_zone_post_type( $post_types = '' ) { + + $did_register_post_types = false; + + if ( ! is_array( $post_types ) ) { + $post_types = array( $post_types ); + } + + foreach ( $post_types as $post_type ) { + if ( ! post_type_exists( $post_type ) ) { + continue; + } + + add_post_type_support( $post_type, $this->zone_taxonomy ); + register_taxonomy_for_object_type( $this->zone_taxonomy, $post_type ); + + // Clear Zoninator supported post types cache + unset( $this->post_types ); + + $did_register_post_types = true; + } + + return $did_register_post_types; + } + + public function insert_zone( $slug, $name = '', $details = array() ) { + + // slug cannot be empty + if ( empty( $slug ) ) { + return new WP_Error( 'zone-empty-slug', __( 'Slug is a required field.', 'zoninator' ) ); + } + + $slug = $this->get_formatted_zone_slug( $slug ); + $name = empty( $name ) ? $slug : $name; + + $details = wp_parse_args( $details, $this->zone_detail_defaults ); + $details = maybe_serialize( stripslashes_deep( $details ) ); + + $args = array( + 'slug' => $slug, + 'description' => $details, + ); + + // Filterize to allow other inputs + $args = apply_filters( 'zoninator_insert_zone', $args ); + + return wp_insert_term( $name, $this->zone_taxonomy, $args ); + } + + public function update_zone( $zone, $data = array() ) { + $zone_id = $this->get_zone_id( $zone ); + + if ( $this->zone_exists( $zone_id ) ) { + $zone = $this->get_zone( $zone ); + + $name = $this->_get_value_or_default( 'name', $data, $zone->name ); + $slug = $this->_get_value_or_default( 'slug', $data, $zone->slug, array( $this, 'get_formatted_zone_slug' ) ); + $details = $this->_get_value_or_default( 'details', $data, array() ); + + // TODO: Back-fill current zone details + // $details = wp_parse_args( $details, $this->zone_detail_defaults ); + $details = wp_parse_args( $details, $this->zone_detail_defaults ); + $details = maybe_serialize( stripslashes_deep( $details ) ); + + $args = array( + 'name' => $name, + 'slug' => $slug, + 'description' => $details, + ); + + // Filterize to allow other inputs + $args = apply_filters( 'zoninator_update_zone', $args, $zone_id, $zone ); + + return wp_update_term( $zone_id, $this->zone_taxonomy, $args ); + } + + return new WP_Error( 'invalid-zone', __( "Sorry, that zone doesn't exist.", 'zoninator' ) ); + } + + public function delete_zone( $zone ) { + $zone_id = $this->get_zone_id( $zone ); + $meta_key = $this->get_zone_meta_key( $zone ); + + $this->_empty_zone_posts_cache( $meta_key ); + + if ( $this->zone_exists( $zone_id ) ) { + // Delete all post associations for the zone + $this->remove_zone_posts( $zone_id ); + + // Delete the term + $delete = wp_delete_term( $zone_id, $this->zone_taxonomy ); + + if ( ! $delete ) { + return new WP_Error( 'delete-zone', __( "Sorry, we couldn't delete the zone.", 'zoninator' ) ); + } else { + do_action( 'zoninator_delete_zone', $zone_id ); + return $delete; + } + } + + return new WP_Error( 'invalid-zone', __( "Sorry, that zone doesn't exist.", 'zoninator' ) ); + } + + /** + * @param $zone + * @param $posts + * @param bool $append + * @return bool|WP_Error + */ + public function add_zone_posts( $zone, $posts, $append = false ) { + $zone = $this->get_zone( $zone ); + $meta_key = $this->get_zone_meta_key( $zone ); + + $this->_empty_zone_posts_cache( $meta_key ); + + if ( $append ) { + // Order should be the highest post order + $last_post = $this->get_last_post_in_zone( $zone ); + $order = $last_post ? $this->get_post_order( $last_post, $zone ) : 0; + } else { + $order = 0; + $this->remove_zone_posts( $zone ); + } + + foreach ( (array) $posts as $post ) { + $post_id = $this->get_post_id( $post ); + if ( $post_id ) { + ++$order; + update_metadata( 'post', $post_id, $meta_key, $order, true ); + } + + // TODO: remove_object_terms -- but need remove object terms function :( + } + + clean_term_cache( $this->get_zone_id( $zone ), $this->zone_taxonomy ); // flush cache for our zone term and related APC caches + + do_action( 'zoninator_add_zone_posts', $posts, $zone ); + + return true; + } + + /** + * @param mixed $zone + * @param mixed $posts + * + * @return bool|WP_Error + */ + public function remove_zone_posts( $zone, $posts = null ) { + $zone = $this->get_zone( $zone ); + $meta_key = $this->get_zone_meta_key( $zone ); + + $this->_empty_zone_posts_cache( $meta_key ); + + // if null, delete all + if ( ! $posts ) { + $posts = $this->get_zone_posts( $zone ); + } + + foreach ( (array) $posts as $post ) { + $post_id = $this->get_post_id( $post ); + if ( $post_id ) { + delete_metadata( 'post', $post_id, $meta_key ); + } + } + + clean_term_cache( $this->get_zone_id( $zone ), $this->zone_taxonomy ); // flush cache for our zone term and related APC caches + + do_action( 'zoninator_remove_zone_posts', $posts, $zone ); + } + + public function get_zone_posts( $zone, $args = array() ) { + // Check cache first + $posts = $this->get_zone_posts_from_cache( $zone, $args ); + if ( $posts ) { + return $posts; + } + + $query = $this->get_zone_query( $zone, $args ); + $posts = $query->posts; + + // Add posts to cache + $this->add_zone_posts_to_cache( $posts, $zone, $args ); + + return $posts; + } + + public function get_zone_query( $zone, $args = array() ) { + $meta_key = $this->get_zone_meta_key( $zone ); + + $defaults = array( + 'order' => 'ASC', + 'posts_per_page' => -1, + 'post_type' => $this->get_supported_post_types(), + 'ignore_sticky_posts' => '1', // don't want sticky posts messing up our order + ); + + // Default to published posts on the front-end + if ( ! is_admin() ) { + $defaults['post_status'] = array( 'publish' ); + } + + if ( is_admin() ) { // skip APC in the admin + // phpcs:ignore WordPressVIPMinimum.Performance.WPQueryParams.SuppressFilters_suppress_filters + $defaults['suppress_filters'] = true; + } + + $args = wp_parse_args( $args, $defaults ); + + // Un-overridable args + $args['orderby'] = 'meta_value_num'; + $args['meta_key'] = $meta_key; + + return new WP_Query( $args ); + } + + public function get_last_post_in_zone( $zone ) { + return $this->get_single_post_in_zone( + $zone, + array( + 'order' => 'DESC', + ) + ); + } + + public function get_first_post_in_zone( $zone ) { + return $this->get_single_post_in_zone( $zone ); + } + + public function get_prev_post_in_zone( $zone, $post_id ) { + // TODO: test this works + $order = $this->get_post_order_in_zone( $zone, $post_id ); + + return $this->get_single_post_in_zone( + $zone, + array( + // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_value + 'meta_value' => $order, + 'meta_compare' => '<=', + ) + ); + } + + public function get_next_post_in_zone( $zone, $post_id ) { + // TODO: test this works + $order = $this->get_post_order_in_zone( $zone, $post_id ); + + return $this->get_single_post_in_zone( + $zone, + array( + // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_value + 'meta_value' => $order, + 'meta_compare' => '>=', + ) + ); + } + + public function get_single_post_in_zone( $zone, $args = array() ) { + + $args = wp_parse_args( + $args, + array( + 'posts_per_page' => 1, + 'showposts' => 1, + ) + ); + + $post = $this->get_zone_posts( $zone, $args ); + + if ( is_array( $post ) && array() !== $post ) { + return array_pop( $post ); + } + + return false; + } + + public function get_zones_for_post( $post_id ) { + // TODO: build this out - see https://github.com/Automattic/zoninator/pull/19 + } + + public function get_zones( $args = array() ) { + + $args = wp_parse_args( + $args, + array( + 'orderby' => 'id', + 'order' => 'ASC', + 'hide_empty' => 0, + ) + ); + + // phpcs:ignore WordPress.WP.DeprecatedParameters.Get_termsParam2Found -- See https://github.com/Automattic/zoninator/issues/111 + $zones = get_terms( $this->zone_taxonomy, $args ); + + if ( ! is_wp_error( $zones ) ) { + // Add extra fields in description as properties + foreach ( $zones as $zone ) { + $zone = $this->_fill_zone_details( $zone ); + } + + return $zones; + } + + return false; + } + + public function get_zone( $zone ) { + if ( is_int( $zone ) ) { + $field = 'id'; + } elseif ( is_string( $zone ) ) { + $field = 'slug'; + $zone = $this->get_zone_slug( $zone ); + } elseif ( is_object( $zone ) ) { + return $zone; + } else { + return false; + } + + if ( function_exists( 'wpcom_vip_get_term_by' ) ) { + // phpcs:ignore WordPressVIPMinimum.Functions.RestrictedFunctions.wpcom_vip_get_term_by_wpcom_vip_get_term_by -- See https://github.com/Automattic/zoninator/issues/110 + $zone = wpcom_vip_get_term_by( $field, $zone, $this->zone_taxonomy ); + } else { + $zone = get_term_by( $field, $zone, $this->zone_taxonomy ); + } + + if ( ! $zone ) { + return false; + } + + return $this->_fill_zone_details( $zone ); + } + + public function lock_zone( $zone, $user_id = 0 ) { + $zone_id = $this->get_zone_id( $zone ); + + if ( ! $zone_id ) { + return false; + } + + if ( ! $user_id ) { + $user = wp_get_current_user(); + $user_id = $user->ID; + } + + $lock_key = $this->get_zone_meta_key( $zone ); + $expiry = $this->zone_lock_period + 1; // Add a one to avoid most race condition issues between lock expiry and ajax call + set_transient( $lock_key, $user->ID, $expiry ); + + // Possible alternative: set zone lock as property with time and user + return null; + } + + // Not really needed with transients... + public function unlock_zone( $zone ) { + $zone_id = $this->get_zone_id( $zone ); + + if ( ! $zone_id ) { + return false; + } + + $lock_key = $this->get_zone_meta_key( $zone ); + + delete_transient( $lock_key ); + return null; + } + + public function is_zone_locked( $zone ) { + $zone_id = $this->get_zone_id( $zone ); + if ( ! $zone_id ) { + return false; + } + + $user = wp_get_current_user(); + $lock_key = $this->get_zone_meta_key( $zone ); + + $lock = get_transient( $lock_key ); + + // If lock doesn't exist, or check if current user same as lock user + if ( ! $lock || absint( $lock ) === absint( $user->ID ) ) { + return false; + } else { // return user_id of locking user + return absint( $lock ); + } + } + + public function zone_exists( $zone ) { + $zone_id = $this->get_zone_id( $zone ); + return (bool) term_exists( $zone_id, $this->zone_taxonomy ); + } + + public function get_zone_id( $zone ) { + if ( is_int( $zone ) ) { + return $zone; + } + + $zone = $this->get_zone( $zone ); + if ( is_object( $zone ) ) { + $zone = $zone->term_id; + } + + return (int) $zone; + } + + public function get_zone_meta_key( $zone ) { + $zone_id = $this->get_zone_id( $zone ); + return $this->zone_meta_prefix . $zone_id; + } + + public function get_zone_slug( $zone ) { + if ( is_int( $zone ) ) { + $zone = $this->get_zone( $zone ); + } + + if ( is_object( $zone ) ) { + $zone = $zone->slug; + } + + return $this->get_formatted_zone_slug( $zone ); + } + + public function get_formatted_zone_slug( $slug ) { + return $slug; // legacy function -- slugs can no longer be changed + } + + public function get_unformatted_zone_slug( $slug ) { + return $slug; // legacy function -- slugs can no longer be changed + } + + public function get_post_id( $post ) { + if ( is_int( $post ) ) { + return $post; + } elseif ( is_array( $post ) ) { + return absint( $post['ID'] ); + } elseif ( is_object( $post ) ) { + return $post->ID; + } + + return false; + } + + public function get_post_order( $post, $zone ) { + $post_id = $this->get_post_id( $post ); + $meta_key = $this->get_zone_meta_key( $zone ); + + return get_metadata( 'post', $post_id, $meta_key, true ); + } + + public function verify_nonce( $action ) { + $action = $this->_get_nonce_key( $action ); + $nonce = $this->_get_request_var( $action ); + + if ( empty( $nonce ) ) { + $nonce = $this->_get_request_var( '_wpnonce' ); + } + + if ( ! wp_verify_nonce( $nonce, $action ) ) { + $this->_unauthorized_access(); + } + } + + public function verify_access( $action = '', $zone_id = null ) { + // TODO: should check if zone locked + + $verify_function = ''; + switch ( $action ) { + case 'insert': + $verify_function = '_current_user_can_add_zones'; + break; + case 'update': + case 'delete': + $verify_function = '_current_user_can_edit_zones'; + break; + default: + $verify_function = '_current_user_can_manage_zones'; + break; + } + + if ( ! call_user_func( array( $this, $verify_function ), $zone_id ) ) { + $this->_unauthorized_access(); + } + } + + public function _unauthorized_access() { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore -- breaking change + wp_die( esc_html__( "Sorry, you're not supposed to do that...", 'zoninator' ) ); + } + + public function _fill_zone_details( $zone ) { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore -- breaking change + if ( ! empty( $zone->zoninator_parsed ) && $zone->zoninator_parsed ) { + return $zone; + } + + $details = array(); + + if ( ! empty( $zone->description ) ) { + $details = maybe_unserialize( $zone->description ); + } + + $details = wp_parse_args( $details, $this->zone_detail_defaults ); + + foreach ( $details as $detail_key => $detail_value ) { + $zone->$detail_key = $detail_value; + } + + $zone->zoninator_parsed = true; + + return $zone; + } + + public function do_zoninator_feeds() { + $query_var = get_query_var( $this->zone_taxonomy ); + + if ( ! empty( $query_var ) ) { + $zone_slug = get_query_var( $this->zone_taxonomy ); + $results = $this->get_zone_feed( $zone_slug ); + if ( is_wp_error( $results ) ) { + $this->send_user_error( $results->get_error_message() ); + } + + $this->json_return( $results ); + } + } + + private function filter_zone_feed_fields( $results ) { + $filtered_results = array(); + $whitelisted_fields = apply_filters( + 'zoninator_zone_feed_fields', + array( 'ID', 'post_date', 'post_title', 'post_content', 'post_excerpt', 'post_status', 'guid' ) + ); + + $filtered_results = array(); + $i = 0; + foreach ( $results as $result ) { + if ( ! isset( $filtered_results[ $i ] ) ) { + $filtered_results[ $i ] = new stdClass(); + } + + foreach ( $whitelisted_fields as $field ) { + if ( ! isset( $filtered_results[ $i ] ) ) { + $filtered_results[ $i ] = new stdClass(); + } + + // phpcs:ignore Squiz.PHP.DisallowMultipleAssignments.Found -- see https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/598 + $filtered_results[ $i ]->$field = $result->$field; + } + + ++$i; + } + + return $filtered_results; + } + + /** + * Encode some data and echo it (possibly without cached headers) + * + * @param array $data + */ + private function json_return( $data ) { + + if ( null == $data ) { + return false; + } + + header( 'Content-Type: application/json' ); + echo wp_json_encode( $data ); + exit(); + } + + private function send_user_error( $message ) { + $this->status_header_with_message( 406, $message ); + exit(); + } + + /** + * Modify the header and description in the global array + * + * @global array $wp_header_to_desc + * @param int $status + * @param string $message + */ + private function status_header_with_message( $status, $message ) { + global $wp_header_to_desc; + + $status = absint( $status ); + $official_message = $wp_header_to_desc[ $status ] ?? ''; + $wp_header_to_desc[ $status ] = $message; // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited + + status_header( $status ); + + // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited + $wp_header_to_desc[ $status ] = $official_message; + } + + // TODO: Caching needs to be testing properly before being implemented! + public function get_zone_cache_key( $zone, $args = array() ) { // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.FoundAfterLastUsed -- potentially breaking change/ + return ''; + } + + public function get_zone_posts_from_cache( $zone, $args = array() ) { // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.FoundAfterLastUsed -- potentially breaking change/ + return false; + } + + public function add_zone_posts_to_cache( $posts, $zone, $args = array() ) { + } + + // Handle 4.2 term-splitting + public function split_shared_term( $old_term_id, $new_term_id, $term_taxonomy_id, $taxonomy ) { + if ( $this->zone_taxonomy === $taxonomy ) { + do_action( 'zoninator_split_shared_term', $old_term_id, $new_term_id, $term_taxonomy_id ); + + // Quick, easy switcheroo; add posts to new zone id and remove from the old one. + $posts = $this->get_zone_posts( $old_term_id ); + if ( ! empty( $posts ) ) { + $this->add_zone_posts( $new_term_id, $posts ); + $this->remove_zone_posts( $old_term_id ); + } + + do_action( 'zoninator_did_split_shared_term', $old_term_id, $new_term_id, $term_taxonomy_id ); + } + } + + public function _empty_zone_posts_cache( $meta_key ) { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore -- breaking change + // TODO: implement + } + + public function _get_message( $message_id, $encode = false ) { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore -- breaking change + $message = ''; + + if ( ! empty( $this->zone_messages[ $message_id ] ) ) { + $message = $this->zone_messages[ $message_id ]; + } + + if ( $encode ) { + $message = urlencode( $message ); + } + + return $message; + } + + public function _get_nonce_key( $action ) { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore -- breaking change + return sprintf( '%s-%s', $this->zone_nonce_prefix, $action ); + } + + public function _current_user_can_add_zones() { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore -- breaking change + return current_user_can( $this->_get_add_zones_cap() ); + } + + public function _current_user_can_edit_zones( $zone_id ) { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore -- breaking change + $has_cap = current_user_can( $this->_get_edit_zones_cap() ); + return apply_filters( 'zoninator_current_user_can_edit_zone', $has_cap, $zone_id ); + } + + public function _current_user_can_manage_zones() { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore -- breaking change + return current_user_can( $this->_get_manage_zones_cap() ); + } + + public function _get_add_zones_cap() { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore -- breaking change + return apply_filters( 'zoninator_add_zone_cap', 'edit_others_posts' ); + } + + public function _get_edit_zones_cap() { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore -- breaking change + return apply_filters( 'zoninator_edit_zone_cap', 'edit_others_posts' ); + } + + public function _get_manage_zones_cap() { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore -- breaking change + return apply_filters( 'zoninator_manage_zone_cap', 'edit_others_posts' ); + } + + public function _get_zone_page_url( $args = array() ) { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore -- breaking change + $url = menu_page_url( $this->key, false ); + + foreach ( $args as $arg_key => $arg_value ) { + $url = add_query_arg( $arg_key, $arg_value, $url ); + } + + return $url; + } + + public function _validate_date_filter( $date ) { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore -- breaking change + return preg_match( '/(\d{4})-(\d{2})-(\d{2})/', $date ); + } + + public function _validate_category_filter( $cat ) { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore -- breaking change + return $cat && get_term_by( 'id', $cat, 'category' ); + } + + public function _sanitize_value( $var ) { // phpcs:ignore Universal.NamingConventions.NoReservedKeywordParameterNames.varFound, PSR2.Methods.MethodDeclaration.Underscore -- breaking change + return htmlentities( stripslashes( $var ) ); + } + + public function _get_value_or_default( $var, $object, $default = '', $sanitize_callback = '' ) { // phpcs:ignore Universal.NamingConventions.NoReservedKeywordParameterNames.defaultFound, Universal.NamingConventions.NoReservedKeywordParameterNames.objectFound, Universal.NamingConventions.NoReservedKeywordParameterNames.varFound, PSR2.Methods.MethodDeclaration.Underscore -- breaking change + if ( is_object( $object ) ) { + $value = empty( $object->$var ) ? $default : $object->$var; + } elseif ( is_array( $object ) ) { + $value = empty( $object[ $var ] ) ? $default : $object[ $var ]; + } else { + $value = $default; + } + + if ( is_callable( $sanitize_callback ) ) { + $value = is_array( $value ) ? array_map( $sanitize_callback, $value ) : call_user_func( $sanitize_callback, $value ); + } + + return $value; + } + + public function _get_request_var( $var, $default = '', $sanitize_callback = '' ) { // phpcs:ignore Universal.NamingConventions.NoReservedKeywordParameterNames.defaultFound, Universal.NamingConventions.NoReservedKeywordParameterNames.varFound, PSR2.Methods.MethodDeclaration.Underscore -- breaking change + // phpcs:ignore WordPress.Security.NonceVerification.Recommended + return $this->_get_value_or_default( $var, $_REQUEST, $default, $sanitize_callback ); + } + + public function _get_get_var( $var, $default = '', $sanitize_callback = '' ) { // phpcs:ignore Universal.NamingConventions.NoReservedKeywordParameterNames.defaultFound, Universal.NamingConventions.NoReservedKeywordParameterNames.varFound, PSR2.Methods.MethodDeclaration.Underscore -- breaking change + // phpcs:ignore WordPress.Security.NonceVerification.Recommended + return $this->_get_value_or_default( $var, $_GET, $default, $sanitize_callback ); + } + + public function _get_post_var( $var, $default = '', $sanitize_callback = '' ) { // phpcs:ignore Universal.NamingConventions.NoReservedKeywordParameterNames.defaultFound, Universal.NamingConventions.NoReservedKeywordParameterNames.varFound, PSR2.Methods.MethodDeclaration.Underscore -- breaking change + // phpcs:ignore WordPress.Security.NonceVerification.Missing + return $this->_get_value_or_default( $var, $_POST, $default, $sanitize_callback ); + } + + public function get_admin_zone_post( $post, $zone ) { + return apply_filters( + 'zoninator_zone_post_columns', + array( + 'post_id' => $post->ID, + 'position' => array( + 'current_position' => intval( $this->get_post_order( $post->ID, $zone ) ), + 'change_position_message' => esc_attr__( 'Click and drag to change the position of this item.', 'zoninator' ), + 'key' => 'position', + ), + 'info' => array( + 'key' => 'info', + 'post' => array( + 'post_title' => esc_html( $post->post_title ), + 'post_status' => esc_html( $post->post_status ), + ), + 'action_link_data' => array( + array( + 'action' => 'edit', + 'anchor' => get_edit_post_link( $post->ID ), + 'title' => __( 'Opens in new window', 'zoninator' ), + 'text' => __( 'Edit', 'zoninator' ), + 'target' => '_blank', + ), + array( + 'action' => 'delete', + 'anchor' => '#', + 'title' => '', + 'text' => __( 'Remove', 'zoninator' ), + ), + array( + 'action' => 'view', + 'anchor' => get_permalink( $post->ID ), + 'title' => __( 'Opens in new window', 'zoninator' ), + 'text' => __( 'View', 'zoninator' ), + 'target' => '_blank', + ), + ), + ), + ), + $post, + $zone + ); + } + + public function get_admin_zone_posts( $zone_or_id ) { + $zone = $this->get_zone( $zone_or_id ); + $posts = $this->get_zone_posts( $zone ); + $admin_zone_posts = array(); + + foreach ( $posts as $post ) { + $admin_zone_posts[] = $this->get_admin_zone_post( $post, $zone ); + } + + return $admin_zone_posts; + } + + /** + * @param $zone_slug_or_id + * @return array|WP_Error + */ + public function get_zone_feed( $zone_slug_or_id ) { + $zone_id = $this->get_zone( $zone_slug_or_id ); + + if ( empty( $zone_id ) ) { + return new WP_Error( 'invalid-zone-supplied', __( 'Invalid zone supplied', 'zoninator' ) ); + } + + $results = $this->get_zone_posts( $zone_id, apply_filters( 'zoninator_json_feed_fields', array(), $zone_slug_or_id ) ); + $filtered_results = $this->filter_zone_feed_fields( $results ); + + return apply_filters( 'zoninator_json_feed_results', $filtered_results, $zone_slug_or_id ); + } + + public function check( $action = '', $zone_id = null ) { + // TODO: should check if zone locked + if ( 'insert' == $action ) { + return $this->_current_user_can_add_zones(); + } + + if ( 'update' == $action || 'delete' == $action ) { + return $this->_current_user_can_edit_zones( $zone_id ); + } + + return $this->_current_user_can_manage_zones(); + } +} diff --git a/zoninator.php b/zoninator.php index 63cf0b3..2f1b69a 100644 --- a/zoninator.php +++ b/zoninator.php @@ -37,1799 +37,7 @@ require_once ZONINATOR_PATH . '/functions.php'; require_once ZONINATOR_PATH . '/widget.zone-posts.php'; - - class Zoninator { - - public $key = 'zoninator'; - - public $zone_taxonomy = 'zoninator_zones'; - - public $zone_term_prefix = 'zone-'; - - public $zone_meta_prefix = '_zoninator_order_'; - - public $zone_nonce_prefix = 'zone-nonce'; - - public $zone_ajax_nonce_action = 'ajax-action'; - - // Number of seconds a lock is valid for. - public $zone_lock_period = 30; - - // Max number of seconds for all locks in a session. - public $zone_max_lock_period = 600; - - public $post_types; - - public $zone_detail_defaults = array( - 'description' => '', - // Add additional properties here! - ); - - public $zone_messages; - - public $posts_per_page = 10; - - /** - * @var Zoninator_Api - */ - public $rest_api; - - /** - * @var array|string[] Default post types that support zones. - */ - public $default_post_types = array( 'post' ); - - public function __construct() { - add_action( 'init', array( $this, 'init' ), 99 ); // init later after other post types have been registered - - add_action( 'plugins_loaded', array( $this, 'load_textdomain' ) ); - - add_action( 'widgets_init', array( $this, 'widgets_init' ) ); - - add_action( 'init', array( $this, 'add_zone_feed' ) ); - - add_action( 'template_redirect', array( $this, 'do_zoninator_feeds' ) ); - - add_action( 'split_shared_term', array( $this, 'split_shared_term' ), 10, 4 ); - - $this->maybe_add_rest_api(); - } - - public function maybe_add_rest_api() { - global $wp_version; - if ( version_compare( $wp_version, '4.7', '<' ) ) { - return false; - } - - include_once ZONINATOR_PATH . '/src/class-zoninator-api.php'; - $this->rest_api = new Zoninator_Api( $this ); - return null; - } - - public function add_zone_feed() { - add_rewrite_tag( '%' . $this->zone_taxonomy . '%', '([^&]+)' ); - add_rewrite_rule( '^zones/([^/]+)/feed.json/?$', 'index.php?' . $this->zone_taxonomy . '=$matches[1]', 'top' ); - } - - public function init() { - $this->zone_messages = array( - 'insert-success' => __( 'The zone was successfully created.', 'zoninator' ), - 'update-success' => __( 'The zone was successfully updated.', 'zoninator' ), - 'delete-success' => __( 'The zone was successfully deleted.', 'zoninator' ), - 'error-general' => __( 'Sorry, something went wrong! Please try again?', 'zoninator' ), - /* translators: User's display name, or "another user" */ - 'error-zone-lock' => __( 'Sorry, this zone is in use by %s and is currently locked. Please try again later.', 'zoninator' ), - 'error-zone-lock-max' => __( 'Sorry, you have reached the maximum idle limit and will now be redirected to the Dashboard.', 'zoninator' ), - ); - - $this->zone_lock_period = apply_filters( 'zoninator_zone_lock_period', $this->zone_lock_period ); - $this->zone_max_lock_period = apply_filters( 'zoninator_zone_max_lock_period', $this->zone_max_lock_period ); - $this->posts_per_page = apply_filters( 'zoninator_posts_per_page', $this->posts_per_page ); - - do_action( 'zoninator_pre_init' ); - - // Default post type support - foreach ( $this->default_post_types as $post_type ) { - add_post_type_support( $post_type, $this->zone_taxonomy ); - } - - // Register taxonomy - if ( ! taxonomy_exists( $this->zone_taxonomy ) ) { - register_taxonomy( - $this->zone_taxonomy, - $this->get_supported_post_types(), - array( - 'label' => __( 'Zones', 'zoninator' ), - 'hierarchical' => false, - 'query_var' => false, - 'rewrite' => false, - 'public' => false, - - ) - ); - } - - add_action( 'admin_init', array( $this, 'admin_controller' ) ); - add_action( 'admin_init', array( $this, 'admin_init' ) ); - - add_action( 'admin_menu', array( $this, 'admin_page_init' ) ); - - // Add default advanced search fields - add_action( 'zoninator_advanced_search_fields', array( $this, 'zone_advanced_search_cat_filter' ) ); - add_action( 'zoninator_advanced_search_fields', array( $this, 'zone_advanced_search_date_filter' ), 20 ); - - do_action( 'zoninator_post_init' ); - } - - public function load_textdomain() { - load_plugin_textdomain( 'zoninator', false, basename( ZONINATOR_PATH ) . '/language' ); - } - - public function widgets_init() { - register_widget( 'Zoninator_ZonePosts_Widget' ); - } - - // Add necessary AJAX actions - public function admin_ajax_init() { - add_action( 'wp_ajax_zoninator_reorder_posts', array( $this, 'ajax_reorder_posts' ) ); - add_action( 'wp_ajax_zoninator_add_post', array( $this, 'ajax_add_post' ) ); - add_action( 'wp_ajax_zoninator_remove_post', array( $this, 'ajax_remove_post' ) ); - add_action( 'wp_ajax_zoninator_search_posts', array( $this, 'ajax_search_posts' ) ); - add_action( 'wp_ajax_zoninator_update_lock', array( $this, 'ajax_update_lock' ) ); - add_action( 'wp_ajax_zoninator_update_recent', array( $this, 'ajax_recent_posts' ) ); - } - - public function admin_init() { - - $this->admin_ajax_init(); - - // Enqueue Scripts and Styles - add_action( 'admin_enqueue_scripts', array( $this, 'admin_enqueue_scripts' ) ); - add_action( 'admin_enqueue_scripts', array( $this, 'admin_enqueue_styles' ) ); - } - - public function admin_page_init() { - // Set up page - add_menu_page( __( 'Zoninator', 'zoninator' ), __( 'Zones', 'zoninator' ), $this->_get_manage_zones_cap(), $this->key, array( $this, 'admin_page' ), '', 11 ); - } - - public function admin_enqueue_scripts() { - if ( $this->is_zoninator_page() ) { - wp_enqueue_script( 'zoninator-js', ZONINATOR_URL . 'js/zoninator.js', array( 'jquery', 'jquery-ui-core', 'jquery-ui-widget', 'jquery-ui-mouse', 'jquery-ui-position', 'jquery-ui-sortable', 'jquery-ui-autocomplete' ), ZONINATOR_VERSION, true ); - - $options = array( - 'baseUrl' => $this->_get_zone_page_url(), - 'adminUrl' => admin_url(), - 'ajaxNonceAction' => $this->_get_nonce_key( $this->zone_ajax_nonce_action ), - 'errorGeneral' => $this->_get_message( 'error-general' ), - 'errorZoneLock' => sprintf( $this->_get_message( 'error-zone-lock' ), __( 'another user', 'zoninator' ) ), - 'errorZoneLockMax' => $this->_get_message( 'error-zone-lock-max' ), - 'zoneLockPeriod' => $this->zone_lock_period, - 'zoneLockPeriodMax' => $this->zone_max_lock_period, - ); - wp_localize_script( 'zoninator-js', 'zoninatorOptions', $options ); - - // For mobile support: https://github.com/furf/jquery-ui-touch-punch - // phpcs:ignore WordPress.WP.EnqueuedResourceParameters.NotInFooter, WordPress.WP.EnqueuedResourceParameters.MissingVersion - wp_enqueue_script( 'jquery-ui-touch-punch', ZONINATOR_URL . 'js/jquery.ui.touch-punch.min.js', array( 'jquery-ui-core', 'jquery-ui-widget', 'jquery-ui-mouse' ) ); - } - } - - public function admin_enqueue_styles() { - if ( $this->is_zoninator_page() ) { - wp_enqueue_style( 'zoninator-jquery-ui', ZONINATOR_URL . 'css/jquery-ui/smoothness/jquery-ui-zoninator.css', false, ZONINATOR_VERSION, 'all' ); - wp_enqueue_style( 'zoninator-styles', ZONINATOR_URL . 'css/zoninator.css', false, ZONINATOR_VERSION, 'all' ); - } - } - - public function admin_controller() { - if ( $this->is_zoninator_page() ) { - $action = $this->_get_request_var( 'action' ); - - switch ( $action ) { - case 'insert': - case 'update': - $zone_id = $this->_get_post_var( 'zone_id', 0, 'absint' ); - - $this->verify_nonce( $action ); - $this->verify_access( $action, $zone_id ); - - $name = $this->_get_post_var( 'name', '', array( $this, '_sanitize_value' ) ); - $slug = $this->_get_post_var( 'slug', sanitize_title( $name ) ); - $details = array( - 'description' => $this->_get_post_var( 'description', '', array( $this, '_sanitize_value' ) ), - ); - - // TODO: handle additional properties - if ( $zone_id ) { - $result = $this->update_zone( - $zone_id, - array( - 'name' => $name, - 'slug' => $slug, - 'details' => $details, - ) - ); - } else { - $result = $this->insert_zone( $slug, $name, $details ); - } - - if ( is_wp_error( $result ) ) { - // phpcs:ignore WordPress.Security.SafeRedirect.wp_redirect_wp_redirect - wp_redirect( add_query_arg( 'message', 'error-general' ) ); - exit; - } else { - if ( ! $zone_id && isset( $result['term_id'] ) ) { - $zone_id = $result['term_id']; - } - - // Redirect with success message - $message = sprintf( '%s-success', $action ); - // phpcs:ignore WordPress.Security.SafeRedirect.wp_redirect_wp_redirect - wp_redirect( - $this->_get_zone_page_url( - array( - 'action' => 'edit', - 'zone_id' => $zone_id, - 'message' => $message, - ) - ) - ); - exit; - } - - case 'delete': - $zone_id = $this->_get_request_var( 'zone_id', 0, 'absint' ); - - $this->verify_nonce( $action ); - $this->verify_access( $action, $zone_id ); - - if ( $zone_id ) { - $result = $this->delete_zone( $zone_id ); - } - - if ( is_wp_error( $result ) ) { - $redirect_args = array( 'error' => $result->get_error_messages() ); - } else { - $redirect_args = array( 'message' => 'delete-success' ); - } - - // phpcs:ignore WordPress.Security.SafeRedirect.wp_redirect_wp_redirect - wp_redirect( $this->_get_zone_page_url( $redirect_args ) ); - exit; - } - } - } - - public function admin_page() { - global $zoninator_admin_page; - - $title = __( 'Zones', 'zoninator' ); - - $zones = $this->get_zones( apply_filters( 'zoninator_admin_page_get_zones_args', array() ) ); - - $default_active_zone = 0; - if ( ! $this->_current_user_can_add_zones() && ! empty( $zones ) ) { - $default_active_zone = $zones[0]->term_id; - } - - $active_zone_id = $this->_get_request_var( 'zone_id', $default_active_zone, 'absint' ); - $active_zone = empty( $active_zone_id ) ? array() : $this->get_zone( $active_zone_id ); - if ( ! empty( $active_zone ) ) { - $title = __( 'Edit Zone', 'zoninator' ); - } - - $message = $this->_get_message( $this->_get_get_var( 'message', '', 'urldecode' ) ); - $error = $this->_get_get_var( 'error', '', 'urldecode' ); - - ?> -
-

-

- - _current_user_can_add_zones() ) : - $new_link = $this->_get_zone_page_url( array( 'action' => 'new' ) ); - ?> - - - - - -

- - -
-

-
- - -
-

-
- - -
- - admin_page_zone_tabs( $zones, $active_zone_id ); ?> - admin_page_zone_edit( $active_zone ); ?> - -
-
- -
-
-
-
- - get_zone_id( $zone ); ?> - _get_zone_page_url( - array( - 'action' => 'edit', - 'zone_id' => $zone_id, - ) - ); - ?> - - - name ); ?> - - name ); ?> - -
-
-
-
- _get_value_or_default( 'term_id', $zone, 0, 'absint' ); - $zone_name = $this->_get_value_or_default( 'name', $zone ); - $zone_slug = $this->_get_value_or_default( 'slug', $zone, '', array( $this, 'get_unformatted_zone_slug' ) ); - $zone_description = $this->_get_value_or_default( 'description', $zone ); - - $zone_posts = $zone_id ? $this->get_zone_posts( $zone ) : array(); - - $zone_locked = $this->is_zone_locked( $zone_id ); - - $delete_link = $this->_get_zone_page_url( - array( - 'action' => 'delete', - 'zone_id' => $zone_id, - ) - ); - $delete_link = wp_nonce_url( $delete_link, $this->_get_nonce_key( 'delete' ) ); - ?> -
- _current_user_can_add_zones() ) || ( 0 != $zone_id && $this->_current_user_can_manage_zones() ) ) : ?> - - -
-

_get_message( 'error-zone-lock' ) ), sprintf( '%s', esc_attr( $locking_user->user_email ), esc_html( $locking_user->display_name ) ) ); ?>

-
- - -
-
- - _current_user_can_edit_zones( $zone_id ) && ! $zone_locked ) : ?> - -
- - - -
- - -
- - -
- - - -
- - -
- - -
- - - - - - _get_nonce_key( 'update' ) ); ?> - - _get_nonce_key( 'insert' ) ); ?> - - -
- - - - - -
- - - - -
- -
- - -
- - -
- - - -
- - -
- - - - -
- - - - _get_nonce_key( $this->zone_ajax_nonce_action ), $this->_get_nonce_key( $this->zone_ajax_nonce_action ), false ); ?> -
- -
- -
-
- -

- - zone_advanced_search_filters(); ?> - - zone_admin_recent_posts_dropdown( $zone_id ); ?> - - zone_admin_search_form(); ?> - -
- -

-
- -
- - admin_page_zone_post( $post, $zone ); ?> - -
- - -

- -
-
- -
- array( $this, 'admin_page_zone_post_col_position' ), - 'info' => array( $this, 'admin_page_zone_post_col_info' ), - ), - $post, - $zone - ); - ?> -
- - - $column_callback ) : ?> - - - - -
- -
- -
- get_post_order( $post->ID, $zone ); - ?> - - - - %s', get_edit_post_link( $post->ID ), __( 'Opens in new window', 'zoninator' ), __( 'Edit', 'zoninator' ) ), - sprintf( '%s', __( 'Remove this item from the zone', 'zoninator' ), __( 'Remove', 'zoninator' ) ), - sprintf( '%s', get_permalink( $post->ID ), __( 'Opens in new window', 'zoninator' ), __( 'View', 'zoninator' ) ), - // Move To - // Copy To - ); - ?> - (%s)', esc_html( $post->post_title ), esc_html( $post->post_status ) ); ?> - -
- -
- -
- -
-
- -
- _get_post_var( 'zone_advanced_filter_taxonomy', '', 'absint' ); - ?> - - __( 'Show all Categories', 'zoninator' ), - 'selected' => $current_cat, - 'name' => 'zone_advanced_filter_taxonomy', - 'id' => 'zone_advanced_filter_taxonomy', - 'hide_if_empty' => true, - ) - ) - ); - } - - public function zone_advanced_search_date_filter() { - $current_date = $this->_get_post_var( 'zone_advanced_filter_date', apply_filters( 'zoninator_advanced_filter_date_default', '' ), 'striptags' ); - $date_filters = apply_filters( 'zoninator_advanced_filter_date', array( 'all', 'today', 'yesterday' ) ); - ?> - - _get_post_var( 'cat', '', 'absint' ); - $date = $this->_get_post_var( 'date', '', 'striptags' ); - $zone_id = $this->_get_post_var( 'zone_id', 0, 'absint' ); - - $limit = $this->posts_per_page; - $post_types = $this->get_supported_post_types(); - $zone_posts = $this->get_zone_posts( $zone_id ); - $zone_post_ids = wp_list_pluck( $zone_posts, 'ID' ); - - // Verify nonce - $this->verify_nonce( $this->zone_ajax_nonce_action ); - $this->verify_access( '', $zone_id ); - - if ( is_wp_error( $zone_posts ) ) { - $status = 0; - $content = $zone_posts->get_error_message(); - } else { - $args = apply_filters( - 'zoninator_recent_posts_args', - array( - 'posts_per_page' => $limit, - 'order' => 'DESC', - 'orderby' => 'post_date', - 'post_type' => $post_types, - 'ignore_sticky_posts' => true, - 'post_status' => array( 'publish', 'future' ), - // phpcs:ignore WordPressVIPMinimum.Performance.WPQueryParams.PostNotIn_post__not_in - 'post__not_in' => $zone_post_ids, - 'suppress_filters' => false, - ) - ); - - if ( $this->_validate_category_filter( $cat ) ) { - $args['cat'] = $cat; - } - - if ( $this->_validate_date_filter( $date ) ) { - $filter_date_parts = explode( '-', $date ); - $args['year'] = $filter_date_parts[0]; - $args['monthnum'] = $filter_date_parts[1]; - $args['day'] = $filter_date_parts[2]; - } - - $content = ''; - $recent_posts = get_posts( $args ); - foreach ( $recent_posts as $post ) : - $content .= sprintf( '', $post->ID, get_the_title( $post->ID ) . ' (' . $post->post_status . ')' ); - endforeach; - - wp_reset_postdata(); - $status = 1; - } - - $empty_label = ''; - if ( ! $content ) { - $empty_label = __( 'No results found', 'zoninator' ); - } elseif ( $cat ) { - /* translators: Category name */ - $empty_label = sprintf( __( 'Choose post from %s', 'zoninator' ), get_the_category_by_ID( $cat ) ); - } else { - $empty_label = __( 'Choose a post', 'zoninator' ); - } - - $content = '' . $content; - - $this->ajax_return( $status, $content ); - } - - public function zone_admin_recent_posts_dropdown( $zone_id ) { - - $limit = $this->posts_per_page; - $post_types = $this->get_supported_post_types(); - $zone_posts = $this->get_zone_posts( $zone_id ); - $zone_post_ids = wp_list_pluck( $zone_posts, 'ID' ); - - $args = apply_filters( - 'zoninator_recent_posts_args', - array( - 'posts_per_page' => $limit, - 'order' => 'DESC', - 'orderby' => 'post_date', - 'post_type' => $post_types, - 'ignore_sticky_posts' => true, - 'post_status' => array( 'publish', 'future' ), - // phpcs:ignore WordPressVIPMinimum.Performance.WPQueryParams.PostNotIn_post__not_in - 'post__not_in' => $zone_post_ids, - 'suppress_filters' => false, - ) - ); - - $recent_posts = get_posts( $args ); - ?> -
-
- -
- -
- - -

-
- key; - } else { - return ! empty( $screen->id ) && strstr( $screen->id, (string) $this->key ); - } - } - - public function ajax_return( $status, $content = '', $action = '' ) { - $action = empty( $action ) ? $this->zone_ajax_nonce_action : $action; - $nonce = wp_create_nonce( $this->_get_nonce_key( $action ) ); - - echo wp_json_encode( - array( - 'status' => $status, - 'content' => $content, - 'nonce' => $nonce, - ) - ); - exit; - } - - public function ajax_add_post() { - $zone_id = $this->_get_post_var( 'zone_id', 0, 'absint' ); - $post_id = $this->_get_post_var( 'post_id', 0, 'absint' ); - - // Verify nonce - $this->verify_nonce( $this->zone_ajax_nonce_action ); - $this->verify_access( '', $zone_id ); - - // Validate - if ( ! $zone_id || ! $post_id ) { - $this->ajax_return( 0 ); - } - - $result = $this->add_zone_posts( $zone_id, $post_id, true ); - - if ( is_wp_error( $result ) ) { - $status = 0; - $content = $result->get_error_message(); - } else { - $post = get_post( $post_id ); - $zone = $this->get_zone( $zone_id ); - - ob_start(); - $this->admin_page_zone_post( $post, $zone ); - $content = ob_get_contents(); - ob_end_clean(); - - $status = 1; - } - - $this->ajax_return( $status, $content ); - } - - public function ajax_remove_post() { - $zone_id = $this->_get_post_var( 'zone_id', 0, 'absint' ); - $post_id = $this->_get_post_var( 'post_id', 0, 'absint' ); - - // Verify nonce - $this->verify_nonce( $this->zone_ajax_nonce_action ); - $this->verify_access( '', $zone_id ); - - // Validate - if ( ! $zone_id || ! $post_id ) { - $this->ajax_return( 0 ); - } - - $result = $this->remove_zone_posts( $zone_id, $post_id ); - - if ( is_wp_error( $result ) ) { - $status = 0; - $content = $result->get_error_message(); - } else { - $status = 1; - $content = ''; - } - - $this->ajax_return( $status, $content ); - } - - public function ajax_reorder_posts() { - $zone_id = $this->_get_post_var( 'zone_id', 0, 'absint' ); - $post_ids = (array) $this->_get_post_var( 'posts', array(), 'absint' ); - - // Verify nonce - $this->verify_nonce( $this->zone_ajax_nonce_action ); - $this->verify_access( '', $zone_id ); - - // validate - if ( ! $zone_id || array() === $post_ids ) { - $this->ajax_return( 0 ); - } - - $result = $this->add_zone_posts( $zone_id, $post_ids, false ); - - if ( is_wp_error( $result ) ) { - $status = 0; - $content = $result->get_error_message(); - } else { - $status = 1; - $content = ''; - } - - $this->ajax_return( $status, $content ); - } - - // TODO: implement in front-end - public function ajax_move_zone_post( $from_zone, $to_zone, $post_id ) { - $from_zone_id = $this->_get_post_var( 'from_zone_id', 0, 'absint' ); - $to_zone_id = $this->_get_post_var( 'to_zone_id', 0, 'absint' ); - - $this->verify_nonce( $this->zone_ajax_nonce_action ); - - // TODO: validate both zones exist, post exists - - // Add to new zone - $this->add_zone_posts( $to_zone_id, $post_id, true ); - - // Remove from old zone - $this->remove_zone_posts( $from_zone_id, $post_id ); - } - - public function ajax_search_posts() { - - $q = $this->_get_request_var( 'term', '', 'stripslashes' ); - - if ( ! empty( $q ) ) { - $filter_cat = $this->_get_request_var( 'cat', '', 'absint' ); - $filter_date = $this->_get_request_var( 'date', '', 'striptags' ); - - $post_types = $this->get_supported_post_types(); - $limit = $this->_get_request_var( 'limit', $this->posts_per_page ); - if ( $limit <= 0 ) { - $limit = $this->posts_per_page; - } - - $exclude = (array) $this->_get_request_var( 'exclude', array(), 'absint' ); - - $args = apply_filters( - 'zoninator_search_args', - array( - 's' => $q, - // phpcs:ignore WordPressVIPMinimum.Performance.WPQueryParams.PostNotIn_post__not_in - 'post__not_in' => $exclude, - 'posts_per_page' => $limit, - 'post_type' => $post_types, - 'post_status' => array( 'publish', 'future' ), - 'order' => 'DESC', - 'orderby' => 'post_date', - // phpcs:ignore WordPressVIPMinimum.Performance.WPQueryParams.SuppressFilters_suppress_filters - 'suppress_filters' => true, - 'no_found_rows' => true, - ) - ); - - if ( $this->_validate_category_filter( $filter_cat ) ) { - $args['cat'] = $filter_cat; - } - - if ( $this->_validate_date_filter( $filter_date ) ) { - $filter_date_parts = explode( '-', $filter_date ); - $args['year'] = $filter_date_parts[0]; - $args['monthnum'] = $filter_date_parts[1]; - $args['day'] = $filter_date_parts[2]; - } - - $query = new WP_Query( $args ); - $stripped_posts = array(); - - if ( ! $query->have_posts() ) { - echo wp_json_encode( array() ); - exit; - } - - foreach ( $query->posts as $post ) { - $stripped_posts[] = apply_filters( - 'zoninator_search_results_post', - array( - 'title' => empty( $post->post_title ) ? __( '(no title)', 'zoninator' ) : $post->post_title, - 'post_id' => $post->ID, - 'date' => get_the_time( get_option( 'date_format' ), $post ), - 'post_type' => $post->post_type, - 'post_status' => $post->post_status, - ), - $post - ); - } - - echo wp_json_encode( $stripped_posts ); - exit; - } - } - - public function ajax_update_lock() { - $zone_id = $this->_get_post_var( 'zone_id', 0, 'absint' ); - - $this->verify_nonce( $this->zone_ajax_nonce_action ); - $this->verify_access( '', $zone_id ); - - if ( ! $zone_id ) { - exit; - } - - if ( ! $this->is_zone_locked( $zone_id ) ) { - $this->lock_zone( $zone_id ); - $this->ajax_return( 1, '' ); - } - } - - public function get_supported_post_types() { - if ( null !== $this->post_types ) { - return $this->post_types; - } - - $this->post_types = array(); - - foreach ( get_post_types() as $post_type ) { - if ( post_type_supports( $post_type, $this->zone_taxonomy ) ) { - $this->post_types[] = $post_type; - } - } - - return $this->post_types; - } - - /** - * Registers a post type to be available for zones - * - * @param string|array $post_types A post type string or array of post type strings to register. - * @return bool True if any post types were added, false if not. - */ - public function register_zone_post_type( $post_types = '' ) { - - $did_register_post_types = false; - - if ( ! is_array( $post_types ) ) { - $post_types = array( $post_types ); - } - - foreach ( $post_types as $post_type ) { - if ( ! post_type_exists( $post_type ) ) { - continue; - } - - add_post_type_support( $post_type, $this->zone_taxonomy ); - register_taxonomy_for_object_type( $this->zone_taxonomy, $post_type ); - - // Clear Zoninator supported post types cache - unset( $this->post_types ); - - $did_register_post_types = true; - } - - return $did_register_post_types; - } - - public function insert_zone( $slug, $name = '', $details = array() ) { - - // slug cannot be empty - if ( empty( $slug ) ) { - return new WP_Error( 'zone-empty-slug', __( 'Slug is a required field.', 'zoninator' ) ); - } - - $slug = $this->get_formatted_zone_slug( $slug ); - $name = empty( $name ) ? $slug : $name; - - $details = wp_parse_args( $details, $this->zone_detail_defaults ); - $details = maybe_serialize( stripslashes_deep( $details ) ); - - $args = array( - 'slug' => $slug, - 'description' => $details, - ); - - // Filterize to allow other inputs - $args = apply_filters( 'zoninator_insert_zone', $args ); - - return wp_insert_term( $name, $this->zone_taxonomy, $args ); - } - - public function update_zone( $zone, $data = array() ) { - $zone_id = $this->get_zone_id( $zone ); - - if ( $this->zone_exists( $zone_id ) ) { - $zone = $this->get_zone( $zone ); - - $name = $this->_get_value_or_default( 'name', $data, $zone->name ); - $slug = $this->_get_value_or_default( 'slug', $data, $zone->slug, array( $this, 'get_formatted_zone_slug' ) ); - $details = $this->_get_value_or_default( 'details', $data, array() ); - - // TODO: Back-fill current zone details - // $details = wp_parse_args( $details, $this->zone_detail_defaults ); - $details = wp_parse_args( $details, $this->zone_detail_defaults ); - $details = maybe_serialize( stripslashes_deep( $details ) ); - - $args = array( - 'name' => $name, - 'slug' => $slug, - 'description' => $details, - ); - - // Filterize to allow other inputs - $args = apply_filters( 'zoninator_update_zone', $args, $zone_id, $zone ); - - return wp_update_term( $zone_id, $this->zone_taxonomy, $args ); - } - - return new WP_Error( 'invalid-zone', __( "Sorry, that zone doesn't exist.", 'zoninator' ) ); - } - - public function delete_zone( $zone ) { - $zone_id = $this->get_zone_id( $zone ); - $meta_key = $this->get_zone_meta_key( $zone ); - - $this->_empty_zone_posts_cache( $meta_key ); - - if ( $this->zone_exists( $zone_id ) ) { - // Delete all post associations for the zone - $this->remove_zone_posts( $zone_id ); - - // Delete the term - $delete = wp_delete_term( $zone_id, $this->zone_taxonomy ); - - if ( ! $delete ) { - return new WP_Error( 'delete-zone', __( "Sorry, we couldn't delete the zone.", 'zoninator' ) ); - } else { - do_action( 'zoninator_delete_zone', $zone_id ); - return $delete; - } - } - - return new WP_Error( 'invalid-zone', __( "Sorry, that zone doesn't exist.", 'zoninator' ) ); - } - - /** - * @param $zone - * @param $posts - * @param bool $append - * @return bool|WP_Error - */ - public function add_zone_posts( $zone, $posts, $append = false ) { - $zone = $this->get_zone( $zone ); - $meta_key = $this->get_zone_meta_key( $zone ); - - $this->_empty_zone_posts_cache( $meta_key ); - - if ( $append ) { - // Order should be the highest post order - $last_post = $this->get_last_post_in_zone( $zone ); - $order = $last_post ? $this->get_post_order( $last_post, $zone ) : 0; - } else { - $order = 0; - $this->remove_zone_posts( $zone ); - } - - foreach ( (array) $posts as $post ) { - $post_id = $this->get_post_id( $post ); - if ( $post_id ) { - ++$order; - update_metadata( 'post', $post_id, $meta_key, $order, true ); - } - - // TODO: remove_object_terms -- but need remove object terms function :( - } - - clean_term_cache( $this->get_zone_id( $zone ), $this->zone_taxonomy ); // flush cache for our zone term and related APC caches - - do_action( 'zoninator_add_zone_posts', $posts, $zone ); - - return true; - } - - /** - * @param mixed $zone - * @param mixed $posts - * - * @return bool|WP_Error - */ - public function remove_zone_posts( $zone, $posts = null ) { - $zone = $this->get_zone( $zone ); - $meta_key = $this->get_zone_meta_key( $zone ); - - $this->_empty_zone_posts_cache( $meta_key ); - - // if null, delete all - if ( ! $posts ) { - $posts = $this->get_zone_posts( $zone ); - } - - foreach ( (array) $posts as $post ) { - $post_id = $this->get_post_id( $post ); - if ( $post_id ) { - delete_metadata( 'post', $post_id, $meta_key ); - } - } - - clean_term_cache( $this->get_zone_id( $zone ), $this->zone_taxonomy ); // flush cache for our zone term and related APC caches - - do_action( 'zoninator_remove_zone_posts', $posts, $zone ); - } - - public function get_zone_posts( $zone, $args = array() ) { - // Check cache first - $posts = $this->get_zone_posts_from_cache( $zone, $args ); - if ( $posts ) { - return $posts; - } - - $query = $this->get_zone_query( $zone, $args ); - $posts = $query->posts; - - // Add posts to cache - $this->add_zone_posts_to_cache( $posts, $zone, $args ); - - return $posts; - } - - public function get_zone_query( $zone, $args = array() ) { - $meta_key = $this->get_zone_meta_key( $zone ); - - $defaults = array( - 'order' => 'ASC', - 'posts_per_page' => -1, - 'post_type' => $this->get_supported_post_types(), - 'ignore_sticky_posts' => '1', // don't want sticky posts messing up our order - ); - - // Default to published posts on the front-end - if ( ! is_admin() ) { - $defaults['post_status'] = array( 'publish' ); - } - - if ( is_admin() ) { // skip APC in the admin - // phpcs:ignore WordPressVIPMinimum.Performance.WPQueryParams.SuppressFilters_suppress_filters - $defaults['suppress_filters'] = true; - } - - $args = wp_parse_args( $args, $defaults ); - - // Un-overridable args - $args['orderby'] = 'meta_value_num'; - $args['meta_key'] = $meta_key; - - return new WP_Query( $args ); - } - - public function get_last_post_in_zone( $zone ) { - return $this->get_single_post_in_zone( - $zone, - array( - 'order' => 'DESC', - ) - ); - } - - public function get_first_post_in_zone( $zone ) { - return $this->get_single_post_in_zone( $zone ); - } - - public function get_prev_post_in_zone( $zone, $post_id ) { - // TODO: test this works - $order = $this->get_post_order_in_zone( $zone, $post_id ); - - return $this->get_single_post_in_zone( - $zone, - array( - // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_value - 'meta_value' => $order, - 'meta_compare' => '<=', - ) - ); - } - - public function get_next_post_in_zone( $zone, $post_id ) { - // TODO: test this works - $order = $this->get_post_order_in_zone( $zone, $post_id ); - - return $this->get_single_post_in_zone( - $zone, - array( - // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_value - 'meta_value' => $order, - 'meta_compare' => '>=', - ) - ); - } - - public function get_single_post_in_zone( $zone, $args = array() ) { - - $args = wp_parse_args( - $args, - array( - 'posts_per_page' => 1, - 'showposts' => 1, - ) - ); - - $post = $this->get_zone_posts( $zone, $args ); - - if ( is_array( $post ) && array() !== $post ) { - return array_pop( $post ); - } - - return false; - } - - public function get_zones_for_post( $post_id ) { - // TODO: build this out - see https://github.com/Automattic/zoninator/pull/19 - } - - public function get_zones( $args = array() ) { - - $args = wp_parse_args( - $args, - array( - 'orderby' => 'id', - 'order' => 'ASC', - 'hide_empty' => 0, - ) - ); - - // phpcs:ignore WordPress.WP.DeprecatedParameters.Get_termsParam2Found -- See https://github.com/Automattic/zoninator/issues/111 - $zones = get_terms( $this->zone_taxonomy, $args ); - - if ( ! is_wp_error( $zones ) ) { - // Add extra fields in description as properties - foreach ( $zones as $zone ) { - $zone = $this->_fill_zone_details( $zone ); - } - - return $zones; - } - - return false; - } - - public function get_zone( $zone ) { - if ( is_int( $zone ) ) { - $field = 'id'; - } elseif ( is_string( $zone ) ) { - $field = 'slug'; - $zone = $this->get_zone_slug( $zone ); - } elseif ( is_object( $zone ) ) { - return $zone; - } else { - return false; - } - - if ( function_exists( 'wpcom_vip_get_term_by' ) ) { - // phpcs:ignore WordPressVIPMinimum.Functions.RestrictedFunctions.wpcom_vip_get_term_by_wpcom_vip_get_term_by -- See https://github.com/Automattic/zoninator/issues/110 - $zone = wpcom_vip_get_term_by( $field, $zone, $this->zone_taxonomy ); - } else { - $zone = get_term_by( $field, $zone, $this->zone_taxonomy ); - } - - if ( ! $zone ) { - return false; - } - - return $this->_fill_zone_details( $zone ); - } - - public function lock_zone( $zone, $user_id = 0 ) { - $zone_id = $this->get_zone_id( $zone ); - - if ( ! $zone_id ) { - return false; - } - - if ( ! $user_id ) { - $user = wp_get_current_user(); - $user_id = $user->ID; - } - - $lock_key = $this->get_zone_meta_key( $zone ); - $expiry = $this->zone_lock_period + 1; // Add a one to avoid most race condition issues between lock expiry and ajax call - set_transient( $lock_key, $user->ID, $expiry ); - - // Possible alternative: set zone lock as property with time and user - return null; - } - - // Not really needed with transients... - public function unlock_zone( $zone ) { - $zone_id = $this->get_zone_id( $zone ); - - if ( ! $zone_id ) { - return false; - } - - $lock_key = $this->get_zone_meta_key( $zone ); - - delete_transient( $lock_key ); - return null; - } - - public function is_zone_locked( $zone ) { - $zone_id = $this->get_zone_id( $zone ); - if ( ! $zone_id ) { - return false; - } - - $user = wp_get_current_user(); - $lock_key = $this->get_zone_meta_key( $zone ); - - $lock = get_transient( $lock_key ); - - // If lock doesn't exist, or check if current user same as lock user - if ( ! $lock || absint( $lock ) === absint( $user->ID ) ) { - return false; - } else { // return user_id of locking user - return absint( $lock ); - } - } - - public function zone_exists( $zone ) { - $zone_id = $this->get_zone_id( $zone ); - return (bool) term_exists( $zone_id, $this->zone_taxonomy ); - } - - public function get_zone_id( $zone ) { - if ( is_int( $zone ) ) { - return $zone; - } - - $zone = $this->get_zone( $zone ); - if ( is_object( $zone ) ) { - $zone = $zone->term_id; - } - - return (int) $zone; - } - - public function get_zone_meta_key( $zone ) { - $zone_id = $this->get_zone_id( $zone ); - return $this->zone_meta_prefix . $zone_id; - } - - public function get_zone_slug( $zone ) { - if ( is_int( $zone ) ) { - $zone = $this->get_zone( $zone ); - } - - if ( is_object( $zone ) ) { - $zone = $zone->slug; - } - - return $this->get_formatted_zone_slug( $zone ); - } - - public function get_formatted_zone_slug( $slug ) { - return $slug; // legacy function -- slugs can no longer be changed - } - - public function get_unformatted_zone_slug( $slug ) { - return $slug; // legacy function -- slugs can no longer be changed - } - - public function get_post_id( $post ) { - if ( is_int( $post ) ) { - return $post; - } elseif ( is_array( $post ) ) { - return absint( $post['ID'] ); - } elseif ( is_object( $post ) ) { - return $post->ID; - } - - return false; - } - - public function get_post_order( $post, $zone ) { - $post_id = $this->get_post_id( $post ); - $meta_key = $this->get_zone_meta_key( $zone ); - - return get_metadata( 'post', $post_id, $meta_key, true ); - } - - public function verify_nonce( $action ) { - $action = $this->_get_nonce_key( $action ); - $nonce = $this->_get_request_var( $action ); - - if ( empty( $nonce ) ) { - $nonce = $this->_get_request_var( '_wpnonce' ); - } - - if ( ! wp_verify_nonce( $nonce, $action ) ) { - $this->_unauthorized_access(); - } - } - - public function verify_access( $action = '', $zone_id = null ) { - // TODO: should check if zone locked - - $verify_function = ''; - switch ( $action ) { - case 'insert': - $verify_function = '_current_user_can_add_zones'; - break; - case 'update': - case 'delete': - $verify_function = '_current_user_can_edit_zones'; - break; - default: - $verify_function = '_current_user_can_manage_zones'; - break; - } - - if ( ! call_user_func( array( $this, $verify_function ), $zone_id ) ) { - $this->_unauthorized_access(); - } - } - - public function _unauthorized_access() { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore -- breaking change - wp_die( esc_html__( "Sorry, you're not supposed to do that...", 'zoninator' ) ); - } - - public function _fill_zone_details( $zone ) { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore -- breaking change - if ( ! empty( $zone->zoninator_parsed ) && $zone->zoninator_parsed ) { - return $zone; - } - - $details = array(); - - if ( ! empty( $zone->description ) ) { - $details = maybe_unserialize( $zone->description ); - } - - $details = wp_parse_args( $details, $this->zone_detail_defaults ); - - foreach ( $details as $detail_key => $detail_value ) { - $zone->$detail_key = $detail_value; - } - - $zone->zoninator_parsed = true; - - return $zone; - } - - public function do_zoninator_feeds() { - $query_var = get_query_var( $this->zone_taxonomy ); - - if ( ! empty( $query_var ) ) { - $zone_slug = get_query_var( $this->zone_taxonomy ); - $results = $this->get_zone_feed( $zone_slug ); - if ( is_wp_error( $results ) ) { - $this->send_user_error( $results->get_error_message() ); - } - - $this->json_return( $results ); - } - } - - private function filter_zone_feed_fields( $results ) { - $filtered_results = array(); - $whitelisted_fields = apply_filters( - 'zoninator_zone_feed_fields', - array( 'ID', 'post_date', 'post_title', 'post_content', 'post_excerpt', 'post_status', 'guid' ) - ); - - $filtered_results = array(); - $i = 0; - foreach ( $results as $result ) { - if ( ! isset( $filtered_results[ $i ] ) ) { - $filtered_results[ $i ] = new stdClass(); - } - - foreach ( $whitelisted_fields as $field ) { - if ( ! isset( $filtered_results[ $i ] ) ) { - $filtered_results[ $i ] = new stdClass(); - } - - // phpcs:ignore Squiz.PHP.DisallowMultipleAssignments.Found -- see https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/598 - $filtered_results[ $i ]->$field = $result->$field; - } - - ++$i; - } - - return $filtered_results; - } - - /** - * Encode some data and echo it (possibly without cached headers) - * - * @param array $data - */ - private function json_return( $data ) { - - if ( null == $data ) { - return false; - } - - header( 'Content-Type: application/json' ); - echo wp_json_encode( $data ); - exit(); - } - - private function send_user_error( $message ) { - $this->status_header_with_message( 406, $message ); - exit(); - } - - /** - * Modify the header and description in the global array - * - * @global array $wp_header_to_desc - * @param int $status - * @param string $message - */ - private function status_header_with_message( $status, $message ) { - global $wp_header_to_desc; - - $status = absint( $status ); - $official_message = $wp_header_to_desc[ $status ] ?? ''; - $wp_header_to_desc[ $status ] = $message; // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited - - status_header( $status ); - - // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited - $wp_header_to_desc[ $status ] = $official_message; - } - - // TODO: Caching needs to be testing properly before being implemented! - public function get_zone_cache_key( $zone, $args = array() ) { // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.FoundAfterLastUsed -- potentially breaking change/ - return ''; - } - - public function get_zone_posts_from_cache( $zone, $args = array() ) { // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.FoundAfterLastUsed -- potentially breaking change/ - return false; - } - - public function add_zone_posts_to_cache( $posts, $zone, $args = array() ) { - } - - // Handle 4.2 term-splitting - public function split_shared_term( $old_term_id, $new_term_id, $term_taxonomy_id, $taxonomy ) { - if ( $this->zone_taxonomy === $taxonomy ) { - do_action( 'zoninator_split_shared_term', $old_term_id, $new_term_id, $term_taxonomy_id ); - - // Quick, easy switcheroo; add posts to new zone id and remove from the old one. - $posts = $this->get_zone_posts( $old_term_id ); - if ( ! empty( $posts ) ) { - $this->add_zone_posts( $new_term_id, $posts ); - $this->remove_zone_posts( $old_term_id ); - } - - do_action( 'zoninator_did_split_shared_term', $old_term_id, $new_term_id, $term_taxonomy_id ); - } - } - - public function _empty_zone_posts_cache( $meta_key ) { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore -- breaking change - // TODO: implement - } - - public function _get_message( $message_id, $encode = false ) { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore -- breaking change - $message = ''; - - if ( ! empty( $this->zone_messages[ $message_id ] ) ) { - $message = $this->zone_messages[ $message_id ]; - } - - if ( $encode ) { - $message = urlencode( $message ); - } - - return $message; - } - - public function _get_nonce_key( $action ) { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore -- breaking change - return sprintf( '%s-%s', $this->zone_nonce_prefix, $action ); - } - - public function _current_user_can_add_zones() { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore -- breaking change - return current_user_can( $this->_get_add_zones_cap() ); - } - - public function _current_user_can_edit_zones( $zone_id ) { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore -- breaking change - $has_cap = current_user_can( $this->_get_edit_zones_cap() ); - return apply_filters( 'zoninator_current_user_can_edit_zone', $has_cap, $zone_id ); - } - - public function _current_user_can_manage_zones() { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore -- breaking change - return current_user_can( $this->_get_manage_zones_cap() ); - } - - public function _get_add_zones_cap() { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore -- breaking change - return apply_filters( 'zoninator_add_zone_cap', 'edit_others_posts' ); - } - - public function _get_edit_zones_cap() { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore -- breaking change - return apply_filters( 'zoninator_edit_zone_cap', 'edit_others_posts' ); - } - - public function _get_manage_zones_cap() { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore -- breaking change - return apply_filters( 'zoninator_manage_zone_cap', 'edit_others_posts' ); - } - - public function _get_zone_page_url( $args = array() ) { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore -- breaking change - $url = menu_page_url( $this->key, false ); - - foreach ( $args as $arg_key => $arg_value ) { - $url = add_query_arg( $arg_key, $arg_value, $url ); - } - - return $url; - } - - public function _validate_date_filter( $date ) { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore -- breaking change - return preg_match( '/(\d{4})-(\d{2})-(\d{2})/', $date ); - } - - public function _validate_category_filter( $cat ) { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore -- breaking change - return $cat && get_term_by( 'id', $cat, 'category' ); - } - - public function _sanitize_value( $var ) { // phpcs:ignore Universal.NamingConventions.NoReservedKeywordParameterNames.varFound, PSR2.Methods.MethodDeclaration.Underscore -- breaking change - return htmlentities( stripslashes( $var ) ); - } - - public function _get_value_or_default( $var, $object, $default = '', $sanitize_callback = '' ) { // phpcs:ignore Universal.NamingConventions.NoReservedKeywordParameterNames.defaultFound, Universal.NamingConventions.NoReservedKeywordParameterNames.objectFound, Universal.NamingConventions.NoReservedKeywordParameterNames.varFound, PSR2.Methods.MethodDeclaration.Underscore -- breaking change - if ( is_object( $object ) ) { - $value = empty( $object->$var ) ? $default : $object->$var; - } elseif ( is_array( $object ) ) { - $value = empty( $object[ $var ] ) ? $default : $object[ $var ]; - } else { - $value = $default; - } - - if ( is_callable( $sanitize_callback ) ) { - $value = is_array( $value ) ? array_map( $sanitize_callback, $value ) : call_user_func( $sanitize_callback, $value ); - } - - return $value; - } - - public function _get_request_var( $var, $default = '', $sanitize_callback = '' ) { // phpcs:ignore Universal.NamingConventions.NoReservedKeywordParameterNames.defaultFound, Universal.NamingConventions.NoReservedKeywordParameterNames.varFound, PSR2.Methods.MethodDeclaration.Underscore -- breaking change - // phpcs:ignore WordPress.Security.NonceVerification.Recommended - return $this->_get_value_or_default( $var, $_REQUEST, $default, $sanitize_callback ); - } - - public function _get_get_var( $var, $default = '', $sanitize_callback = '' ) { // phpcs:ignore Universal.NamingConventions.NoReservedKeywordParameterNames.defaultFound, Universal.NamingConventions.NoReservedKeywordParameterNames.varFound, PSR2.Methods.MethodDeclaration.Underscore -- breaking change - // phpcs:ignore WordPress.Security.NonceVerification.Recommended - return $this->_get_value_or_default( $var, $_GET, $default, $sanitize_callback ); - } - - public function _get_post_var( $var, $default = '', $sanitize_callback = '' ) { // phpcs:ignore Universal.NamingConventions.NoReservedKeywordParameterNames.defaultFound, Universal.NamingConventions.NoReservedKeywordParameterNames.varFound, PSR2.Methods.MethodDeclaration.Underscore -- breaking change - // phpcs:ignore WordPress.Security.NonceVerification.Missing - return $this->_get_value_or_default( $var, $_POST, $default, $sanitize_callback ); - } - - public function get_admin_zone_post( $post, $zone ) { - return apply_filters( - 'zoninator_zone_post_columns', - array( - 'post_id' => $post->ID, - 'position' => array( - 'current_position' => intval( $this->get_post_order( $post->ID, $zone ) ), - 'change_position_message' => esc_attr__( 'Click and drag to change the position of this item.', 'zoninator' ), - 'key' => 'position', - ), - 'info' => array( - 'key' => 'info', - 'post' => array( - 'post_title' => esc_html( $post->post_title ), - 'post_status' => esc_html( $post->post_status ), - ), - 'action_link_data' => array( - array( - 'action' => 'edit', - 'anchor' => get_edit_post_link( $post->ID ), - 'title' => __( 'Opens in new window', 'zoninator' ), - 'text' => __( 'Edit', 'zoninator' ), - 'target' => '_blank', - ), - array( - 'action' => 'delete', - 'anchor' => '#', - 'title' => '', - 'text' => __( 'Remove', 'zoninator' ), - ), - array( - 'action' => 'view', - 'anchor' => get_permalink( $post->ID ), - 'title' => __( 'Opens in new window', 'zoninator' ), - 'text' => __( 'View', 'zoninator' ), - 'target' => '_blank', - ), - ), - ), - ), - $post, - $zone - ); - } - - public function get_admin_zone_posts( $zone_or_id ) { - $zone = $this->get_zone( $zone_or_id ); - $posts = $this->get_zone_posts( $zone ); - $admin_zone_posts = array(); - - foreach ( $posts as $post ) { - $admin_zone_posts[] = $this->get_admin_zone_post( $post, $zone ); - } - - return $admin_zone_posts; - } - - /** - * @param $zone_slug_or_id - * @return array|WP_Error - */ - public function get_zone_feed( $zone_slug_or_id ) { - $zone_id = $this->get_zone( $zone_slug_or_id ); - - if ( empty( $zone_id ) ) { - return new WP_Error( 'invalid-zone-supplied', __( 'Invalid zone supplied', 'zoninator' ) ); - } - - $results = $this->get_zone_posts( $zone_id, apply_filters( 'zoninator_json_feed_fields', array(), $zone_slug_or_id ) ); - $filtered_results = $this->filter_zone_feed_fields( $results ); - - return apply_filters( 'zoninator_json_feed_results', $filtered_results, $zone_slug_or_id ); - } - - public function check( $action = '', $zone_id = null ) { - // TODO: should check if zone locked - if ( 'insert' == $action ) { - return $this->_current_user_can_add_zones(); - } - - if ( 'update' == $action || 'delete' == $action ) { - return $this->_current_user_can_edit_zones( $zone_id ); - } - - return $this->_current_user_can_manage_zones(); - } - } + require_once ZONINATOR_PATH . '/src/class-zoninator.php'; function Zoninator() { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid, Universal.Files.SeparateFunctionsFromOO.Mixed -- Windows is case-sensitive, so changing this is a breaking change. global $zoninator; From 62847450cf8b35a73c630359b258b05202388a27 Mon Sep 17 00:00:00 2001 From: Gary Jones Date: Sat, 23 Nov 2024 13:25:16 +0000 Subject: [PATCH 46/56] Move and rename widget class file Closes #115. --- .../class-zoninator-zoneposts-widget.php | 0 zoninator.php | 2 +- 2 files changed, 1 insertion(+), 1 deletion(-) rename widget.zone-posts.php => src/class-zoninator-zoneposts-widget.php (100%) diff --git a/widget.zone-posts.php b/src/class-zoninator-zoneposts-widget.php similarity index 100% rename from widget.zone-posts.php rename to src/class-zoninator-zoneposts-widget.php diff --git a/zoninator.php b/zoninator.php index 2f1b69a..8cfaac5 100644 --- a/zoninator.php +++ b/zoninator.php @@ -36,7 +36,7 @@ define( 'ZONINATOR_URL', trailingslashit( plugins_url( '', __FILE__ ) ) ); require_once ZONINATOR_PATH . '/functions.php'; - require_once ZONINATOR_PATH . '/widget.zone-posts.php'; + require_once ZONINATOR_PATH . '/src/class-zoninator-zoneposts-widget.php'; require_once ZONINATOR_PATH . '/src/class-zoninator.php'; function Zoninator() { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid, Universal.Files.SeparateFunctionsFromOO.Mixed -- Windows is case-sensitive, so changing this is a breaking change. From 15ada44fe36f6dd643ee15df60300f08ab2ff6d6 Mon Sep 17 00:00:00 2001 From: Gary Jones Date: Sat, 23 Nov 2024 13:58:21 +0000 Subject: [PATCH 47/56] Refactor root file - Reduce constants being defined and used. - Remove class_exists() check. --- src/class-zoninator-api.php | 2 +- src/class-zoninator.php | 12 ++++++------ zoninator.php | 33 +++++++++++++++------------------ 3 files changed, 22 insertions(+), 25 deletions(-) diff --git a/src/class-zoninator-api.php b/src/class-zoninator-api.php index d07e1ef..91d06ac 100644 --- a/src/class-zoninator-api.php +++ b/src/class-zoninator-api.php @@ -29,7 +29,7 @@ public function __construct( $instance ) { * Rest Api. */ public function rest_api() { - include_once ZONINATOR_PATH . '/src/zoninator_rest/class-zoninator-rest-bootstrap.php'; + include_once dirname( ZONINATOR_FILE ) . '/src/zoninator_rest/class-zoninator-rest-bootstrap.php'; $this->bootstrap = Zoninator_REST_Bootstrap::create()->load(); include_once __DIR__ . '/class-zoninator-api-schema-converter.php'; include_once __DIR__ . '/class-zoninator-api-filter-search.php'; diff --git a/src/class-zoninator.php b/src/class-zoninator.php index 25e64dd..0bb14fe 100644 --- a/src/class-zoninator.php +++ b/src/class-zoninator.php @@ -69,7 +69,7 @@ public function maybe_add_rest_api() { return false; } - include_once ZONINATOR_PATH . '/src/class-zoninator-api.php'; + include_once dirname( ZONINATOR_FILE ) . '/src/class-zoninator-api.php'; $this->rest_api = new Zoninator_Api( $this ); return null; } @@ -130,7 +130,7 @@ public function init() { } public function load_textdomain() { - load_plugin_textdomain( 'zoninator', false, basename( ZONINATOR_PATH ) . '/language' ); + load_plugin_textdomain( 'zoninator', false, basename( dirname( ZONINATOR_FILE ) ) . '/language' ); } public function widgets_init() { @@ -163,7 +163,7 @@ public function admin_page_init() { public function admin_enqueue_scripts() { if ( $this->is_zoninator_page() ) { - wp_enqueue_script( 'zoninator-js', ZONINATOR_URL . 'js/zoninator.js', array( 'jquery', 'jquery-ui-core', 'jquery-ui-widget', 'jquery-ui-mouse', 'jquery-ui-position', 'jquery-ui-sortable', 'jquery-ui-autocomplete' ), ZONINATOR_VERSION, true ); + wp_enqueue_script( 'zoninator-js', plugin_dir_url( ZONINATOR_FILE ) . 'js/zoninator.js', array( 'jquery', 'jquery-ui-core', 'jquery-ui-widget', 'jquery-ui-mouse', 'jquery-ui-position', 'jquery-ui-sortable', 'jquery-ui-autocomplete' ), ZONINATOR_VERSION, true ); $options = array( 'baseUrl' => $this->_get_zone_page_url(), @@ -179,14 +179,14 @@ public function admin_enqueue_scripts() { // For mobile support: https://github.com/furf/jquery-ui-touch-punch // phpcs:ignore WordPress.WP.EnqueuedResourceParameters.NotInFooter, WordPress.WP.EnqueuedResourceParameters.MissingVersion - wp_enqueue_script( 'jquery-ui-touch-punch', ZONINATOR_URL . 'js/jquery.ui.touch-punch.min.js', array( 'jquery-ui-core', 'jquery-ui-widget', 'jquery-ui-mouse' ) ); + wp_enqueue_script( 'jquery-ui-touch-punch', plugin_dir_url( ZONINATOR_FILE ) . 'js/jquery.ui.touch-punch.min.js', array( 'jquery-ui-core', 'jquery-ui-widget', 'jquery-ui-mouse' ) ); } } public function admin_enqueue_styles() { if ( $this->is_zoninator_page() ) { - wp_enqueue_style( 'zoninator-jquery-ui', ZONINATOR_URL . 'css/jquery-ui/smoothness/jquery-ui-zoninator.css', false, ZONINATOR_VERSION, 'all' ); - wp_enqueue_style( 'zoninator-styles', ZONINATOR_URL . 'css/zoninator.css', false, ZONINATOR_VERSION, 'all' ); + wp_enqueue_style( 'zoninator-jquery-ui', plugin_dir_url( ZONINATOR_FILE ) . 'css/jquery-ui/smoothness/jquery-ui-zoninator.css', false, ZONINATOR_VERSION, 'all' ); + wp_enqueue_style( 'zoninator-styles', plugin_dir_url( ZONINATOR_FILE ) . 'css/zoninator.css', false, ZONINATOR_VERSION, 'all' ); } } diff --git a/zoninator.php b/zoninator.php index 8cfaac5..a2abf56 100644 --- a/zoninator.php +++ b/zoninator.php @@ -30,23 +30,20 @@ */ -if ( ! class_exists( 'Zoninator' ) ) : - define( 'ZONINATOR_VERSION', '0.10.1' ); - define( 'ZONINATOR_PATH', __DIR__ ); - define( 'ZONINATOR_URL', trailingslashit( plugins_url( '', __FILE__ ) ) ); - - require_once ZONINATOR_PATH . '/functions.php'; - require_once ZONINATOR_PATH . '/src/class-zoninator-zoneposts-widget.php'; - require_once ZONINATOR_PATH . '/src/class-zoninator.php'; - - function Zoninator() { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid, Universal.Files.SeparateFunctionsFromOO.Mixed -- Windows is case-sensitive, so changing this is a breaking change. - global $zoninator; - if ( ! isset( $zoninator ) || null === $zoninator ) { - $zoninator = new Zoninator(); - } - - return $zoninator; +define( 'ZONINATOR_VERSION', '0.10.1' ); +define( 'ZONINATOR_FILE', __FILE__ ); + +require_once __DIR__ . '/functions.php'; +require_once __DIR__ . '/src/class-zoninator-zoneposts-widget.php'; +require_once __DIR__ . '/src/class-zoninator.php'; + +function Zoninator() { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid, Universal.Files.SeparateFunctionsFromOO.Mixed -- Windows is case-sensitive, so changing this is a breaking change. + global $zoninator; + if ( ! isset( $zoninator ) || null === $zoninator ) { + $zoninator = new Zoninator(); } - Zoninator(); -endif; + return $zoninator; +} + +Zoninator(); From 7bff4833ccee9f817e91a6a9afb63f69c35e6717 Mon Sep 17 00:00:00 2001 From: Gary Jones Date: Sat, 23 Nov 2024 14:06:52 +0000 Subject: [PATCH 48/56] Fix rector config See #117. --- rector.php | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/rector.php b/rector.php index c5b0d92..4bed137 100644 --- a/rector.php +++ b/rector.php @@ -20,11 +20,9 @@ return RectorConfig::configure() ->withPaths( array( - __DIR__ . '/includes', - __DIR__ . '/lib', + __DIR__ . '/src', __DIR__ . '/tests', __DIR__ . '/functions.php', - __DIR__ . '/widget.zone-posts.php', __DIR__ . '/zoninator.php', ) ) @@ -33,7 +31,7 @@ LongArrayToShortArrayRector::class, // Need a better understanding of intent in this file before switching out the use of empty(). DisallowedEmptyRuleFixerRector::class => array( - __DIR__ . '/lib/zoninator_rest/type/class-zoninator-rest-type-registry.php', + __DIR__ . '/src/zoninator_rest/type/class-zoninator-rest-type-registry.php', ), // Child classes can legitimately relax the visibility of a method, so while this // might not be desirable, changing them from public to the original parent-defined From ee88d3d366d63de2b3db3188d2b9d1f477fffa1a Mon Sep 17 00:00:00 2001 From: Raam Dev Date: Tue, 3 Dec 2024 22:21:22 -0500 Subject: [PATCH 49/56] Update GitHub action to install SVN before deploy to WordPress.org --- .github/workflows/deploy.yml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index bc0afb4..618820d 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -11,6 +11,12 @@ jobs: steps: - name: Checkout uses: actions/checkout@v4 + + - name: Install SVN (Subversion) + run: | + sudo apt-get update + sudo apt-get install subversion + - name: Push to WordPress.org uses: 10up/action-wordpress-plugin-deploy@stable env: From 3b1566c6cdbf7828cd268ac86b7664dd7fb670e5 Mon Sep 17 00:00:00 2001 From: Gary Jones Date: Thu, 2 Oct 2025 12:01:33 +0100 Subject: [PATCH 50/56] ci: Add SVN installation step for integration tests --- .github/workflows/integrations.yml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/.github/workflows/integrations.yml b/.github/workflows/integrations.yml index 65de1ac..f83627b 100644 --- a/.github/workflows/integrations.yml +++ b/.github/workflows/integrations.yml @@ -65,6 +65,12 @@ jobs: - name: Start MySQL Service run: sudo systemctl start mysql.service + # This is needed as the integration tests use SVN to download the WordPress core and test dependencies. + - name: Install SVN (Subversion) + run: | + sudo apt-get update + sudo apt-get install subversion + - name: Prepare environment for integration tests run: composer prepare-ci ${{ matrix.wordpress }} From ea5079e5c300a0ec79202ea9094e1999fe85cc6c Mon Sep 17 00:00:00 2001 From: Gary Jones Date: Thu, 2 Oct 2025 11:44:31 +0100 Subject: [PATCH 51/56] fix: Address deprecation notices during tests Also update PHPUnit configuration to be more strict about deprecation notices. --- phpunit.xml.dist | 37 ++++++++++--------- .../class-zoninator-api-controller-test.php | 14 +++++++ 2 files changed, 33 insertions(+), 18 deletions(-) diff --git a/phpunit.xml.dist b/phpunit.xml.dist index 04f8f65..5060c5e 100644 --- a/phpunit.xml.dist +++ b/phpunit.xml.dist @@ -1,23 +1,24 @@ + - - - - - - - - - ./tests/ - ./tests/unit-testing-classes - ./tests/bin - - + testdox="true"> + + + + ./tests/ + + diff --git a/tests/unit/class-zoninator-api-controller-test.php b/tests/unit/class-zoninator-api-controller-test.php index 11b4f4e..feb0c4d 100644 --- a/tests/unit/class-zoninator-api-controller-test.php +++ b/tests/unit/class-zoninator-api-controller-test.php @@ -16,6 +16,20 @@ class Zoninator_Api_Controller_Test extends WP_UnitTestCase { */ private $admin_id; + /** + * Default User ID + * + * @var int + */ + private $default_user_id; + + /** + * Environment + * + * @var mixed + */ + private $environment; + /** * Assert Status * From eb84c929faeefcabe79a826ae052d4c6a8bc9735 Mon Sep 17 00:00:00 2001 From: Gary Jones Date: Thu, 2 Oct 2025 12:26:54 +0100 Subject: [PATCH 52/56] fix: Prevent exposure of content for password-protected posts Added a check to ensure that the content and excerpt of password-protected posts are not exposed in the zone feed. Updated unit tests to verify this security fix. --- src/class-zoninator.php | 9 +++- .../class-zoninator-api-controller-test.php | 45 +++++++++++++++++++ 2 files changed, 52 insertions(+), 2 deletions(-) diff --git a/src/class-zoninator.php b/src/class-zoninator.php index 0bb14fe..51d6cfa 100644 --- a/src/class-zoninator.php +++ b/src/class-zoninator.php @@ -1532,8 +1532,13 @@ private function filter_zone_feed_fields( $results ) { $filtered_results[ $i ] = new stdClass(); } - // phpcs:ignore Squiz.PHP.DisallowMultipleAssignments.Found -- see https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/598 - $filtered_results[ $i ]->$field = $result->$field; + // Don't expose content or excerpt for password-protected posts + if ( ( 'post_content' === $field || 'post_excerpt' === $field ) && ! empty( $result->post_password ) ) { + $filtered_results[ $i ]->$field = ''; + } else { + // phpcs:ignore Squiz.PHP.DisallowMultipleAssignments.Found -- see https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/598 + $filtered_results[ $i ]->$field = $result->$field; + } } ++$i; diff --git a/tests/unit/class-zoninator-api-controller-test.php b/tests/unit/class-zoninator-api-controller-test.php index feb0c4d..bfa8204 100644 --- a/tests/unit/class-zoninator-api-controller-test.php +++ b/tests/unit/class-zoninator-api-controller-test.php @@ -433,4 +433,49 @@ private function add_a_zone( $slug = 'zone-1' ) { 'slug' => $slug, )); } + + /** + * Test that password-protected posts do NOT expose their content in zone feed + * This test verifies the security fix is working + */ + public function test_password_protected_posts_do_not_expose_content_in_zone_feed() { + // Create a password-protected post + $post_id = wp_insert_post(array( + 'post_title' => 'Password-protected post', + 'post_content' => 'This is secret content that should not be exposed!', + 'post_excerpt' => 'This is a secret excerpt that should not be exposed!', + 'post_status' => 'publish', + 'post_password' => 'secret123', + 'post_type' => 'post' + )); + + $this->assertNotWPError($post_id); + + // Create a zone and add the password-protected post to it + $zone_id = $this->create_a_zone('test-security-zone', 'Test Security Zone'); + $response = $this->put('/zoninator/v1/zones/' . $zone_id . '/posts', array( + 'post_ids' => array($post_id), + )); + $this->assertResponseStatus($response, 200); + + // Test as unauthenticated user (simulating public access) + wp_set_current_user(0); + + // Get the zone posts via REST API + $response = $this->get('/zoninator/v1/zones/' . $zone_id . '/posts'); + $this->assertResponseStatus($response, 200); + + $data = $response->get_data(); + $this->assertIsArray($data); + $this->assertCount(1, $data); + + $post_data = $data[0]; + $this->assertEquals($post_id, $post_data->ID); + $this->assertEquals('Password-protected post', $post_data->post_title); + + // Security fix: password-protected content and excerpt should be empty + $this->assertEquals('', $post_data->post_content); + $this->assertEquals('', $post_data->post_excerpt); + } + } From bd5f7cc478bb0ca9a574691860c5083c82afc39f Mon Sep 17 00:00:00 2001 From: Gary Jones Date: Thu, 2 Oct 2025 14:41:36 +0100 Subject: [PATCH 53/56] chore: Modernise i18n - Remove outdated Hebrew language files - Adjust the domain path for languages to match the default. - Add a new i18n command for generating translation files. --- composer.json | 3 + language/zoninator-he_IL.mo | Bin 4961 -> 0 bytes language/zoninator-he_IL.po | 222 ------------------------------------ src/class-zoninator.php | 6 - zoninator.php | 2 +- 5 files changed, 4 insertions(+), 229 deletions(-) delete mode 100644 language/zoninator-he_IL.mo delete mode 100644 language/zoninator-he_IL.po diff --git a/composer.json b/composer.json index 98ece83..81d8618 100644 --- a/composer.json +++ b/composer.json @@ -36,6 +36,9 @@ "cs": [ "@php ./vendor/bin/phpcs" ], + "i18n": [ + "@php wp i18n make-pot . ./languages/zoninator.pot" + ], "lint": [ "@php ./vendor/php-parallel-lint/php-parallel-lint/parallel-lint . -e php --exclude vendor --exclude .git" ], diff --git a/language/zoninator-he_IL.mo b/language/zoninator-he_IL.mo deleted file mode 100644 index e8151849f646cae37e7305f11870db3b7a9a4c83..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 4961 zcmai$U2Ggz700Kv1?uwEQfNylTnE}Xt#{+3>DQ*ANu88NO&b%tZ74|Ac<0(X&F;*0 zX0~gCcmM>5w|uOVY~v=p>+yZ_Y+yQ5UBk*@N3}rz%PNn z1HS>j3yy&^IJ*h_PKm1}z7776^}m6SgRPGib}oavng0xwKmP#5=X)TocsE0a@K#W~ z+{Q<8_keGI2%Dh%|2rh!32O5;;4aXB4}jW#7F0a5;0(9~%Fb^}{6mR<1ttGaunXQu z@|2%%gDiPJ0>wiQ6i+_~RTpo9;^X(A;(re$1n=HYc;0>B{h;g}0F}R&N^F6K`S-zb z@FJ*l?|=`0e*~WdZ~kPlzYjdgJOLjCZz1^|a1Xc(`~^4){u@-@?}QA^9|3;_9tIb{ zQHntR{1~i*Jy5*83(CI{ND$u!RNN1M;`dQdatFa1K-mzl_wrVG^^~pQ;<=wWX>uHD zZ;V&G-K7Z+VL1Q9Au8P?yW(Ji7aHAjPl@XwUn=X961NV`3B%RDV)-nue7=KMx%o2h zW?sdwTtcyXKF9Y#UP^TEY+emx#oH4E=6Tz7c*xdml$psm%0O?j5yz=TwjHN~nZ{;5iCgBr)SGOE^&`fQ0uvbm^=&-H5xU@G&hWezR#N{md@JNodP8m$+bq zJ-N^gg9V#;)6LF;`xw~viQ&~wnApI~hqf71z3Dhfmc~sQw=ASY3#O}Vcau0;7&TK( zE0VKh$@mL?7(KZzo;Cceh(3sI8g0&uT@2G~pl-mgjN(fNEptm$hf4-)^-hvtsJUdC zas7x5s{dunG>I`8XzW_@*J%c_6}W0~i7#?k2C)=(OamSX(yup&QS7$-#jw?BnJ{Qt z(+pc7g-$_qLuicPc242}l+-hwP;FSV*H0UBv7c-Zgzn9Weu_-JZqszW(7dGoajJJ;!P#-E9ASfKd8KDla%YGrdy^EHQTBa z)rpZqwjC!~<+*er3@T4`7ShU0Tr-U= zp73}38Xl=eHv7uR0j|`JzhEmf)^F9!RN;`(%si3t-Cg>)A&U2QcK?Bq=k`ChZzFD^ z9VuC?%q+DDK$q!O@)$-tb#*7H&33&o^K|904LSKYZ2(oX%5WRb`dOA>eK52e!y&0g)@qhgZdgdUVIj2<*i+nxZ9i+& zOm$;%I_@NOJ6TXwGX+;u%}(MsD^JHsE3KKR?WXCj?K@2|+%*=N(OqWSmYpd2s*P+? zlP!oQ;?Ka(%#SMw|RRsELd$MREoUo(>*%}=s* zh2QhM$KZT^QLCr&6Zx9Q(PFKi|HN>788zp0

L@^K;&?qKoeIX&sV!bQ*L?<7tzh z)o(r~*Nk&W+dnmYR`TOc6|!eA+1K`3zRHesjZZH>%el*}ykXc{kX>8aOap)%2%G8#*7PR z;Oi;8AtnWKJ*J?(pm*Kb^JrFd=V}GH=bd`|)#;N3xh@|fg0x-5A`W^){)SGlw2HHr z3O|(*H_WeIyE#bfAO&ba0l8&xD(@*UF|DZkgM^E%9uZ#AV8t=JoL|0{adFjK4@-V2 zJ??C{HsdbBK`pYmN=FIuzA0r1})h z@y$6EcUGk!pUc4@YN>WMRXQgWwkq#fA$kd$MQyw>uBg@!Cixd7w&uL)j~b2>&k8i1 zmt)#Nfh)Uf&krYB2gsCC2krk?copNMQM9dbK(&a?3t~nw_VpJLYb!qboD#KF4>eGEk*z+f zjy*Qz1e4Xg2kS+8UYCE%NV2FT6P4s?#~$HbM!snD_cPwlIk}=w51BO=qVwQ_OB2JB ztX6SgqR7RN015`TLLaT}{wq}yXjw*s z3x|F-V+g5xPAGeF>b$Pmqq^vDkB!&26nU42?!r_}m`wy%HXVPK;l86(6uR4am4jve zhVEf^W$Hp3+~V)Mv!uq|JOnaub`5bFLriS+o7kq`hHmUZhbsvxV3;qjex`(@>MO4` z8Xh5v7&})TPsi1cWxxvO{p^VnevhQs!?-&tbAul+=gd$} ehrAuEaz&S3D+tdSQu9%r*R1R2D6P6oc>e(#*S;qJ diff --git a/language/zoninator-he_IL.po b/language/zoninator-he_IL.po deleted file mode 100644 index 0b0ec5e..0000000 --- a/language/zoninator-he_IL.po +++ /dev/null @@ -1,222 +0,0 @@ -msgid "" -msgstr "" -"Project-Id-Version: Zoninator 1.0.0\n" -"Report-Msgid-Bugs-To: http://pojo.me/\n" -"POT-Creation-Date: 2014-06-09 17:04+0200\n" -"PO-Revision-Date: 2014-06-09 17:13+0200\n" -"Last-Translator: Ariel K \n" -"Language-Team: Pojo.me Team \n" -"Language: he_IL\n" -"MIME-Version: 1.0\n" -"Content-Type: text/plain; charset=UTF-8\n" -"Content-Transfer-Encoding: 8bit\n" -"X-Poedit-KeywordsList: __;_e;__ngettext:1,2;_n:1,2;__ngettext_noop:1,2;" -"_n_noop:1,2;_c,_nc:4c,1,2;_x:1,2c;_nx:4c,1,2;_nx_noop:4c,1,2;_ex:1,2c;" -"esc_attr__;esc_attr_e;esc_attr_x:1,2c;esc_html__;esc_html_e;esc_html_x:1,2c\n" -"X-Poedit-Basepath: .\n" -"X-Poedit-SourceCharset: UTF-8\n" -"Plural-Forms: nplurals=2; plural=(n != 1);\n" -"X-Generator: Poedit 1.5.5\n" -"X-Poedit-SearchPath-0: ..\n" - -#: ../widget.zone-posts.php:11 -msgid "Use this widget to display a list of posts from any zone." -msgstr "יש להשתמש בוידג'ט הזה כדי להציג רשימת פוסטים מאזור כלשהו." - -#: ../widget.zone-posts.php:21 -msgid "Zone Posts" -msgstr "אזור פוסטים" - -#: ../widget.zone-posts.php:99 -msgid "You need to create at least one zone before you use this widget!" -msgstr "צריך ליצור אזור אחד לפחות לפני שניתן להשתמש בוידג'ט זה!" - -#: ../widget.zone-posts.php:108 -msgid "Zone:" -msgstr "אזור:" - -#: ../widget.zone-posts.php:111 -msgid "-- Select a zone --" -msgstr "--בחירת אזור--" - -#: ../widget.zone-posts.php:125 -msgid "Show zone description in widget" -msgstr "להציג תיאור אזור בוידג'ט" - -#: ../zoninator.php:81 -msgid "The zone was successfully created." -msgstr "האזור נוצר בהצלחה." - -#: ../zoninator.php:82 -msgid "The zone was successfully updated." -msgstr "אזור עודכן בהצלחה." - -#: ../zoninator.php:83 -msgid "The zone was successfully deleted." -msgstr "אזור נמחק בהצלחה" - -#: ../zoninator.php:84 -msgid "Sorry, something went wrong! Please try again?" -msgstr "מצטערים, משהו פה שגוי! יש לנסות שוב." - -#: ../zoninator.php:85 -#, php-format -msgid "" -"Sorry, this zone is in use by %s and is currently locked. Please try again " -"later." -msgstr "" -"מצטערים, אזור זה נמצא בשימוש על ידי %s ולכן הוא נעול ברגע זה. יש לנסות שוב " -"מאוחר יותר." - -#: ../zoninator.php:86 -msgid "" -"Sorry, you have reached the maximum idle limit and will now be redirected to " -"the Dashboard." -msgstr "מצטערים, המערכת לא זיהתה פעילות לאחרונה, הינך מופנה אל לוח הבקרה." - -#: ../zoninator.php:102 ../zoninator.php:153 ../zoninator.php:258 -msgid "Zones" -msgstr "אזורים" - -#: ../zoninator.php:153 -msgid "Zoninator" -msgstr "ניהול אזורים" - -#: ../zoninator.php:165 -msgid "another user" -msgstr "משתמש אחר" - -#: ../zoninator.php:271 -msgid "Edit Zone" -msgstr "עריכת אזור" - -#: ../zoninator.php:284 ../zoninator.php:286 -msgid "Add New" -msgstr "הוספת חדש" - -#: ../zoninator.php:368 ../zoninator.php:411 -msgid "Name" -msgstr "שם" - -#: ../zoninator.php:374 ../zoninator.php:417 -msgid "Slug" -msgstr "מזהה" - -#: ../zoninator.php:381 ../zoninator.php:423 -msgid "Description" -msgstr "תיאור" - -#: ../zoninator.php:395 -msgid "Save" -msgstr "שמירה" - -#: ../zoninator.php:398 -msgid "Delete" -msgstr "מחיקה" - -#: ../zoninator.php:442 -msgid "Zone Content" -msgstr "תוכן אזור" - -#: ../zoninator.php:457 -msgid "" -"To create a zone, enter a name (and any other info) to to left and click " -"\"Save\". You can then choose content items to add to the zone." -msgstr "" -"כדי ליצור אזור, יש להזין שם (ומידע נוסף אם צריך) וללחוץ על \"שמירה\". לאחר " -"מכן ניתן לבחור פריטי תוכן ולהוסיף לאזור." - -#: ../zoninator.php:493 -msgid "Click and drag to change the position of this item." -msgstr "יש ללחוץ ולגרור כדי לשנות את המיקום של פריט זה." - -#: ../zoninator.php:500 ../zoninator.php:502 -msgid "Opens in new window" -msgstr "פתיחה בלשונית חדשה" - -#: ../zoninator.php:500 -msgid "Edit" -msgstr "עריכה" - -#: ../zoninator.php:501 -msgid "Remove this item from the zone" -msgstr "למחוק פריט זה מהאזור" - -#: ../zoninator.php:501 -msgid "Remove" -msgstr "הסרה" - -#: ../zoninator.php:502 -msgid "View" -msgstr "תצוגה" - -#: ../zoninator.php:518 -msgid "Hide" -msgstr "להסתיר" - -#: ../zoninator.php:518 -msgid "Show Filters" -msgstr "להציג סינון" - -#: ../zoninator.php:529 -msgid "Filter:" -msgstr "סינון:" - -#: ../zoninator.php:532 -msgid "Show all Categories" -msgstr "הצגת כל הקטגוריות" - -#: ../zoninator.php:609 -msgid "No results found" -msgstr "לא נמצאו תוצאות" - -#: ../zoninator.php:611 -#, php-format -msgid "Choose post from %s" -msgstr "לבחור פוסט מ %s" - -#: ../zoninator.php:613 ../zoninator.php:645 -msgid "Choose a post" -msgstr "בחירת פוסט" - -#: ../zoninator.php:643 -msgid "Add Recent Content" -msgstr "להוסיף תוכן אחרון" - -#: ../zoninator.php:660 -msgid "Search for content" -msgstr "חיפוש בתוכן" - -#: ../zoninator.php:662 -msgid "" -"Enter a term or phrase in the text box above to search for and add content " -"to this zone." -msgstr "יש להזין מונח או ביטוי בתיבת הטקסט כדי לחפש ולהוסיף תוכן לאזור זה." - -#: ../zoninator.php:835 -msgid "(no title)" -msgstr "(ללא כותרת)" - -#: ../zoninator.php:881 -msgid "Slug is a required field." -msgstr "מזהה פוסט הינו שדה חובה" - -#: ../zoninator.php:926 ../zoninator.php:949 -msgid "Sorry, that zone doesn't exist." -msgstr "מצטערים, אזור זה לא קיים." - -#: ../zoninator.php:943 -msgid "Sorry, we couldn't delete the zone." -msgstr "מצטערים, לא ניתן למחוק אזור זה." - -#: ../zoninator.php:1306 -msgid "Sorry, you're not supposed to do that..." -msgstr "מצטערים, איך לך הרשאות לעשות זאת..." - -#: ../zoninator.php:1340 -msgid "Invalid zone supplied" -msgstr "הוזן אזור לא תקין" - -#: ../zoninator.php:1346 -msgid "No zone posts found" -msgstr "לא נמצא אזור פוסטים" diff --git a/src/class-zoninator.php b/src/class-zoninator.php index 51d6cfa..ae538f8 100644 --- a/src/class-zoninator.php +++ b/src/class-zoninator.php @@ -50,8 +50,6 @@ class Zoninator { public function __construct() { add_action( 'init', array( $this, 'init' ), 99 ); // init later after other post types have been registered - add_action( 'plugins_loaded', array( $this, 'load_textdomain' ) ); - add_action( 'widgets_init', array( $this, 'widgets_init' ) ); add_action( 'init', array( $this, 'add_zone_feed' ) ); @@ -129,10 +127,6 @@ public function init() { do_action( 'zoninator_post_init' ); } - public function load_textdomain() { - load_plugin_textdomain( 'zoninator', false, basename( dirname( ZONINATOR_FILE ) ) . '/language' ); - } - public function widgets_init() { register_widget( 'Zoninator_ZonePosts_Widget' ); } diff --git a/zoninator.php b/zoninator.php index a2abf56..c0931d4 100644 --- a/zoninator.php +++ b/zoninator.php @@ -6,7 +6,7 @@ Version: 0.10.1 Author URI: http://vip.wordpress.com Text Domain: zoninator -Domain Path: /language/ +Domain Path: /languages/ Copyright 2010-2015 Mohammad Jangda, Automattic From 81d2a7aeefdbfa41fe14b17e7c3c64eb2ec27ae5 Mon Sep 17 00:00:00 2001 From: Gary Jones Date: Thu, 2 Oct 2025 14:54:36 +0100 Subject: [PATCH 54/56] Version 0.10.2 changelog --- CHANGELOG.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 221d165..8afc34f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,25 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [0.10.2] - 2025-10-02 + +### Fixed + +* fix: Prevent exposure of content for password-protected posts by @GaryJones in https://github.com/Automattic/zoninator/pull/125 + +### Maintenance + +* Deploy: Don't include .git/ directory by @GaryJones in https://github.com/Automattic/zoninator/pull/106 +* Add and apply Rector by @GaryJones in https://github.com/Automattic/zoninator/pull/107 +* CS: Fix or ignore coding standards issues by @GaryJones in https://github.com/Automattic/zoninator/pull/112 +* Consolidate classes by @GaryJones in https://github.com/Automattic/zoninator/pull/117 +* Refactor root file by @GaryJones in https://github.com/Automattic/zoninator/pull/118 +* Fix rector config by @GaryJones in https://github.com/Automattic/zoninator/pull/119 +* Update GitHub action to install SVN before deploy to WordPress.org by @raamdev in https://github.com/Automattic/zoninator/pull/120 +* ci: Add SVN installation step for integration tests by @GaryJones in https://github.com/Automattic/zoninator/pull/123 +* fix: Address deprecation notices during tests by @GaryJones in https://github.com/Automattic/zoninator/pull/124 +* chore: Modernise i18n by @GaryJones in https://github.com/Automattic/zoninator/pull/126 + ## [0.10.1] - 2024-08-15 ### Fixed @@ -103,6 +122,7 @@ This release has PHP 7.4 and WordPress 5.9 as the minimum supported versions. * Initial Release! +[0.10.2]: https://github.com/automattic/zoninator/compare/0.10.1..0.10.2 [0.10.1]: https://github.com/automattic/zoninator/compare/0.10.0..0.10.1 [0.10.0]: https://github.com/automattic/zoninator/compare/0.9..0.10.0 [0.9]: https://github.com/automattic/zoninator/compare/0.8..0.9 From e3585dfe1828db52b913c77bfafb707a456cb573 Mon Sep 17 00:00:00 2001 From: Gary Jones Date: Thu, 2 Oct 2025 14:55:29 +0100 Subject: [PATCH 55/56] Version 0.10.2 i18n --- languages/zoninator.pot | 290 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 290 insertions(+) create mode 100644 languages/zoninator.pot diff --git a/languages/zoninator.pot b/languages/zoninator.pot new file mode 100644 index 0000000..977a8cc --- /dev/null +++ b/languages/zoninator.pot @@ -0,0 +1,290 @@ +# Copyright (C) 2025 Mohammad Jangda, Automattic +# This file is distributed under the same license as the Zone Manager (Zoninator) plugin. +msgid "" +msgstr "" +"Project-Id-Version: Zone Manager (Zoninator) 0.10.2\n" +"Report-Msgid-Bugs-To: https://wordpress.org/support/plugin/zoninator\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"POT-Creation-Date: 2025-10-02T13:54:49+00:00\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"X-Generator: WP-CLI 2.12.0\n" +"X-Domain: zoninator\n" + +#. Plugin Name of the plugin +#: zoninator.php +msgid "Zone Manager (Zoninator)" +msgstr "" + +#. Description of the plugin +#: zoninator.php +msgid "Curation made easy! Create \"zones\" then add and order your content!" +msgstr "" + +#. Author of the plugin +#: zoninator.php +msgid "Mohammad Jangda, Automattic" +msgstr "" + +#. Author URI of the plugin +#: zoninator.php +msgid "https://wpvip.com" +msgstr "" + +#: src/class-zoninator-api-controller.php:68 +#: src/class-zoninator-api-controller.php:70 +msgid "Zone not found" +msgstr "" + +#: src/class-zoninator-api-controller.php:69 +msgid "Invalid post id" +msgstr "" + +#: src/class-zoninator-api-controller.php:71 +msgid "post id and zone id required" +msgstr "" + +#: src/class-zoninator-api-controller.php:306 +msgid "zone id required" +msgstr "" + +#: src/class-zoninator-api-controller.php:500 +#: src/class-zoninator.php:1471 +msgid "Sorry, you're not supposed to do that..." +msgstr "" + +#: src/class-zoninator-api-filter-search.php:26 +msgid "search term" +msgstr "" + +#: src/class-zoninator-api-filter-search.php:31 +msgid "filter by category" +msgstr "" + +#: src/class-zoninator-api-filter-search.php:35 +msgid "only get posts after this date (format YYYY-mm-dd)" +msgstr "" + +#: src/class-zoninator-api-filter-search.php:39 +msgid "limit results" +msgstr "" + +#: src/class-zoninator-api-filter-search.php:43 +msgid "post_ids to exclude" +msgstr "" + +#: src/class-zoninator-zoneposts-widget.php:12 +msgid "Use this widget to display a list of posts from any zone." +msgstr "" + +#: src/class-zoninator-zoneposts-widget.php:22 +msgid "Zone Posts" +msgstr "" + +#: src/class-zoninator-zoneposts-widget.php:133 +msgid "You need to create at least one zone before you use this widget!" +msgstr "" + +#: src/class-zoninator-zoneposts-widget.php:142 +msgid "Zone:" +msgstr "" + +#: src/class-zoninator-zoneposts-widget.php:145 +msgid "-- Select a zone --" +msgstr "" + +#: src/class-zoninator-zoneposts-widget.php:161 +msgid "Show zone description in widget" +msgstr "" + +#: src/class-zoninator.php:82 +msgid "The zone was successfully created." +msgstr "" + +#: src/class-zoninator.php:83 +msgid "The zone was successfully updated." +msgstr "" + +#: src/class-zoninator.php:84 +msgid "The zone was successfully deleted." +msgstr "" + +#: src/class-zoninator.php:85 +msgid "Sorry, something went wrong! Please try again?" +msgstr "" + +#. translators: User's display name, or "another user" +#: src/class-zoninator.php:87 +#, php-format +msgid "Sorry, this zone is in use by %s and is currently locked. Please try again later." +msgstr "" + +#: src/class-zoninator.php:88 +msgid "Sorry, you have reached the maximum idle limit and will now be redirected to the Dashboard." +msgstr "" + +#: src/class-zoninator.php:108 +#: src/class-zoninator.php:155 +#: src/class-zoninator.php:269 +msgid "Zones" +msgstr "" + +#: src/class-zoninator.php:155 +msgid "Zoninator" +msgstr "" + +#: src/class-zoninator.php:167 +msgid "another user" +msgstr "" + +#: src/class-zoninator.php:281 +msgid "Edit Zone" +msgstr "" + +#: src/class-zoninator.php:297 +#: src/class-zoninator.php:299 +msgid "Add New" +msgstr "" + +#: src/class-zoninator.php:402 +#: src/class-zoninator.php:451 +msgid "Name" +msgstr "" + +#: src/class-zoninator.php:408 +#: src/class-zoninator.php:457 +msgid "Slug" +msgstr "" + +#: src/class-zoninator.php:417 +#: src/class-zoninator.php:463 +msgid "Description" +msgstr "" + +#: src/class-zoninator.php:433 +msgid "Save zone info" +msgstr "" + +#: src/class-zoninator.php:436 +msgid "Delete" +msgstr "" + +#: src/class-zoninator.php:484 +msgid "Zone Content" +msgstr "" + +#: src/class-zoninator.php:506 +msgid "To create a zone, enter a name (and optional description) and click \"Save zone info\". You can then choose content items to add to the zone." +msgstr "" + +#: src/class-zoninator.php:552 +#: src/class-zoninator.php:1720 +msgid "Click and drag to change the position of this item." +msgstr "" + +#: src/class-zoninator.php:560 +#: src/class-zoninator.php:562 +#: src/class-zoninator.php:1733 +#: src/class-zoninator.php:1746 +msgid "Opens in new window" +msgstr "" + +#: src/class-zoninator.php:560 +#: src/class-zoninator.php:1734 +msgid "Edit" +msgstr "" + +#: src/class-zoninator.php:561 +msgid "Remove this item from the zone" +msgstr "" + +#: src/class-zoninator.php:561 +#: src/class-zoninator.php:1741 +msgid "Remove" +msgstr "" + +#: src/class-zoninator.php:562 +#: src/class-zoninator.php:1747 +msgid "View" +msgstr "" + +#: src/class-zoninator.php:578 +msgid "Hide" +msgstr "" + +#: src/class-zoninator.php:578 +msgid "Show Filters" +msgstr "" + +#: src/class-zoninator.php:589 +msgid "Filter:" +msgstr "" + +#: src/class-zoninator.php:595 +msgid "Show all Categories" +msgstr "" + +#: src/class-zoninator.php:687 +msgid "No results found" +msgstr "" + +#. translators: Category name +#: src/class-zoninator.php:690 +#, php-format +msgid "Choose post from %s" +msgstr "" + +#: src/class-zoninator.php:692 +#: src/class-zoninator.php:727 +msgid "Choose a post" +msgstr "" + +#: src/class-zoninator.php:725 +msgid "Add Recent Content" +msgstr "" + +#: src/class-zoninator.php:743 +msgid "Search for content" +msgstr "" + +#: src/class-zoninator.php:745 +msgid "Enter a term or phrase in the text box above to search for and add content to this zone." +msgstr "" + +#: src/class-zoninator.php:936 +msgid "(no title)" +msgstr "" + +#: src/class-zoninator.php:1018 +msgid "Slug is a required field." +msgstr "" + +#: src/class-zoninator.php:1065 +#: src/class-zoninator.php:1089 +msgid "Sorry, that zone doesn't exist." +msgstr "" + +#: src/class-zoninator.php:1082 +msgid "Sorry, we couldn't delete the zone." +msgstr "" + +#: src/class-zoninator.php:1778 +msgid "Invalid zone supplied" +msgstr "" + +#. translators: %s is usually a field name. +#: src/zoninator_rest/class-zoninator-rest-model.php:221 +#, php-format +msgid "%s cannot be empty" +msgstr "" + +#: src/zoninator_rest/controller/class-zoninator-rest-controller-crud.php:48 +msgid "Model not found" +msgstr "" + +#: src/zoninator_rest/controller/class-zoninator-rest-controller-settings.php:35 +msgid "Settings not found" +msgstr "" From 6a42baae3d3f09058bf43c2a3d64a3e4054bc8de Mon Sep 17 00:00:00 2001 From: Gary Jones Date: Thu, 2 Oct 2025 14:56:27 +0100 Subject: [PATCH 56/56] Version 0.10.2 --- README.md | 2 +- package-lock.json | 2 +- package.json | 8 ++++---- zoninator.php | 8 ++++---- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index f9e6b6d..e72d853 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Zone Manager (Zoninator) -Stable tag: 0.10.1 +Stable tag: 0.10.2 Requires at least: 5.9 Tested up to: 6.6 Requires PHP: 7.4 diff --git a/package-lock.json b/package-lock.json index de1ab59..42d73f6 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "zoninator", - "version": "0.10.1", + "version": "0.10.2", "lockfileVersion": 3, "requires": true, "packages": { diff --git a/package.json b/package.json index bf7d25a..f29be3d 100644 --- a/package.json +++ b/package.json @@ -1,14 +1,14 @@ { "name": "zoninator", - "version": "0.10.1", + "version": "0.10.2", "description": "Curation made easy! Create \"zones\" then add and order your content!", "license": "GPL-2.0-or-later", "private": true, "repository": "automattic/zoninator", "scripts": { - "bump:patch": "bump patch --commit 'Version %s.' package.json package-lock.json zoninator.php README.md", - "bump:minor": "bump minor --commit 'Version %s.' package.json package-lock.json zoninator.php README.md", - "bump:major": "bump major --commit 'Version %s.' package.json package-lock.json zoninator.php README.md" + "bump:patch": "bump patch package.json package-lock.json zoninator.php README.md", + "bump:minor": "bump minor package.json package-lock.json zoninator.php README.md", + "bump:major": "bump major package.json package-lock.json zoninator.php README.md" }, "devDependencies": { "mixtape": "git+https://github.com/Automattic/mixtape.git#3a8440", diff --git a/zoninator.php b/zoninator.php index c0931d4..213c2a0 100644 --- a/zoninator.php +++ b/zoninator.php @@ -3,12 +3,12 @@ Plugin Name: Zone Manager (Zoninator) Description: Curation made easy! Create "zones" then add and order your content! Author: Mohammad Jangda, Automattic -Version: 0.10.1 -Author URI: http://vip.wordpress.com +Version: 0.10.2 +Author URI: https://wpvip.com Text Domain: zoninator Domain Path: /languages/ -Copyright 2010-2015 Mohammad Jangda, Automattic +Copyright 2010-2025 Mohammad Jangda, Automattic This plugin was built by Mohammad Jangda in conjunction with William Davis and the Bangor Daily News. @@ -30,7 +30,7 @@ */ -define( 'ZONINATOR_VERSION', '0.10.1' ); +define( 'ZONINATOR_VERSION', '0.10.2' ); define( 'ZONINATOR_FILE', __FILE__ ); require_once __DIR__ . '/functions.php';