API Set extension hook implementation visibility to protected

silverstripe · May 20, 2024 · f6941e0 · f6941e0
1 parent 5ccd361
commit f6941e0
Show file tree

Hide file tree

Showing 20 changed files with 30 additions and 27 deletions.
diff --git a/src/ORM/DataExtension.php b/src/ORM/DataExtension.php
@@ -63,7 +63,7 @@ protected function augmentWrite(&$manipulation)
      *
      * See {@link DataObject::onBeforeWrite()} for context.
      */
-    public function onBeforeWrite()
+    protected function onBeforeWrite()
     {
     }
 
@@ -72,7 +72,7 @@ public function onBeforeWrite()
      *
      * See {@link DataObject::onAfterWrite()} for context.
      */
-    public function onAfterWrite()
+    protected function onAfterWrite()
     {
     }
 
@@ -81,7 +81,7 @@ public function onAfterWrite()
      *
      * See {@link DataObject::onBeforeDelete()} for context.
      */
-    public function onBeforeDelete()
+    protected function onBeforeDelete()
     {
     }
 
@@ -90,7 +90,7 @@ public function onBeforeDelete()
      *
      * See {@link DataObject::onAfterDelete()} for context.
      */
-    public function onAfterDelete()
+    protected function onAfterDelete()
     {
     }
 

diff --git a/src/Security/Group.php b/src/Security/Group.php
@@ -532,7 +532,7 @@ public function getCMSCompositeValidator(): CompositeValidator
         return $validator;
     }
 
-    public function onBeforeWrite()
+    protected function onBeforeWrite()
     {
         parent::onBeforeWrite();
 
@@ -547,7 +547,7 @@ public function onBeforeWrite()
         $this->dedupeCode();
     }
 
-    public function onBeforeDelete()
+    protected function onBeforeDelete()
     {
         parent::onBeforeDelete();
 

diff --git a/src/Security/Member.php b/src/Security/Member.php
@@ -733,7 +733,7 @@ public static function actAs($member, $callback)
     /**
      * Event handler called before writing to the database.
      */
-    public function onBeforeWrite()
+    protected function onBeforeWrite()
     {
         // Remove any line-break or space characters accidentally added during a copy-paste operation
         if ($this->Email) {
@@ -818,7 +818,7 @@ public function onBeforeWrite()
         parent::onBeforeWrite();
     }
 
-    public function onAfterWrite()
+    protected function onAfterWrite()
     {
         parent::onAfterWrite();
 
@@ -829,7 +829,7 @@ public function onAfterWrite()
         }
     }
 
-    public function onAfterDelete()
+    protected function onAfterDelete()
     {
         parent::onAfterDelete();
 

diff --git a/src/Security/Permission.php b/src/Security/Permission.php
@@ -636,7 +636,7 @@ public static function sort_permissions($a, $b)
         }
     }
 
-    public function onBeforeWrite()
+    protected function onBeforeWrite()
     {
         parent::onBeforeWrite();
 

diff --git a/src/Security/PermissionRole.php b/src/Security/PermissionRole.php
@@ -69,7 +69,7 @@ public function getCMSFields()
         return $fields;
     }
 
