Add email automation system for customer segments (#326)

Author: fballiano

.phpstorm.meta.php/blocks.meta.php

@@ -994,9 +994,15 @@
         'customersegmentation/adminhtml_segment_edit_form' => \Maho_CustomerSegmentation_Block_Adminhtml_Segment_Edit_Form::class,
         'customersegmentation/adminhtml_segment_edit_tab_conditions' => \Maho_CustomerSegmentation_Block_Adminhtml_Segment_Edit_Tab_Conditions::class,
         'customersegmentation/adminhtml_segment_edit_tab_customers' => \Maho_CustomerSegmentation_Block_Adminhtml_Segment_Edit_Tab_Customers::class,
+        'customersegmentation/adminhtml_segment_edit_tab_emailautomation' => \Maho_CustomerSegmentation_Block_Adminhtml_Segment_Edit_Tab_EmailAutomation::class,
+        'customersegmentation/adminhtml_segment_edit_tab_emailsequences_renderer_delay' => \Maho_CustomerSegmentation_Block_Adminhtml_Segment_Edit_Tab_EmailSequences_Renderer_Delay::class,
+        'customersegmentation/adminhtml_segment_edit_tab_emailsequencesenter' => \Maho_CustomerSegmentation_Block_Adminhtml_Segment_Edit_Tab_EmailSequencesEnter::class,
+        'customersegmentation/adminhtml_segment_edit_tab_emailsequencesexit' => \Maho_CustomerSegmentation_Block_Adminhtml_Segment_Edit_Tab_EmailSequencesExit::class,
         'customersegmentation/adminhtml_segment_edit_tab_general' => \Maho_CustomerSegmentation_Block_Adminhtml_Segment_Edit_Tab_General::class,
         'customersegmentation/adminhtml_segment_edit_tabs' => \Maho_CustomerSegmentation_Block_Adminhtml_Segment_Edit_Tabs::class,
         'customersegmentation/adminhtml_segment_grid' => \Maho_CustomerSegmentation_Block_Adminhtml_Segment_Grid::class,
+        'customersegmentation/adminhtml_segment_sequence_edit' => \Maho_CustomerSegmentation_Block_Adminhtml_Segment_Sequence_Edit::class,
+        'customersegmentation/adminhtml_segment_sequence_edit_form' => \Maho_CustomerSegmentation_Block_Adminhtml_Segment_Sequence_Edit_Form::class,
         'directory/adminhtml_country' => \Mage_Directory_Block_Adminhtml_Country::class,
         'directory/adminhtml_country_edit' => \Mage_Directory_Block_Adminhtml_Country_Edit::class,
         'directory/adminhtml_country_edit_form' => \Mage_Directory_Block_Adminhtml_Country_Edit_Form::class,
@@ -2301,9 +2307,15 @@
         'customersegmentation/adminhtml_segment_edit_form' => \Maho_CustomerSegmentation_Block_Adminhtml_Segment_Edit_Form::class,
         'customersegmentation/adminhtml_segment_edit_tab_conditions' => \Maho_CustomerSegmentation_Block_Adminhtml_Segment_Edit_Tab_Conditions::class,
         'customersegmentation/adminhtml_segment_edit_tab_customers' => \Maho_CustomerSegmentation_Block_Adminhtml_Segment_Edit_Tab_Customers::class,
+        'customersegmentation/adminhtml_segment_edit_tab_emailautomation' => \Maho_CustomerSegmentation_Block_Adminhtml_Segment_Edit_Tab_EmailAutomation::class,
+        'customersegmentation/adminhtml_segment_edit_tab_emailsequences_renderer_delay' => \Maho_CustomerSegmentation_Block_Adminhtml_Segment_Edit_Tab_EmailSequences_Renderer_Delay::class,
+        'customersegmentation/adminhtml_segment_edit_tab_emailsequencesenter' => \Maho_CustomerSegmentation_Block_Adminhtml_Segment_Edit_Tab_EmailSequencesEnter::class,
+        'customersegmentation/adminhtml_segment_edit_tab_emailsequencesexit' => \Maho_CustomerSegmentation_Block_Adminhtml_Segment_Edit_Tab_EmailSequencesExit::class,
         'customersegmentation/adminhtml_segment_edit_tab_general' => \Maho_CustomerSegmentation_Block_Adminhtml_Segment_Edit_Tab_General::class,
         'customersegmentation/adminhtml_segment_edit_tabs' => \Maho_CustomerSegmentation_Block_Adminhtml_Segment_Edit_Tabs::class,
         'customersegmentation/adminhtml_segment_grid' => \Maho_CustomerSegmentation_Block_Adminhtml_Segment_Grid::class,
+        'customersegmentation/adminhtml_segment_sequence_edit' => \Maho_CustomerSegmentation_Block_Adminhtml_Segment_Sequence_Edit::class,
+        'customersegmentation/adminhtml_segment_sequence_edit_form' => \Maho_CustomerSegmentation_Block_Adminhtml_Segment_Sequence_Edit_Form::class,
         'directory/adminhtml_country' => \Mage_Directory_Block_Adminhtml_Country::class,
         'directory/adminhtml_country_edit' => \Mage_Directory_Block_Adminhtml_Country_Edit::class,
         'directory/adminhtml_country_edit_form' => \Mage_Directory_Block_Adminhtml_Country_Edit_Form::class,

.phpstorm.meta.php/helpers.meta.php

@@ -39,6 +39,7 @@
         'configurableswatches/productlist' => \Mage_ConfigurableSwatches_Helper_Productlist::class,
         'configurableswatches/swatchdimensions' => \Mage_ConfigurableSwatches_Helper_Swatchdimensions::class,
         'currencysymbol/data' => \Mage_CurrencySymbol_Helper_Data::class,
+        'customersegmentation/coupon' => \Maho_CustomerSegmentation_Helper_Coupon::class,
         'customersegmentation/data' => \Maho_CustomerSegmentation_Helper_Data::class,
         'giftmessage/data' => \Mage_GiftMessage_Helper_Data::class,
         'giftmessage/message' => \Mage_GiftMessage_Helper_Message::class,

.phpstorm.meta.php/models.meta.php

@@ -1138,9 +1138,15 @@
         'customer_resource/group_collection' => \Mage_Customer_Model_Resource_Group_Collection::class,
         'customer_resource/setup' => \Mage_Customer_Model_Resource_Setup::class,
         'customersegmentation/cron' => \Maho_CustomerSegmentation_Model_Cron::class,
+        'customersegmentation/emailsequence' => \Maho_CustomerSegmentation_Model_EmailSequence::class,
+        'customersegmentation/observer_emailautomation' => \Maho_CustomerSegmentation_Model_Observer_EmailAutomation::class,
         'customersegmentation/observer_pricerule' => \Maho_CustomerSegmentation_Model_Observer_PriceRule::class,
+        'customersegmentation/resource_emailsequence' => \Maho_CustomerSegmentation_Model_Resource_EmailSequence::class,
+        'customersegmentation/resource_emailsequence_collection' => \Maho_CustomerSegmentation_Model_Resource_EmailSequence_Collection::class,
         'customersegmentation/resource_segment' => \Maho_CustomerSegmentation_Model_Resource_Segment::class,
         'customersegmentation/resource_segment_collection' => \Maho_CustomerSegmentation_Model_Resource_Segment_Collection::class,
+        'customersegmentation/resource_sequenceprogress' => \Maho_CustomerSegmentation_Model_Resource_SequenceProgress::class,
+        'customersegmentation/resource_sequenceprogress_collection' => \Maho_CustomerSegmentation_Model_Resource_SequenceProgress_Collection::class,
         'customersegmentation/rule_condition_segment' => \Maho_CustomerSegmentation_Model_Rule_Condition_Segment::class,
         'customersegmentation/segment' => \Maho_CustomerSegmentation_Model_Segment::class,
         'customersegmentation/segment_condition_abstract' => \Maho_CustomerSegmentation_Model_Segment_Condition_Abstract::class,
@@ -1156,8 +1162,13 @@
         'customersegmentation/segment_condition_order_items' => \Maho_CustomerSegmentation_Model_Segment_Condition_Order_Items::class,
         'customersegmentation/segment_condition_product_viewed' => \Maho_CustomerSegmentation_Model_Segment_Condition_Product_Viewed::class,
         'customersegmentation/segment_condition_product_wishlist' => \Maho_CustomerSegmentation_Model_Segment_Condition_Product_Wishlist::class,
+        'customersegmentation/sequenceprogress' => \Maho_CustomerSegmentation_Model_SequenceProgress::class,
+        'customersegmentation_resource/emailsequence' => \Maho_CustomerSegmentation_Model_Resource_EmailSequence::class,
+        'customersegmentation_resource/emailsequence_collection' => \Maho_CustomerSegmentation_Model_Resource_EmailSequence_Collection::class,
         'customersegmentation_resource/segment' => \Maho_CustomerSegmentation_Model_Resource_Segment::class,
         'customersegmentation_resource/segment_collection' => \Maho_CustomerSegmentation_Model_Resource_Segment_Collection::class,
+        'customersegmentation_resource/sequenceprogress' => \Maho_CustomerSegmentation_Model_Resource_SequenceProgress::class,
+        'customersegmentation_resource/sequenceprogress_collection' => \Maho_CustomerSegmentation_Model_Resource_SequenceProgress_Collection::class,
         'dataflow/batch' => \Mage_Dataflow_Model_Batch::class,
         'dataflow/batch_abstract' => \Mage_Dataflow_Model_Batch_Abstract::class,
         'dataflow/batch_export' => \Mage_Dataflow_Model_Batch_Export::class,
@@ -3715,9 +3726,15 @@
         'customer_resource/group_collection' => \Mage_Customer_Model_Resource_Group_Collection::class,
         'customer_resource/setup' => \Mage_Customer_Model_Resource_Setup::class,
         'customersegmentation/cron' => \Maho_CustomerSegmentation_Model_Cron::class,
+        'customersegmentation/emailsequence' => \Maho_CustomerSegmentation_Model_EmailSequence::class,
+        'customersegmentation/observer_emailautomation' => \Maho_CustomerSegmentation_Model_Observer_EmailAutomation::class,
         'customersegmentation/observer_pricerule' => \Maho_CustomerSegmentation_Model_Observer_PriceRule::class,
+        'customersegmentation/resource_emailsequence' => \Maho_CustomerSegmentation_Model_Resource_EmailSequence::class,
+        'customersegmentation/resource_emailsequence_collection' => \Maho_CustomerSegmentation_Model_Resource_EmailSequence_Collection::class,
         'customersegmentation/resource_segment' => \Maho_CustomerSegmentation_Model_Resource_Segment::class,
         'customersegmentation/resource_segment_collection' => \Maho_CustomerSegmentation_Model_Resource_Segment_Collection::class,
+        'customersegmentation/resource_sequenceprogress' => \Maho_CustomerSegmentation_Model_Resource_SequenceProgress::class,
+        'customersegmentation/resource_sequenceprogress_collection' => \Maho_CustomerSegmentation_Model_Resource_SequenceProgress_Collection::class,
         'customersegmentation/rule_condition_segment' => \Maho_CustomerSegmentation_Model_Rule_Condition_Segment::class,
         'customersegmentation/segment' => \Maho_CustomerSegmentation_Model_Segment::class,
         'customersegmentation/segment_condition_abstract' => \Maho_CustomerSegmentation_Model_Segment_Condition_Abstract::class,
@@ -3733,8 +3750,13 @@
         'customersegmentation/segment_condition_order_items' => \Maho_CustomerSegmentation_Model_Segment_Condition_Order_Items::class,
         'customersegmentation/segment_condition_product_viewed' => \Maho_CustomerSegmentation_Model_Segment_Condition_Product_Viewed::class,
         'customersegmentation/segment_condition_product_wishlist' => \Maho_CustomerSegmentation_Model_Segment_Condition_Product_Wishlist::class,
+        'customersegmentation/sequenceprogress' => \Maho_CustomerSegmentation_Model_SequenceProgress::class,
+        'customersegmentation_resource/emailsequence' => \Maho_CustomerSegmentation_Model_Resource_EmailSequence::class,
+        'customersegmentation_resource/emailsequence_collection' => \Maho_CustomerSegmentation_Model_Resource_EmailSequence_Collection::class,
         'customersegmentation_resource/segment' => \Maho_CustomerSegmentation_Model_Resource_Segment::class,
         'customersegmentation_resource/segment_collection' => \Maho_CustomerSegmentation_Model_Resource_Segment_Collection::class,
+        'customersegmentation_resource/sequenceprogress' => \Maho_CustomerSegmentation_Model_Resource_SequenceProgress::class,
+        'customersegmentation_resource/sequenceprogress_collection' => \Maho_CustomerSegmentation_Model_Resource_SequenceProgress_Collection::class,
         'dataflow/batch' => \Mage_Dataflow_Model_Batch::class,
         'dataflow/batch_abstract' => \Mage_Dataflow_Model_Batch_Abstract::class,
         'dataflow/batch_export' => \Mage_Dataflow_Model_Batch_Export::class,

.phpstorm.meta.php/registry.meta.php

@@ -27,6 +27,7 @@
         current_customer,
         current_customer_segment,
         current_dataflow_session_id,
+        current_email_sequence,
         current_email_template,
         current_entity_key,
         current_group,

.phpstorm.meta.php/resource_models.meta.php

@@ -236,8 +236,12 @@
         'customer_resource/group' => \Mage_Customer_Model_Resource_Group::class,
         'customer_resource/group_collection' => \Mage_Customer_Model_Resource_Group_Collection::class,
         'customer_resource/setup' => \Mage_Customer_Model_Resource_Setup::class,
+        'customersegmentation_resource/emailsequence' => \Maho_CustomerSegmentation_Model_Resource_EmailSequence::class,
+        'customersegmentation_resource/emailsequence_collection' => \Maho_CustomerSegmentation_Model_Resource_EmailSequence_Collection::class,
         'customersegmentation_resource/segment' => \Maho_CustomerSegmentation_Model_Resource_Segment::class,
         'customersegmentation_resource/segment_collection' => \Maho_CustomerSegmentation_Model_Resource_Segment_Collection::class,
+        'customersegmentation_resource/sequenceprogress' => \Maho_CustomerSegmentation_Model_Resource_SequenceProgress::class,
+        'customersegmentation_resource/sequenceprogress_collection' => \Maho_CustomerSegmentation_Model_Resource_SequenceProgress_Collection::class,
         'dataflow_resource/batch' => \Mage_Dataflow_Model_Resource_Batch::class,
         'dataflow_resource/batch_abstract' => \Mage_Dataflow_Model_Resource_Batch_Abstract::class,
         'dataflow_resource/batch_collection' => \Mage_Dataflow_Model_Resource_Batch_Collection::class,

.rector.php

@@ -29,6 +29,7 @@
         CodeQuality\Ternary\SimplifyTautologyTernaryRector::class,
         DeadCode\ClassMethod\RemoveUselessParamTagRector::class,
         DeadCode\ClassMethod\RemoveUselessReturnTagRector::class,
+        DeadCode\MethodCall\RemoveNullArgOnNullDefaultParamRector::class,
         DeadCode\Property\RemoveUselessVarTagRector::class,
         Rector\CodingStyle\Rector\FuncCall\ConsistentImplodeRector::class,
         Rector\Php71\Rector\List_\ListToArrayDestructRector::class,
@@ -43,4 +44,4 @@
         'sensitive_parameters' => [
             'apiKey', 'email', 'useremail', 'username', 'password'
         ],
-    ]);
+    ]);

