code cleanup

Author: eceltov

app/helpers/MetaFormats/FormatDefinitions/GroupFormat.php

@@ -7,15 +7,15 @@
 use App\Helpers\MetaFormats\Attributes\FPost;
 use App\Helpers\MetaFormats\Validators\VArray;
 use App\Helpers\MetaFormats\Validators\VBool;
-use App\Helpers\MetaFormats\Validators\VEmail;
-use App\Helpers\MetaFormats\Validators\VMixed;
 use App\Helpers\MetaFormats\Validators\VObject;
 use App\Helpers\MetaFormats\Validators\VString;
 use App\Helpers\MetaFormats\Validators\VUuid;
-use ArrayAccess;
 
+/**
+ * Format definition used by the GroupsPresenter.
+ */
 #[Format(GroupFormat::class)]
-class GroupFormat extends MetaFormat// implements ArrayAccess
+class GroupFormat extends MetaFormat
 {
     #[FPost(new VUuid(), "An identifier of the group")]
     public string $id;
@@ -71,39 +71,4 @@ class GroupFormat extends MetaFormat// implements ArrayAccess
 
     #[FPost(new VArray())]
     public ?array $permissionHints;
-
-
-    // public function offsetExists(mixed $offset): bool
-    // {
-    //     return isset($this->$offset);
-    // }
-
-    // /**
-    //  * Offset to retrieve
-    //  * @param mixed $offset The offset to retrieve.
-    //  * @return mixed Can return all value types.
-    //  */
-    // public function offsetGet(mixed $offset): mixed
-    // {
-    //     return $this->$offset ?? null;
-    // }
-
-    // /**
-    //  * Offset to set
-    //  * @param mixed $offset The offset to assign the value to.
-    //  * @param mixed $value The value to set.
-    //  */
-    // public function offsetSet(mixed $offset, mixed $value): void
-    // {
-    //     $this->$offset = $value;
-    // }
-
-    // /**
-    //  * Offset to unset
-    //  * @param mixed $offset The offset to unset.
-    //  */
-    // public function offsetUnset(mixed $offset): void
-    // {
-    //     $this->$offset = null;
-    // }
 }

app/helpers/MetaFormats/FormatDefinitions/GroupPrivateDataFormat.php

@@ -8,14 +8,13 @@
 use App\Helpers\MetaFormats\Validators\VArray;
 use App\Helpers\MetaFormats\Validators\VBool;
 use App\Helpers\MetaFormats\Validators\VDouble;
-use App\Helpers\MetaFormats\Validators\VEmail;
 use App\Helpers\MetaFormats\Validators\VInt;
-use App\Helpers\MetaFormats\Validators\VMixed;
-use App\Helpers\MetaFormats\Validators\VString;
 use App\Helpers\MetaFormats\Validators\VTimestamp;
 use App\Helpers\MetaFormats\Validators\VUuid;
-use ArrayAccess;
 
+/**
+ * Nested Format definition used by the GroupFormat.
+ */
 #[Format(GroupPrivateDataFormat::class)]
 class GroupPrivateDataFormat extends MetaFormat
 {

app/helpers/MetaFormats/FormatDefinitions/SuccessResponseFormat.php

@@ -9,6 +9,10 @@
 use App\Helpers\MetaFormats\Validators\VInt;
 use App\Helpers\MetaFormats\Validators\VMixed;
 
+/**
+ * Wrapper Format definition of the common output schema.
+ * The ResponseFormat attribute has a flag that can automatically wrap any Format with this one.
+ */
 #[Format(SuccessResponseFormat::class)]
 class SuccessResponseFormat extends MetaFormat
 {

app/model/view/GroupViewFactory.php

@@ -4,7 +4,6 @@
 
 use App\Helpers\EvaluationStatus\EvaluationStatus;
 use App\Helpers\GroupBindings\GroupBindingAccessor;
-use App\Helpers\MetaFormats\FormatDefinitions\GroupFormat;
 use App\Helpers\PermissionHints;
 use App\Model\Entity\Assignment;
 use App\Model\Entity\AssignmentSolution;
@@ -272,28 +271,6 @@ function (Group $group) use ($ignoreArchived) {
             }
         );
 
-        // $groupFormat = new GroupFormat();
-        // $groupFormat->id = $group->getId();
-        // $groupFormat->externalId = $group->getExternalId();
-        // $groupFormat->organizational = $group->isOrganizational();
-        // $groupFormat->exam = $group->isExam();
-        // $groupFormat->archived = $group->isArchived();
-        // $groupFormat->public = $group->isPublic();
-        // $groupFormat->directlyArchived = $group->isDirectlyArchived();
-        // $groupFormat->localizedTexts = $group->getLocalizedTexts()->getValues();
-        // $groupFormat->primaryAdminsIds = $group->getPrimaryAdminsIds();
-        // $groupFormat->parentGroupId = $group->getParentGroup() ? $group->getParentGroup()->getId() : null;
-        // $groupFormat->parentGroupsIds = $group->getParentGroupsIds();
-        // $groupFormat->childGroups = $childGroups->map(
-        //     function (Group $group) {
-        //         return $group->getId();
-        //     }
-        // )->getValues();
-        // $groupFormat->privateData = $privateData;
-        // $groupFormat->permissionHints = PermissionHints::get($this->groupAcl, $group);
-
-        // return $groupFormat;
-
         return [
             "id" => $group->getId(),
             "externalId" => $group->getExternalId(),