Action: make getHighestGroupedAction obsoleted

* Mark getHighestGroupedAction() deprecated.
* Add ActionGateway::getHighestGrouped as a replacement.
* Rewrite all getHighestGroupedAction() into
  ActionGateway::getHighestGrouped() calls.

Author: yookoala

functions.php

@@ -22,6 +22,7 @@
 use Gibbon\Services\Format;
 use Gibbon\Contracts\Comms\Mailer;
 use Gibbon\Domain\Students\MedicalGateway;
+use Gibbon\Domain\System\ActionGateway;
 use Gibbon\Domain\System\AlertLevelGateway;
 use Gibbon\Domain\System\LogGateway;
 use Gibbon\Domain\System\SettingGateway;
@@ -377,7 +378,7 @@ function getPasswordPolicy($guid, $connection2)
 
 function getFastFinder($connection2, $guid)
 {
-    global $session;
+    global $session, $container;
     $form = Form::create('fastFinder', Url::fromHandlerRoute('indexFindRedirect.php'), 'get');
     $form->setClass('blank fullWidth');
 
@@ -396,7 +397,7 @@ function getFastFinder($connection2, $guid)
             ->addValidation('Validate.Presence', 'failureMessage: " "')
             ->append('<input type="submit" style="height:34px;padding:0 1rem;" value="'.__('Go').'">');
 
-    $highestActionClass = getHighestGroupedAction($guid, '/modules/Planner/planner.php', $connection2);
+    $highestActionClass = $container->get(ActionGateway::class)->getHighestGrouped('/modules/Planner/planner.php');
 
     $templateData = [
         'roleCategory'        => getRoleCategory($session->get('gibbonRoleIDCurrent'), $connection2),
@@ -777,7 +778,22 @@ function getHighestMedicalRisk($guid, $gibbonPersonID, $connection2)
     return $output;
 }
 
-//Looks at the grouped actions accessible to the user in the current module and returns the highest
+/**
+ * Looks at the grouped actions accessible to the user in the current
+ * module and returns the highest.
+ *
+ * @deprecated v25
+ *             Use ActionGateway::getHighestGrouped instead.
+ *
+ * @since    v12
+ * @version  v23
+ *
+ * @param string  $guid
+ * @param string  $address
+ * @param \PDO    $connection2
+ *
+ * @return string|false
+ */
 function getHighestGroupedAction($guid, $address, $connection2)
 {
     global $session;
@@ -905,7 +921,8 @@ function getAlertBar($guid, $connection2, $gibbonPersonID, $privacy = '', $divEx
 
     $target = ($target == "_blank") ? "_blank" : "_self";
 
-    $highestAction = getHighestGroupedAction($guid, '/modules/Students/student_view_details.php', $connection2);
+    /** @var string|false */
+    $highestAction = $container->get(ActionGateway::class)->getHighestGrouped('/modules/Students/student_view_details.php');
     if ($highestAction == 'View Student Profile_full' or $highestAction == 'View Student Profile_fullNoNotes' or $highestAction == 'View Student Profile_fullEditAllNotes') {
         // Individual Needs
         $dataAlert = array('gibbonPersonID' => $gibbonPersonID);

index_fastFinder_ajax.php

@@ -37,14 +37,17 @@
     // Cancel out early for empty searches
     if (empty($searchTerm)) die('[]');
 
+    /** @var ActionGateway */
+    $actionGateway = $container->get(ActionGateway::class);
+
     // Check access levels
     $studentIsAccessible = isActionAccessible($guid, $connection2, '/modules/students/student_view.php');
-    $highestActionStudent = getHighestGroupedAction($guid, '/modules/students/student_view.php', $connection2);
+    $highestActionStudent = $actionGateway->getHighestGrouped('/modules/students/student_view.php');
 
     $staffIsAccessible = isActionAccessible($guid, $connection2, '/modules/Staff/staff_view.php');
     $classIsAccessible = false;
     $alarmIsAccessible = isActionAccessible($guid, $connection2, '/modules/System Admin/alarm.php');
-    $highestActionClass = getHighestGroupedAction($guid, '/modules/Planner/planner.php', $connection2);
+    $highestActionClass = $actionGateway->getHighestGrouped('/modules/Planner/planner.php');
     if (isActionAccessible($guid, $connection2, '/modules/Planner/planner.php') and $highestActionClass != 'Lesson Planner_viewMyChildrensClasses') {
         $classIsAccessible = true;
     }
@@ -60,7 +63,7 @@
     } else {
         $actions = $session->get('fastFinderActions');
     }
-    
+
     if (!empty($actions) && is_array($actions)) {
         foreach ($actions as $action) {
             // Add actions that match the search query to the result set
@@ -145,12 +148,12 @@
                         WHEN gibbonPerson.studentID LIKE :search THEN concat(surname, ', ', preferredName, ' (', gibbonFormGroup.name, ', ', gibbonPerson.studentID, ')')
                         WHEN gibbonPerson.firstName LIKE :search AND firstName<>preferredName THEN concat(surname, ', ', firstName, ' \"', preferredName, '\" (', gibbonFormGroup.name, ')' )
                         ELSE concat(surname, ', ', preferredName, ' (', gibbonFormGroup.name, ')') END) AS name,
-                    NULL as type 
+                    NULL as type
                     FROM gibbonPerson, gibbonStudentEnrolment, gibbonFormGroup, gibbonFamilyChild, gibbonFamilyAdult
                     WHERE gibbonPerson.gibbonPersonID=gibbonStudentEnrolment.gibbonPersonID
-                    AND gibbonStudentEnrolment.gibbonFormGroupID=gibbonFormGroup.gibbonFormGroupID 
+                    AND gibbonStudentEnrolment.gibbonFormGroupID=gibbonFormGroup.gibbonFormGroupID
                     AND gibbonFamilyAdult.gibbonPersonID=:gibbonPersonID
-                    AND gibbonFamilyChild.gibbonPersonID=gibbonPerson.gibbonPersonID 
+                    AND gibbonFamilyChild.gibbonPersonID=gibbonPerson.gibbonPersonID
                     AND gibbonFamilyChild.gibbonFamilyID=gibbonFamilyAdult.gibbonFamilyID";
         }
         // Allow individuals to only search themselves
@@ -164,7 +167,7 @@
                     NULL as type
                     FROM gibbonPerson, gibbonStudentEnrolment, gibbonFormGroup
                     WHERE gibbonPerson.gibbonPersonID=gibbonStudentEnrolment.gibbonPersonID
-                    AND gibbonStudentEnrolment.gibbonFormGroupID=gibbonFormGroup.gibbonFormGroupID 
+                    AND gibbonStudentEnrolment.gibbonFormGroupID=gibbonFormGroup.gibbonFormGroupID
                     AND gibbonPerson.gibbonPersonID=:gibbonPersonID";
         }
         // Allow searching of all students

modules/Activities/activities_attendance.php

@@ -17,6 +17,7 @@
 along with this program. If not, see <http://www.gnu.org/licenses/>.
 */
 
+use Gibbon\Domain\System\ActionGateway;
 use Gibbon\Forms\Form;
 use Gibbon\Services\Format;
 
@@ -34,7 +35,7 @@
     echo __('Choose Activity');
     echo '</h2>';
 
-    $highestAction = getHighestGroupedAction($guid, '/modules/Activities/activities_attendance.php', $connection2);
+    $highestAction = $container->get(ActionGateway::class)->getHighestGrouped('/modules/Activities/activities_attendance.php');
     $gibbonActivityID = null;
     if (isset($_GET['gibbonActivityID'])) {
         $gibbonActivityID = $_GET['gibbonActivityID'];
@@ -180,7 +181,7 @@
 
         $form->addHiddenValue('address', $session->get('address'));
         $form->addHiddenValue('gibbonPersonID', $session->get('gibbonPersonID'));
-        
+
         if (isActionAccessible($guid, $connection2, '/modules/Activities/report_attendanceExport.php')) {
             $form->addHeaderAction('download', __('Export to Excel'))
                 ->setURL('/modules/Activities/report_attendanceExport.php')

modules/Activities/activities_attendanceProcess.php

@@ -17,6 +17,7 @@
 along with this program. If not, see <http://www.gnu.org/licenses/>.
 */
 use Gibbon\Data\Validator;
+use Gibbon\Domain\System\ActionGateway;
 
 require_once '../../gibbon.php';
 
@@ -34,7 +35,7 @@
 
     $gibbonPersonID = $_POST['gibbonPersonID'] ?? '';
 
-    $highestAction = getHighestGroupedAction($guid, '/modules/Activities/activities_attendance.php', $connection2);
+    $highestAction = $container->get(ActionGateway::class)->getHighestGrouped('/modules/Activities/activities_attendance.php');
 
     if($highestAction == "Enter Activity Attendance_leader") {
         try {

modules/Activities/activities_manage_enrolment.php

@@ -18,6 +18,7 @@
 */
 
 use Gibbon\Domain\School\SchoolYearTermGateway;
+use Gibbon\Domain\System\ActionGateway;
 use Gibbon\Domain\System\SettingGateway;
 use Gibbon\Forms\Form;
 use Gibbon\Services\Format;
@@ -33,7 +34,7 @@
     //Proceed!
     $gibbonActivityID = (isset($_GET['gibbonActivityID']))? $_GET['gibbonActivityID'] : null;
 
-    $highestAction = getHighestGroupedAction($guid, '/modules/Activities/activities_manage_enrolment.php', $connection2);
+    $highestAction = $container->get(ActionGateway::class)->getHighestGrouped('/modules/Activities/activities_manage_enrolment.php');
     if ($highestAction == 'My Activities_viewEditEnrolment') {
 
             $data = array('gibbonPersonID' => $gibbon->session->get('gibbonPersonID'), 'gibbonSchoolYearID' => $gibbon->session->get('gibbonSchoolYearID'), 'gibbonActivityID' => $gibbonActivityID);

modules/Activities/activities_manage_enrolment_add.php

@@ -18,6 +18,7 @@
 */
 
 use Gibbon\Domain\School\SchoolYearTermGateway;
+use Gibbon\Domain\System\ActionGateway;
 use Gibbon\Domain\System\SettingGateway;
 use Gibbon\Forms\Form;
 use Gibbon\Services\Format;
@@ -32,7 +33,7 @@
     //Proceed!
     $gibbonActivityID = (isset($_GET['gibbonActivityID']))? $_GET['gibbonActivityID'] : null;
 
-    $highestAction = getHighestGroupedAction($guid, '/modules/Activities/activities_manage_enrolment.php', $connection2);
+    $highestAction = $container->get(ActionGateway::class)->getHighestGrouped('/modules/Activities/activities_manage_enrolment.php');
     if ($highestAction == 'My Activities_viewEditEnrolment') {
         $data = array('gibbonPersonID' => $session->get('gibbonPersonID'), 'gibbonSchoolYearID' => $session->get('gibbonSchoolYearID'), 'gibbonActivityID' => $gibbonActivityID);
         $sql = "SELECT gibbonActivity.*, NULL as status, gibbonActivityStaff.role FROM gibbonActivity JOIN gibbonActivityStaff ON (gibbonActivity.gibbonActivityID=gibbonActivityStaff.gibbonActivityID) WHERE gibbonActivity.gibbonActivityID=:gibbonActivityID AND gibbonActivityStaff.gibbonPersonID=:gibbonPersonID AND gibbonActivityStaff.role='Organiser' AND gibbonSchoolYearID=:gibbonSchoolYearID AND active='Y' ORDER BY name";

modules/Activities/activities_manage_enrolment_delete.php

@@ -17,6 +17,7 @@
 along with this program. If not, see <http://www.gnu.org/licenses/>.
 */
 
+use Gibbon\Domain\System\ActionGateway;
 use Gibbon\Forms\Prefab\DeleteForm;
 
 if (isActionAccessible($guid, $connection2, '/modules/Activities/activities_manage_enrolment_delete.php') == false) {
@@ -26,7 +27,7 @@
     //Proceed!
     $gibbonActivityID = (isset($_GET['gibbonActivityID']))? $_GET['gibbonActivityID'] : null;
 
-    $highestAction = getHighestGroupedAction($guid, '/modules/Activities/activities_manage_enrolment.php', $connection2);
+    $highestAction = $container->get(ActionGateway::class)->getHighestGrouped('/modules/Activities/activities_manage_enrolment.php');
     if ($highestAction == 'My Activities_viewEditEnrolment') {
 
 

modules/Activities/activities_manage_enrolment_edit.php

@@ -18,6 +18,7 @@
 */
 
 use Gibbon\Domain\School\SchoolYearTermGateway;
+use Gibbon\Domain\System\ActionGateway;
 use Gibbon\Domain\System\SettingGateway;
 use Gibbon\Forms\Form;
 use Gibbon\Services\Format;
@@ -32,7 +33,7 @@
     //Proceed!
     $gibbonActivityID = (isset($_GET['gibbonActivityID']))? $_GET['gibbonActivityID'] : null;
 
-    $highestAction = getHighestGroupedAction($guid, '/modules/Activities/activities_manage_enrolment.php', $connection2);
+    $highestAction = $container->get(ActionGateway::class)->getHighestGrouped('/modules/Activities/activities_manage_enrolment.php');
     if ($highestAction == 'My Activities_viewEditEnrolment') {
 
 

modules/Activities/activities_my.php

@@ -20,6 +20,7 @@
 use Gibbon\Services\Format;
 use Gibbon\Tables\DataTable;
 use Gibbon\Domain\Activities\ActivityGateway;
+use Gibbon\Domain\System\ActionGateway;
 use Gibbon\Domain\System\SettingGateway;
 
 //Module includes
@@ -29,13 +30,13 @@
     // Access denied
     $page->addError(__('You do not have access to this action.'));
 } else {
-    $page->breadcrumbs->add(__('My Activities')); 
+    $page->breadcrumbs->add(__('My Activities'));
 
-    $highestAction = getHighestGroupedAction($guid, '/modules/Activities/activities_attendance.php', $connection2);
+    $highestAction = $container->get(ActionGateway::class)->getHighestGrouped('/modules/Activities/activities_attendance.php');
     $canAccessEnrolment = isActionAccessible($guid, $connection2, '/modules/Activities/activities_manage_enrolment.php');
 
     $activityGateway = $container->get(ActivityGateway::class);
-    
+
     // CRITERIA
     $criteria = $activityGateway->newQueryCriteria()
         ->sortBy('name')
@@ -75,7 +76,7 @@
                 ->isModal(1000, 550)
                 ->setURL('/modules/Activities/activities_my_full.php');
 
-            if ($highestAction == "Enter Activity Attendance" || 
+            if ($highestAction == "Enter Activity Attendance" ||
                ($highestAction == "Enter Activity Attendance_leader" && ($activity['role'] == 'Organiser' || $activity['role'] == 'Assistant' || $activity['role'] == 'Coach'))) {
                 $actions->addAction('attendance', __('Attendance'))
                     ->setIcon('attendance')

modules/Activities/activities_my_full.php

@@ -18,6 +18,7 @@
 */
 
 use Gibbon\Domain\School\SchoolYearTermGateway;
+use Gibbon\Domain\System\ActionGateway;
 use Gibbon\Domain\System\SettingGateway;
 use Gibbon\Services\Format;
 
@@ -31,7 +32,7 @@
     echo '</div>';
 } else {
     //Get action with highest precendence
-    $highestAction = getHighestGroupedAction($guid, $_GET['q'], $connection2);
+    $highestAction = $container->get(ActionGateway::class)->getHighestGrouped($_GET['q']);
     if ($highestAction == false) {
         echo "<div class='error'>";
         echo __('The highest grouped action cannot be determined.');