function LinkTest::linkComparisonProvider

Provides test data for link comparison.

File

core/modules/jsonapi/tests/src/Unit/JsonApiResource/LinkTest.php, line 40

Class

LinkTest

@coversDefaultClass <a href="/api/drupal/core%21modules%21jsonapi%21src%21JsonApiResource%21Link.php/class/Link/11.x" title="Represents an RFC8288 based link." class="local">\Drupal\jsonapi\JsonApiResource\Link</a> @group jsonapi

Namespace

Code

public static function linkComparisonProvider() : \Generator {
    (yield 'same href and same link relation type' => [
        [
            'https://jsonapi.org/foo',
            'self',
        ],
        [
            'https://jsonapi.org/foo',
            'self',
        ],
        TRUE,
    ]);
    (yield 'different href and same link relation type' => [
        [
            'https://jsonapi.org/foo',
            'self',
        ],
        [
            'https://jsonapi.org/bar',
            'self',
        ],
        FALSE,
    ]);
    (yield 'same href and different link relation type' => [
        [
            'https://jsonapi.org/foo',
            'self',
        ],
        [
            'https://jsonapi.org/foo',
            'related',
        ],
        FALSE,
    ]);
    (yield 'same href and same link relation type and empty target attributes' => [
        [
            'https://jsonapi.org/foo',
            'self',
            [],
        ],
        [
            'https://jsonapi.org/foo',
            'self',
            [],
        ],
        TRUE,
    ]);
    (yield 'same href and same link relation type and same target attributes' => [
        [
            'https://jsonapi.org/foo',
            'self',
            [
                'anchor' => 'https://jsonapi.org',
            ],
        ],
        [
            'https://jsonapi.org/foo',
            'self',
            [
                'anchor' => 'https://jsonapi.org',
            ],
        ],
        TRUE,
    ]);
    // These links are not considered equivalent because it would while the
    // `href` remains the same, the anchor changes the context of the link.
    (yield 'same href and same link relation type and different target attributes' => [
        [
            'https://jsonapi.org/boy',
            'self',
            [
                'title' => 'sue',
            ],
        ],
        [
            'https://jsonapi.org/boy',
            'self',
            [
                'anchor' => '/sob',
                'title' => 'pa',
            ],
        ],
        FALSE,
    ]);
    (yield 'same href and same link relation type and same nested target attributes' => [
        [
            'https://jsonapi.org/foo',
            'self',
            [
                'data' => [
                    'foo' => 'bar',
                ],
            ],
        ],
        [
            'https://jsonapi.org/foo',
            'self',
            [
                'data' => [
                    'foo' => 'bar',
                ],
            ],
        ],
        TRUE,
    ]);
    (yield 'same href and same link relation type and different nested target attributes' => [
        [
            'https://jsonapi.org/foo',
            'self',
            [
                'data' => [
                    'foo' => 'bar',
                ],
            ],
        ],
        [
            'https://jsonapi.org/foo',
            'self',
            [
                'data' => [
                    'foo' => 'baz',
                ],
            ],
        ],
        FALSE,
    ]);
    // These links are not considered equivalent because it would be unclear
    // which title corresponds to which link relation type.
    (yield 'same href and different link relation types and different target attributes' => [
        [
            'https://jsonapi.org/boy',
            'self',
            [
                'title' => 'A boy named Sue',
            ],
        ],
        [
            'https://jsonapi.org/boy',
            'edit',
            [
                'title' => 'Change name to Bill or George',
            ],
        ],
        FALSE,
    ]);
}