-    public function onAfterDelete()
+    protected function onAfterDelete()
     {
         parent::onAfterDelete();
 

diff --git a/tests/php/Control/RequestHandlingTest/ControllerExtension.php b/tests/php/Control/RequestHandlingTest/ControllerExtension.php
@@ -25,7 +25,7 @@ public function extendedMethod()
     /**
      * Called whenever there is an HTTP error
      */
-    public function onBeforeHTTPError()
+    protected function onBeforeHTTPError()
     {
         self::$called_error = true;
     }

diff --git a/tests/php/Forms/FormFactoryTest/ControllerExtension.php b/tests/php/Forms/FormFactoryTest/ControllerExtension.php
@@ -38,7 +38,7 @@ class ControllerExtension extends Extension
      * @param string     $name
      * @param array      $context
      */
-    public function updateFormActions(FieldList &$actions, Controller $controller, $name, $context = [])
+    protected function updateFormActions(FieldList &$actions, Controller $controller, $name, $context = [])
     {
         // Add publish button if record is versioned
         if (empty($context['Record'])) {
@@ -59,7 +59,7 @@ public function updateFormActions(FieldList &$actions, Controller $controller, $
      * @param string     $name
      * @param array      $context
      */
-    public function updateFormFields(FieldList &$fields, Controller $controller, $name, $context = [])
+    protected function updateFormFields(FieldList &$fields, Controller $controller, $name, $context = [])
     {
         // Add preview link
         if (empty($context['Record'])) {

diff --git a/tests/php/Forms/FormFieldTest/FieldValidationExtension.php b/tests/php/Forms/FormFieldTest/FieldValidationExtension.php
@@ -12,7 +12,7 @@ class FieldValidationExtension extends Extension implements TestOnly
 
     protected bool $triggerTestValidationError = false;
 
-    public function updateValidationResult(bool &$result, Validator $validator)
+    protected function updateValidationResult(bool &$result, Validator $validator)
     {
         if ($this->excludeFromValidation) {
             $result = true;

diff --git a/tests/php/Forms/FormFieldTest/TestExtension.php b/tests/php/Forms/FormFieldTest/TestExtension.php
@@ -8,7 +8,7 @@
 class TestExtension extends Extension implements TestOnly
 {
 
-    public function updateAttributes(&$attrs)
+    protected function updateAttributes(&$attrs)
     {
         $attrs['extended'] = true;
     }

diff --git a/tests/php/Forms/FormScaffolderTest/ArticleExtension.php b/tests/php/Forms/FormScaffolderTest/ArticleExtension.php
@@ -13,7 +13,7 @@ class ArticleExtension extends DataExtension implements TestOnly
         'ExtendedField' => 'Varchar'
     ];
 
-    public function updateCMSFields(FieldList $fields)
+    protected function updateCMSFields(FieldList $fields)
     {
         $fields->addFieldToTab(
             'Root.Main',

diff --git a/tests/php/Forms/GridField/GridFieldTest/StadiumExtension.php b/tests/php/Forms/GridField/GridFieldTest/StadiumExtension.php
@@ -9,7 +9,7 @@
 
 class StadiumExtension extends DataExtension implements TestOnly
 {
-    public function updateSearchableFields(&$fields)
+    protected function updateSearchableFields(&$fields)
     {
         $fields['Type']['filter'] = new FulltextFilter();
     }

diff --git a/tests/php/ORM/DataExtensionTest/CMSFieldsBaseExtension.php b/tests/php/ORM/DataExtensionTest/CMSFieldsBaseExtension.php
@@ -17,7 +17,7 @@ class CMSFieldsBaseExtension extends DataExtension implements TestOnly
         'ExtendedFieldRemove' => 'Varchar(255)'
     ];
 
-    public function updateCMSFields(FieldList $fields)
+    protected function updateCMSFields(FieldList $fields)
     {
         $fields->addFieldToTab('Root.Test', new TextField('ExtendedFieldRemove'));
         $fields->addFieldToTab('Root.Test', new TextField('ExtendedFieldKeep'));

diff --git a/tests/php/ORM/DataObjectTest/Team_Extension.php b/tests/php/ORM/DataObjectTest/Team_Extension.php
@@ -24,7 +24,7 @@ public function getExtendedDynamicField()
         return "extended dynamic field";
     }
 
-    public function augmentHydrateFields()
+    protected function augmentHydrateFields()
     {
         return [
             'CustomHydratedField' => true,

diff --git a/tests/php/ORM/UniqueKey/ExtraKeysExtension.php b/tests/php/ORM/UniqueKey/ExtraKeysExtension.php
@@ -7,7 +7,7 @@
 
 class ExtraKeysExtension extends Extension implements TestOnly
 {
-    public function cacheKeyComponent(): string
+    protected function cacheKeyComponent(): string
     {
         return 'extra-key';
     }

diff --git a/tests/php/Security/MemberTest.php b/tests/php/Security/MemberTest.php
@@ -34,6 +34,7 @@
 use SilverStripe\Security\Security;
 use SilverStripe\Security\Tests\MemberTest\FieldsExtension;
 use SilverStripe\SessionManager\Models\LoginSession;
+use ReflectionMethod;
 
 class MemberTest extends FunctionalTest
 {
@@ -1605,7 +1606,9 @@ public function testCustomMemberValidator()
         $this->assertFalse($fail, 'Missing FirstName');
 
         $ext = new MemberTest\ValidatorExtension();
-        $ext->updateValidator($validator);
+        $method = new ReflectionMethod(MemberTest\ValidatorExtension::class, 'updateValidator');
+        $method->setAccessible(true);
+        $method->invokeArgs($ext, [&$validator]);
 
         $pass = $validator->php(
             [

diff --git a/tests/php/Security/MemberTest/AlwaysFailExtension.php b/tests/php/Security/MemberTest/AlwaysFailExtension.php
@@ -10,7 +10,7 @@
  */
 class AlwaysFailExtension extends DataExtension implements TestOnly
 {
-    public function updatePHP($data, $form)
+    protected function updatePHP($data, $form)
     {
         return false;
     }

diff --git a/tests/php/Security/MemberTest/ExtendedChangePasswordExtension.php b/tests/php/Security/MemberTest/ExtendedChangePasswordExtension.php
@@ -11,7 +11,7 @@
  */
 class ExtendedChangePasswordExtension extends DataExtension implements TestOnly
 {
-    public function onBeforeChangePassword($newPassword, $valid)
+    protected function onBeforeChangePassword($newPassword, $valid)
     {
         $valid->addError('Extension failed to handle Mary changing her password');
     }

diff --git a/tests/php/Security/MemberTest/FieldsExtension.php b/tests/php/Security/MemberTest/FieldsExtension.php
@@ -9,7 +9,7 @@
 
 class FieldsExtension extends DataExtension implements TestOnly
 {
-    public function updateCMSFields(FieldList $fields)
+    protected function updateCMSFields(FieldList $fields)
     {
         $fields->addFieldToTab('Root.Main', new TextField('TestMemberField', 'Test'));
     }

diff --git a/tests/php/Security/MemberTest/SurnameMustMatchFirstNameExtension.php b/tests/php/Security/MemberTest/SurnameMustMatchFirstNameExtension.php
@@ -10,7 +10,7 @@
  */
 class SurnameMustMatchFirstNameExtension extends DataExtension implements TestOnly
 {
-    public function updatePHP($data, $form)
+    protected function updatePHP($data, $form)
     {
         return $data['FirstName'] == $data['Surname'];
     }

diff --git a/tests/php/Security/MemberTest/ValidatorExtension.php b/tests/php/Security/MemberTest/ValidatorExtension.php
@@ -8,7 +8,7 @@
 class ValidatorExtension extends DataExtension implements TestOnly
 {
 
-    public function updateValidator(&$validator)
+    protected function updateValidator(&$validator)
     {
         $validator->addRequiredField('Surname');
         $validator->removeRequiredField('FirstName');