Snck3rs/contao-leaflet-maps
1
0
Fork 1
mirror of https://github.com/netzmacht/contao-leaflet-maps.git synced 2025-11-30 20:13:49 +01:00
Code Issues Packages Projects Releases Wiki Activity

Extract OptionsBuilder from AbstractMapper

Browse Source
This commit is contained in:
David Molineus
2015-01-22 08:54:08 +01:00
parent ac9ab7324c
commit b96cd80669
3 changed files with 278 additions and 144 deletions
Download Patch File Download Diff File Expand all files Collapse all files

171
src/Netzmacht/Contao/Leaflet/Mapper/AbstractMapper.php
View File

@@ -41,24 +41,18 @@ abstract class AbstractMapper implements Mapper
protected static $definitionClass = null;
/**
* Options mapping.
* Options builder
*
* @var array
* @var OptionsBuilder
*/
private $options = array();
/**
* Conditional option mapping.
*
* @var array
*/
private $conditional = array();
protected $optionsBuilder;
/**
* Construct.
*/
public function __construct()
{
$this->optionsBuilder = new OptionsBuilder();
$this->initialize();
}
@@ -72,9 +66,12 @@ abstract class AbstractMapper implements Mapper
*/
public function addOption($option, $mapping = null)
{
if (!isset($this->options[$option])) {
$this->options[$option] = $this->getMapping($option, $mapping);
}
trigger_error(
__METHOD__ . ' is deprecated. Use $this->optionsBuilder->' . __FUNCTION__ . '()',
E_USER_DEPRECATED
);
$this->optionsBuilder->addOption($option, $mapping);
return $this;
}
@@ -88,19 +85,14 @@ abstract class AbstractMapper implements Mapper
*/
public function addOptions($options)
{
trigger_error(
__METHOD__ . ' is deprecated. Use $this->optionsBuilder->' . __FUNCTION__ . '()',
E_USER_DEPRECATED
);
$arguments = func_get_args();
if (count($arguments) > 1) {
$options = $arguments;
}
foreach ($options as $key => $value) {
if (is_numeric($key)) {
$this->addOption($value);
} else {
$this->addOption($key, $value);
}
}
$this->optionsBuilder->addOptions($arguments);
return $this;
}
@@ -117,11 +109,12 @@ abstract class AbstractMapper implements Mapper
*/
public function addConditionalOption($column, $option = null, $mapping = null, $value = self::VALUE_NOT_EMPTY)
{
$option = $option ?: $column;
trigger_error(
__METHOD__ . ' is deprecated. Use $this->optionsBuilder->' . __FUNCTION__ . '()',
E_USER_DEPRECATED
);
if (!isset($this->conditional[$column][$value][$option])) {
$this->conditional[$column][$value][$option] = $this->getMapping($option, $mapping);
}
$this->optionsBuilder->addConditionalOption($column, $option, $mapping, $value);
return $this;
}
@@ -137,13 +130,12 @@ abstract class AbstractMapper implements Mapper
*/
public function addConditionalOptions($column, array $options, $value = self::VALUE_NOT_EMPTY)
{
foreach ($options as $key => $option) {
if (is_numeric($key)) {
$this->addConditionalOption($column, $option, null, $value);
} else {
$this->addConditionalOption($column, $key, $option, $value);
}
}
trigger_error(
__METHOD__ . ' is deprecated. Use $this->optionsBuilder->' . __FUNCTION__ . '()',
E_USER_DEPRECATED
);
$this->optionsBuilder->addConditionalOptions($column, $options, $value);
return $this;
}
@@ -160,8 +152,7 @@ abstract class AbstractMapper implements Mapper
) {
$definition = $this->createInstance($model, $mapper, $bounds, $elementId);
$this->buildOptions($definition, $model);
$this->buildConditionals($definition, $model);
$this->optionsBuilder->build($definition, $model);
$this->build($definition, $model, $mapper, $bounds, $parent);
return $definition;
@@ -253,112 +244,6 @@ abstract class AbstractMapper implements Mapper
);
}
/**
* Build options.
*
* @param Definition $definition The definition being built.
* @param \Model $model The model.
*
* @return void
*/
private function buildOptions($definition, $model)
{
$this->applyOptions($this->options, $definition, $model);
}
/**
* Build conditional options.
*
* @param Definition $definition The definition being built.
* @param \Model $model The model.
*
* @return void
*/
private function buildConditionals(Definition $definition, \Model $model)
{
foreach ($this->conditional as $column => $conditions) {
foreach ($conditions as $value => $options) {
if ($value === static::VALUE_EMPTY && empty($model->$column)) {
$this->applyOptions($options, $definition, $model);
} elseif ($value === static::VALUE_NOT_EMPTY && !empty($model->$column)) {
$this->applyOptions($options, $definition, $model);
} elseif ($model->$column == $value) {
$this->applyOptions($options, $definition, $model);
}
}
}
}
/**
* Get the mapping column.
*
* @param string $option Option name.
* @param string|null $mapping Mapping column.
*
* @return string
*/
private function getMapping($option, $mapping)
{
if ($mapping === null) {
return $option;
}
return $mapping;
}
/**
* Apply options from the model to the definition.
*
* @param array $options The options.
* @param Definition $definition The definition being built.
* @param \Model $model The model.
*
* @return void
*/
protected function applyOptions($options, $definition, $model)
{
foreach ($options as $option => $mapping) {
$setter = 'set' . ucfirst($option);
$default = $this->getDefaultOption($option, $definition);
if ($model->$mapping === '1' || $model->$mapping === '') {
if (((bool) $model->$mapping) !== $default) {
$definition->$setter($model->$mapping);
}
} elseif (is_numeric($default)) {
if ($model->$mapping != $default) {
$definition->$setter($model->$mapping);
}
} elseif ($model->$mapping !== $default) {
$definition->$setter($model->$mapping);
}
}
}
/**
* Get default option value.
*
* @param string $option The option name.
* @param Definition $definition The definition being built.
*
* @return mixed
*/
private function getDefaultOption($option, $definition)
{
$keys = array('has', 'is', 'get');
$suffix = ucfirst($option);
foreach ($keys as $key) {
$method = $key . $suffix;
if (method_exists($definition, $method)) {
return $definition->$method();
}
}
return null;
}
/**
* Get definition class name.
*

3
src/Netzmacht/Contao/Leaflet/Mapper/Layer/ProviderLayerMapper.php
View File

@@ -12,6 +12,7 @@
namespace Netzmacht\Contao\Leaflet\Mapper\Layer;
use Netzmacht\Contao\Leaflet\Mapper\DefinitionMapper;
use Netzmacht\Contao\Leaflet\Mapper\OptionsBuilder;
use Netzmacht\LeafletPHP\Definition;
use Netzmacht\LeafletPHP\Definition\Type\LatLngBounds;
@@ -78,7 +79,7 @@ class ProviderLayerMapper extends AbstractLayerMapper
Definition $parent = null
) {
if (!empty($this->providers[$model->tile_provider]['options'])) {
$this->applyOptions(
OptionsBuilder::applyOptions(
$this->providers[$model->tile_provider]['options'],
$definition,
$model

248
src/Netzmacht/Contao/Leaflet/Mapper/OptionsBuilder.php Normal file
View File

@@ -0,0 +1,248 @@
<?php
/**
* @package dev
* @author David Molineus <david.molineus@netzmacht.de>
* @copyright 2015 netzmacht creative David Molineus
* @license LGPL 3.0
* @filesource
*
*/
namespace Netzmacht\Contao\Leaflet\Mapper;
use Netzmacht\LeafletPHP\Definition;
/**
* Class OptionsBuilder handles the option mapping between the database model and the definition.
*
* @package Netzmacht\Contao\Leaflet\Mapper
*/
class OptionsBuilder
{
const VALUE_NOT_EMPTY = '__value_not_empty__';
const VALUE_EMPTY = '__value_empty__';
/**
* Options mapping.
*
* @var array
*/
private $options = array();
/**
* Conditional option mapping.
*
* @var array
*/
private $conditional = array();
/**
* Add a option mapping.
*
* @param string $option Name of the option.
* @param string $mapping Mapping column name. Set if column name differs.
*
* @return $this
*/
public function addOption($option, $mapping = null)
{
if (!isset($this->options[$option])) {
$this->options[$option] = $this->getMapping($option, $mapping);
}
return $this;
}
/**
* Add options mapping.
*
* @param array|mixed $options List of option names.
*
* @return $this
*/
public function addOptions($options)
{
$arguments = func_get_args();
if (count($arguments) > 1) {
$options = $arguments;
}
foreach ($options as $key => $value) {
if (is_numeric($key)) {
$this->addOption($value);
} else {
$this->addOption($key, $value);
}
}
return $this;
}
/**
* Add a conditional option.
*
* @param string $column Condition column.
* @param string $option Option name.
* @param null $mapping Mapping column name.
* @param mixed $value Value of the conditional column.
*
* @return $this
*/
public function addConditionalOption($column, $option = null, $mapping = null, $value = self::VALUE_NOT_EMPTY)
{
$option = $option ?: $column;
if (!isset($this->conditional[$column][$value][$option])) {
$this->conditional[$column][$value][$option] = $this->getMapping($option, $mapping);
}
return $this;
}
/**
* Add a conditional options.
*
* @param string $column Condition column.
* @param array $options Option names.
* @param mixed $value Value of the conditional column.
*
* @return $this
*/
public function addConditionalOptions($column, array $options, $value = self::VALUE_NOT_EMPTY)
{
foreach ($options as $key => $option) {
if (is_numeric($key)) {
$this->addConditionalOption($column, $option, null, $value);
} else {
$this->addConditionalOption($column, $key, $option, $value);
}
}
return $this;
}
/**
* Build options and conditional options.
*
* @param Definition $definition The definition being built.
* @param \Model $model The model.
*
* @return $this
*/
public function build($definition, $model)
{
$this->buildOptions($definition, $model);
$this->buildConditionals($definition, $model);
return $this;
}
/**
* Build options.
*
* @param Definition $definition The definition being built.
* @param \Model $model The model.
*
* @return void
*/
private function buildOptions($definition, $model)
{
$this->applyOptions($this->options, $definition, $model);
}
/**
* Build conditional options.
*
* @param Definition $definition The definition being built.
* @param \Model $model The model.
*
* @return void
*/
private function buildConditionals(Definition $definition, \Model $model)
{
foreach ($this->conditional as $column => $conditions) {
foreach ($conditions as $value => $options) {
if ($value === static::VALUE_EMPTY && empty($model->$column)) {
$this->applyOptions($options, $definition, $model);
} elseif ($value === static::VALUE_NOT_EMPTY && !empty($model->$column)) {
$this->applyOptions($options, $definition, $model);
} elseif ($model->$column == $value) {
$this->applyOptions($options, $definition, $model);
}
}
}
}
/**
* Get the mapping column.
*
* @param string $option Option name.
* @param string|null $mapping Mapping column.
*
* @return string
*/
private function getMapping($option, $mapping)
{
if ($mapping === null) {
return $option;
}
return $mapping;
}
/**
* Apply options from the model to the definition.
*
* @param array $options The options.
* @param Definition $definition The definition being built.
* @param \Model $model The model.
*
* @return void
*/
public static function applyOptions($options, $definition, $model)
{
foreach ($options as $option => $mapping) {
$setter = 'set' . ucfirst($option);
$default = static::getDefaultOption($option, $definition);
if ($model->$mapping === '1' || $model->$mapping === '') {
if (((bool) $model->$mapping) !== $default) {
$definition->$setter($model->$mapping);
}
} elseif (is_numeric($default)) {
if ($model->$mapping != $default) {
$definition->$setter($model->$mapping);
}
} elseif ($model->$mapping !== $default) {
$definition->$setter($model->$mapping);
}
}
}
/**
* Get default option value.
*
* @param string $option The option name.
* @param Definition $definition The definition being built.
*
* @return mixed
*/
private static function getDefaultOption($option, $definition)
{
$keys = array('has', 'is', 'get');
$suffix = ucfirst($option);
foreach ($keys as $key) {
$method = $key . $suffix;
if (method_exists($definition, $method)) {
return $definition->$method();
}
}
return null;
}
}