VGirol\JsonApiAssert\Asserts\Structure\AssertRelationshipsObject

Complexity

Total Complexity

3

Size/Duplication

Total Lines	62
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	assertIsValidRelationshipsObject()	0	3	1
A	assertIsValidRelationshipObject()	0	3	1
A	assertIsValidRelationshipLinksObject()	0	3	1

<?php

declare(strict_types=1);

namespace VGirol\JsonApiAssert\Asserts\Structure;

/**
 * Assertions relating to the relationships object
 */
trait AssertRelationshipsObject
{
    /**
     * 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 assertIsNotArrayOfObjects).
     * 2) asserts that each relationship of the collection has a valid name (@see assertIsValidMemberName)
     * and is a valid relationship object (@see assertIsValidRelationshipObject).
     *
     * @param array   $json
     * @param boolean $strict If true, unsafe characters are not allowed when checking members name.
     *
     * @return void
     * @throws \PHPUnit\Framework\AssertionFailedError
     */
    public static function assertIsValidRelationshipsObject($json, bool $strict): void
    {
        static::askService('validateRelationshipsObject', $json, $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 assertContainsAtLeastOneMember).
     *
     * Optionaly, if presents, it will checks :
     * 2) asserts that the data member is valid (@see assertIsValidResourceLinkage).
     * 3) asserts that the links member is valid (@see assertIsValidRelationshipLinksObject).
     * 4) asserts that the meta object is valid (@see assertIsValidMetaObject).
     *
     * @param array   $json
     * @param boolean $strict If true, unsafe characters are not allowed when checking members name.
     *
     * @return void
     * @throws \PHPUnit\Framework\AssertionFailedError
     */
    public static function assertIsValidRelationshipObject($json, bool $strict): void
    {
        static::askService('validateRelationshipObject', $json, $strict);
    }

    /**
     * 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 \PHPUnit\Framework\AssertionFailedError
     */
    public static function assertIsValidRelationshipLinksObject($json, bool $withPagination, bool $strict): void
    {
        static::askService('validateRelationshipLinksObject', $json, $withPagination, $strict);
    }
}