Indices de type dans PHP 7 - tableau d'objets

Question

Peut-être ai-je oublié quelque chose, mais y a-t-il une option pour définir cette fonction qui devrait avoir un argument ou retourner, par exemple, un tableau d'objets User?

Considérons le code suivant:

<?php

class User
{
    protected $name;

    protected $age;

    /**
     * User constructor.
     *
     * @param $name
     */
    public function __construct(string $name, int $age)
    {
        $this->name = $name;
        $this->age = $age;
    }

    /**
     * @return mixed
     */
    public function getName() : string
    {
        return $this->name;
    }

    public function getAge() : int
    {
        return $this->age;
    }
}

function findUserByAge(int $age, array $users) : array
{
    $result = [];
    foreach ($users as $user) {
        if ($user->getAge() == $age) {
            if ($user->getName() == 'John') {
                // complicated code here
                $result[] = $user->getName(); // bug
            } else {
                $result[] = $user;
            }
        }
    }

    return $result;
}

$users = [
    new User('John', 15),
    new User('Daniel', 25),
    new User('Michael', 15),
];

$matches = findUserByAge(15, $users);

foreach ($matches as $user) {
    echo $user->getName() . ' '.$user->getAge() . "\n";
}

Existe-t-il une option dans PHP7 pour indiquer à la fonction findUserByAge de renvoyer un tableau d'utilisateurs? Je m'attendrais à ce que, lorsque l'ajout de soupçon de type soit ajouté, cela soit possible, mais je n'ai trouvé aucune information sur le soupçon de type d'un tableau d'objets. Elle n'est donc probablement pas incluse dans PHP 7. Si ce n'est pas inclus Avez-vous la moindre idée de la raison pour laquelle il n’a pas été inclus lors de l’ajout de la suggestion de type?

Answer 1

Ce n'est pas inclus.

Si elle n’est pas incluse, avez-vous une idée de la raison pour laquelle elle n’a pas été incluse lors de l’ajout de la suggestion de type?

Avec l'implémentation actuelle du tableau, il faudrait vérifier tous les éléments du tableau au moment de l'exécution, car le tableau lui-même ne contient aucune information de type.

En fait, il a déjà été proposé pour PHP 5.6 mais rejeté: RFC "arrayof" - curieusement non à cause de problèmes de performances qui se sont révélés négligeables, mais parce aucun accord sur la manière dont elle devrait être mise en œuvre avec exactitude. Il y avait également une objection à ce que ce soit incomplet sans indications de type scalaire. Si vous êtes intéressé par toute la discussion, lisez-la dans les archives de la liste de diffusion .

Les conseils de type tableau IMHO apporteraient le plus d'avantages avec les tableaux typés, et j'aimerais les voir implémentés.

Alors peut-être qu'il est temps de lancer une nouvelle RFC et de rouvrir cette discussion.

---

Contournement partiel:

vous pouvez taper des arguments variadic indice et écrire ainsi la signature comme

function findUserByAge(int $age, User ...$users) : array

Usage:

findUserByAge(15, ...$userInput);

Dans cet appel, l'argument $userInput sera "décompacté" en variables uniques et, dans la méthode elle-même, "replié" dans un tableau $users. Chaque élément est validé pour être de type User. $userInput peut aussi être un itérateur, il sera converti en tableau.

Malheureusement, il n'existe aucune solution de contournement similaire pour les types de retour et vous ne pouvez l'utiliser que pour le dernier argument.

Answer 2

Comme les tableaux peuvent contenir des valeurs mixtes, cela n’est pas possible.

Vous devez utiliser un objet/une classe à cette fin.

Vous pouvez créer une classe qui gérera son propre tableau de liste (attribut privé/protégé) et interdire l’ajout d’autres valeurs comme solution de contournement à ce problème si cela est vraiment nécessaire.

Cependant, aucun programmeur responsable ne rompra jamais le modèle souhaité, surtout si vous le commentez correctement. De toute façon, il y aura des erreurs dans le programme.

L'exaplanation:

Par exemple, vous pouvez créer n’importe quel tableau:

$myArray = array();

et ajouter un numéro:

