Returns the description message.
| public static description ( ) : string | ||
| return | string | The description message. |
});
});
context("with a traversable instance", function () {
it("passes when the key is contained", function () {
expect(new Traversable(['data' => [1, 2, 3]]))->toContainKey(2);
expect(new Traversable(['data' => ['a' => 1, 'b' => 2, 'c' => 3]]))->toContainKey('a');
expect(new Traversable(['data' => ['a' => null]]))->toContainKey('a');
});
it("passes when the keys are contained", function () {
expect(new Traversable(['data' => ['a' => 1, 'b' => 2, 'c' => 3]]))->toContainKeys('a', 'b');
expect(new Traversable(['data' => ['a' => 1, 'b' => 2, 'c' => 3]]))->toContainKeys(['a', 'b']);
});
it("returns `false` when a key is missing", function () {
expect(new Traversable(['data' => ['a' => 1, 'b' => 2, 'c' => 3]]))->not->toContainKey('d');
expect(new Traversable(['data' => ['a' => 1, 'b' => 2, 'c' => 3]]))->not->toContainKeys('a', 'd');
expect(new Traversable(['data' => ['a' => 1, 'b' => 2, 'c' => 3]]))->not->toContainKeys(['a', 'd']);
});
});
it("fails with non array/collection/traversable", function () {
expect(new stdClass())->not->toContainKey('key');
expect(false)->not->toContainKey('0');
expect(true)->not->toContainKey('1');
});
});
describe("::description()", function () {
it("returns the description message", function () {
$actual = ToContainKey::description();
expect($actual)->toBe('contain expected key.');
});
});
});
