generator-chisel 2.1.2 → 2.2.0

package/lib/commands/create/creators/app/chisel-starter-theme/inc/{Helper → Helpers}/GravityFormsHelpers.php

@@ -1,20 +1,20 @@
 <?php
 
-namespace Chisel\Helper;
+namespace Chisel\Helpers;
 
 /**
  * Helper functions.
  *
  * @package Chisel
  */
-class GravityFormsHelpers {
+final class GravityFormsHelpers {
 
 	/**
 	 * Check if Gravity Forms plugin is active.
 	 *
 	 * @return bool
 	 */
-	public static function is_gf_active() {
+	public static function is_gf_active(): bool {
 		return class_exists( '\GFForms' );
 	}
 
@@ -23,7 +23,7 @@ class GravityFormsHelpers {
 	 *
 	 * @return array
 	 */
-	public static function get_forms_list() {
+	public static function get_forms_list(): array {
 		if ( ! class_exists( 'GFForms' ) ) {
 			return array();
 		}
@@ -44,18 +44,18 @@ class GravityFormsHelpers {
 	/**
 	 * This function will generate the gravity form for a given id with default parameters. Use if you need to generate ajax fomr outside of blocks.
 	 *
-	 * @param int   $form_id
-	 * @param bool  $display_title
-	 * @param bool  $display_description
-	 * @param bool  $display_inactive
-	 * @param array $field_values
-	 * @param bool  $ajax
-	 * @param int   $tabindex
-	 * @param bool  $_echo
+	 * @param int    $form_id
+	 * @param bool   $display_title
+	 * @param bool   $display_description
+	 * @param bool   $display_inactive
+	 * @param ?array $field_values
+	 * @param bool   $ajax
+	 * @param int    $tabindex
+	 * @param bool   $_echo
 	 *
 	 * @return mixed
 	 */
-	public static function get_form( $form_id, $display_title = false, $display_description = false, $display_inactive = false, $field_values = null, $ajax = true, $tabindex = 0, $_echo = false ) {
+	public static function get_form( int $form_id, bool $display_title = false, bool $display_description = false, bool $display_inactive = false, ?array $field_values = null, bool $ajax = true, int $tabindex = 0, bool $_echo = false ): mixed {
 		if ( function_exists( 'gravity_form' ) ) {
 			return gravity_form( $form_id, $display_title, $display_description, $display_inactive, $field_values, $ajax, $tabindex, $_echo );
 		}

package/lib/commands/create/creators/app/chisel-starter-theme/inc/{Helper → Helpers}/ImageHelpers.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Chisel\Helper;
+namespace Chisel\Helpers;
 
 use Timber\Timber;
 
@@ -9,14 +9,17 @@ use Timber\Timber;
  *
  * @package Chisel
  */
-class ImageHelpers {
+final class ImageHelpers {
 
 	/**
 	 * Responsive image data.
 	 *
 	 * @var array
 	 */
-	private static $responsive_image_data = array();
+	private static $responsive_image_data = array(
+		'image_id' => 0,
+		'attrs'    => array(),
+	);
 
 	/**
 	 * Get image url of the theme images.
@@ -26,12 +29,16 @@ class ImageHelpers {
 	 *
 	 * @return string
 	 */
-	public static function get_image_url( $image_name, $is_icon = false ) {
+	public static function get_image_url( string $image_name, bool $is_icon = false ): string {
+		if ( $image_name === '' ) {
+			return '';
+		}
+
 		$folder_name = $is_icon ? 'icons' : 'images';
 		$image_path  = '/assets/' . $folder_name . '/' . $image_name;
 		$file_path   = get_template_directory() . $image_path;
 
-		if ( ! file_exists( $file_path ) ) {
+		if ( ! is_file( $file_path ) ) {
 			return '';
 		}
 
@@ -47,19 +54,17 @@ class ImageHelpers {
 	 *
 	 * @return string|html
 	 */
-	public static function get_responsive_image( $image_id, $image_size = 'medium', $attrs = array() ) {
-		if ( ! $image_id ) {
+	public static function get_responsive_image( int $image_id, string $image_size = 'medium', array $attrs = array() ): string {
+		if ( $image_id <= 0 ) {
 			return '';
 		}
 
-		$image = Timber::get_image( $image_id );
-
 		self::$responsive_image_data = array(
 			'image_id' => $image_id,
 			'attrs'    => $attrs,
 		);
 
-		// Adjust image width and height to prevent layout shifts.
+		// Adjust image width and height to preven content layout shifts (CLS).
 		if ( isset( $attrs['width'] ) && isset( $attrs['height'] ) ) {
 			add_filter(
 				'wp_get_attachment_image_src',
@@ -69,7 +74,8 @@ class ImageHelpers {
 			);
 		}
 
-		$responsive_image = $image ? $image->responsive( $image_size, $attrs ) : '';
+		$image = Timber::get_image( $image_id );
+		$html  = $image ? (string) $image->responsive( $image_size, $attrs ) : '';
 
 		remove_filter(
 			'wp_get_attachment_image_src',
@@ -77,7 +83,7 @@ class ImageHelpers {
 			10
 		);
 
-		return $responsive_image;
+		return $html;
 	}
 
 	/**
@@ -88,13 +94,22 @@ class ImageHelpers {
 	 *
 	 * @return array
 	 */
-	public static function responsive_image_dimensions( $src, $id ) {
+	public static function responsive_image_dimensions( array $src, int $id ) {
+		if ( empty( $src ) ) {
+			return $src;
+		}
+
 		$image_id = self::$responsive_image_data['image_id'] ?? 0;
 		$attrs    = self::$responsive_image_data['attrs'] ?? array();
 
 		if ( $id === $image_id && isset( $attrs['width'] ) && isset( $attrs['height'] ) ) {
-				$src[1] = $attrs['width'];
-				$src[2] = $attrs['height'];
+			$width  = (int) $attrs['width'];
+			$height = (int) $attrs['height'];
+
+			if ( $width > 0 && $height > 0 ) {
+				$src[1] = $width;
+				$src[2] = $height;
+			}
 		}
 
 		return $src;

package/lib/commands/create/creators/app/chisel-starter-theme/inc/{Helper → Helpers}/ThemeHelpers.php

@@ -1,21 +1,21 @@
 <?php
 
-namespace Chisel\Helper;
+namespace Chisel\Helpers;
 
-use Chisel\Helper\ImageHelpers;
+use Chisel\Helpers\ImageHelpers;
 
 /**
  * Helper functions.
  *
  * @package Chisel
  */
-class ThemeHelpers {
+final class ThemeHelpers {
 	/**
 	 * Color palettes.
 	 *
 	 * @var array
 	 */
-	private static $colors_palettes = array(
+	private static array $colors_palettes = array(
 		'acf'     => array(),
 		'tinymce' => '',
 	);
@@ -25,7 +25,7 @@ class ThemeHelpers {
 	 *
 	 * @return bool
 	 */
-	public static function is_dev_env() {
+	public static function is_dev_env(): bool {
 		return wp_get_environment_type() === 'development';
 	}
 
@@ -34,7 +34,7 @@ class ThemeHelpers {
 	 *
 	 * @return bool
 	 */
-	public static function is_fast_refresh() {
+	public static function is_fast_refresh(): bool {
 		$runtime = get_template_directory() . '/build/runtime.js';
 
 		return self::is_dev_env() && is_file( $runtime );
@@ -43,11 +43,11 @@ class ThemeHelpers {
 	/**
 	 * Get theme version.
 	 *
-	 * @return bool
+	 * @return string
 	 */
-	public static function get_theme_version() {
+	public static function get_theme_version(): string {
 		$theme = wp_get_theme();
-		return $theme->get( 'Version' );
+		return (string) $theme->get( 'Version' );
 	}
 
 	/**
@@ -55,8 +55,8 @@ class ThemeHelpers {
 	 *
 	 * @return bool
 	 */
-	public static function get_theme_name() {
-		return esc_attr( get_bloginfo( 'name' ) );
+	public static function get_theme_name(): string {
+		return (string) get_bloginfo( 'name' );
 	}
 
 	/**
@@ -67,8 +67,8 @@ class ThemeHelpers {
 	 *
 	 * @return string
 	 */
-	public static function bem( $name = '', ...$modifiers ) {
-		if ( empty( $name ) || empty( $modifiers ) ) {
+	public static function bem( string $name = '', mixed ...$modifiers ): string {
+		if ( $name === '' || empty( $modifiers ) ) {
 			return '';
 		}
 
@@ -112,27 +112,31 @@ class ThemeHelpers {
 	 *
 	 * @param string $type Type of palette to get.
 	 *
-	 * @return array
+	 * @return string|array
 	 */
-	public static function get_colors_palette( $type ) {
+	public static function get_colors_palette( string $type ): string|array {
 		if ( ! isset( self::$colors_palettes[$type] ) || self::$colors_palettes[$type] ) {
-			return self::$colors_palettes[$type];
+			return apply_filters( 'chisel_' . $type . '_colors_palette', self::$colors_palettes[$type] );
 		}
 
 		$theme_json      = get_template_directory() . '/theme.json';
-		$theme_json_data = wp_json_file_decode( $theme_json, array( 'associative' => true ) );
-		$colors_palette  = $theme_json_data['settings']['color']['palette'];
+		$theme_json_data = is_file( $theme_json ) ? wp_json_file_decode( $theme_json, array( 'associative' => true ) ) : array();
+		$colors_palette  = isset( $theme_json_data['settings']['color']['palette'] ) ? $theme_json_data['settings']['color']['palette'] : array();
 
-		if ( $colors_palette ) {
+		if ( ! empty( $colors_palette ) ) {
 			foreach ( $colors_palette as $color_data ) {
-				$color = sanitize_hex_color( $color_data['color'] );
+				$hex_color = isset( $color_data['color'] ) ? sanitize_hex_color( (string) $color_data['color'] ) : null;
+
+				if ( ! $hex_color ) {
+						continue;
+				}
 
 				if ( $type === 'acf' ) {
-					self::$colors_palettes[$type][] = $color;
+					self::$colors_palettes[$type][] = $hex_color;
 				} elseif ( $type === 'tinymce' ) {
 					self::$colors_palettes[$type] .= sprintf(
 						'"%s", "%s",',
-						str_replace( '#', '', $color ),
+						str_replace( '#', '', $hex_color ),
 						esc_attr( $color_data['name'] )
 					);
 				}
@@ -147,11 +151,11 @@ class ThemeHelpers {
 	 *
 	 * @return array
 	 */
-	public static function get_login_page_logo_data() {
-		$logo_id   = get_theme_mod( 'custom_logo', 0 );
+	public static function get_login_page_logo_data(): array {
+		$logo_id   = (int) get_theme_mod( 'custom_logo', 0 );
 		$logo_data = array();
 
-		if ( $logo_id ) {
+		if ( $logo_id > 0 ) {
 			$logo_data = wp_get_attachment_image_src( $logo_id, 'medium' );
 		} else {
 			$logo_data = array(

package/lib/commands/create/creators/app/chisel-starter-theme/inc/{Helper → Helpers}/WoocommerceHelpers.php

@@ -1,29 +1,35 @@
 <?php
 
-namespace Chisel\Helper;
+namespace Chisel\Helpers;
 
 /**
  * Helper functions.
  *
  * @package Chisel
  */
-class WoocommerceHelpers {
+final class WoocommerceHelpers {
 
 	/**
 	 * Check if WooCommerce is active.
 	 *
 	 * @return bool
 	 */
-	public static function is_woocommerce_active() {
+	public static function is_woocommerce_active(): bool {
 		return class_exists( '\Woocommerce' );
 	}
 
 	/**
 	 * Set the product object. For some reason, products in the loop don’t get the right context by default. Without this, some elements of the listed products would show the same information as the first product in the loop. This function fixes that.
 	 *
-	 * @param object $post The post object.
+	 * @param object $post
+	 *
+	 * @return void
 	 */
-	public static function timber_set_product( $post ) {
+	public static function timber_set_product( object $post ): void {
+		if ( ! self::is_woocommerce_active() ) {
+			return;
+		}
+
 		global $product;
 
 		if ( is_woocommerce() ) {
@@ -34,13 +40,13 @@ class WoocommerceHelpers {
 	/**
 	 * Get products grid classnames
 	 *
-	 * @param bool $products
-	 * @param bool $has_sidebar
+	 * @param bool $products - Whether there are products to render.
+	 * @param bool $has_sidebar -Whether the layout includes a sidebar.
 	 *
 	 * @return string
 	 */
-	public static function get_products_grid_classnames( $products, $has_sidebar ) {
-		$loop_columns = wc_get_loop_prop( 'columns' );
+	public static function get_products_grid_classnames( bool $products, bool $has_sidebar ): string {
+		$loop_columns = (int) wc_get_loop_prop( 'columns' );
 
 		// Set max columns to 4.
 		if ( $loop_columns > 4 ) {

package/lib/commands/create/creators/app/chisel-starter-theme/inc/{Helper → Helpers}/YoastHelpers.php

@@ -1,29 +1,29 @@
 <?php
 
-namespace Chisel\Helper;
+namespace Chisel\Helpers;
 
 /**
  * Helper functions.
  *
  * @package Chisel
  */
-class YoastHelpers {
+final class YoastHelpers {
 
 	/**
 	 * Check if Yoast plugin is active.
 	 *
 	 * @return bool
 	 */
-	public static function is_yoast_active() {
+	public static function is_yoast_active(): bool {
 		return class_exists( '\WPSEO_Options' );
 	}
 
 	/**
 	 * Display breadcrumbs.
 	 *
-	 * @return html
+	 * @return string
 	 */
-	public static function breadcrumbs() {
+	public static function breadcrumbs(): string {
 		if ( ! self::is_yoast_active() ) {
 			return '';
 		}
@@ -32,6 +32,6 @@ class YoastHelpers {
 			return '';
 		}
 
-		return yoast_breadcrumb( '<div class="c-breadcrumbs">', '</div>', false );
+		return (string) yoast_breadcrumb( '<div class="c-breadcrumbs o-wrapper__inner">', '</div>', false );
 	}
 }

package/lib/commands/create/creators/app/chisel-starter-theme/inc/Interfaces/HooksInterface.php

@@ -12,15 +12,15 @@ interface HooksInterface {
 	/**
 	 * Set class properties.
 	 */
-	public function set_properties();
+	public function set_properties(): void;
 
 	/**
 	 * Register action hooks.
 	 */
-	public function action_hooks();
+	public function action_hooks(): void;
 
 	/**
 	 * Register filter hooks.
 	 */
-	public function filter_hooks();
+	public function filter_hooks(): void;
 }

package/lib/commands/create/creators/app/chisel-starter-theme/inc/Interfaces/InstanceInterface.php

@@ -12,5 +12,5 @@ interface InstanceInterface {
 	/**
 	 * Get the instance of the class.
 	 */
-	public static function get_instance();
+	public static function get_instance(): static;
 }

package/lib/commands/create/creators/app/chisel-starter-theme/inc/{Plugin → Plugins}/GravityForms.php

@@ -1,18 +1,18 @@
 <?php
 
-namespace Chisel\Plugin;
+namespace Chisel\Plugins;
 
 use Chisel\Interfaces\InstanceInterface;
 use Chisel\Interfaces\HooksInterface;
 use Chisel\Traits\Singleton;
-use Chisel\Helper\GravityFormsHelpers;
+use Chisel\Helpers\GravityFormsHelpers;
 
 /**
  * GravityForms related functionalities.
  *
  * @package Chisel
  */
-class GravityForms implements InstanceInterface, HooksInterface {
+final class GravityForms implements InstanceInterface, HooksInterface {
 
 	use Singleton;
 
@@ -33,19 +33,19 @@ class GravityForms implements InstanceInterface, HooksInterface {
 	/**
 	 * Set properties.
 	 */
-	public function set_properties() {}
+	public function set_properties(): void {}
 
 	/**
 	 * Register action hooks.
 	 */
-	public function action_hooks() {
+	public function action_hooks(): void {
 		add_action( 'wp_enqueue_scripts', array( $this, 'deregister_scripts' ), 999 );
 	}
 
 	/**
 	 * Register filter hooks.
 	 */
-	public function filter_hooks() {
+	public function filter_hooks(): void {
 		add_filter( 'chisel_frontend_footer_styles', array( $this, 'register_custom_styles' ) );
 		add_filter( 'chisel_enqueue_frontend_footer_style', array( $this, 'enqueue_custom_styles' ), 10, 3 );
 		add_filter( 'gform_form_theme_slug', array( $this, 'default_form_styles' ), 99, 2 );
@@ -55,7 +55,7 @@ class GravityForms implements InstanceInterface, HooksInterface {
 	/**
 	 * This function will deregister gforms specific scripts
 	 */
-	public function deregister_scripts() {
+	public function deregister_scripts(): void {
 		wp_dequeue_style( 'gforms_reset_css' );
 	}
 
@@ -66,7 +66,7 @@ class GravityForms implements InstanceInterface, HooksInterface {
 	 *
 	 * @return array
 	 */
-	public function register_custom_styles( $styles ) {
+	public function register_custom_styles( array $styles ): array {
 		$styles['gravity-forms'] = array();
 
 		return $styles;
@@ -81,14 +81,14 @@ class GravityForms implements InstanceInterface, HooksInterface {
 	 *
 	 * @return bool
 	 */
-	public function enqueue_custom_styles( $enqueue, $handle, $args ) {
+	public function enqueue_custom_styles( bool $enqueue, string $handle, array $args ): bool {
 		if ( $handle !== 'gravity-forms' ) {
 			return $enqueue;
 		}
 
 		global $post;
 
-		if ( $post ) {
+		if ( $post instanceof \WP_Post ) {
 			$enqueue = has_block( 'gravityforms/form', $post );
 		}
 
@@ -103,7 +103,7 @@ class GravityForms implements InstanceInterface, HooksInterface {
 	 *
 	 * @return string
 	 */
-	public function default_form_styles( $slug, $form ) {
+	public function default_form_styles( string $slug, array $form ): string {
 		if ( ! is_admin() ) {
 			$slug = 'gravity-theme';
 		}
@@ -118,10 +118,8 @@ class GravityForms implements InstanceInterface, HooksInterface {
 	 *
 	 * @return array
 	 */
-	public function plugin_settings_fields( $fields ) {
-		if ( isset( $fields['default_theme'] ) ) {
-			unset( $fields['default_theme'] );
-		}
+	public function plugin_settings_fields( array $fields ): array {
+		unset( $fields['default_theme'] );
 
 		return $fields;
 	}

package/lib/commands/create/creators/app/chisel-starter-theme/inc/{Plugin → Plugins}/Woocommerce.php

@@ -1,18 +1,18 @@
 <?php
 
-namespace Chisel\Plugin;
+namespace Chisel\Plugins;
 
 use Chisel\Interfaces\InstanceInterface;
 use Chisel\Interfaces\HooksInterface;
 use Chisel\Traits\Singleton;
-use Chisel\Helper\WoocommerceHelpers;
+use Chisel\Helpers\WoocommerceHelpers;
 
 /**
  * Class used to extend Timber functionality.
  *
  * @package Chisel
  */
-class Woocommerce implements InstanceInterface, HooksInterface {
+final class Woocommerce implements InstanceInterface, HooksInterface {
 
 	use Singleton;
 
@@ -40,7 +40,7 @@ class Woocommerce implements InstanceInterface, HooksInterface {
 	/**
 	 * Set properties.
 	 */
-	public function set_properties() {
+	public function set_properties(): void {
 		$this->sidebars = array(
 			'woocommerce' => array(
 				'name'        => __( 'Woocommerce', 'chisel' ),
@@ -52,7 +52,7 @@ class Woocommerce implements InstanceInterface, HooksInterface {
 	/**
 	 * Register action hooks.
 	 */
-	public function action_hooks() {
+	public function action_hooks(): void {
 		$this->remove_actions();
 
 		add_action( 'after_setup_theme', array( $this, 'add_woocommerce_support' ) );
@@ -66,7 +66,7 @@ class Woocommerce implements InstanceInterface, HooksInterface {
 	/**
 	 * Register filter hooks.
 	 */
-	public function filter_hooks() {
+	public function filter_hooks(): void {
 		add_filter( 'chisel_sidebars', array( $this, 'register_sidebars' ) );
 		add_filter( 'woocommerce_enqueue_styles', array( $this, 'enqueue_styles' ) );
 		add_filter( 'chisel_frontend_styles', array( $this, 'register_custom_styles' ) );
@@ -102,7 +102,7 @@ class Woocommerce implements InstanceInterface, HooksInterface {
 	/**
 	 * Add WooCommerce support.
 	 */
-	public function add_woocommerce_support() {
+	public function add_woocommerce_support(): void {
 		add_theme_support( 'woocommerce' );
 		add_theme_support( 'wc-product-gallery-zoom' );
 		add_theme_support( 'wc-product-gallery-lightbox' );
@@ -112,25 +112,25 @@ class Woocommerce implements InstanceInterface, HooksInterface {
 	/**
 	 * Open container for sort bar.
 	 */
-	public function before_shop_loop_div_open() {
+	public function before_shop_loop_div_open(): void {
 		echo '<div class="c-shop__sort"> ';
 	}
 
 	/**
 	 * Close container for sort bar.
 	 */
-	public function before_shop_loop_div_close() {
+	public function before_shop_loop_div_close(): void {
 		echo ' </div> ';
 	}
 
 	/**
 	 * Modify woocommerce customizer settings.
 	 *
-	 * @param WP_Customize_Manager $wp_customize
+	 * @param \WP_Customize_Manager $wp_customize
 	 *
 	 * @return void
 	 */
-	public function modify_customizer( $wp_customize ) {
+	public function modify_customizer( \WP_Customize_Manager $wp_customize ): void {
 		$shop_page_display_control     = $wp_customize->get_control( 'woocommerce_shop_page_display' );
 		$category_page_display_control = $wp_customize->get_control( 'woocommerce_category_archive_display' );
 
@@ -150,7 +150,7 @@ class Woocommerce implements InstanceInterface, HooksInterface {
 	 *
 	 * @return array
 	 */
-	public function register_sidebars( $sidebars ) {
+	public function register_sidebars( array $sidebars ): array {
 		$sidebars = array_merge( $sidebars, $this->sidebars );
 
 		return $sidebars;
@@ -163,7 +163,7 @@ class Woocommerce implements InstanceInterface, HooksInterface {
 	 *
 	 * @return array
 	 */
-	public function enqueue_styles( $enqueue_styles ) {
+	public function enqueue_styles( array $enqueue_styles ): array {
 		unset( $enqueue_styles['woocommerce-layout'] );
 
 		return $enqueue_styles;
@@ -177,7 +177,7 @@ class Woocommerce implements InstanceInterface, HooksInterface {
 	 *
 	 * @return array
 	 */
-	public function register_custom_styles( $styles ) {
+	public function register_custom_styles( array $styles ): array {
 		$styles['woocommerce'] = array();
 
 		return $styles;