$myArray[] = 1;

un string:

$myArray[] = "abc123";

et un objet

$myArray[] = new MyClass("some parameter", "and one more");

N'oubliez pas également que vous pouvez avoir un tableau simple, un tableau empilé multidimensionnel ainsi que des tableaux associatifs pouvant également comporter des motifs mixtes.

C'est assez difficile, voire impossible, de trouver un analyseur syntaxique/une note pour que toutes les versions fonctionnent avec une expression qui force le format d'un tableau, je pense.

Ce serait cool d'un côté, mais de l'autre côté de la médaille, vous perdriez un peu de capacité à mélanger des données dans un tableau, ce qui pourrait être crucial pour beaucoup de code existant et la flexibilité PHP a offrir.

En raison du contenu mixte que nous ne souhaitons pas manquer à la fonctionnalité PHP 7, il n'est pas possible de dactylographier le contenu exact d'un tableau, car vous pouvez le placer dans un élément.

Answer 3

Ajoutant à ce que Steini a répondu.

Vous pouvez créer une classe ObjectNIterator qui gère votre ObjectN et implémente un Iterator: http://php.net/manual/en/class.iterator.php

Depuis methodN, appelez classMethodM qui restitue un ObjectNIterator rempli, puis transmettez ces données à un methodO qui attend ObjectNIterator:

public function methodO(ObjectNIterator $objectNCollection)

Answer 4

Je donne une réponse générique à propos de l'indication de type des tableaux en général.

J'ai fait une variation de la réponse sélectionnée. La principale différence est que le paramètre est un tableau au lieu de nombreuses instances de la classe contrôlée.

/**
 * @param $_foos Foo[]
 */
function doFoo(array $_foos)
{return (function(Foo ...$_foos){

    // Do whatever you want with the $_foos array

})(...$_foos);}

Cela semble un peu flou mais c'est assez facile à comprendre. Au lieu de toujours décompresser manuellement le tableau à chaque appel, la fermeture de la fonction est appelée avec votre tableau décompressé en tant que paramètre.

function doFoo(array $_foos)
{
    return (function(Foo ...$_foos){ // Closure

    // Do whatever you want with the $_foos array

    })(...$_foos); //Main function's parameter $_foos unpacked
}

Je trouve cela plutôt cool puisque vous pouvez utiliser la fonction comme n'importe quelle autre fonction de langage ayant un paramètre ArrayOfType. De plus, l’erreur est gérée de la même manière que le reste de PHP tapez des erreurs de soupçon. De plus, vous ne confondez pas les autres programmeurs qui utiliseront votre fonction et devront décompresser leur tableau, ce qui donne toujours l'impression un peu hacky.

Vous avez besoin d’un peu d’expérience en programmation pour comprendre comment cela fonctionne. Si vous avez besoin de plus d'un paramètre, vous pouvez toujours les ajouter dans la section 'utilisation' de la fermeture.

Vous pouvez également utiliser les commentaires doc pour exposer l'indicateur de type.

/**
 * @param $_foos Foo[] <- An array of type Foo
 */

Voici un exemple OO:

class Foo{}

class NotFoo{}

class Bar{
    /**
     * @param $_foos Foo[]
     */
    public function doFoo(array $_foos, $_param2)
    {return (function(Foo ...$_foos) use($_param2){

        return $_param2;

    })(...$_foos);}
}

$myBar = new Bar();
$arrayOfFoo = array(new Foo(), new Foo(), new Foo());
$notArrayOfFoo = array(new Foo(), new NotFoo(), new Foo());

echo $myBar->doFoo($arrayOfFoo, 'Success');
// Success

echo $myBar->doFoo($notArrayOfFoo, 'Success');
// Uncaught TypeError: Argument 2 passed to Bar::{closure}() must be an instance of Foo, instance of NotFoo given...

Note: Ceci fonctionne aussi avec les types non-objets (int, chaîne, etc.)

Answer 5

Dans notre base de code, nous avons le concept de collections. Celles-ci sont basées sur une classe appelée TypedArray basée sur ArrayObject.

