seboettg / Collection

src/Stack/StackTrait.php

<?php
declare(strict_types=1);
/*
 * Copyright (C) 2018 Sebastian Böttger <seboettg@gmail.com>
 * You may use, distribute and modify this code under the
 * terms of the MIT license.
 *
 * You should have received a copy of the MIT license with
 * this file. If not, please visit: https://opensource.org/licenses/mit-license.php
 */

namespace Seboettg\Collection\Stack;

/**
 * Trait StackTrait
 * @package Seboettg\Collection
 * @author Sebastian Böttger <seboettg@gmail.com>
 * @property $array Base array of this data structure
 */

The doc comment $array at position 0 could not be parsed: Unknown type name '$array' at position 0 in $array.

trait StackTrait
{
    /**
     * {@inheritdoc}
     */
    public function push($item): StackInterface
    {
        $this->array[] = $item;

The property array does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        return $this;

The expression return $this returns the type Seboettg\Collection\Stack\StackTrait which is incompatible with the type-hinted return Seboettg\Collection\Stack\StackInterface.

    }

    /**
     * {@inheritdoc}
     */
    public function pop()
    {
        return array_pop($this->array);
    }

    /**
     * {@inheritdoc}
     */
    public function peek()
    {
        return end($this->array);
    }

    /**
     * {@inheritdoc}
     */
    public function search($element)
    {
        $pos = array_search($element, $this->array);
        if ($pos === false) {
            return 0;
        }
        $count = $this->count();
        return $count - $pos;
    }

    /**
     * {@inheritdoc}
     */
    public function count(): int
    {
        return count($this->array);
    }
}