Merge pull request #19 from eighteen73/feature/branded-emails

Added branded emails for non html and GF Notifications

Author: brettsmason

README.md

@@ -16,13 +16,21 @@ If necessary, you may install it manually by downloading a Zip archive from [Git
 
 ## Summary of Features
 
+### Branded Emails
+- Adds branding to emails that aren't set to be 'text/html'
+- Adds branding to Gravity Forms notification emails
+- When possible uses WooCommerce email branding for consistenty
+- Main email template can be overriden by copying `templates/branded-emails/email-template.php` into `yourtheme/orbit/branded-emails`
+- Email styles template can be overriden by copying `templates/branded-emails/email-styles.php` into `yourtheme/orbit/branded-emails`
+
 ### UI Cleanup
 
 - Remove unwanted items from the menu (with limited configuration)
 - Remove unwanted items from the toolbar (with limited configuration)
 - Remove unwanted dashboard widgets
 - Replace the login logo (configurable)
 - Remove the footer message in CMS
+- Adds an environment icon to indicate the configured environment type
 
 ### Security
 
@@ -53,22 +61,57 @@ If necessary, you may install it manually by downloading a Zip archive from [Git
 
 ## Available Filters
 
+### Branded Emails
+
+The following filters can be used to override default behaviour/values of branded email features.
+
+-   `orbit_enable_branded_emails`: Enable Orbit's branded emails feature. Default `true` (enabled).
+-   `orbit_branded_emails_header_logo`: Set the logo image in branded emails. Default `''` (empty).
+-   `orbit_branded_emails_background_color`: Set the background color of branded emails. Default `woocommerce_email_background_color || '#ffffff'`.
+-   `orbit_branded_emails_body_background_color`: Set the body background color of branded emails. Default `woocommerce_email_body_background_color || '#ffffff'`.
+-   `orbit_branded_emails_body_border_color`: Set the border color of branded emails. Default `var(--wp--custom--color--border) || '#edeff1'`.
+-   `orbit_branded_emails_body_text_color`: Set the body text color of branded emails. Default `woocommerce_email_text_color || var(--wp--preset--color--contrast) || '#3f474d'`.
+-   `orbit_branded_emails_link_color`: Set the link color of branded emails. Default `woocommerce_email_base_color || var(--wp--custom--color--link) || '#8549ff'`.
+-   `orbit_branded_emails_footer_text_color`: Set the footer text color of branded emails. Default `woocommerce_email_footer_text_color || var(--wp--preset--color--contrast) || '#3F474d'`.
+-   `orbit_branded_emails_font_family`: Set the font family of branded emails. Default `woocommerce_email_font_family || '"Helvetica Neue", Helvetica, Roboto, Arial, sans-serif'`.
+-   `orbit_branded_emails_logo_image_width`: Set the logo image width in branded emails. Default `woocommerce_email_header_image_width || 120`.
+
+### UI Cleanup
+
 The following filters can be used to override the default behavior of certain features. Set the filter to `true` to enable the feature, or `false` to disable it.
 
--   `orbit_enable_wordpress_updates`: Control the visibility of the WordPress updates item in the toolbar. Default `false` (hidden).
--   `orbit_enable_xmlrpc`: Enable or disable XML-RPC functionality. Default `false` (disabled).
--   `orbit_enable_user_caps_access`: Enable Orbit's user capability restrictions. Default `true` (enabled).
--   `orbit_enable_editor_caps_access`: Enable Orbit's editor capability restrictions. Default `true` (enabled).
--   `orbit_enable_gravity_forms_access`: Enable Orbit's Gravity Forms capability restrictions. Default `true` (enabled).
--   `orbit_enable_expose_wordpress_version`: Show or hide the WordPress version in the site's frontend markup. Default `false` (hidden).
--   `orbit_enable_admin_environment_name`: Control the display of the environment name in the admin area. Default `true` (enabled).
 -   `orbit_enable_menu_item_dashboard`: Control the visibility of the Dashboard menu item. Default `true` (visible).
 -   `orbit_enable_menu_item_posts`: Control the visibility of the Posts menu item. Default `true` (visible).
 -   `orbit_enable_menu_item_comments`: Control the visibility of the Comments menu item and toolbar item. Default `false` (hidden).
 -   `orbit_enable_toolbar_item_new_content`: Control the visibility of the "New Content" item in the toolbar. Default `true` (visible).
 -   `orbit_enable_login_logo`: Enable replacement of the login logo. Default `true` (enabled).
 -   `orbit_login_logo_url`: Provide a URL to replace the default WordPress login logo. No default.
+-   `orbit_enable_admin_environment_name`: Control the display of the environment name in the admin area. Default `true` (enabled).
+
+### Security
+
+The following filters can be used to override the default behavior of certain features. Set the filter to `true` to enable the feature, or `false` to disable it.
+
 -   `orbit_enable_rest_api_user_endpoints`: Enable or disable REST API user endpoints. Default `false` (disabled).
+-   `orbit_enable_xmlrpc`: Enable or disable XML-RPC functionality. Default `false` (disabled).
+-   `orbit_enable_expose_wordpress_version`: Show or hide the WordPress version in the site's frontend markup. Default `false` (hidden).
+
+### Capabilities
+
+The following filters can be used to override the default behavior of certain features. Set the filter to `true` to enable the feature, or `false` to disable it.
+
+-   `orbit_enable_user_caps_access`: Enable Orbit's user capability restrictions. Default `true` (enabled).
+-   `orbit_enable_editor_caps_access`: Enable Orbit's editor capability restrictions. Default `true` (enabled).
+-   `orbit_enable_gravity_forms_access`: Enable Orbit's Gravity Forms capability restrictions. Default `true` (enabled).
+
+### Other Safety Measures
+
+The following filters can be used to override the default behavior of certain features. Set the filter to `true` to enable the feature, or `false` to disable it.
+
+-   `orbit_enable_wordpress_updates`: Control the visibility of the WordPress updates item in the toolbar. Default `false` (hidden).
+
+### Other Features
+
 -   `orbit_remote_files_url`: Override the production URL used for loading remote media files. Default value comes from `ORBIT_REMOTE_FILES_URL`.
 
 ### Examples

autoload.php

@@ -16,6 +16,7 @@
 	function ( $class ) {
 		$namspaces = [
 			'Eighteen73\\Orbit\\' => __DIR__ . '/includes/classes/',
+			'Eighteen73\\Orbit\\Dependencies\\' => __DIR__ . '/includes/dependencies/',
 		];
 		foreach ( $namspaces as $prefix => $base_dir ) {
 			$len = strlen( $prefix );

composer.json

@@ -5,7 +5,8 @@
 	"license": "MIT",
 	"minimum-stability": "stable",
 	"require": {
-		"php": ">=8.0"
+		"php": ">=8.0",
+		"pelago/emogrifier": "^8.0"
 	},
 	"autoload": {
 		"psr-4": {
@@ -18,11 +19,31 @@
 		}
 	},
 	"require-dev": {
-		"eighteen73/wordpress-coding-standards": "^2.0.0"
+		"eighteen73/wordpress-coding-standards": "^2.0.0",
+		"coenjacobs/mozart": "^0.7.1"
 	},
+  "extra": {
+    "mozart": {
+        "dep_namespace": "Eighteen73\\Orbit\\Dependencies\\",
+        "dep_directory": "/includes/Dependencies/",
+        "classmap_directory": "/includes/classes/dependencies/",
+        "classmap_prefix": "Eighteen73_Orbit_",
+        "packages": [
+            "pelago/emogrifier"
+        ]
+    }
+  },
   "scripts": {
     "test": [
       "phpcs"
+    ],
+    "post-install-cmd": [
+        "\"vendor/bin/mozart\" compose",
+        "composer dump-autoload"
+    ],
+    "post-update-cmd": [
+        "\"vendor/bin/mozart\" compose",
+        "composer dump-autoload"
     ]
   }
 }

includes/Dependencies/Pelago/Emogrifier/Caching/SimpleStringCache.php

@@ -0,0 +1,87 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Eighteen73\Orbit\Dependencies\Pelago\Emogrifier\Caching;
+
+/**
+ * This cache caches string values with string keys. It is not PSR-6-compliant.
+ *
+ * Usage:
+ *
+ * ```php
+ * $cache = new SimpleStringCache();
+ * $cache->set($key, $value);
+ * …
+ * if ($cache->has($key) {
+ *     $cachedValue = $cache->get($value);
+ * }
+ * ```
+ *
+ * @internal
+ */
+final class SimpleStringCache
+{
+    /**
+     * @var array<string, string>
+     */
+    private $values = [];
+
+    /**
+     * Checks whether there is an entry stored for the given key.
+     *
+     * @param string $key the key to check; must not be empty
+     *
+     * @throws \InvalidArgumentException
+     */
+    public function has(string $key): bool
+    {
+        $this->assertNotEmptyKey($key);
+
+        return isset($this->values[$key]);
+    }
+
+    /**
+     * Returns the entry stored for the given key, and throws an exception if the value does not exist
+     * (which helps keep the return type simple).
+     *
+     * @param string $key the key to of the item to retrieve; must not be empty
+     *
+     * @return string the retrieved value; may be empty
+     *
+     * @throws \BadMethodCallException
+     */
+    public function get(string $key): string
+    {
+        if (!$this->has($key)) {
+            throw new \BadMethodCallException('You can only call `get` with a key for an existing value.', 1625996246);
+        }
+
+        return $this->values[$key];
+    }
+
+    /**
+     * Sets or overwrites an entry.
+     *
+     * @param string $key the key to of the item to set; must not be empty
+     * @param string $value the value to set; can be empty
+     *
+     * @throws \BadMethodCallException
+     */
+    public function set(string $key, string $value): void
+    {
+        $this->assertNotEmptyKey($key);
+
+        $this->values[$key] = $value;
+    }
+
+    /**
+     * @throws \InvalidArgumentException
+     */
+    private function assertNotEmptyKey(string $key): void
+    {
+        if ($key === '') {
+            throw new \InvalidArgumentException('Please provide a non-empty key.', 1625995840);
+        }
+    }
+}