CLAUDE.md

@@ -142,6 +142,7 @@ try {
 - **NEVER use Varien_Date or Zend_Date** - Use native PHP DateTime and `Mage_Core_Model_Locale` methods.
 - **NEVER use Zend_Db or Zend_Db_Select directly** - Use `Maho\Db\Select` and `Maho\Db\Adapter\AdapterInterface`.
 - **NEVER use Varien_ prefixed classes in new code** - All Varien classes have been moved to the Maho namespace. Use the new `Maho\*` classes instead (see Varien Migration section below).
+- **NEVER use TinyMCE** - It has been completely removed from Maho. Use TipTap 3.x (see WYSIWYG Editor section below).
 
 ### General Guidelines
 - When you write CSS, use the most modern features, do not care for Internet Explorer or old unsupported browsers.
@@ -338,6 +339,21 @@ new Maho\Io\File();
 new Maho\Event\Observer();
 ```
 
+### WYSIWYG Editor (TipTap 3.x)
+
+**Configuration Location:**
+- Extensions: `public/js/mage/adminhtml/wysiwyg/tiptap/extensions.js`
+- Setup: `public/js/mage/adminhtml/wysiwyg/tiptap/setup.js`
+- Styles: `public/js/mage/adminhtml/wysiwyg/tiptap/tiptap.css`
+
+**Features:**
+- All nodes support `class` and `style` attributes
+- Custom Maho extensions for widgets, images, and slideshows
+- Directive support for `{{widget}}` and `{{config}}` syntax
+- HTML5 content conversion to/from plain text
+- Table editing with bubble menu
+- Fullscreen mode
+
 ### Other Components
 
 - **Exceptions**: Use `Mage_Core_Exception` (Zend_Exception removed)

app/code/core/Mage/Admin/Model/Config.php

@@ -77,7 +77,7 @@ public function loadAclResources(Mage_Admin_Model_Acl $acl, $resource = null, $p
         }
 
         if (isset($resource->all)) {
-            $acl->addResource(Mage::getModel('admin/acl_resource', 'all'), null);
+            $acl->addResource(Mage::getModel('admin/acl_resource', 'all'));
         }
 
         if (isset($resource->admin)) {

app/code/core/Mage/Admin/Model/Observer.php

@@ -54,7 +54,7 @@ public function actionPreDispatchAdmin($observer)
                         $password = $postLogin['password'] ?? '';
                         $twofaVerificationCode = $postLogin['twofa_verification_code'] ?? '';
                         $session->login($username, $password, $request, $twofaVerificationCode);
-                        $request->setPost('login', null);
+                        $request->setPost('login');
                     } else {
                         if (!$request->getParam('messageSent')) {
                             Mage::getSingleton('adminhtml/session')->addError(

app/code/core/Mage/Admin/Model/User.php

@@ -885,10 +885,10 @@ public function isResetPasswordLinkTokenExpired()
      */
     public function cleanPasswordsValidationData()
     {
-        $this->setData('password', null);
-        $this->setData('current_password', null);
-        $this->setData('new_password', null);
-        $this->setData('password_confirmation', null);
+        $this->setData('password');
+        $this->setData('current_password');
+        $this->setData('new_password');
+        $this->setData('password_confirmation');
         return $this;
     }
 
@@ -970,7 +970,7 @@ public function getTwofaSecret(): ?string
     public function setTwofaSecret(#[\SensitiveParameter] ?string $secret): self
     {
         if ($secret === null) {
-            $this->setData('twofa_secret', null);
+            $this->setData('twofa_secret');
         } else {
             $encrypted = Mage::helper('core')->getEncryptor()->encrypt($secret);
             $this->setData('twofa_secret', $encrypted);