class ArrayObject extends \ArrayObject
{
    /**
     * Clone a collection by cloning all items.
     */
    public function __clone()
    {
        foreach ($this as $key => $value) {
            $this[$key] = is_object($value) ? clone $value : $value;
        }
    }

    /**
     * Inserting the provided element at the index. If index is negative, it will be calculated from the end of the Array Object
     *
     * @param int $index
     * @param mixed $element
     */
    public function insert(int $index, $element)
    {
        $data = $this->getArrayCopy();
        if ($index < 0) {
            $index = $this->count() + $index;
        }

        $data = array_merge(array_slice($data, 0, $index, true), [$element], array_slice($data, $index, null, true));
        $this->exchangeArray($data);
    }

    /**
     * Remove a portion of the array and optionally replace it with something else.
     *
     * @see array_splice()
     *
     * @param int $offset
     * @param int|null $length
     * @param null $replacement
     *
     * @return static
     */
    public function splice(int $offset, int $length = null, $replacement = null)
    {
        $data = $this->getArrayCopy();

        // A null $length AND a null $replacement is not the same as supplying null to the call.
        if (is_null($length) && is_null($replacement)) {
            $result = array_splice($data, $offset);
        } else {
            $result = array_splice($data, $offset, $length, $replacement);
        }
        $this->exchangeArray($data);

        return new static($result);
    }

    /**
     * Adding a new value at the beginning of the collection
     *
     * @param mixed $value
     *
     * @return int Returns the new number of elements in the Array
     */
    public function unshift($value): int
    {
        $data = $this->getArrayCopy();
        $result = array_unshift($data, $value);
        $this->exchangeArray($data);

        return $result;
    }

    /**
     * Extract a slice of the array.
     *
     * @see array_slice()
     *
     * @param int $offset
     * @param int|null $length
     * @param bool $preserveKeys
     *
     * @return static
     */
    public function slice(int $offset, int $length = null, bool $preserveKeys = false)
    {
        return new static(array_slice($this->getArrayCopy(), $offset, $length, $preserveKeys));
    }

    /**
     * Sort an array.
     *
     * @see sort()
     *
     * @param int $sortFlags
     *
     * @return bool
     */
    public function sort($sortFlags = SORT_REGULAR)
    {
        $data = $this->getArrayCopy();
        $result = sort($data, $sortFlags);
        $this->exchangeArray($data);

        return $result;
    }

    /**
     * Apply a user supplied function to every member of an array
     *
     * @see array_walk
     *
     * @param callable $callback
     * @param mixed|null $userData
     *
     * @return bool Returns true on success, otherwise false
     *
     * @see array_walk()
     */
    public function walk($callback, $userData = null)
    {
        $data = $this->getArrayCopy();
        $result = array_walk($data, $callback, $userData);
        $this->exchangeArray($data);

        return $result;
    }

    /**
     * Chunks the object into ArrayObject containing
     *
     * @param int $size
     * @param bool $preserveKeys
     *
     * @return ArrayObject
     */
    public function chunk(int $size, bool $preserveKeys = false): ArrayObject
    {
        $data = $this->getArrayCopy();
        $result = array_chunk($data, $size, $preserveKeys);

        return new ArrayObject($result);
    }

    /**
     * @see array_column
     *
     * @param mixed $columnKey
     *
     * @return array
     */
    public function column($columnKey): array
    {
        $data = $this->getArrayCopy();
        $result = array_column($data, $columnKey);

        return $result;
    }

    /**
     * @param callable $mapper Will be called as $mapper(mixed $item)
     *
     * @return ArrayObject A collection of the results of $mapper(mixed $item)
     */
    public function map(callable $mapper): ArrayObject
    {
        $data = $this->getArrayCopy();
        $result = array_map($mapper, $data);

        return new self($result);
    }

    /**
     * Applies the callback function $callable to each item in the collection.
     *
     * @param callable $callable
     */
    public function each(callable $callable)
    {
        foreach ($this as &$item) {
            $callable($item);
        }
        unset($item);
    }

