added new signs metamodel (#135)

GET api/v1/summits/{summitid}/signs?filter=location_id==XYZ
POST api/v1/summits/{summitid}/signs payload { location_id : XYZ , template: ''}
PUT api/v1/summits/{summitid}/signs/{sign_id}

Change-Id: I5602ed9c493b75111231b7a8bf8814c5819c77fb

Author: smarcet

app/Http/Controllers/Apis/Protected/Summit/OAuth2SummitSignApiController.php

@@ -0,0 +1,118 @@
+<?php namespace App\Http\Controllers;
+
+/*
+ * Copyright 2023 OpenStack Foundation
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ **/
+
+use App\Models\Foundation\Summit\Repositories\ISummitSignRepository;
+use App\Services\Model\ISummitSignService;
+use models\oauth2\IResourceServerContext;
+use models\summit\ISummitRepository;
+use models\summit\Summit;
+use models\utils\IEntity;
+
+/**
+ * Class OAuth2SummitSignApiController
+ * @package App\Http\Controller
+ */
+final class OAuth2SummitSignApiController extends OAuth2ProtectedController
+{
+    private $summit_repository;
+
+    private $service;
+
+    /**
+     * @param ISummitSignRepository $repository
+     * @param ISummitRepository $summit_repository
+     * @param ISummitSignService $service
+     * @param IResourceServerContext $resource_server_context
+     */
+    public function __construct
+    (
+        ISummitSignRepository $repository,
+        ISummitRepository $summit_repository,
+        ISummitSignService $service,
+        IResourceServerContext $resource_server_context
+    )
+    {
+        parent::__construct($resource_server_context);
+        $this->summit_repository = $summit_repository;
+        $this->service = $service;
+        $this->repository = $repository;
+    }
+
+    use GetAllBySummit;
+
+    use GetSummitChildElementById;
+
+    use AddSummitChildElement;
+
+    use UpdateSummitChildElement;
+
+    protected function addChild(Summit $summit, array $payload): IEntity
+    {
+        return $this->service->add($summit, $payload);
+    }
+
+    function getAddValidationRules(array $payload): array
+    {
+       return [
+           'location_id' => 'required|integer',
+           'template' => 'required|string'
+       ];
+    }
+
+    protected function getSummitRepository(): ISummitRepository
+    {
+       return $this->summit_repository;
+    }
+
+    protected function getChildFromSummit(Summit $summit, $child_id): ?IEntity
+    {
+        return $summit->getSignById(intval($child_id));
+    }
+
+    function getUpdateValidationRules(array $payload): array
+    {
+        return [
+            'template' => 'sometimes|string'
+        ];
+    }
+
+    protected function updateChild(Summit $summit, int $child_id, array $payload): IEntity
+    {
+        return $this->service->update($summit, $child_id, $payload);
+    }
+
+    protected function getFilterRules():array{
+        return [
+            'location_id' => ['=='],
+        ];
+    }
+
+    /**
+     * @return array
+     */
+    protected function getFilterValidatorRules():array{
+        return [
+            'location_id' => 'sometimes|integer',
+        ];
+    }
+    /**
+     * @return array
+     */
+    protected function getOrderRules():array{
+        return [
+            'id'
+        ];
+    }
+}

app/Http/Utils/Filters/FilterParser.php

@@ -102,6 +102,11 @@ public static function parse($filters, $allowed_fields = [])
                 if (!isset($allowed_fields[$field])){
                     throw new FilterParserException(sprintf("filter by field %s is not allowed", $field));
                 }
+
+                if (!is_array($allowed_fields[$field])){
+                    throw new FilterParserException(sprintf("filter by field %s is not an array", $field));
+                }
+
                 if (!in_array($op, $allowed_fields[$field])){
                     throw new FilterParserException(sprintf("%s op is not allowed for filter by field %s",$op, $field));
 

app/ModelSerializers/SerializerRegistry.php

@@ -114,7 +114,7 @@
 use ModelSerializers\Locations\SummitVenueFloorSerializer;
 use ModelSerializers\Locations\SummitVenueRoomSerializer;
 use ModelSerializers\Locations\SummitVenueSerializer;
-
+use App\ModelSerializers\Summit\SummitSignSerializer;
 /**
  * Class SerializerRegistry
  * @package ModelSerializers
@@ -249,6 +249,11 @@ private function __construct()
         $this->registry['TrackCheckBoxListQuestionTemplate'] = TrackMultiValueQuestionTemplateSerializer::class;
         $this->registry['TrackRadioButtonListQuestionTemplate'] = TrackMultiValueQuestionTemplateSerializer::class;
         $this->registry['TrackLiteralContentQuestionTemplate'] = TrackLiteralContentQuestionTemplateSerializer::class;
+
+        // signs
+
+        $this->registry['SummitSign'] = SummitSignSerializer::class;
+
         // events
 
         $this->registry['SummitEvent'] = [

app/ModelSerializers/Summit/SummitSignSerializer.php

@@ -0,0 +1,29 @@
+<?php namespace App\ModelSerializers\Summit;
+/*
+ * Copyright 2023 OpenStack Foundation
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ **/
+
+
+use ModelSerializers\SilverStripeSerializer;
+
+/**
+ * Class SummitSignSerializer
+ * @package App\ModelSerializers\Summit
+ */
+final class SummitSignSerializer extends SilverStripeSerializer
+{
+    protected static $array_mappings = [
+        'Template' => 'template:json_string',
+        'SummitId' => 'summit_id:json_int',
+        'LocationId' => 'location_id:json_int',
+    ];
+}

app/Models/Foundation/Summit/Repositories/ISummitSignRepository.php

@@ -0,0 +1,24 @@
+<?php namespace App\Models\Foundation\Summit\Repositories;
+/*
+ * Copyright 2023 OpenStack Foundation
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ **/
+
+use models\utils\IBaseRepository;
+
+/**
+ * Interface ISummitSignRepository
+ * @package App\Models\Foundation\Summit\Repositories
+ */
+interface ISummitSignRepository extends IBaseRepository
+{
+
+}

app/Models/Foundation/Summit/Signs/SummitSign.php

@@ -0,0 +1,94 @@
+<?php namespace App\Models\Foundation\Summit\Signs;
+/*
+ * Copyright 2023 OpenStack Foundation
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ **/
+
+use Doctrine\ORM\Mapping as ORM;
+use models\summit\SummitAbstractLocation;
+use models\summit\SummitOwned;
+use models\utils\One2ManyPropertyTrait;
+use models\utils\SilverstripeBaseModel;
+/**
+ * @ORM\Entity(repositoryClass="App\Repositories\Summit\DoctrineSummitSignRepository")
+ * @ORM\Table(name="SummitSign")
+ * @ORM\AssociationOverrides({
+ *     @ORM\AssociationOverride(
+ *          name="summit",
+ *          inversedBy="signs"
+ *     )
+ * })
+ * Class SummitSign
+ * @package App\Models\Foundation\Summit\Signs;
+ */
+class SummitSign extends SilverstripeBaseModel
+{
+
+    use One2ManyPropertyTrait;
+
+    protected $getIdMappings = [
+        'getLocationId' => 'location',
+    ];
+
+    protected $hasPropertyMappings = [
+        'hasLocation' => 'location',
+    ];
+
+    use SummitOwned;
+
+    /**
+     * @ORM\Column(name="Template", type="string")
+     * @var string
+     */
+    private $template;
+
+
+    /**
+     * @ORM\OneToOne(targetEntity="models\summit\SummitAbstractLocation")
+     * @ORM\JoinColumn(name="LocationID", referencedColumnName="ID")
+     * @var SummitAbstractLocation
+     */
+    private $location;
+
+    /**
+     * @return string
+     */
+    public function getTemplate(): ?string
+    {
+        return $this->template;
+    }
+
+    /**
+     * @param string $template
+     */
+    public function setTemplate(string $template): void
+    {
+        $this->template = trim($template);
+    }
+
+    /**
+     * @return SummitAbstractLocation
+     */
+    public function getLocation(): ?SummitAbstractLocation
+    {
+        return $this->location;
+    }
+
+    /**
+     * @param SummitAbstractLocation $location
+     */
+    public function setLocation(SummitAbstractLocation $location): void
+    {
+        $this->location = $location;
+    }
+
+
+}

app/Models/Foundation/Summit/Summit.php

@@ -14,7 +14,6 @@
 
 use App\Models\Foundation\Main\IGroup;
 use App\Models\Foundation\Main\OrderableChilds;
-use App\Models\Foundation\Summit\AllowedCurrencies;
 use App\Models\Foundation\Summit\EmailFlows\SummitEmailEventFlowType;
 use App\Models\Foundation\Summit\Events\RSVP\RSVPTemplate;
 use App\Models\Foundation\Summit\ExtraQuestions\SummitSelectionPlanExtraQuestionType;
@@ -24,6 +23,7 @@
 use App\Models\Foundation\Summit\Registration\ISummitExternalRegistrationFeedType;
 use App\Models\Foundation\Summit\ScheduleEntity;
 use App\Models\Foundation\Summit\SelectionPlan;
+use App\Models\Foundation\Summit\Signs\SummitSign;
 use App\Models\Foundation\Summit\Speakers\FeaturedSpeaker;
 use App\Models\Foundation\Summit\TrackTagGroup;
 use App\Models\Foundation\Summit\TrackTagGroupAllowedTag;
@@ -386,6 +386,11 @@ class Summit extends SilverstripeBaseModel
      */
     private $locations;
 
+    /**
+     * @ORM\OneToMany(targetEntity="App\Models\Foundation\Summit\Signs\SummitSign", mappedBy="summit", cascade={"persist","remove"}, orphanRemoval=true)
+     */
+    private $signs;
+
     /**
      * @ORM\OneToMany(targetEntity="SummitBookableVenueRoomAttributeType", mappedBy="summit", cascade={"persist","remove"}, orphanRemoval=true)
      */
@@ -1128,6 +1133,7 @@ public function __construct()
         $this->sponsorship_types = new ArrayCollection();
         $this->selection_plan_extra_questions = new ArrayCollection();
         $this->submission_invitations = new ArrayCollection();
+        $this->signs = new ArrayCollection();
     }
 
     /**
@@ -6341,4 +6347,46 @@ public function parseDateTime(int $epoch):?Datetime
         $datetime->setTimezone($this->getTimeZone());
         return $datetime;
     }
+
+    /**
+     * @return ArrayCollection
+     */
+    public function getSigns(): ArrayCollection
+    {
+        return $this->signs;
+    }
+
+    /**
+     * @param int $sign_id
+     * @return SummitSign|null
+     */
+    public function getSignById(int $sign_id):?SummitSign{
+        $criteria = Criteria::create();
+        $criteria->where(Criteria::expr()->eq('id', $sign_id));
+        $sign = $this->signs->matching($criteria)->first();
+        return $sign === false ? null : $sign;
+    }
+
+    /**
+     * @param int $location_id
+     * @return SummitSign|null
+     */
+    public function getSignByLocationId(int $location_id):?SummitSign{
+        $location = $this->getLocation($location_id);
+        if(is_null($location)) return null;
+        $criteria = Criteria::create();
+        $criteria->where(Criteria::expr()->eq('location', $location));
+        $sign = $this->signs->matching($criteria)->first();
+        return $sign === false ? null : $sign;
+    }
+
+    /**
+     * @param SummitSign $sign
+     * @return void
+     */
+    public function addSign(SummitSign $sign):void{
+        if($this->signs->contains($sign)) return;
+        $this->signs->add($sign);
+        $sign->setSummit($this);
+    }
 }