Query/RegistryInterface.php at master · CommonApi/Query · 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
<?php
/**
 * Registry Interface
 *
 * @package    Molajo
 * @copyright  2014-2015 Amy Stephen. All rights reserved.
 * @license    http://www.opensource.org/licenses/mit-license.html MIT License
 */
namespace CommonApi\Query;

/**
 * Registry Interface
 *
 * @package    Query
 * @license    http://www.opensource.org/licenses/mit-license.html MIT License
 * @copyright  2014-2015 Amy Stephen. All rights reserved.
 * @since      1.0.0
 */
interface RegistryInterface
{
    /**
     * Verifies if registry, or registry key, exists
     *
     * @param   string      $name
     * @param   null|string $key
     *
     * @return  boolean
     * @since   1.0.0
     */
    public function exists($name, $key = null);

    /**
     * Create a registry
     *
     * @param   string $name
     *
     * @return  array
     * @since   1.0.0
     */
    public function createRegistry($name);

    /**
     * Get Registry Data
     *
     * @param   string $name
     * @param   string $key
     *
     * @return  mixed
     * @since   1.0.0
     */
    public function get($name, $key = null);

    /**
     * Sets the value for a specific registry $key $value pair
     *
     * @param   string $name
     * @param   string $key
     * @param   mixed  $value
     *
     * @return  $this
     * @since   1.0.0
     */
    public function set($name, $key, $value = null);

    /**
     * Sort Registry
     *
     * @param   string $name
     *
     * @return  $this
     * @since   1.0.0
     */
    public function sort($name);
}