Fix visibility of the method Controller::getAccessRules() (#6635)

* Fix visibility of the method `Controller::getAccessRules()` * Update php-test.yml --------- Co-authored-by: Lucas Bartholemy <luke-@users.noreply.github.com>
2025-01-16 21:58:17 +01:00 · 2023-10-28 14:06:21 +02:00 · 2023-10-28 14:06:21 +02:00 · 225f5da4b4
commit 225f5da4b4
parent 04937ececb
37 changed files with 72 additions and 62 deletions
--- a/.github/workflows/php-test.yml
+++ b/.github/workflows/php-test.yml
@ -57,7 +57,7 @@ jobs:
        steps:
            - name: Start Selenium
              run: |
-                docker run --detach --net=host --shm-size="2g" selenium/standalone-chrome
+                docker run --detach --net=host --shm-size="2g" selenium/standalone-chrome:117.0-20230926

            - uses: actions/checkout@v2
            - uses: actions/setup-node@v1
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@ -9,6 +9,7 @@ HumHub Changelog
 - Fix #6615: Improve scrolling to anchor with fixed header
 - Fix #6629: Fix visibility of new message counter on space chooser
 - Fix #6630: Fix visibility of top sorted stream entries on dashboard from external filters
+- Fix #6635: Fix visibility of the method `Controller::getAccessRules()`

 1.14.4 (September 20, 2023)
 ---------------------------
--- a/protected/humhub/components/behaviors/AccessControl.php
+++ b/protected/humhub/components/behaviors/AccessControl.php
@ -24,7 +24,7 @@ use yii\web\HttpException;
 * Disable guest access for all controller actions:
 *
 * ```php
- * public function getAccessRules()
+ * protected function getAccessRules()
 * {
 *     return [
 *          ['login']
@ -35,7 +35,7 @@ use yii\web\HttpException;
 * Disable guest access for specific controller actions:
 *
 * ```php
- * public function getAccessRules()
+ * protected function getAccessRules()
 * {
 *     return [
 *          ['login' => ['action1', 'action2']]
@ -46,7 +46,7 @@ use yii\web\HttpException;
 * All users have to be logged in + additional permission check for 'action1' and 'action2':
 *
 * ```php
- * public function getAccessRules()
+ * protected function getAccessRules()
 * {
 *     return [
 *          ['login'],
@ -58,7 +58,7 @@ use yii\web\HttpException;
 * Custom inline validator for action 'action1':
 *
 * ```php
- * public function getAccessRules()
+ * protected function getAccessRules()
 * {
 *     return [
 *          ['validateMyCustomRule', 'someParameter' => 'someValue', 'actions' => ['action1']]
--- a/protected/humhub/controllers/OembedController.php
+++ b/protected/humhub/controllers/OembedController.php
@ -22,7 +22,7 @@ class OembedController extends Controller
    /**
     * @inheritdoc
     */
-    public function getAccessRules()
+    protected function getAccessRules()
    {
        return [['login']];
    }
--- a/protected/humhub/modules/activity/controllers/AdminController.php
+++ b/protected/humhub/modules/activity/controllers/AdminController.php
@ -25,7 +25,7 @@ class AdminController extends Controller
    /**
     * @inheritdoc
     */
-    public function getAccessRules()
+    protected function getAccessRules()
    {
        return [
            ['permissions' => ManageSettings::class],
--- a/protected/humhub/modules/admin/controllers/ApprovalController.php
+++ b/protected/humhub/modules/admin/controllers/ApprovalController.php
@ -39,13 +39,13 @@ class ApprovalController extends Controller
    {
        $this->subLayout = '@admin/views/layouts/user';
        $this->appendPageTitle(Yii::t('AdminModule.base', 'Approval'));
-        return parent::init();
+        parent::init();
    }

    /**
     * @inheritdoc
     */
-    public function getAccessRules()
+    protected function getAccessRules()
    {
        return [
            [ControllerAccess::RULE_LOGGED_IN_ONLY],
--- a/protected/humhub/modules/admin/controllers/AuthenticationController.php
+++ b/protected/humhub/modules/admin/controllers/AuthenticationController.php
@ -38,13 +38,13 @@ class AuthenticationController extends Controller

        $this->subLayout = '@admin/views/layouts/user';

-        return parent::init();
+        parent::init();
    }

    /**
     * @inheritdoc
     */
-    public function getAccessRules()
+    protected function getAccessRules()
    {
        return [
            ['permissions' => ManageSettings::class]
--- a/protected/humhub/modules/admin/controllers/GroupController.php
+++ b/protected/humhub/modules/admin/controllers/GroupController.php
@ -42,13 +42,13 @@ class GroupController extends Controller
        $this->subLayout = '@admin/views/layouts/user';
        $this->appendPageTitle(Yii::t('AdminModule.base', 'Groups'));

-        return parent::init();
+        parent::init();
    }

    /**
     * @inheritdoc
     */
-    public function getAccessRules()
+    protected function getAccessRules()
    {
        return [
            ['permissions' => ManageGroups::class],
--- a/protected/humhub/modules/admin/controllers/InformationController.php
+++ b/protected/humhub/modules/admin/controllers/InformationController.php
@ -37,16 +37,19 @@ class InformationController extends Controller
     */
    public $defaultAction = 'about';

+    /**
+     * @inheritdoc
+     */
    public function init()
    {
        $this->subLayout = '@admin/views/layouts/information';
-        return parent::init();
+        parent::init();
    }

    /**
     * @inheritdoc
     */
-    public function getAccessRules()
+    protected function getAccessRules()
    {
        return [
            ['permissions' => \humhub\modules\admin\permissions\SeeAdminInformation::class],
--- a/protected/humhub/modules/admin/controllers/LoggingController.php
+++ b/protected/humhub/modules/admin/controllers/LoggingController.php
@ -32,13 +32,13 @@ class LoggingController extends Controller
        $this->appendPageTitle(Yii::t('AdminModule.base', 'Logging'));
        $this->subLayout = '@admin/views/layouts/information';

-		return parent::init();
+        parent::init();
    }

    /**
     * @inheritdoc
     */
-    public function getAccessRules()
+    protected function getAccessRules()
    {
        return [
            ['permissions' => SeeAdminInformation::class]
--- a/protected/humhub/modules/admin/controllers/ModuleController.php
+++ b/protected/humhub/modules/admin/controllers/ModuleController.php
@ -43,13 +43,13 @@ class ModuleController extends Controller
    {
        $this->appendPageTitle(Yii::t('AdminModule.base', 'Modules'));

-        return parent::init();
+        parent::init();
    }

    /**
     * @inheritdoc
     */
-    public function getAccessRules()
+    protected function getAccessRules()
    {
        return [
            ['permissions' => ManageModules::class]
--- a/protected/humhub/modules/admin/controllers/PendingRegistrationsController.php
+++ b/protected/humhub/modules/admin/controllers/PendingRegistrationsController.php
@ -34,7 +34,7 @@ class PendingRegistrationsController extends Controller
    /**
     * @inheritdoc
     */
-    public function getAccessRules()
+    protected function getAccessRules()
    {
        return [
            [
--- a/protected/humhub/modules/admin/controllers/SettingController.php
+++ b/protected/humhub/modules/admin/controllers/SettingController.php
@ -28,7 +28,6 @@ use humhub\models\UrlOembed;
 use humhub\modules\admin\components\Controller;
 use humhub\modules\admin\models\Log;
 use humhub\modules\notification\models\forms\NotificationSettings;
-use yii\base\BaseObject;

 /**
 * SettingController
@ -65,13 +64,13 @@ class SettingController extends Controller
        ]);
        $this->subLayout = '@admin/views/layouts/setting';

-        return parent::init();
+        parent::init();
    }

    /**
     * @inheritdoc
     */
-    public function getAccessRules()
+    protected function getAccessRules()
    {
        return [
            ['permissions' => ManageSettings::class]
--- a/protected/humhub/modules/admin/controllers/SpaceController.php
+++ b/protected/humhub/modules/admin/controllers/SpaceController.php
@ -41,13 +41,13 @@ class SpaceController extends Controller
        $this->subLayout = '@admin/views/layouts/space';
        $this->appendPageTitle(Yii::t('AdminModule.base', 'Spaces'));

-        return parent::init();
+        parent::init();
    }

    /**
     * @inheritdoc
     */
-    public function getAccessRules()
+    protected function getAccessRules()
    {
        return [
            ['permissions' => [ManageSpaces::class, ManageSettings::class]],
--- a/protected/humhub/modules/admin/controllers/UserController.php
+++ b/protected/humhub/modules/admin/controllers/UserController.php
@ -55,7 +55,7 @@ class UserController extends Controller
    /**
     * @inheritdoc
     */
-    public function getAccessRules()
+    protected function getAccessRules()
    {
        return [
            ['permissions' => [ManageUsers::class, ManageGroups::class]],
--- a/protected/humhub/modules/admin/controllers/UserPeopleController.php
+++ b/protected/humhub/modules/admin/controllers/UserPeopleController.php
@ -40,7 +40,7 @@ class UserPeopleController extends Controller
    /**
     * @inheritdoc
     */
-    public function getAccessRules()
+    protected function getAccessRules()
    {
        return [
            ['permissions' => [ManageSettings::class]]
--- a/protected/humhub/modules/admin/controllers/UserPermissionsController.php
+++ b/protected/humhub/modules/admin/controllers/UserPermissionsController.php
@ -11,13 +11,10 @@ use humhub\modules\admin\components\Controller;
 use humhub\modules\admin\permissions\ManageSettings;
 use humhub\modules\admin\permissions\ManageUsers;
 use humhub\modules\content\components\ContentContainerDefaultPermissionManager;
-use humhub\modules\content\models\ContentContainerDefaultPermission;
 use humhub\modules\content\models\ContentContainerPermission;
-use humhub\modules\content\models\ContentContainerSetting;
 use humhub\modules\user\models\User;
 use humhub\modules\user\Module;
 use Yii;
-use yii\db\Expression;
 use yii\web\HttpException;

 /**
@ -47,7 +44,7 @@ class UserPermissionsController extends Controller
    /**
     * @inheritdoc
     */
-    public function getAccessRules()
+    protected function getAccessRules()
    {
        return [
            ['permissions' => [ManageUsers::class]],
--- a/protected/humhub/modules/admin/controllers/UserProfileController.php
+++ b/protected/humhub/modules/admin/controllers/UserProfileController.php
@ -39,13 +39,13 @@ class UserProfileController extends Controller
        $this->appendPageTitle(Yii::t('AdminModule.base', 'Userprofiles'));
        $this->subLayout = '@admin/views/layouts/user';

-        return parent::init();
+        parent::init();
    }

    /**
     * @inheritdoc
     */
-    public function getAccessRules()
+    protected function getAccessRules()
    {
        return [
            ['permissions' => ManageUsers::class]
--- a/protected/humhub/modules/comment/controllers/CommentController.php
+++ b/protected/humhub/modules/comment/controllers/CommentController.php
@ -39,9 +39,9 @@ use yii\web\NotFoundHttpException;
 class CommentController extends Controller
 {
    /**
-     * @return array
+     * @inheritdoc
     */
-    public function getAccessRules()
+    protected function getAccessRules()
    {
        return [
            [ControllerAccess::RULE_LOGGED_IN_ONLY => ['post', 'edit', 'delete']],
--- a/protected/humhub/modules/file/controllers/FileController.php
+++ b/protected/humhub/modules/file/controllers/FileController.php
@ -31,7 +31,7 @@ class FileController extends Controller
    /**
     * @inheritdoc
     */
-    public function getAccessRules()
+    protected function getAccessRules()
    {
        return [
            [ControllerAccess::RULE_LOGGED_IN_ONLY => ['upload', 'delete']]
--- a/protected/humhub/modules/marketplace/controllers/BrowseController.php
+++ b/protected/humhub/modules/marketplace/controllers/BrowseController.php
@ -24,7 +24,7 @@ class BrowseController extends Controller
    /**
     * @inheritdoc
     */
-    public function getAccessRules()
+    protected function getAccessRules()
    {
        return [
            ['permissions' => ManageModules::class]
--- a/protected/humhub/modules/marketplace/controllers/PurchaseController.php
+++ b/protected/humhub/modules/marketplace/controllers/PurchaseController.php
@ -30,7 +30,7 @@ class PurchaseController extends Controller
    /**
     * @inheritdoc
     */
-    public function getAccessRules()
+    protected function getAccessRules()
    {
        return [
            ['permissions' => ManageModules::class]
--- a/protected/humhub/modules/marketplace/controllers/UpdateController.php
+++ b/protected/humhub/modules/marketplace/controllers/UpdateController.php
@ -24,7 +24,7 @@ class UpdateController extends Controller
    /**
     * @inheritdoc
     */
-    public function getAccessRules()
+    protected function getAccessRules()
    {
        return [
            ['permissions' => ManageModules::class]
--- a/protected/humhub/modules/notification/controllers/AdminController.php
+++ b/protected/humhub/modules/notification/controllers/AdminController.php
@ -25,7 +25,7 @@ class AdminController extends Controller
    /**
     * @inheritdoc
     */
-    public function getAccessRules()
+    protected function getAccessRules()
    {
        return [
            ['permissions' => ManageSettings::class],
--- a/protected/humhub/modules/notification/controllers/EntryController.php
+++ b/protected/humhub/modules/notification/controllers/EntryController.php
@ -30,7 +30,7 @@ class EntryController extends Controller
    /**
     * @inheritdoc
     */
-    public function getAccessRules()
+    protected function getAccessRules()
    {
        return [
            [ControllerAccess::RULE_LOGGED_IN_ONLY]
--- a/protected/humhub/modules/notification/controllers/ListController.php
+++ b/protected/humhub/modules/notification/controllers/ListController.php
@ -22,9 +22,9 @@ use yii\db\IntegrityException;
 class ListController extends Controller
 {
    /**
-     * @inheritDoc
+     * @inheritdoc
     */
-    public function getAccessRules()
+    protected function getAccessRules()
    {
        return [
            [ControllerAccess::RULE_LOGGED_IN_ONLY]
--- a/protected/humhub/modules/notification/controllers/OverviewController.php
+++ b/protected/humhub/modules/notification/controllers/OverviewController.php
@ -29,7 +29,7 @@ class OverviewController extends Controller
    /**
     * @inheritdoc
     */
-    public function getAccessRules()
+    protected function getAccessRules()
    {
        return [
            [ControllerAccess::RULE_LOGGED_IN_ONLY]
--- a/protected/humhub/modules/search/controllers/MentioningController.php
+++ b/protected/humhub/modules/search/controllers/MentioningController.php
@ -10,7 +10,7 @@ namespace humhub\modules\search\controllers;

 use humhub\components\Controller;
 use humhub\libs\ParameterEvent;
-use \humhub\modules\comment\Module as CommentModule;
+use humhub\modules\comment\Module as CommentModule;
 use humhub\modules\content\components\ContentContainerActiveRecord;
 use humhub\modules\content\models\Content;
 use humhub\modules\post\models\Post;
@ -45,7 +45,7 @@ class MentioningController extends Controller
    /**
     * @inheritdoc
     */
-    public function getAccessRules()
+    protected function getAccessRules()
    {
        return [
            ['login']
--- a/protected/humhub/modules/search/controllers/SearchController.php
+++ b/protected/humhub/modules/search/controllers/SearchController.php
@ -48,7 +48,7 @@ class SearchController extends Controller
    /**
     * @inheritdoc
     */
-    public function getAccessRules()
+    protected function getAccessRules()
    {
        return [
            ['login']
--- a/protected/humhub/modules/space/controllers/MembershipController.php
+++ b/protected/humhub/modules/space/controllers/MembershipController.php
@ -36,7 +36,10 @@ use yii\web\HttpException;
 */
 class MembershipController extends ContentContainerController
 {
-    public function getAccessRules()
+    /**
+     * @inheritdoc
+     */
+    protected function getAccessRules()
    {
        return [
            ['permission' => [InviteUsers::class], 'actions' => ['invite']],
--- a/protected/humhub/modules/space/modules/manage/controllers/ImageController.php
+++ b/protected/humhub/modules/space/modules/manage/controllers/ImageController.php
@ -21,7 +21,10 @@ class ImageController extends ContainerImageController
 {
    public $validContentContainerClasses = [Space::class];

-    public function getAccessRules()
+    /**
+     * @inheritdoc
+     */
+    protected function getAccessRules()
    {
        return [
            [ContentContainerControllerAccess::RULE_USER_GROUP_ONLY => [Space::USERGROUP_ADMIN]],
--- a/protected/humhub/modules/topic/controllers/ManageController.php
+++ b/protected/humhub/modules/topic/controllers/ManageController.php
@ -19,7 +19,10 @@ use yii\web\HttpException;

 class ManageController extends ContentContainerController
 {
-    public function getAccessRules()
+    /**
+     * @inheritdoc
+     */
+    protected function getAccessRules()
    {
        return [
            ['login'],
--- a/protected/humhub/modules/topic/controllers/TopicController.php
+++ b/protected/humhub/modules/topic/controllers/TopicController.php
@ -8,13 +8,8 @@

 namespace humhub\modules\topic\controllers;

-
 use humhub\modules\content\components\ContentContainerController;
-use humhub\modules\content\models\Content;
-use humhub\modules\topic\models\forms\ContentTopicsForm;
 use humhub\modules\topic\widgets\TopicPicker;
-use Yii;
-use yii\web\HttpException;

 class TopicController extends ContentContainerController
 {
@ -26,7 +21,7 @@ class TopicController extends ContentContainerController
    /**
     * @inheritdoc
     */
-    public function getAccessRules()
+    protected function getAccessRules()
    {
        return [
            ['json']
--- a/protected/humhub/modules/tour/controllers/TourController.php
+++ b/protected/humhub/modules/tour/controllers/TourController.php
@ -9,10 +9,10 @@
 namespace humhub\modules\tour\controllers;

 use humhub\modules\space\models\Membership;
+use humhub\modules\space\models\Space;
 use humhub\modules\tour\Module;
 use Yii;
 use yii\web\HttpException;
-use humhub\modules\space\models\Space;


 /**
@ -24,7 +24,10 @@ use humhub\modules\space\models\Space;
 */
 class TourController extends \humhub\components\Controller
 {
-    public function getAccessRules()
+    /**
+     * @inheritdoc
+     */
+    protected function getAccessRules()
    {
        return [
            ['login']
--- a/protected/humhub/modules/user/components/BaseAccountController.php
+++ b/protected/humhub/modules/user/components/BaseAccountController.php
@ -28,7 +28,7 @@ class BaseAccountController extends \humhub\components\Controller
    /**
     * @inheritdoc
     */
-    public function getAccessRules()
+    protected function getAccessRules()
    {
        return [
            [ControllerAccess::RULE_LOGGED_IN_ONLY]
@ -46,7 +46,7 @@ class BaseAccountController extends \humhub\components\Controller
    public function init()
    {
        $this->appendPageTitle(\Yii::t('UserModule.base', 'My Account'));
-        return parent::init();
+        parent::init();
    }

    /**
--- a/protected/humhub/modules/user/controllers/ImageController.php
+++ b/protected/humhub/modules/user/controllers/ImageController.php
@ -49,7 +49,10 @@ class ImageController extends ContainerImageController
        }
    }

-    public function getAccessRules()
+    /**
+     * @inheritdoc
+     */
+    protected function getAccessRules()
    {
        return [
            ['validateAccess'],
--- a/protected/humhub/modules/user/controllers/PeopleController.php
+++ b/protected/humhub/modules/user/controllers/PeopleController.php
@ -44,7 +44,7 @@ class PeopleController extends Controller
    /**
     * @inheritdoc
     */
-    public function getAccessRules()
+    protected function getAccessRules()
    {
        return [
            [ControllerAccess::RULE_LOGGED_IN_ONLY],