[ADVAPP-969]: Add the ability to merge the value in for the preferred…

… name of a student and prospect in engagement scenarios (#1103) * Add the ability to merge the value in for the preferred name of a student and prospect in engagement scenarios * chore: fix code style * Reference the correct model Signed-off-by: Kevin Ullyott <kevin.ullyott@canyongbs.com> --------- Signed-off-by: Kevin Ullyott <kevin.ullyott@canyongbs.com> Co-authored-by: ketan-canyon <ketan-canyon@users.noreply.github.com> Co-authored-by: Kevin Ullyott <kevin.ullyott@canyongbs.com>
canyongbs · Nov 6, 2024 · 77cb9ff · 77cb9ff
1 parent 0c44f07
commit 77cb9ff
Show file tree

Hide file tree

Showing 17 changed files with 26 additions and 0 deletions.
diff --git a/app-modules/campaign/src/Filament/Blocks/EngagementBatchEmailBlock.php b/app-modules/campaign/src/Filament/Blocks/EngagementBatchEmailBlock.php
@@ -83,6 +83,7 @@ public function generateFields(string $fieldPrefix = ''): array
                     'student last name',
                     'student full name',
                     'student email',
+                    'student preferred name',
                 ])
                 ->profile('email')
                 ->required()

diff --git a/app-modules/campaign/src/Filament/Blocks/EngagementBatchSmsBlock.php b/app-modules/campaign/src/Filament/Blocks/EngagementBatchSmsBlock.php
@@ -70,6 +70,7 @@ public function generateFields(string $fieldPrefix = ''): array
                         'student last name',
                         'student full name',
                         'student email',
+                        'student preferred name',
                     ]),
             ]),
             DateTimePicker::make('execute_at')

diff --git a/app-modules/engagement/src/Filament/Actions/BulkEngagementAction.php b/app-modules/engagement/src/Filament/Actions/BulkEngagementAction.php
@@ -95,6 +95,7 @@ public static function make(string $context)
                                 'student last name',
                                 'student full name',
                                 'student email',
+                                'student preferred name',
                             ])
                             ->showMergeTagsInBlocksPanel(false)
                             ->profile('email')

diff --git a/app-modules/engagement/src/Filament/Actions/SendEngagementAction.php b/app-modules/engagement/src/Filament/Actions/SendEngagementAction.php
@@ -92,6 +92,7 @@ protected function setUp(): void
                                 'student last name',
                                 'student full name',
                                 'student email',
+                                'student preferred name',
                             ])
                             ->profile('email')
                             ->required()

diff --git a/app-modules/engagement/src/Filament/ManageRelatedRecords/ManageRelatedEngagementRecords.php b/app-modules/engagement/src/Filament/ManageRelatedRecords/ManageRelatedEngagementRecords.php
@@ -164,6 +164,7 @@ public function form(Form $form): Form
                             'student last name',
                             'student full name',
                             'student email',
+                            'student preferred name',
                         ])
                         ->showMergeTagsInBlocksPanel(! ($form->getLivewire() instanceof RelationManager))
                         ->profile('email')

diff --git a/...les/engagement/src/Filament/Resources/EmailTemplateResource/Pages/CreateEmailTemplate.php b/...les/engagement/src/Filament/Resources/EmailTemplateResource/Pages/CreateEmailTemplate.php
@@ -69,6 +69,7 @@ public function form(Form $form): Form
                         'student last name',
                         'student full name',
                         'student email',
+                        'student preferred name',
                     ])
                     ->profile('email')
                     ->columnSpanFull()

diff --git a/...dules/engagement/src/Filament/Resources/EmailTemplateResource/Pages/EditEmailTemplate.php b/...dules/engagement/src/Filament/Resources/EmailTemplateResource/Pages/EditEmailTemplate.php
@@ -69,6 +69,7 @@ public function form(Form $form): Form
                         'student last name',
                         'student full name',
                         'student email',
+                        'student preferred name',
                     ])
                     ->profile('email')
                     ->columnSpanFull()

diff --git a/...es/engagement/src/Filament/Resources/EngagementResource/Fields/EngagementSmsBodyField.php b/...es/engagement/src/Filament/Resources/EngagementResource/Fields/EngagementSmsBodyField.php
@@ -64,6 +64,7 @@ public static function make(string $context, ?Form $form = null)
                 'student last name',
                 'student full name',
                 'student email',
+                'student preferred name',
             ])
             ->showMergeTagsInBlocksPanel(is_null($form) ? false : ! ($form->getLivewire() instanceof RelationManager))
             ->profile('sms')

