v0.5.3 - Merge pull request #58 from JoryHogeveen/dev

v0.5.3

Author: JoryHogeveen

.codeclimate.yml

@@ -156,5 +156,6 @@ exclude_paths:
 - "bin/*"
 # Libraries
 - "js/fastclick.js"
+- "slidebars/*"
 # Local
 - "vendor/*"

includes/api.php

@@ -4,7 +4,7 @@
  *
  * @author  Jory Hogeveen <[email protected]>
  * @package Off_Canvas_Sidebars
- * @version 0.5.2
+ * @version 0.5.3
  */
 
 if ( ! defined( 'ABSPATH' ) ) {
@@ -16,7 +16,7 @@
  *
  * @api
  * @since  0.3.0
- * @param  string|array  $sidebars  (Optional) The ID of this sidebar as configured in: Appearances > Off-Canvas Sidebars > Sidebars.
+ * @param  string|array  $sidebars  (optional) The ID(s) of the sidebar(s) as configured in: Appearances > Off-Canvas Sidebars > Sidebars.
  */
 function the_ocs_off_canvas_sidebar( $sidebars = '' ) {
 	$instance = off_canvas_sidebars_frontend();
@@ -43,7 +43,7 @@ function the_ocs_off_canvas_sidebar( $sidebars = '' ) {
  * @since  0.5.0  Add icon options.
  * @param  array   $atts {
  *     Required array of arguments
- *     @type  string        $id               (Required) The off-canvas sidebar ID.
+ *     @type  string        $id               (required) The off-canvas sidebar ID.
  *     @type  string        $text             The text to show. Default: ''.
  *     @type  string        $action           The trigger action. Default: `toggle`.
  *     @type  string        $element          The HTML element. Default: `button`.

includes/class-base.php

@@ -16,7 +16,7 @@
  * @author  Jory Hogeveen <[email protected]>
  * @package Off_Canvas_Sidebars
  * @since   0.5.0
- * @version 0.5.0
+ * @version 0.5.3
  */
 abstract class OCS_Off_Canvas_Sidebars_Base
 {
@@ -28,7 +28,7 @@ abstract class OCS_Off_Canvas_Sidebars_Base
 	 * @return  mixed
 	 */
 	public function get_settings( $key ) {
-		return OCS_Off_Canvas_Sidebars_Settings::get_instance()->get_settings( $key );
+		return off_canvas_sidebars_settings()->get_settings( $key );
 	}
 
 	/**

includes/class-control-trigger.php

@@ -16,7 +16,7 @@
  * @author  Jory Hogeveen <[email protected]>
  * @package Off_Canvas_Sidebars
  * @since   0.5.1
- * @version 0.5.1
+ * @version 0.5.3
  * @uses    \OCS_Off_Canvas_Sidebars_Base Extends class
  */
 final class OCS_Off_Canvas_Sidebars_Control_Trigger extends OCS_Off_Canvas_Sidebars_Base
@@ -105,6 +105,7 @@ public static function render( $sidebar_id, $args = array() ) {
 			'icon_location' => 'before', // before|after.
 			'attr'          => array(), // An array of attribute keys and their values.
 		);
+
 		$args = wp_parse_args( $args, $defaults );
 
 		$args['attr'] = off_canvas_sidebars_parse_attr_string( $args['attr'] );
@@ -131,13 +132,8 @@ public static function render( $sidebar_id, $args = array() ) {
 		);
 		$attr = array_merge( $attr, $args['attr'] );
 
-		// Add our own classes.
-		$prefix = off_canvas_sidebars()->get_settings( 'css_prefix' );
-		$classes = array(
-			$prefix . '-trigger',
-			$prefix . '-' . $args['action'],
-			$prefix . '-' . $args['action'] . '-' . $sidebar_id,
-		);
+		// Get the default classes.
+		$classes = self::get_trigger_classes( $sidebar_id, $args['action'] );
 
 		// Optionally add extra classes.
 		if ( ! empty( $args['class'] ) ) {
@@ -183,13 +179,38 @@ public static function render( $sidebar_id, $args = array() ) {
 		return $return;
 	}
 
+	/**
+	 * Get the default control trigger classes.
+	 *
+	 * @since   0.5.3
+	 * @static
+	 *
+	 * @param   string  $sidebar_id  The sidebar ID.
+	 * @param   string  $action      The trigger action.
+	 * @return  array
+	 */
+	public static function get_trigger_classes( $sidebar_id, $action = 'toggle' ) {
+		$prefix = off_canvas_sidebars_settings()->get_settings( 'css_prefix' );
+
+		$classes = array(
+			'ocs-trigger',
+			$prefix . '-trigger',
+			$prefix . '-' . $action,
+			$prefix . '-' . $action . '-' . $sidebar_id,
+		);
+
+		return $classes;
+	}
+
 	/**
 	 * Get control trigger field options.
 	 *
 	 * @SuppressWarnings(PHPMD.ExcessiveMethodLength)
 	 * @todo Refactor to enable above checks?
 	 *
 	 * @since   0.5.1
+	 * @static
+	 *
 	 * @return  array {
 	 *     @type array $field_id {
 	 *         @type  string  $type
@@ -219,24 +240,21 @@ public static function get_fields() {
 				'label' => '-- ' . __( 'select', OCS_DOMAIN ) . ' --',
 			),
 		);
-		foreach ( off_canvas_sidebars()->get_sidebars() as $sidebar_id => $sidebar_data ) {
-			if ( empty( $sidebar_data['enable'] ) ) {
-				continue;
-			}
+		foreach ( off_canvas_sidebars_settings()->get_enabled_sidebars() as $sidebar_id => $sidebar_data ) {
 			$label = $sidebar_id;
 			if ( ! empty( $sidebar_data['label'] ) ) {
 				$label = $sidebar_data['label'] . ' (' . $sidebar_id . ')';
 			}
 			$sidebars[] = array(
-				'label'  => $label,
+				'label' => $label,
 				'value' => $sidebar_id,
 			);
 		}
 
 		$elements = array();
 		foreach ( self::$control_elements as $e ) {
 			$elements[] = array(
-				'label'  => '<' . $e . '>',
+				'label' => '<' . $e . '>',
 				'value' => $e,
 			);
 		}
@@ -245,11 +263,11 @@ public static function get_fields() {
 			// Translators: [ocs_trigger text="Your text"] or [ocs_trigger]Your text[/ocs_trigger]
 			'your_text' => __( 'Your text', OCS_DOMAIN ),
 			// Translators: [ocs_trigger text="Your text"] or [ocs_trigger]Your text[/ocs_trigger]
-			'or' => __( 'or', OCS_DOMAIN ),
+			'or'        => __( 'or', OCS_DOMAIN ),
 		);
 
 		$fields = array(
-			'id' => array(
+			'id'            => array(
 				'type'        => 'select',
 				'name'        => 'id',
 				'label'       => __( 'Sidebar ID', OCS_DOMAIN ),
@@ -258,15 +276,15 @@ public static function get_fields() {
 				'required'    => true,
 				'group'       => 'basic',
 			),
-			'text' => array(
+			'text'          => array(
 				'type'        => 'text',
 				'name'        => 'text',
 				'label'       => __( 'Text', OCS_DOMAIN ),
 				'description' => __( 'Limited HTML allowed', OCS_DOMAIN ),
 				'multiline'   => true,
 				'group'       => 'basic',
 			),
-			'icon' => array(
+			'icon'          => array(
 				'type'        => 'text',
 				'name'        => 'icon',
 				'label'       => __( 'Icon', OCS_DOMAIN ),
@@ -288,9 +306,9 @@ public static function get_fields() {
 						'value' => 'after',
 					),
 				),
-				'group'       => 'basic',
+				'group'   => 'basic',
 			),
-			'action' => array(
+			'action'        => array(
 				'type'    => 'select',
 				'name'    => 'action',
 				'label'   => __( 'Trigger action', OCS_DOMAIN ),
@@ -308,32 +326,32 @@ public static function get_fields() {
 						'value' => 'close',
 					),
 				),
-				'group'       => 'advanced',
+				'group'   => 'advanced',
 			),
-			'element' => array(
+			'element'       => array(
 				'type'        => 'select',
 				'name'        => 'element',
 				'label'       => __( 'HTML element', OCS_DOMAIN ),
 				'options'     => $elements,
 				'description' => __( 'Choose wisely', OCS_DOMAIN ),
 				'group'       => 'advanced',
 			),
-			'class' => array(
+			'class'         => array(
 				'type'        => 'text',
 				'name'        => 'class',
 				'label'       => __( 'Extra classes', OCS_DOMAIN ),
 				'description' => __( 'Separate multiple classes with a space', OCS_DOMAIN ),
 				'group'       => 'advanced',
 			),
-			'attr' => array(
+			'attr'          => array(
 				'type'        => 'text',
 				'name'        => 'attr',
 				'label'       => __( 'Custom attributes', OCS_DOMAIN ),
 				'description' => __( 'key : value ; key : value', OCS_DOMAIN ),
 				'multiline'   => true,
 				'group'       => 'advanced',
 			),
-			'nested' => array(
+			'nested'        => array(
 				'type'        => 'checkbox',
 				'name'        => 'nested',
 				'label'       => __( 'Nested shortcode', OCS_DOMAIN ) . '?',