    /**
     * Returns the item in the collection at $index.
     *
     * @param int $index
     *
     * @return mixed
     *
     * @throws InvalidArgumentException
     * @throws OutOfRangeException
     */
    public function at(int $index)
    {
        $this->validateIndex($index);

        return $this[$index];
    }

    /**
     * Validates a number to be used as an index
     *
     * @param int $index The number to be validated as an index
     *
     * @throws OutOfRangeException
     * @throws InvalidArgumentException
     */
    private function validateIndex(int $index)
    {
        $exists = $this->indexExists($index);

        if (!$exists) {
            throw new OutOfRangeException('Index out of bounds of collection');
        }
    }

    /**
     * Returns true if $index is within the collection's range and returns false
     * if it is not.
     *
     * @param int $index
     *
     * @return bool
     *
     * @throws InvalidArgumentException
     */
    public function indexExists(int $index)
    {
        if ($index < 0) {
            throw new InvalidArgumentException('Index must be a non-negative integer');
        }

        return $index < $this->count();
    }

    /**
     * Finding the first element in the Array, for which $callback returns true
     *
     * @param callable $callback
     *
     * @return mixed Element Found in the Array or null
     */
    public function find(callable $callback)
    {
        foreach ($this as $element) {
            if ($callback($element)) {
                return $element;
            }
        }

        return null;
    }

    /**
     * Filtering the array by retrieving only these elements for which callback returns true
     *
     * @param callable $callback
     * @param int $flag Use ARRAY_FILTER_USE_KEY to pass key as the only argument to $callback instead of value.
     *                  Use ARRAY_FILTER_USE_BOTH pass both value and key as arguments to $callback instead of value.
     *
     * @return static
     *
     * @see array_filter
     */
    public function filter(callable $callback, int $flag = 0)
    {
        $data = $this->getArrayCopy();
        $result = array_filter($data, $callback, $flag);

        return new static($result);
    }

    /**
     * Reset the array pointer to the first element and return the element.
     *
     * @return mixed
     *
     * @throws \OutOfBoundsException
     */
    public function first()
    {
        if ($this->count() === 0) {
            throw new \OutOfBoundsException('Cannot get first element of empty Collection');
        }

        return reset($this);
    }

    /**
     * Reset the array pointer to the last element and return the element.
     *
     * @return mixed
     *
     * @throws \OutOfBoundsException
     */
    public function last()
    {
        if ($this->count() === 0) {
            throw new \OutOfBoundsException('Cannot get last element of empty Collection');
        }

        return end($this);
    }

    /**
     * Apply a user supplied function to every member of an array
     *
     * @see array_reverse
     *
     * @param bool $preserveKeys
     *
     * @return static
     */
    public function reverse(bool $preserveKeys = false)
    {
        return new static(array_reverse($this->getArrayCopy(), $preserveKeys));
    }

    public function keys(): array
    {
        return array_keys($this->getArrayCopy());
    }

    /**
     * Use a user supplied callback to reduce the array to a single member and return it.
     *
     * @param callable $callback
     * @param mixed|null $initial
     *
     * @return mixed
     */
    public function reduce(callable $callback, $initial = null)
    {
        return array_reduce($this->getArrayCopy(), $callback, $initial);
    }
}

et

/**
 * Class TypedArray
 *
 * This is a typed array
 *
 * By enforcing the type, you can guarantee that the content is safe to simply iterate and call methods on.
 */
abstract class AbstractTypedArray extends ArrayObject
{
    use TypeValidator;

    /**
     * Define the class that will be used for all items in the array.
     * To be defined in each sub-class.
     */
    const ARRAY_TYPE = null;

    /**
     * Array Type
     *
     * Once set, this ArrayObject will only accept instances of that type.
     *
     * @var string $arrayType
     */
    private $arrayType = null;