diff --git a/app-modules/engagement/src/Filament/Resources/EngagementResource/Pages/CreateEngagement.php b/app-modules/engagement/src/Filament/Resources/EngagementResource/Pages/CreateEngagement.php
@@ -90,6 +90,7 @@ public function form(Form $form): Form
                                 'student last name',
                                 'student full name',
                                 'student email',
+                                'student preferred name',
                             ])
                             ->showMergeTagsInBlocksPanel(! ($form->getLivewire() instanceof RelationManager))
                             ->profile('email')

diff --git a/...modules/engagement/src/Filament/Resources/SmsTemplateResource/Pages/CreateSmsTemplate.php b/...modules/engagement/src/Filament/Resources/SmsTemplateResource/Pages/CreateSmsTemplate.php
@@ -70,6 +70,7 @@ public function form(Form $form): Form
                         'student last name',
                         'student full name',
                         'student email',
+                        'student preferred name',
                     ])
                     ->profile('sms')
                     ->columnSpanFull()

diff --git a/app-modules/engagement/src/Filament/Resources/SmsTemplateResource/Pages/EditSmsTemplate.php b/app-modules/engagement/src/Filament/Resources/SmsTemplateResource/Pages/EditSmsTemplate.php
@@ -68,6 +68,7 @@ public function form(Form $form): Form
                         'student last name',
                         'student full name',
                         'student email',
+                        'student preferred name',
                     ])
                     ->profile('sms')
                     ->columnSpanFull()

diff --git a/app-modules/engagement/src/Models/Engagement.php b/app-modules/engagement/src/Models/Engagement.php
@@ -224,6 +224,7 @@ public function getMergeData(): array
             'student last name' => $this->recipient->getAttribute($this->recipient->displayLastNameKey()),
             'student full name' => $this->recipient->getAttribute($this->recipient->displayNameKey()),
             'student email' => $this->recipient->getAttribute($this->recipient->displayEmailKey()),
+            'student preferred name' => $this->recipient->getAttribute($this->recipient->displayPreferredNameKey()),
         ];
     }
 
@@ -238,6 +239,7 @@ public static function getMergeTags(string $type): array
                 'student last name',
                 'student full name',
                 'student email',
+                'student preferred name',
             ],
             default => [],
         };

diff --git a/app-modules/form/src/Filament/Resources/FormResource/Pages/ManageFormEmailAutoReply.php b/app-modules/form/src/Filament/Resources/FormResource/Pages/ManageFormEmailAutoReply.php
@@ -99,6 +99,7 @@ public function form(FilamentForm $form): FilamentForm
                                 'student last name',
                                 'student full name',
                                 'student email',
+                                'student preferred name',
                             ])
                             ->profile('email')
                             ->required(fn (Get $get) => $get('is_enabled'))

diff --git a/app-modules/form/src/Models/FormEmailAutoReply.php b/app-modules/form/src/Models/FormEmailAutoReply.php
@@ -86,6 +86,7 @@ public function getMergeData(Student|Prospect|null $author): array
             'student last name' => $author->getAttribute($author->displayLastNameKey()),
             'student full name' => $author->getAttribute($author->displayNameKey()),
             'student email' => $author->getAttribute($author->displayEmailKey()),
+            'student preferred name' => $author->getAttribute($author->displayPreferredNameKey()),
         ];
     }
 }
diff --git a/app-modules/prospect/src/Models/Prospect.php b/app-modules/prospect/src/Models/Prospect.php
@@ -241,6 +241,11 @@ public static function displayLastNameKey(): string
         return 'last_name';
     }
 
+    public static function displayPreferredNameKey(): string
+    {
+        return 'preferred';
+    }
+
     public static function filamentResource(): string
     {
         return ProspectResource::class;

diff --git a/.../Filament/Resources/StudentResource/RelationManagers/StudentEngagementRelationManager.php b/.../Filament/Resources/StudentResource/RelationManagers/StudentEngagementRelationManager.php
@@ -164,6 +164,7 @@ public function form(Form $form): Form
                             'student last name',
                             'student full name',
                             'student email',
+                            'student preferred name',
                         ])
                         ->showMergeTagsInBlocksPanel(! ($form->getLivewire() instanceof RelationManager))
                         ->profile('email')

diff --git a/app-modules/student-data-model/src/Models/Student.php b/app-modules/student-data-model/src/Models/Student.php
@@ -177,6 +177,11 @@ public static function displayEmailKey(): string
         return 'email';
     }
 
+    public static function displayPreferredNameKey(): string
+    {
+        return 'preferred';
+    }
+
     public function serviceRequests(): MorphMany
     {
         return $this->morphMany(