https://github.com/hamlet-framework/type

Hamlet Framework / Type
https://github.com/hamlet-framework/type

Last synced: 4 days ago
JSON representation

Hamlet Framework / Type

• Host: GitHub
• URL: https://github.com/hamlet-framework/type
• Owner: hamlet-framework
• License: gpl-2.0
• Created: 2019-04-30T04:59:02.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-02-06T02:31:37.000Z (9 months ago)
• Last Synced: 2024-07-27T22:40:02.153Z (4 months ago)
• Language: PHP
• Homepage:
• Size: 290 KB
• Stars: 19
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Hamlet Type 

===

![CI Status](https://github.com/hamlet-framework/type/workflows/CI/badge.svg?branch=master&event=push)

[![Packagist](https://img.shields.io/packagist/v/hamlet-framework/type.svg)](https://packagist.org/packages/hamlet-framework/type)

[![Packagist](https://img.shields.io/packagist/dt/hamlet-framework/type.svg)](https://packagist.org/packages/hamlet-framework/type)

[![Coverage Status](https://coveralls.io/repos/github/hamlet-framework/type/badge.svg?branch=master)](https://coveralls.io/github/hamlet-framework/type?branch=master)

![Psalm coverage](https://shepherd.dev/github/hamlet-framework/type/coverage.svg?)

There are few aspects of specifying type of expression in PHP:

1. The most exact specification of the type (we assume it's in psalm syntax): `array`

2. The sequence of run time assertions: `assert($records instanceof array)`

3. The type hint for static analysers (which is _psalm_ at the moment): `(array) $records`

4. The ability to derive types without string manipulation: `array || null`

5. The ability to cast when it's safe, i.e. falsey should cast to false, etc.

This library provides the basic building blocks for type specifications. For example, the following expression:

```php

$type = _map(

  _int(), 

  _union(

    _class(DateTime::class), 

    _null()

  )

)

```

creates an object of type `Type>`.

Asserting at run time, that the type of `$records` is `array>`:

```php

$type->assert($records);

```

Cast `$records` to `array>` and throw an exception when `$records` cannot be cast to `array>`:

```php

return $type->cast($records);

```

Combine type with other types, for example, making it nullable `array>|null`:

```php

_union($type, _null())

```

## Object like arrays

Object like arrays require more leg work. For example the type `array{id:int,name:string,valid?:bool}` 

corresponds to this construct:

```php

/** @var Type */

$type = _object_like([

    'id'     => _int(),

    'name'   => _string(),

    'valid?' => _bool()

]);

``` 

Quite a mouthful. Also, note the required `@var` as psalm currently have no support for dependent types. 

If you want to assert types matching your PHPDoc you can use the type parser (WiP):

```php

/** @var Type */

$type = Type::of('array{id:int}');

assert($type->matches($record));

```

## Background

- Move completely to PHPStan parsed including docblock

- Add union and intersection types 

- Support for enums

- Support for non-empty-* types

- Support for tuples as int `array{int,string}`

- Support for iterable|self|static|class-string

- Better support for callables

- Add PHPStan to QA pipeline