midcom\datamanager\storage\parameter

Complexity

Total Complexity

26

Size/Duplication

Total Lines	143
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

57.14%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	load()	0	10	2
A	save()	0	15	4
D	convert_multiple_from_storage()	0	29	9
B	convert_multiple_to_storage()	0	25	6
B	get_imploded_options()	0	27	5

<?php
/**
 * @copyright CONTENT CONTROL GmbH, http://www.contentcontrol-berlin.de
 */

namespace midcom\datamanager\storage;

use midcom_error;

/**
 * Experimental storage class
 */
class parameter extends delayed
{
    private $multiple_separator = '|';

    /**
     * This member contains the other key, in case it is set. In case of multiselects,
     * the full list of unknown keys is collected here, in case of single select, this value
     * takes precedence from the standard selection.
     *
     * This is only valid if the allow_other flag is set.
     * TODO: still to be implentend
     * @var string
     */
    private $other = array();

The property $other is not used and could be removed.

    /**
     * {@inheritdoc}
     */
    public function load()
    {
        $source = $this->object->get_parameter($this->config['storage']['domain'], $this->config['storage']['name']);

        if (!empty($this->config['type_config']['multiple_storagemode'])) {
            $source = $this->convert_multiple_from_storage($source);
        }

        return $source;
    }

    /**
     * {@inheritdoc}
     */
    public function save()
    {
        //workaround for weird mgd API behavior where setting falsy (i.e. deleting) a nonexistent parameter
        //returns an error
        if (   !$this->value
            && $this->load() === null) {
            return true;
        }

        if (!empty($this->config['type_config']['multiple_storagemode'])) {
            $this->value = $this->convert_multiple_to_storage();
        }

        return $this->object->set_parameter($this->config['storage']['domain'], $this->config['storage']['name'], $this->value);
    }

    private function convert_multiple_from_storage($source)
    {
        $glue = $this->multiple_separator;

        switch ($this->config['type_config']['multiple_storagemode']) {
            case 'serialized':
            case 'array':
                if (   !is_array($source)
                    && empty($source)) {
                    $source = array();
                }
                return $source;

            case 'imploded':
                if (!is_string($source)) {
                    return array();
                }
                return explode($glue, $source);

            case 'imploded_wrapped':
                if (!is_string($source)) {
                    return array();
                }
                return explode($glue, substr($source, 1, -1));

            default:
                throw new midcom_error("The multiple_storagemode '{$this->config['type_config']['multiple_storagemode']}' is invalid, cannot continue.");
        }
    }

    /**
     * Converts the selected options according to the multiple_storagemode setting.
     *
     * @return mixed The data converted to the final data storage.
    */
    function convert_multiple_to_storage()

It is generally recommended to explicitly declare the visibility for methods.

    {
        switch ($this->config['type_config']['multiple_storagemode']) {
            case 'array':
                return $this->value;

            case 'serialized':
                if ($this->others) {
                    return array_merge($this->value, $this->others);
                }
                return $this->value;

            case 'imploded':
                $options = $this->get_imploded_options();
                return $options;

            case 'imploded_wrapped':
                $glue = $this->multiple_separator;
                $options = $this->get_imploded_options();
                return "{$glue}{$options}{$glue}";

            default:
                throw new midcom_error("The multiple_storagemode '{$this->config['type_config']['multiple_storagemode']}' is invalid, cannot continue.");
        }
    }

    /**
     * Prepares the imploded storage string. All entries containing the pipe char (used as glue)
     * will be logged and skipped silently.
     *
     * @return string The imploded data string.
     */
    private function get_imploded_options()
    {
        $glue = $this->multiple_separator;

        if ($this->others) {
            if (is_string($this->others)) {
                $this->others = array(
                    $this->others => $this->others,
                );
            }
            $options = array_merge($this->value, $this->others);
        } else {
            $options = $this->value;
        }

        $result = array();
        foreach ($options as $key) {
            if (strpos($key, $glue) !== false) {
                debug_add("The option key '{$key}' contained the multiple separator ($this->config['type_config']['multiple_storagemode']) char, which is not allowed for imploded storage targets. ignoring silently.",
                MIDCOM_LOG_WARN);
                continue;
            }

            $result[] = $key;
        }
        return implode($glue, $result);
    }
}