chillerlan / php-traits

src/Enumerable.php

<?php
/**
 * Trait Enumerable
 *
 * @filesource   Enumerable.php
 * @created      28.06.2017
 * @package      chillerlan\Traits
 * @author       Smiley <smiley@chillerlan.net>
 * @copyright    2017 Smiley
 * @license      MIT
 */

namespace chillerlan\Traits;

/**
 * @link http://api.prototypejs.org/language/Enumerable/
 */
trait Enumerable{

	/**
	 * @var array
	 */
	protected $array = [];

	/**
	 * @var int
	 */
	protected $offset = 0;

	/**
	 * @link http://api.prototypejs.org/language/Enumerable/prototype/toArray/
	 *
	 * @return array
	 *
	 * @codeCoverageIgnore
	 */
	public function __toArray():array {
		return $this->array;
	}

	/**
	 * @link http://api.prototypejs.org/language/Enumerable/prototype/each/
	 *
	 * @param callable $callback
	 *
	 * @return $this
	 */
	public function __each($callback){
		$this->__map($callback);

		return $this;
	}

	/**
	 * @link http://api.prototypejs.org/language/Enumerable/prototype/collect/
	 * @link http://api.prototypejs.org/language/Enumerable/prototype/map/
	 *
	 * @param callable $callback
	 *
	 * @return array
	 * @throws \chillerlan\Traits\TraitException
	 */
	public function __map($callback):array {

		if(!\is_callable($callback)){
			throw new TraitException('invalid callback');
		}

		$return = [];

		foreach($this->array as $index => $element){
			$return[$index] = \call_user_func_array($callback, [$element, $index]);
		}

		return $return;
	}

	/**
	 * @link http://api.prototypejs.org/language/Array/prototype/reverse/
	 *
	 * @return \chillerlan\Traits\EnumerableInterface
	 */
	public function __reverse():EnumerableInterface{
		$this->array  = \array_reverse($this->array);
		$this->offset = 0;

		return $this;

The expression return $this returns the type chillerlan\Traits\Enumerable which is incompatible with the type-hinted return chillerlan\Traits\EnumerableInterface.

	}

	/**
	 * @return mixed
	 */
	public function __first(){
		return $this->array[0] ?? null;
	}

	/**
	 * @return mixed
	 */
	public function __last(){
		return $this->array[\count($this->array) - 1] ?? null;
	}

	/**
	 * @return \chillerlan\Traits\EnumerableInterface
	 */
	public function __clear():EnumerableInterface{
		$this->array = [];

		return $this;

The expression return $this returns the type chillerlan\Traits\Enumerable which is incompatible with the type-hinted return chillerlan\Traits\EnumerableInterface.

	}

	/**
	 * @link http://api.prototypejs.org/language/Array/prototype/inspect/
	 *
	 * @return string
	 */
	public function __inspect():string {
		return \print_r($this->array, true);
	}

	/**
	 * @link http://api.prototypejs.org/language/Enumerable/prototype/findAll/
	 *
	 * @param callable $callback
	 *
	 * @return array
	 * @throws \chillerlan\Traits\TraitException
	 */
	public function __findAll($callback):array{

		if(!\is_callable($callback)){
			throw new TraitException('invalid callback');
		}

		$return = [];

		foreach($this->array as $index => $element){

			if(\call_user_func_array($callback, [$element, $index]) === true){
				$return[] = $element;
			}

		}

		return $return;
	}

	/**
	 * @link http://api.prototypejs.org/language/Enumerable/prototype/reject/
	 *
	 * @param callable $callback
	 *
	 * @return array
	 * @throws \chillerlan\Traits\TraitException
	 */
	public function __reject($callback):array{

		if(!\is_callable($callback)){
			throw new TraitException('invalid callback');
		}

		$return = [];

		foreach($this->array as $index => $element){

			if(\call_user_func_array($callback, [$element, $index]) !== true){
				$return[] = $element;
			}

		}

		return $return;
	}

}