scrumworks/property-reader

Property reader which can work with typed properties and phpdoc

v0.8 2024-10-23 13:43 UTC

Requires

• php: >=8.1
• nette/utils: ^3.1 || ^4.0.4

Requires (Dev)

• php-parallel-lint/php-parallel-lint: ^1.3
• phpstan/phpstan: ^1.10
• phpunit/phpunit: ^10.5.9
• rector/rector: ^1.0
• slevomat/coding-standard: ^8.14
• symplify/easy-ci: 12.0.2
• symplify/easy-coding-standard: ^12.1
• symplify/phpstan-extensions: ^11.4.3

MIT

• Tomas Lang

• property

README

Installation

composer require scrumworks/property-reader

Documentation

Class property can be translated to these variants:

null

null is returned for properties without any information.

It's generally mixed type, but it's acting differently f.e. in array types.

public $var;

MixedVariableType

It's returned for variables with mixed directly information.

/**
 * @var mixed
 */
public $var;

ScalarVariableType

Supports this basic scalar types:

• int, integer
• float
• bool, boolean
• string

/**
 * @var integer
 */
public int $var;

ArrayVariableType

Arrays are considered to be seqential array or hashmap.

Arrays are translated in this way: (we use definition array<key, type>)

• generic array has type array<null, null>
• seqential int[] has type array<null, int>
• hashmap array<string, string> has type array<string, string>

In general - null in key is proposing seqential array, other types (only integer and string are supported) are propose hashmap. Only difference is key == value == null, then it's generic array.

Warning - mixed[] has different type than array

We also support nested arrays like int[][] or array<string, string>[]

/**
 * @var int[]
 */
public array $var;

ClassVariableType

/**
 * @var SomeClass
 */
public SomeClass $var;

UnionVariableType

/**
 * @var int|string
 */
public $var;

Nullablity of types

Every type can by set to be nullable in this ways:

• ?int
• int|null

Types null and MixedVariableType are nullable by default.

Warning - ?int|string isn't (?int)|string but int|string|null

Example usage

<?php

use ScrumWorks\PropertyReader\PropertyTypeReader;
use ScrumWorks\PropertyReader\VariableTypeWriter;
use ScrumWorks\PropertyReader\VariableTypeUnifyService;

class Example
{
    public $untyped;

    public int $integer;

    /**
     * @var ?string
     */
    public $nullableString;

    /**
     * @var array<string, string[]>
     */
    public array $hashmap;

    public VariableTypeWriter $class;

    /**
     * @var int|int[]|null
     */
    public $union;
}

$reflection = new ReflectionClass(Example::class);

$variableTypeUnifyService = new VariableTypeUnifyService();
$propertyTypeReader = new PropertyTypeReader($variableTypeUnifyService);
$variableTypeWriter = new VariableTypeWriter();

foreach ($reflection->getProperties() as $propertyReflection) {
    $variableType = $propertyTypeReader->readUnifiedVariableType($propertyReflection);
    printf(
        "%s: %s\n",
        $propertyReflection->getName(),
        $variableTypeWriter->variableTypeToString($variableType)
    );
}

will result to

untyped: mixed
integer: int
nullableString: ?string
hashmap: array<string, string[]>
class: ScrumWorks\PropertyReader\VariableTypeWriter
union: ?int|int[]

VariableType API

use ScrumWorks\PropertyReader\VariableType\ArrayVariableType;
use ScrumWorks\PropertyReader\VariableType\ScalarVariableType;

// load object...

/** @var ArrayVariableType $hashmapType */
$hashmapType = $propertyTypeReader->readUnifiedVariableType($reflection->getProperty('hashmap'));
assert($hashmapType->isNullable() === false);
assert($hashmapType->getKeyType() instanceof ScalarVariableType);
assert($hashmapType->getKeyType()->getType() === ScalarVariableType::TYPE_STRING);

Testing

You can run the tests with:

composer run-script test

Contribution Guide

Feel free to open an Issue or add a Pull request.

Credits

People:

• Tomas Lang
• Adam Lutka