Skip to content
Snippets Groups Projects
Select Git revision
  • 0d66414391a6fd9f8a28b2da78aabdaf396b9019
  • main default protected
  • studip-rector
  • ci-opt
  • course-members-export-as-word
  • data-vue-app
  • pipeline-improvements
  • webpack-optimizations
  • rector
  • icon-renewal
  • http-client-and-factories
  • jsonapi-atomic-operations
  • vueify-messages
  • tic-2341
  • 135-translatable-study-areas
  • extensible-sorm-action-parameters
  • sorm-configuration-trait
  • jsonapi-mvv-routes
  • docblocks-for-magic-methods
19 results

CoursewareCanvasBlock.vue

Blame
  • Forked from Stud.IP / Stud.IP
    Source project has a limited visibility.
    Code owners
    Assign users and groups as approvers for specific file changes. Learn more.
    StructuralElementFeedbackUpdate.php 4.05 KiB
    <?php
    
    namespace JsonApi\Routes\Courseware;
    
    use Courseware\StructuralElementFeedback;
    use JsonApi\Errors\AuthorizationFailedException;
    use JsonApi\Errors\RecordNotFoundException;
    use JsonApi\JsonApiController;
    use JsonApi\Routes\ValidationTrait;
    use JsonApi\Schemas\Courseware\StructuralElement as StructuralElementSchema;
    use JsonApi\Schemas\Courseware\StructuralElementFeedback as StructuralElementFeedbackSchema;
    use JsonApi\Schemas\User as UserSchema;
    use Psr\Http\Message\ResponseInterface as Response;
    use Psr\Http\Message\ServerRequestInterface as Request;
    
    /**
     * Update a feedback on a structural-element
     */
    class StructuralElementFeedbackUpdate extends JsonApiController
    {
        use ValidationTrait, UserProgressesHelper;
    
        /**
         * @SuppressWarnings(PHPMD.UnusedFormalParameter)
         */
        public function __invoke(Request $request, Response $response, $args)
        {
            if (!($resource = StructuralElementFeedback::find($args['id']))) {
                throw new RecordNotFoundException();
            }
            $json = $this->validate($request, $resource);
            if (!Authority::canUpdateStructuralElementFeedback($this->getUser($request), $resource)) {
                throw new AuthorizationFailedException();
            }
            $structuralElementFeedback = $this->updateStructuralElementFeedback($json, $resource);
    
            return $this->getContentResponse($structuralElementFeedback);
        }
    
        /**
         * @SuppressWarnings(PHPMD.UnusedFormalParameters)
         * @SuppressWarnings(CyclomaticComplexity)
         * @SuppressWarnings(NPathComplexity)
         */
        protected function validateResourceDocument($json, $data)
        {
            if (!self::arrayHas($json, 'data')) {
                return 'Missing `data` member at document´s top level.';
            }
            if (StructuralElementFeedbackSchema::TYPE !== self::arrayGet($json, 'data.type')) {
                return 'Wrong `type` member of document´s `data`.';
            }
            if (self::arrayGet($json, 'data.id') !== $data->id) {
                return 'Mismatch in document `id`.';
            }
    
            if (!($feedback = self::arrayGet($json, 'data.attributes.feedback'))) {
                return 'Missing `feedback` attribute.';
            }
            if (!is_string($feedback)) {
                return 'Attribute `feedback` must be a string.';
            }
            if ($feedback == '') {
                return 'Attribute `feedback` must not be empty.';
            }
    
            if (self::arrayHas($json, 'data.relationships.user')) {
                if (!($user = $this->getUserFromJson($json))) {
                    return 'Invalid `user` relationship.';
                }
                if ($user->id !== $data['user_id']) {
                    return 'Cannot update `user` relationship.';
                }
            }
    
            if (self::arrayHas($json, 'data.relationships.structural-element')) {
                if (!($structuralElement = $this->getStructuralElementFromJson($json))) {
                    return 'Invalid `structural-element` relationship.';
                }
                if ($structuralElement->id !== $data['structural_element_id']) {
                    return 'Cannot update `structural-element` relationship.';
                }
            }
        }
    
        private function getStructuralElementFromJson($json)
        {
            if (!$this->validateResourceObject($json, 'data.relationships.structural-element', StructuralElementSchema::TYPE)) {
                return null;
            }
            $structuralElementId = self::arrayGet($json, 'data.relationships.structural-element.data.id');
    
            return \Courseware\StructuralElement::find($structuralElementId);
        }
    
        private function getUserFromJson($json)
        {
            if (!$this->validateResourceObject($json, 'data.relationships.user', UserSchema::TYPE)) {
                return null;
            }
            $userId = self::arrayGet($json, 'data.relationships.user.data.id');
    
            return \User::find($userId);
        }
    
        private function updateStructuralElementFeedback(array $json, \Courseware\StructuralElementFeedback $resource)
        {
            $resource->feedback = self::arrayGet($json, 'data.attributes.feedback', '');
            $resource->store();
    
            return $resource;
        }
    }