interfaces/OptionsInterface.php at master · arikaim/interfaces · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
<?php
/**
 * Arikaim
 *
 * @link        http://www.arikaim.com
 * @copyright   Copyright (c)  Konstantin Atanasov <info@arikaim.com>
 * @license     http://www.arikaim.com/license
 *
*/
namespace Arikaim\Core\Interfaces;

use Arikaim\Core\Interfaces\OptionsStorageInterface;;

/**
 * Options interface
 */
interface OptionsInterface
{
    /**
     * Set storage adapter
     *
     * @param OptionsStorageInterface $adapter
     * @return void
     */
    public function setStorageAdapter(OptionsStorageInterface $adapter);

    /**
     * Create option, if option exists return false
     *
     * @param string $key
     * @param mixed $value
     * @param boolean $autoLoad
     * @param string|null $extension
     * @return boolean
    */
    public function createOption(string $key, $value, bool $autoLoad = false, ?string $extension = null): bool;

    /**
     * Save option
     *
     * @param string $key
     * @param mixed $value
     * @param string|null $extension
     * @return bool
     */
    public function set(string $key, $value, $extension = null);

    /**
     * Get option
     *
     * @param string $key
     * @param mixed $default
     * @return mixed
    */
    public function get(string $key, $default = null);

    /**
     * Return true if option name exist
     *
     * @param string $key
     * @return boolean
    */
    public function has(string $key): bool;

    /**
     * Remove option(s)
     *
     * @param string $key
     * @param string|null $extension
     * @return bool
    */
    public function removeOptions($key = null, $extension = null);

    /**
     * Search options
     *
     * @param string $searchKey
     * @param bool $compactKeys
     * @return array
     */
    public function searchOptions($searchKey, $compactKeys = false);

    /**
     * Get extension options
     *
     * @param string $extensioName
     * @return mixed
     */
    public function getExtensionOptions($extensioName);

    /**
     * Force load option
     *
     * @param string $key
     * @param mixed $default
     * @return mixed
     */
    public function read(string $key, $default = null);
}