Implemented FixtureManagement

This commit is contained in:
Kevin Frantz
2019-02-02 23:02:28 +01:00
parent 52d38a0c84
commit aa735367d9
14 changed files with 549 additions and 293 deletions

View File

@@ -0,0 +1,12 @@
<?php
namespace App\Domain\FixtureManagement\FixtureSource;
/**
* Classes which inhiere from this class and should be loaded by SourceFixtures MUST be declared as final.
*
* @author kevinfrantz
*/
abstract class AbstractFixtureSource implements FixtureSourceInterface
{
}

View File

@@ -0,0 +1,26 @@
<?php
namespace App\Domain\FixtureManagement\FixtureSource;
use App\Entity\Source\SourceInterface;
use App\Attribut\SlugAttributInterface;
/**
* This interface allows to save the configuration values of an fixture in a class.
*
* @author kevinfrantz
*/
interface FixtureSourceInterface
{
/**
* @return SourceInterface An source, which can be handled by Doctrine ORM persist
*/
public function getORMReadyObject(): SourceInterface;
/**
* It's necessary for tests and to address the object correct.
*
* @return SlugAttributInterface
*/
public static function getSlug(): string;
}

View File

@@ -0,0 +1,37 @@
<?php
namespace App\Domain\FixtureManagement\FixtureSource;
use App\Entity\Source\SourceInterface;
use App\Entity\Source\Complex\UserSource;
/**
* This class containes the guest user.
*
* @author kevinfrantz
*/
final class GuestUserFixtureSource extends AbstractFixtureSource
{
const SLUG = 'GUEST_USER';
/**
* {@inheritdoc}
*
* @see \App\Domain\FixtureManagement\FixtureSource\FixtureSourceInterface::getORMReadyObject()
*/
public function getORMReadyObject(): SourceInterface
{
$userSource = new UserSource();
$userSource->setSlug(self::SLUG);
return $userSource;
}
/**
* @return string
*/
public static function getSlug(): string
{
return self::SLUG;
}
}

View File

@@ -0,0 +1,36 @@
<?php
namespace App\Domain\FixtureManagement\FixtureSource;
use App\Entity\Source\SourceInterface;
use App\Entity\Source\Primitive\Text\TextSource;
/**
* @author kevinfrantz
*/
final class ImpressumFixtureSource extends AbstractFixtureSource
{
const SLUG = 'IMPRINT';
/**
* {@inheritdoc}
*
* @see \App\Domain\FixtureManagement\FixtureSource\FixtureSourceInterface::getORMReadyObject()
*/
public function getORMReadyObject(): SourceInterface
{
$impressumSource = new TextSource();
$impressumSource->setText('Example Impressum');
$impressumSource->setSlug(self::SLUG);
return $impressumSource;
}
/**
* @return string
*/
public static function getSlug(): string
{
return self::SLUG;
}
}

View File

@@ -0,0 +1,2 @@
# Fixture Sources
This folder containes all source class objects which will be load into the database. This structure allows unit tests for the source fixtures.

View File

@@ -0,0 +1,64 @@
<?php
namespace App\Domain\FixtureManagement;
use HaydenPierce\ClassFinder\ClassFinder;
use App\Domain\FixtureManagement\FixtureSource\FixtureSourceInterface;
/**
* @author kevinfrantz
*/
final class FixtureSourceFactory implements FixtureSourceFactoryInterface
{
const FIXTURE_SOURCE_NAMESPACE = 'App\Domain\FixtureManagement\FixtureSource';
/**
* @return array|FixtureSourceInterface[]
*/
private static function getAllClassesInSourceFixtureNamespace(): array
{
return ClassFinder::getClassesInNamespace(self::FIXTURE_SOURCE_NAMESPACE);
}
/**
* @param array $unfilteredClasses|FixtureSourceInterface[]
*
* @return array|FixtureSourceInterface[] Returns just the classes which are final
*/
private static function filterFinal(array $unfilteredClasses): array
{
$filtered = [];
foreach ($unfilteredClasses as $unfilteredClass) {
$unfilteredClassReflection = new \ReflectionClass($unfilteredClass);
if ($unfilteredClassReflection->isFinal()) {
$filtered[] = $unfilteredClass;
}
}
return $filtered;
}
/**
* @param array $classes|FixtureSourceInterface[]
*
* @return array|FixtureSourceInterface[]
*/
private static function loadObjects(array $classes): array
{
$objects = [];
foreach ($classes as $class) {
$objects[] = new $class();
}
return $objects;
}
public static function getAllFixtureSources(): array
{
$unfilteredClasses = self::getAllClassesInSourceFixtureNamespace();
$filtered = self::filterFinal($unfilteredClasses);
$objects = self::loadObjects($filtered);
return $objects;
}
}

View File

@@ -0,0 +1,18 @@
<?php
namespace App\Domain\FixtureManagement;
use App\Domain\FixtureManagement\FixtureSource\FixtureSourceInterface;
/**
* Offers a Factory to produce sources.
*
* @author kevinfrantz
*/
interface FixtureSourceFactoryInterface
{
/**
* @return array|FixtureSourceInterface[] Returns all existing fixture sources
*/
public static function getAllFixtureSources(): array;
}