Mirrors/wiosna-dev_common-library
1
0
Fork 1
mirror of https://github.com/wiosna-dev/common-library.git synced 2026-03-12 01:31:45 +01:00
Code Issues Packages Projects Releases Wiki Activity

Create and implement CollectionInterface as contract of all collections (e.g. based on the BaseCollection class)

Browse Source
This commit is contained in:
Meritoo
2021-03-29 19:02:28 +02:00
parent e47eaae8b2
commit 4f8c355d1b
8 changed files with 93 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGELOG.md
View File

@@ -5,6 +5,7 @@ Common and useful classes, methods, exceptions etc.
# 1.1.3
1. Move `Renderable` class: `Meritoo\Common` -> `Meritoo\Common\Contract`
2. Create and implement `CollectionInterface` as contract of all collections (e.g. based on the `BaseCollection` class)
# 1.1.2

8
src/Collection/BaseCollection.php
View File

@@ -6,11 +6,11 @@
* file that was distributed with this source code.
*/
declare(strict_types=1);
namespace Meritoo\Common\Collection;
use ArrayAccess;
use Countable;
use IteratorAggregate;
use Meritoo\Common\Contract\Collection\CollectionInterface;
use Meritoo\Common\Traits\CollectionTrait;
/**
@@ -19,7 +19,7 @@ use Meritoo\Common\Traits\CollectionTrait;
* @author Meritoo <github@meritoo.pl>
* @copyright Meritoo <http://www.meritoo.pl>
*/
abstract class BaseCollection implements Countable, ArrayAccess, IteratorAggregate
abstract class BaseCollection implements CollectionInterface
{
use CollectionTrait;

52
src/Contract/Collection/CollectionInterface.php Normal file
View File

@@ -0,0 +1,52 @@
<?php
/**
* (c) Meritoo.pl, http://www.meritoo.pl
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
declare(strict_types=1);
namespace Meritoo\Common\Contract\Collection;
use ArrayAccess;
use Countable;
use IteratorAggregate;
/**
* Interface/Contract of collection of elements with the same type
*
* @author Meritoo <github@meritoo.pl>
* @copyright Meritoo <http://www.meritoo.pl>
*/
interface CollectionInterface extends Countable, ArrayAccess, IteratorAggregate
{
public function toArray(): array;
public function add($element, $index = null): void;
public function addMultiple($elements, bool $useIndexes = false): void;
public function prepend($element): void;
public function remove($element): void;
public function getPrevious($element);
public function getNext($element);
public function getFirst();
public function getLast();
public function getByIndex($index);
public function isEmpty(): bool;
public function isFirst($element): bool;
public function isLast($element): bool;
public function has($element): bool;
}

2
src/Contract/Renderable/RenderableInterface.php
View File

@@ -13,7 +13,7 @@ namespace Meritoo\Common\Contract\Renderable;
use Meritoo\Common\Collection\Templates;
/**
* Something that may be rendered
* Interface/Contract of something that may be rendered
*
* @author Meritoo <github@meritoo.pl>
* @copyright Meritoo <http://www.meritoo.pl>

8
src/Traits/Collection/AddTrait.php
View File

@@ -8,7 +8,7 @@
namespace Meritoo\Common\Traits\Collection;
use Meritoo\Common\Collection\BaseCollection;
use Meritoo\Common\Contract\Collection\CollectionInterface;
/**
* Trait for the Collection with add*() methods
@@ -42,9 +42,9 @@ trait AddTrait
/**
* Adds given elements (at the end of collection)
*
* @param array|BaseCollection $elements The elements to add
* @param bool $useIndexes (optional) If is set to true, indexes of given elements will be used in
* this collection. Otherwise - not.
* @param array|CollectionInterface $elements The elements to add
* @param bool $useIndexes (optional) If is set to true, indexes of given elements will be
* used in this collection. Otherwise - not.
*/
public function addMultiple($elements, bool $useIndexes = false): void
{

2
src/Traits/CollectionTrait.php
View File

@@ -6,6 +6,8 @@
* file that was distributed with this source code.
*/
declare(strict_types=1);
namespace Meritoo\Common\Traits;
use Meritoo\Common\Traits\Collection\AddTrait;

14
src/Utilities/Reflection.php
View File

@@ -10,7 +10,7 @@ namespace Meritoo\Common\Utilities;
use Doctrine\Inflector\InflectorFactory;
use Doctrine\Persistence\Proxy;
use Meritoo\Common\Collection\BaseCollection;
use Meritoo\Common\Contract\Collection\CollectionInterface;
use Meritoo\Common\Exception\Reflection\CannotResolveClassNameException;
use Meritoo\Common\Exception\Reflection\MissingChildClassesException;
use Meritoo\Common\Exception\Reflection\NotExistingPropertyException;
@@ -207,11 +207,11 @@ class Reflection
* Returns values of given property for given objects.
* Looks for proper getter for the property.
*
* @param array|BaseCollection|object $objects The objects that should contain given property. It may be also one
* object.
* @param string $property Name of the property that contains a value
* @param bool $force (optional) If is set to true, try to retrieve value even if the
* object does not have property. Otherwise - not.
* @param array|CollectionInterface|object $objects The objects that should contain given property. It may be also
* one object.
* @param string $property Name of the property that contains a value
* @param bool $force (optional) If is set to true, try to retrieve value even if
* the object does not have property. Otherwise - not.
* @return array
*/
public static function getPropertyValues($objects, string $property, bool $force = false): array
@@ -224,7 +224,7 @@ class Reflection
return [];
}
if ($objects instanceof BaseCollection) {
if ($objects instanceof CollectionInterface) {
$objects = $objects->toArray();
}

39
tests/Collection/BaseCollectionTest.php
View File

@@ -13,6 +13,7 @@ use Generator;
use Meritoo\Common\Collection\BaseCollection;
use Meritoo\Common\Collection\DateTimeCollection;
use Meritoo\Common\Collection\StringCollection;
use Meritoo\Common\Contract\Collection\CollectionInterface;
use Meritoo\Common\Test\Base\BaseTestCase;
use Meritoo\Common\Type\OopVisibilityType;
use Meritoo\Test\Common\Collection\BaseCollection\FirstNamesCollection;
@@ -139,15 +140,19 @@ class BaseCollectionTest extends BaseTestCase
}
/**
* @param mixed $element The element to add
* @param int $expectedCount Expected count of elements in collection
* @param int $expectedIndex Expected index of added element in collection
* @param BaseCollection $collection The collection
* @param mixed $element The element to add
* @param int $expectedCount Expected count of elements in collection
* @param int $expectedIndex Expected index of added element in collection
* @param CollectionInterface $collection The collection
*
* @dataProvider provideElementToAdd
*/
public function testAddWithoutIndex($element, $expectedCount, $expectedIndex, BaseCollection $collection)
{
public function testAddWithoutIndex(
$element,
int $expectedCount,
int $expectedIndex,
CollectionInterface $collection
) {
$collection->add($element);
static::assertTrue($collection->has($element));
@@ -156,15 +161,15 @@ class BaseCollectionTest extends BaseTestCase
}
/**
* @param mixed $element The element to add
* @param mixed $index Index of element to add
* @param int $expectedCount Expected count of elements in collection
* @param int $expectedIndex Expected index of added element in collection
* @param BaseCollection $collection The collection
* @param mixed $element The element to add
* @param mixed $index Index of element to add
* @param int $expectedCount Expected count of elements in collection
* @param int $expectedIndex Expected index of added element in collection
* @param CollectionInterface $collection The collection
*
* @dataProvider provideElementToAddWithIndex
*/
public function testAddWithIndex($element, $index, $expectedCount, $expectedIndex, BaseCollection $collection)
public function testAddWithIndex($element, $index, $expectedCount, $expectedIndex, CollectionInterface $collection)
{
$collection->add($element, $index);
@@ -340,14 +345,14 @@ class BaseCollectionTest extends BaseTestCase
}
/**
* @param string $description Description of test
* @param BaseCollection $collection Collection to search for element with given index
* @param mixed $index Index / key of the element
* @param mixed $expected Expected element with given index
* @param string $description Description of test
* @param CollectionInterface $collection Collection to search for element with given index
* @param mixed $index Index / key of the element
* @param mixed $expected Expected element with given index
*
* @dataProvider provideElementGetByIndex
*/
public function testGetByIndex($description, BaseCollection $collection, $index, $expected)
public function testGetByIndex($description, CollectionInterface $collection, $index, $expected)
{
static::assertEquals($expected, $collection->getByIndex($index), $description);
}