pion/laravel-logic-factory

The abstract LogicFactory for easier logic classes

v1.1 2016-01-28 18:08 UTC

Requires

• illuminate/support: 5.*

Requires (Dev)

• phpunit/phpunit: ^4.8

MIT

• Martin Kluska

README

A class that support quick creation of logic classes from the LogicFactory. When you need to create a class from a string that represents the Class of the Logic Class.

• Fully unit tested.
• Easy usage.

Instalation

composer require pion/laravel-logic-factory

Content

• Usage
• Eloquent Model traits
• Example
• Todo

Usage

You must subclass the LogicFactory and implement own static functions. Full example can be found in tests/Mock/TypeFactory.php

createLogicList (static)

Returns a Collection of availiable logic classes. Indexed by the Class name (without namespace) and title as value.

Example

/**
 * Create an own colleciton of types
 * @return \Illuminate\Support\Collection
 */
static function createLogicList()
{
    return new \Illuminate\Support\Collection([
        "TestType" => "Testing type"
    ]);
}

logicNamespace (static)

Returns current namespace of the factory subclass to load correct classes.

Example

/**
 * A namespace where the logic classes are stored. Like
 * __NAMESPACE__."\\Types
 * @return string
 */
static function logicNamespace()
{
    return __NAMESPACE__."\\Types";
}

lists (static)

Ideal to create a select of available types. Ideal to use in database with getLogic in the model

Example

{!! Form::select("test", TestFactory::lists()->toArray()) !!}

valide (static)

Used to quicky check if the passed logic class string is valide (without namespace). Uses isValide function.

title (static)

Returns the title for given logic class string (uses getTitle function)

Eloquent Model traits

Ideal for quick usage of the factory in models. Support the caching of the classes and functions for quick accesing of the factory and the final class.

/**
 * Returns the logic factory.
 *
 * @param string|null $attribute    the used attribute from the model to use as a class. When null, the default
 * property will be used. Enables multiple logic usage in model.
 *
 * @return LogicFactory
 */
public function getLogicInstance($attribute = null);

/**
 * Returns the logic class from the logic factory
 *
 * @param string|null $attribute    the used attribute from the model to use as a class. When null, the default
 * property will be used. Enables multiple logic usage in model.
 *
 * @return mixed
 */
public function getLogicFactory($attribute = null);

ModelLogicTrait

Used for models that has more attributes with logic interface. By passing the attribute you define the correct value to use. You can set (overide __construct method) logicAttributeName property for own attribute name to use.

You need to implement the createLogicFactory function and return the own factory. More advance example in tests/Mock/Models/ModelLogic.php

Example

use ModelLogicTrait;

public function createLogicFactory($classValue, $attributeName)
{
    return new LogicFactory($classValue);
}

ModelSingleLogicTrait

Used when the model has single attribute with logic class. You need to implement only getLogicFactoryClass method.

Example

use ModelSingleLogicTrait;

public function getLogicFactoryClass()
{
    return TypeFactory::class;
}

Example

Basic example

$logic = new TypeFactory("VarcharType");

// returns the class you need
$type = $logic->getLogic();

$type->customMethodYouProvide();

Validation

if (!TypeFactory::valide("VarcharType")) {
	throw new Exception();
}

Title

return TypeFactory::title("VarcharType");

Eloquent Model example

/**
 * @var OptionType|null
 */
protected $optionType = null;

protected $fillable = [
	'type'
];

/**
 * @return string
 */
public function getType() {
    return $this->type;
}

/**
 * Returns a type helper
 * @return OptionType|null
 */
public function getTypeHelper()
{
	if (is_null($this->optionType)) {
		$this->optionType = new OptionType($this->getType(), $this);
	}

	return $this->optionType;
}

Todo

• refactor to interface
• add automatic file based Logic Class loading from the given logicNamespace (defined as a folder) with some sort of caching.