ONGR\SettingsBundle\Settings\General\SettingsManager

Complexity

Total Complexity

12

Size/Duplication

Total Lines	177
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes	5
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	10	1
A	set()	0	16	1
A	save()	0	7	1
A	remove()	0	8	1
A	duplicate()	0	9	1
A	get()	0	12	3
A	getById()	0	9	2
A	createSetting()	0	14	2

<?php

/*
 * This file is part of the ONGR package.
 *
 * (c) NFQ Technologies UAB <info@nfq.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace ONGR\SettingsBundle\Settings\General;

use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Symfony\Component\Translation\TranslatorInterface;
use ONGR\ElasticsearchBundle\Service\Repository;
use ONGR\ElasticsearchBundle\Service\Manager;
use ONGR\SettingsBundle\Document\Setting;
use ONGR\SettingsBundle\Event\SettingChangeEvent;

/**
 * Class SettingsManager responsible for managing settings actions.
 */
class SettingsManager
{
    /**
     * @var TranslatorInterface
     */
    protected $translator;

    /**
     * @var EventDispatcherInterface
     */
    protected $eventDispatcher;

    /**
     * @var Manager
     */
    protected $manager;

    /**
     * @var Repository
     */
    protected $repo;

    /**
     * @param TranslatorInterface      $translator
     * @param EventDispatcherInterface $eventDispatcher
     * @param Manager                  $manager
     */
    public function __construct(
        TranslatorInterface $translator,
        EventDispatcherInterface $eventDispatcher,
        Manager $manager
    ) {
        $this->translator = $translator;
        $this->eventDispatcher = $eventDispatcher;
        $this->manager = $manager;
        $this->repo = $this->manager->getRepository('ONGRSettingsBundle:Setting');
    }

    /**
     * Overwrites setting with given name.
     *
     * @param string       $name
     * @param string       $description
     * @param string       $type
     * @param string|array $value
     * @param string       $profile
     *
     * @throws \LogicException
     */
    public function set($name, $description, $type, $value, $profile = 'default')
    {
        $setting = new Setting();
        $setting->setId($profile . '_' . $name);
        $setting->setName($name);
        $setting->setDescription($description);
        $setting->setData((object)['value' => $value]);
        $setting->setType($type);
        $setting->setProfile($profile);

        $this->manager->persist($setting);
        $this->manager->commit();
        $this->manager->flush();

        $this->eventDispatcher->dispatch('ongr_settings.setting_change', new SettingChangeEvent('save'));

'save' is of type string, but the function expects a object<ONGR\SettingsBundle\Event\Action>.

    }

    /**
     * Saves setting.
     *
     * @param Setting $setting
     */
    public function save(Setting $setting)
    {
        $this->manager->persist($setting);
        $this->manager->commit();

        $this->eventDispatcher->dispatch('ongr_settings.setting_change', new SettingChangeEvent('save'));

'save' is of type string, but the function expects a object<ONGR\SettingsBundle\Event\Action>.

    }

    /**
     * Removes a setting.
     *
     * @param Setting $setting
     */
    public function remove(Setting $setting)
    {
        $this->repo->remove($setting->getId());
        $this->manager->flush();
        $this->manager->refresh();

        $this->eventDispatcher->dispatch('ongr_settings.setting_change', new SettingChangeEvent('delete'));

'delete' is of type string, but the function expects a object<ONGR\SettingsBundle\Event\Action>.

    }

    /**
     * Copy a setting to the new profile.
     *
     * @param Setting $setting
     * @param string  $newProfile
     */
    public function duplicate(Setting $setting, $newProfile)
    {
        $newSetting = clone $setting;

        $newSetting->setId($newProfile . '_' . $setting->getName());
        $newSetting->setProfile($newProfile);

        $this->save($newSetting);
    }

    /**
     * Returns setting model by name and profile or creates new if $mustExist is set to FALSE.
     *
     * @param string $name
     * @param string $profile
     * @param bool   $mustExist
     * @param string $type
     *
     * @throws \UnexpectedValueException
     *
     * @return Setting
     */
    public function get($name, $profile = 'default', $mustExist = true, $type = 'string')
    {
        $setting = $this->repo->find($profile . '_' . $name);

The expression $this->repo->find($profile . '_' . $name); of type null|ReflectionClass adds the type ReflectionClass to the return on line 155 which is incompatible with the return type documented by ONGR\SettingsBundle\Settings\General\SettingsManager::get of type ONGR\SettingsBundle\Document\Setting.

        if ($setting === null) {
            if ($mustExist === true) {
                throw new \UnexpectedValueException();
            }
            $setting = $this->createSetting($name, $profile, $type);
        }

        return $setting;
    }

    /**
     * Returns setting model by id
     *
     * @param string $id
     *
     * @throws \UnexpectedValueException
     *
     * @return Setting
     */
    public function getById($id)
    {
        $setting = $this->repo->find($id);
        if ($setting === null) {
            throw new \UnexpectedValueException();
        }

        return $setting;
    }

    /**
     * Creates new setting object.
     *
     * @param string $name
     * @param string $profile
     * @param string $type
     *
     * @return Setting
     */
    protected function createSetting($name, $profile, $type)
    {
        $setting = new Setting();
        $setting->setId($profile . '_' . $name);
        $setting->setName($name);
        $setting->setProfile($profile);
        $setting->setType($type);

        if ($type == 'array') {
            $setting->setData(['value' => null]);

array('value' => null) is of type array<string,null,{"value":"null"}>, but the function expects a string.

        }

        return $setting;
    }
}