Merge branch 'release/5.0.1' into v5

nystudio107 · Jun 18, 2024 · 883b044 · 883b044
2 parents 2ee1efa + fe9c67a
commit 883b044
Show file tree

Hide file tree

Showing 10 changed files with 82 additions and 33 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Typogrify Changelog
 
+## 5.0.1 - 2024.06.18
+### Added
+* Added `ServicesTrait` for the plugin service component registration
+
 ## 5.0.0 - 2024.04.16
 ### Added
 * Stable release for Craft CMS 5

diff --git a/composer.json b/composer.json
@@ -2,7 +2,7 @@
   "name": "nystudio107/craft-typogrify",
   "description": "Typogrify prettifies your web typography by preventing ugly quotes and 'widows' and more",
   "type": "craft-plugin",
-  "version": "5.0.0",
+  "version": "5.0.1",
   "keywords": [
     "craft",
     "cms",

diff --git a/src/Typogrify.php b/src/Typogrify.php
@@ -1,11 +1,11 @@
 <?php
 /**
- * Typogrify plugin for Craft CMS 3.x
+ * Typogrify plugin for Craft CMS
  *
  * Typogrify prettifies your web typography by preventing ugly quotes and 'widows' and more
  *
  * @link      https://nystudio107.com/
- * @copyright Copyright (c) 2017 nystudio107
+ * @copyright Copyright (c) nystudio107
  */
 
 namespace nystudio107\typogrify;
@@ -15,7 +15,7 @@
 use craft\base\Plugin;
 use craft\web\twig\variables\CraftVariable;
 use nystudio107\typogrify\models\Settings;
-use nystudio107\typogrify\services\TypogrifyService;
+use nystudio107\typogrify\services\ServicesTrait;
 use nystudio107\typogrify\twigextensions\TypogrifyTwigExtension;
 use nystudio107\typogrify\variables\TypogrifyVariable;
 use yii\base\Event;
@@ -28,22 +28,26 @@
  * @since     1.0.0
  *
  * @property  Settings $settings
- * @property  TypogrifyService $typogrify
  */
 class Typogrify extends Plugin
 {
+    // Traits
+    // =========================================================================
+
+    use ServicesTrait;
+
     // Static Properties
     // =========================================================================
 
     /**
-     * @var Typogrify
+     * @var ?Typogrify
      */
-    public static $plugin;
+    public static ?Typogrify $plugin = null;
 
     /**
-     * @var TypogrifyVariable
+     * @var ?TypogrifyVariable
      */
-    public static $variable;
+    public static ?TypogrifyVariable $variable = null;
 
     // Public Properties
     // =========================================================================
@@ -65,18 +69,6 @@ class Typogrify extends Plugin
     // Public Methods
     // =========================================================================
 
-    /**
-     * @inheritdoc
-     */
-    public function __construct($id, $parent = null, array $config = [])
-    {
-        $config['components'] = [
-            'typogrify' => TypogrifyService::class,
-        ];
-
-        parent::__construct($id, $parent, $config);
-    }
-
     /**
      * @inheritdoc
      */

diff --git a/src/config.php b/src/config.php
@@ -1,11 +1,11 @@
 <?php
 /**
- * Typogrify plugin for Craft CMS 3.x
+ * Typogrify plugin for Craft CMS
  *
  * Typogrify prettifies your web typography by preventing ugly quotes and 'widows' and more
  *
  * @link      https://nystudio107.com/
- * @copyright Copyright (c) 2017 nystudio107
+ * @copyright Copyright (c) nystudio107
  */
 
 use PHP_Typography\Settings\Dash_Style;

diff --git a/src/models/Settings.php b/src/models/Settings.php
@@ -1,11 +1,11 @@
 <?php
 /**
- * Typogrify plugin for Craft CMS 3.x
+ * Typogrify plugin for Craft CMS
  *
  * Typogrify prettifies your web typography by preventing ugly quotes and 'widows' and more
  *
  * @link      https://nystudio107.com/
- * @copyright Copyright (c) 2017 nystudio107
+ * @copyright Copyright (c) nystudio107
  */
 
 namespace nystudio107\typogrify\models;

diff --git a/src/services/ServicesTrait.php b/src/services/ServicesTrait.php
@@ -0,0 +1,53 @@
+<?php
+/**
+ * Typogrify plugin for Craft CMS
+ *
+ * Typogrify prettifies your web typography by preventing ugly quotes and
+ * 'widows' and more
+ *
+ * @link      https://nystudio107.com/
+ * @copyright Copyright (c) nystudio107
+ */
+
+namespace nystudio107\typogrify\services;
+
+use yii\base\InvalidConfigException;
+
+/**
+ * @author    nystudio107
+ * @package   Typogrify
+ * @since     1.0.0
+ *
+ * @property  TypogrifyService $typogrify
+ */
+trait ServicesTrait
+{
+    // Public Static Methods
+    // =========================================================================
+
+    /**
+     * @inheritdoc
+     */
+    public static function config(): array
+    {
+        return [
+            'components' => [
+                'typogrify' => TypogrifyService::class,
+            ],
+        ];
+    }
+
+    // Public Methods
+    // =========================================================================
+
+    /**
+     * Returns the typogrify service
+     *
+     * @return TypogrifyService The typogrify service
+     * @throws InvalidConfigException
+     */
+    public function getTypogrify(): TypogrifyService
+    {
+        return $this->get('typogrify');
+    }
+}
diff --git a/src/services/TypogrifyService.php b/src/services/TypogrifyService.php
@@ -1,12 +1,12 @@
 <?php
 /**
- * Typogrify plugin for Craft CMS 3.x
+ * Typogrify plugin for Craft CMS
  *
  * Typogrify prettifies your web typography by preventing ugly quotes and
  * 'widows' and more
  *
  * @link      https://nystudio107.com/
- * @copyright Copyright (c) 2017 nystudio107
+ * @copyright Copyright (c) nystudio107
  */
 
 namespace nystudio107\typogrify\services;

diff --git a/src/translations/en/typogrify.php b/src/translations/en/typogrify.php
@@ -1,11 +1,11 @@
 <?php
 /**
- * Typogrify plugin for Craft CMS 3.x
+ * Typogrify plugin for Craft CMS
  *
  * Typogrify prettifies your web typography by preventing ugly quotes and 'widows' and more
  *
  * @link      https://nystudio107.com/
- * @copyright Copyright (c) 2017 nystudio107
+ * @copyright Copyright (c) nystudio107
  */
 
 /**

diff --git a/src/twigextensions/TypogrifyTwigExtension.php b/src/twigextensions/TypogrifyTwigExtension.php
@@ -1,11 +1,11 @@
 <?php
 /**
- * Typogrify plugin for Craft CMS 3.x
+ * Typogrify plugin for Craft CMS
  *
  * Typogrify prettifies your web typography by preventing ugly quotes and 'widows' and more
  *
  * @link      https://nystudio107.com/
- * @copyright Copyright (c) 2017 nystudio107
+ * @copyright Copyright (c) nystudio107
  */
 
 namespace nystudio107\typogrify\twigextensions;

diff --git a/src/variables/TypogrifyVariable.php b/src/variables/TypogrifyVariable.php
@@ -1,11 +1,11 @@
 <?php
 /**
- * Typogrify plugin for Craft CMS 3.x
+ * Typogrify plugin for Craft CMS
  *
  * Typogrify prettifies your web typography by preventing ugly quotes and 'widows' and more
  *
  * @link      https://nystudio107.com/
- * @copyright Copyright (c) 2017 nystudio107
+ * @copyright Copyright (c) nystudio107
  */
 
 namespace nystudio107\typogrify\variables;