Merge branch 'release/4.0.4' into v4

nystudio107 · Jun 18, 2024 · 5186842 · 5186842
2 parents 43a147c + c7bab6e
commit 5186842
Show file tree

Hide file tree

Showing 12 changed files with 1,229 additions and 330 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Typogrify Changelog
 
+## 4.0.4 - 2024.06.18
+### Added
+* Added `ServicesTrait` for the plugin service component registration
+
 ## 4.0.3 - 2024.03.27
 ### Fixed
 * Fixed a regression that happened when modernizing the `default_escape` functionality ([#86](https://github.com/nystudio107/craft-typogrify/issues/86))

diff --git a/LICENSE.md b/LICENSE.md
@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2022 nystudio107
+Copyright (c) nystudio107
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

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": "4.0.3",
+  "version": "4.0.4",
   "keywords": [
     "craft",
     "cms",

diff --git a/docs/package-lock.json b/docs/package-lock.json
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;