<?php

/**
 * @noinspection PhpInconsistentReturnPointsInspection
 * @noinspection PhpReturnDocTypeMismatchInspection
 */

namespace bff\base;

use ArrayAccess;
use bff\extend\Extension;
use Illuminate\Contracts\Config\Repository as ConfigContract;

/**
 * Класс работы с конфигурацией
 * Настройки бывают следующих типов:
 *  1) системные - хранятся отдельно в файле (/config/sys.php)
 *  2) статические - редактируются в админ-панели, "Настройки сайта/Системные настройки"
 *  3) динамические(счетчики) - не сохраняются в cache и загружаются каждый раз из БД (для счетчиков модулей)
 * @copyright Tamaranga
 */
class Config implements ArrayAccess, ConfigContract
{
    /**
     * Сохраняем настройку
     * @param string|array $key ключ настройки
     * @param mixed $value значение
     * @param bool $dynamic динамическая настройка
     * @return void
     */
    public function save($key, $value = false, $dynamic = false)
    {
    }

    /**
     * Удаляем настройку
     * @param string|array $key ключ настройки
     * @param bool $save
     * @return void
     */
    public function remove($key, $save = false)
    {
    }

    /**
     * Обновляем счетчик, в настройках сайта (сохраняем)
     * @param string $key ключ настройки
     * @param int $increment инкремент/декремент значение счетчика
     * @param bool $dynamic динамическая настройка (если создаем счетчик)
     * @return void
     */
    public function saveCount($key, $increment, $dynamic = false)
    {
    }

    /**
     * Устанавливаем значение настройки (без сохранения)
     * @param string|array $key ключ настройки: array массив ключ=>значение, string - ключ
     * @param mixed $value значение
     * @return void
     */
    public function set($key, $value = null)
    {
    }

    /**
     * Получаем настройку из текущего загруженного конфига
     * @param string|array $key ключ настройки: array массив ключ=>значение, string - ключ
     * @param mixed $default значение по-умолчанию
     * @return mixed|void
     */
    public function get($key, $default = null)
    {
    }

    /**
     * Получаем настройки с нужным префиксом
     * @param string $prefix
     * @param mixed $default
     * @return array
     */
    public function prefixed(string $prefix, array $default = [])
    {
    }

    /**
     * Получаем системные настройки
     * @param string|array $key ключ настройки, ключи строек
     * @param string|mixed $default значение по-умолчанию
     * @param int|mixed $filter тип фильтрации TYPE_ (в случае если ключ string)
     * @return mixed
     */
    public function sys($key, $default = null, $filter = 0)
    {
    }

    /**
     * Получаем системную настройки указанную в админ. панели
     * @param string $key ключ настройки
     * @param mixed $default значение по-умолчанию
     * @param int|mixed $filter тип фильтрации TYPE_
     * @return mixed
     */
    public function sysAdmin(string $key, $default = null, $filter = 0)
    {
    }

    /**
     * Склейка двух массивов с настройками
     * @param array $data
     * @param array $dataPlus
     * @param int $maxLevel
     * @return array
     */
    public function merge(array $data, array $dataPlus = [], $maxLevel = 2)
    {
    }

    /**
     * Подключаем требуемый config-файл
     * @param string $fileName имя config-файла (без расширения): site, sys, ...
     * @param bool $returnPath возвращаем только путь к файлу (без подключения)
     * @return mixed|string
     */
    public function file($fileName, $returnPath = false)
    {
    }

    /**
     * Настройки расширения (значения)
     * @param string $extensionName название расширения: Extension::extension_name
     * @param array $settings настройки расширения
     * @param Extension $extension объект расширения
     * @return array
     */
    public function extension($extensionName, array $settings, $extension)
    {
    }

    /**
     * Сохранение настройки расширения
     * @param string|array $key ключ настройки
     * @param mixed $value значение
     * @param string $extensionName название расширения
     * @param array $settings настройки расширения
     * @param bool $dynamic динамическая настройка
     * @return bool
     */
    public function extensionSave($key, $value, $extensionName, array $settings = [], $dynamic = false)
    {
    }

    /**
     * Получаем все настройки
     * @return array
     */
    public function all()
    {
    }

    /**
     * Проверяем наличие настройки по ключу
     * @param string $key
     * @return bool
     */
    public function has($key)
    {
    }

    /**
     * Prepend a value onto an array configuration value.
     * @param string $key
     * @param mixed $value
     * @return void
     */
    public function prepend($key, $value)
    {
    }

    /**
     * Push a value onto an array configuration value.
     * @param string $key
     * @param mixed $value
     * @return void
     */
    public function push($key, $value)
    {
    }

    /**
     * Determine if the given configuration option exists.
     * @param string $key
     * @return bool
     */
    public function offsetExists($key)
    {
    }

    /**
     * Get a configuration option.
     * @param string $key
     * @return mixed
     */
    public function offsetGet($key)
    {
    }

    /**
     * Set a configuration option.
     * @param string $key
     * @param mixed $value
     * @return void
     */
    public function offsetSet($key, $value)
    {
    }

    /**
     * Unset a configuration option.
     * @param string $key
     * @return void
     */
    public function offsetUnset($key)
    {
    }
}