VGirol / JsonApi-Structure

src/Concern/ValidateRelationshipsObject.php

<?php

declare(strict_types=1);

namespace VGirol\JsonApiStructure\Concern;

use VGirol\JsonApiConstant\Members;
use VGirol\JsonApiStructure\Messages;

/**
 * Assertions relating to the relationships object
 */
trait ValidateRelationshipsObject
{
    /**
     * Asserts that a json fragment is a valid relationships object.
     *
     * It will do the following checks :
     * 1) asserts that the relationships object is not an array of objects (@see mustNotBeArrayOfObjects).
     * 2) asserts that each relationship of the collection has a valid name (@see validateMemberName)
     * and is a valid relationship object (@see validateRelationshipObject).
     *
     * @param array   $json
     * @param boolean $strict If true, unsafe characters are not allowed when checking members name.
     *
     * @return void
     * @throws \VGirol\JsonApiStructure\Exception\ValidationException
     */
    public function validateRelationshipsObject($json, bool $strict): void
    {
        $this->mustNotBeArrayOfObjects($json);

It seems like mustNotBeArrayOfObjects() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        foreach ($json as $key => $relationship) {
            $this->validateMemberName($key, $strict);

It seems like validateMemberName() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            $this->validateRelationshipObject($relationship, $strict);
        }
    }

    /**
     * Asserts that a json fragment is a valid relationship object.
     *
     * It will do the following checks :
     * 1) asserts that the relationship object contains at least one of the following member : "links", "data", "meta"
     * (@see containsAtLeastOneMember).
     *
     * Optionaly, if presents, it will checks :
     * 2) asserts that the data member is valid (@see validateResourceLinkage).
     * 3) asserts that the links member is valid (@see validateRelationshipLinksObject).
     * 4) asserts that the meta object is valid (@see validateMetaObject).
     *
     * @param array   $json
     * @param boolean $strict If true, unsafe characters are not allowed when checking members name.
     *
     * @return void
     * @throws \VGirol\JsonApiStructure\Exception\ValidationException
     */
    public function validateRelationshipObject($json, bool $strict): void
    {
        $this->isValidArgument(1, 'array', $json);

It seems like isValidArgument() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $this->containsAtLeastOneMember(

It seems like containsAtLeastOneMember() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            $this->getRule('RelationshipObject.AtLeast'),

It seems like getRule() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            $json
        );

        if (!$this->isAutomatic() && ($this->isPost() || $this->isUpdate())

It seems like isAutomatic() must be provided by classes using this trait. How about adding it as abstract method to this trait?

It seems like isUpdate() must be provided by classes using this trait. How about adding it as abstract method to this trait?

It seems like isPost() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            && !\array_key_exists(Members::DATA, $json)
        ) {
            $this->throw(Messages::RELATIONSHIP_NO_DATA_MEMBER, 403);

It seems like throw() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        }

        if (\array_key_exists(Members::DATA, $json)) {
            $data = $json[Members::DATA];
            $this->validateResourceLinkage($data, $strict);

It seems like validateResourceLinkage() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        }

        if (\array_key_exists(Members::LINKS, $json)) {
            $links = $json[Members::LINKS];
            $withPagination = $this->canBePaginated($json);

It seems like canBePaginated() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            $this->validateRelationshipLinksObject($links, $withPagination, $strict);
        }

        if (\array_key_exists(Members::META, $json)) {
            $this->validateMetaObject($json[Members::META], $strict);

It seems like validateMetaObject() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        }
    }

    /**
     * Asserts that a json fragment is a valid link object extracted from a relationship object.
     *
     * It will do the following checks :
     * 1) asserts that the links object is valid (@see assertIsValidLinksObject)
     * with the following allowed members : "self", "related"
     * and eventually pagination links ("first", "last", "prev" and "next").
     *
     * @param array   $json
     * @param boolean $withPagination
     * @param boolean $strict         If true, unsafe characters are not allowed when checking members name.
     *
     * @return void
     * @throws \VGirol\JsonApiStructure\Exception\ValidationException
     */
    public function validateRelationshipLinksObject($json, bool $withPagination, bool $strict): void
    {
        $allowed = $this->getRule('Document.LinksObject.Allowed');
        if ($withPagination) {
            $allowed = array_merge($allowed, $this->getRule('LinksObject.Pagination'));
        }
        $this->validateLinksObject($json, $allowed, $strict);

It seems like validateLinksObject() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }
}