https://github.com/decodelabs/tightrope

Reusable constraints for your PHP classes
https://github.com/decodelabs/tightrope

constraints php

Last synced: 1 day ago
JSON representation

Reusable constraints for your PHP classes

• Host: GitHub
• URL: https://github.com/decodelabs/tightrope
• Owner: decodelabs
• License: mit
• Created: 2022-08-30T13:02:21.000Z (over 2 years ago)
• Default Branch: develop
• Last Pushed: 2024-09-04T21:38:03.000Z (4 months ago)
• Last Synced: 2025-01-03T18:43:55.380Z (6 days ago)
• Topics: constraints, php
• Language: PHP
• Homepage:
• Size: 30.3 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Tightrope

[![PHP from Packagist](https://img.shields.io/packagist/php-v/decodelabs/tightrope?style=flat)](https://packagist.org/packages/decodelabs/tightrope)

[![Latest Version](https://img.shields.io/packagist/v/decodelabs/tightrope.svg?style=flat)](https://packagist.org/packages/decodelabs/tightrope)

[![Total Downloads](https://img.shields.io/packagist/dt/decodelabs/tightrope.svg?style=flat)](https://packagist.org/packages/decodelabs/tightrope)

[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/decodelabs/tightrope/integrate.yml?branch=develop)](https://github.com/decodelabs/tightrope/actions/workflows/integrate.yml)

[![PHPStan](https://img.shields.io/badge/PHPStan-enabled-44CC11.svg?longCache=true&style=flat)](https://github.com/phpstan/phpstan)

[![License](https://img.shields.io/packagist/l/decodelabs/tightrope?style=flat)](https://packagist.org/packages/decodelabs/tightrope)

### Reusable constraints for your PHP classes.

Tightrope is a middleware package that provides library developers with a set of reusable semantic constraints.

_Get news and updates on the [DecodeLabs blog](https://blog.decodelabs.com)._

---

## Installation

```bash

composer require decodelabs/tightrope

```

## Usage

Tightrope defines a number of reusable interfaces that represent a property of an object, such as being disableable, readable or requirable:

```php

namespace DecodeLabs\Tightrope;

interface Nullable {

    public function isNullable(): bool;

}

```

It also supplies a _manifest_ version of each interface along with a trait implementation:

```php

namespace DecodeLabs\Tightrope\Manifest;

use DecodeLabs\Tightrope\Nullable as StaticNullable;

interface Nullable extends StaticNullable {

    public function setNullable(bool $flag): static;

}

```

You can use these interfaces to define properties of your objects:

```php

namespace My\Project;

use DecodeLabs\Exceptional;

use DecodeLabs\Tightrope\Manifest\Nullable;

use DecodeLabs\Tightrope\Manifest\NullableTrait;

class MyClass implements Nullable {

    use NullableTrait;

    public function doSomething(?string $value): void {

        if(

            !$this->isNullable() &&

            $value === null

        ) {

            throw Exceptional::InvalidArgument('Value cannot be null');

        }

        // ...

    }

}

$myObject = new MyClass();

$myObject->setNullable(true);

$myObject->doSomething(null); // Fine

$myObject->setNullable(false);

$myObject->doSomething(null); // Not fine

```

## Available properties

The following interfaces are currently available:

- Disableable

- Immutable

- Nullable

- Readable

- ReadOnlyable

- Requirable

- Writable

## Licensing

Tightrope is licensed under the MIT License. See [LICENSE](./LICENSE) for the full license text.