    /**
     * Constructor
     *
     * Store the required array type prior to parental construction.
     *
     * @param mixed[] $input Any data to preset the array to.
     * @param int $flags The flags to control the behaviour of the ArrayObject.
     * @param string $iteratorClass Specify the class that will be used for iteration of the ArrayObject object. ArrayIterator is the default class used.
     *
     * @throws InvalidArgumentException
     */
    public function __construct($input = [], $flags = 0, $iteratorClass = ArrayIterator::class)
    {
        // ARRAY_TYPE must be defined.
        if (empty(static::ARRAY_TYPE)) {
            throw new \RuntimeException(
                sprintf(
                    '%s::ARRAY_TYPE must be set to an allowable type.',
                    get_called_class()
                )
            );
        }

        // Validate that the ARRAY_TYPE is appropriate.
        try {
            $this->arrayType = $this->determineType(static::ARRAY_TYPE);
        } catch (\Collections\Exceptions\InvalidArgumentException $e) {
            throw new InvalidArgumentException($e->getMessage(), $e->getCode(), $e);
        }

        // Validate that the input is an array or an object with an Traversable interface.
        if (!(is_array($input) || (is_object($input) && in_array(Traversable::class, class_implements($input))))) {
            throw new InvalidArgumentException('$input must be an array or an object that implements \Traversable.');
        }

        // Create an empty array.
        parent::__construct([], $flags, $iteratorClass);

        // Append each item so to validate it's type.
        foreach ($input as $key => $value) {
            $this[$key] = $value;
        }
    }

    /**
     * Adding a new value at the beginning of the collection
     *
     * @param mixed $value
     *
     * @return int Returns the new number of elements in the Array
     *
     * @throws InvalidArgumentException
     */
    public function unshift($value): int
    {
        try {
            $this->validateItem($value, $this->arrayType);
        } catch (\Collections\Exceptions\InvalidArgumentException $e) {
            throw new InvalidArgumentException($e->getMessage(), $e->getCode(), $e);
        }

        return parent::unshift($value);
    }

    /**
     * Check the type and then store the value.
     *
     * @param mixed $offset The offset to store the value at or null to append the value.
     * @param mixed $value The value to store.
     *
     * @throws InvalidArgumentException
     */
    public function offsetSet($offset, $value)
    {
        try {
            $this->validateItem($value, $this->arrayType);
        } catch (\Collections\Exceptions\InvalidArgumentException $e) {
            throw new InvalidArgumentException($e->getMessage(), $e->getCode(), $e);
        }

        parent::offsetSet($offset, $value);
    }

    /**
     * Sort an array, taking into account objects being able to represent their sortable value.
     *
     * {@inheritdoc}
     */
    public function sort($sortFlags = SORT_REGULAR)
    {
        if (!in_array(SortableInterface::class, class_implements($this->arrayType))) {
            throw new \RuntimeException(
                sprintf(
                    "Cannot sort an array of '%s' as that class does not implement '%s'.",
                    $this->arrayType,
                    SortableInterface::class
                )
            );
        }
        // Get the data from
        $originalData = $this->getArrayCopy();
        $sortableData = array_map(
            function (SortableInterface $item) {
                return $item->getSortValue();
            },
            $originalData
        );

        $result = asort($sortableData, $sortFlags);

        $order = array_keys($sortableData);
        uksort(
            $originalData,
            function ($key1, $key2) use ($order) {
                return array_search($key1, $order) <=> array_search($key2, $order);
            }
        );

        $this->exchangeArray($originalData);

        return $result;
    }

    /**
     * {@inheritdoc}
     */
    public function filter(callable $callback, int $flag = 0)
    {
        if ($flag == ARRAY_FILTER_USE_KEY) {
            throw new InvalidArgumentException('Cannot filter solely by key. Use ARRAY_FILTER_USE_BOTH and amend your callback to receive $value and $key.');
        }

        return parent::filter($callback, $flag);
    }
}

Un exemple d'utilisation.

class PaymentChannelCollection extends AbstractTypedArray
{
    const ARRAY_TYPE = PaymentChannel::class;
}

Vous pouvez maintenant taper pointe avec PaymentChannelCollection et vous assurer que vous avez une collection de PaymentChannels (par exemple).

Certains codes peuvent appeler des exceptions dans notre espace de noms. Je pense qu’il existe également un validateur de types de danielgsims/php-collections (nous avions initialement utilisé ces collections, mais nous avions des problèmes de flexibilité - elles sont bonnes, mais pas pour nous - alors jetez-y un coup d’œil quand même!).