PHPackages                             brightnucleus/keys - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Validation & Sanitization](/categories/validation)
4. /
5. brightnucleus/keys

ActiveLibrary[Validation & Sanitization](/categories/validation)

brightnucleus/keys
==================

Validatable key objects.

v0.1.2(8y ago)31821MITPHP

Since Jul 4Pushed 8y ago2 watchersCompare

[ Source](https://github.com/brightnucleus/keys)[ Packagist](https://packagist.org/packages/brightnucleus/keys)[ RSS](/packages/brightnucleus-keys/feed)WikiDiscussions master Synced 4w ago

READMEChangelogDependencies (4)Versions (4)Used By (1)

Bright Nucleus Keys
===================

[](#bright-nucleus-keys)

[![Latest Stable Version](https://camo.githubusercontent.com/efaf282233376bb73444901d6c6d4943e20ca897cc17ed6f7d715b3c0be3468d/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6272696768746e75636c6575732f6b6579732e737667)](https://packagist.org/packages/brightnucleus/keys)[![Total Downloads](https://camo.githubusercontent.com/bb000eedc5a3aee05f8e0ee0f8fea36dbcfe56cf16f5ffbc5221083f7225f116/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f6272696768746e75636c6575732f6b6579732e737667)](https://packagist.org/packages/brightnucleus/keys)[![Latest Unstable Version](https://camo.githubusercontent.com/1dff708c1c564217c6922984925c18b42779ffeba19a3845162ef153bbcab638/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f767072652f6272696768746e75636c6575732f6b6579732e737667)](https://packagist.org/packages/brightnucleus/keys)[![License](https://camo.githubusercontent.com/0a16cd00459158509800292bc07ff072e75f09dcdc2a81ae3601a58d02bf62ca/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f6272696768746e75636c6575732f6b6579732e737667)](https://packagist.org/packages/brightnucleus/keys)

This package provides validatable key objects that are meant to be used as identifiers.

Table Of Contents
-----------------

[](#table-of-contents)

- [Installation](#installation)
- [Basic Usage](#basic-usage)
- [Advanced Usage](#advanced-usage)
- [Contributing](#contributing)
- [License](#license)

Installation
------------

[](#installation)

The best way to use this package is through Composer:

```
composer require brightnucleus/keys
```

Basic Usage
-----------

[](#basic-usage)

### Basic `Key` class

[](#basic-key-class)

Usage of the basic `BrightNucleus\Keys\Key` class is very simple, you just instantiate it by passing the actual value you want to use as a key through the constructor.

Example:

```