API Strong typing for the view layer

silverstripe · Aug 23, 2024 · 516a934 · 516a934
1 parent eb400ca
commit 516a934
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 22 deletions.
diff --git a/code/Model/VirtualPage.php b/code/Model/VirtualPage.php
@@ -401,11 +401,8 @@ public function CMSTreeClasses()
 
     /**
      * Use the target page's class name for fetching templates - as we need to take on its appearance
-     *
-     * @param string $suffix
-     * @return array
      */
-    public function getViewerTemplates($suffix = '')
+    public function getViewerTemplates(string $suffix = ''): array
     {
         $copy = $this->CopyContentFrom();
         if ($copy && $copy->exists()) {
@@ -418,11 +415,8 @@ public function getViewerTemplates($suffix = '')
     /**
      * Allow attributes on the master page to pass
      * through to the virtual page
-     *
-     * @param string $field
-     * @return mixed
      */
-    public function __get($field)
+    public function __get(string $field): mixed
     {
         if (parent::hasMethod($funcName = "get$field")) {
             return $this->$funcName();
@@ -436,7 +430,7 @@ public function __get($field)
         return null;
     }
 
-    public function getField($field)
+    public function getField(string $field): mixed
     {
         if ($this->isFieldVirtualised($field)) {
             return $this->CopyContentFrom()->getField($field);
@@ -484,17 +478,13 @@ public function __call($method, $args)
         }
     }
 
-    /**
-     * @param string $field
-     * @return bool
-     */
-    public function hasField($field)
+    public function hasField(string $fieldName): bool
     {
-        if (parent::hasField($field)) {
+        if (parent::hasField($fieldName)) {
             return true;
         }
         $copy = $this->CopyContentFrom();
-        return $copy && $copy->exists() && $copy->hasField($field);
+        return $copy && $copy->exists() && $copy->hasField($fieldName);
     }
 
     /**
@@ -513,11 +503,8 @@ public function hasMethod($method)
     /**
      * Return the "casting helper" (a piece of PHP code that when evaluated creates a casted value object) for a field
      * on this object.
-     *
-     * @param string $field
-     * @return string|null
      */
-    public function castingHelper($field, bool $useFallback = true)
+    public function castingHelper(string $field, bool $useFallback = true): ?string
     {
         $copy = $this->CopyContentFrom();
         if ($copy && $copy->exists() && ($helper = $copy->castingHelper($field, $useFallback))) {

diff --git a/tests/php/Model/VirtualPageTest.php b/tests/php/Model/VirtualPageTest.php
@@ -29,7 +29,6 @@ class VirtualPageTest extends FunctionalTest
         VirtualPageTest_NotRoot::class,
         VirtualPageTest_PageExtension::class,
         VirtualPageTest_PageWithAllowedChildren::class,
-        VirtualPageTest_TestDBField::class,
         VirtualPageTest_VirtualPageSub::class,
     ];
 

diff --git a/tests/php/Model/VirtualPageTest_TestDBField.php b/tests/php/Model/VirtualPageTest_TestDBField.php
@@ -7,7 +7,7 @@
 
 class VirtualPageTest_TestDBField extends DBVarchar implements TestOnly
 {
-    public function forTemplate()
+    public function forTemplate(): string
     {
         return strtoupper($this->XML() ?? '');
     }