hashmark/Module.php at master · codeactual/hashmark · 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
100
101
102
103
104
105
106
<?php
// vim: fenc=utf-8:ft=php:ai:si:ts=4:sw=4:et:

/**
 * Hashmark_Module
 *
 * @filesource
 * @copyright   Copyright (c) 2008-2011 David Smith
 * @license     http://www.opensource.org/licenses/mit-license.php MIT License
 * @package     Hashmark
 * @subpackage  Base
 * @version     $Id$
*/

/**
 * Base for all classes produced by Hashmark::getModule() factory.
 *
 * @package     Hashmark
 * @subpackage  Base
*/
abstract class Hashmark_Module
{
    /**
     * @var string Module base name, ex. 'Client'.
     */
    protected $_base;

    /**
     * @var mixed Base module configs, ex. for all 'Client' implementations.
     */
    protected $_baseConfig;

    /**
     * @var string Module type name, ex. 'DbDependent' (Hashmark_Module_DbDependent).
     */
    protected $_type;

    /**
     * @var mixed Module type-specific configs.
     */
    protected $_typeConfig;

    /**
     * @var Hashmark_Cache_*    Cache object.
     */
    protected $_cache;

    /**
     * @param string            $base
     * @param mixed             $baseConfig
     * @param string            $type
     * @param mixed             $typeConfig
     * @param Hashmark_Cache_*  $cache  Instance of implementation selected
     *                                  in Config/Cache.php and created in
     *                                  Hashmark::getModule().
     * @return void
     */
    public function __construct($base, $baseConfig, $type, $typeConfig, $cache)
    {
        $this->_base = $base;
        $this->_baseConfig = $baseConfig;
        $this->_type = $type;
        $this->_typeConfig = $typeConfig;
        $this->_cache = $cache;
    }

    /**
     * Public access to $_base.
     *
     * @return string
     */
    public function getBase()
    {
        return $this->_base;
    }

    /**
     * Public access to $_baseConfig.
     *
     * @return string
     */
    public function getBaseConfig()
    {
        return $this->_baseConfig;
    }

    /**
     * Public access to $_type.
     *
     * @return string
     */
    public function getType()
    {
        return $this->_type;
    }

    /**
     * Public access to $_typeConfig.
     *
     * @return string
     */
    public function getTypeConfig()
    {
        return $this->_typeConfig;
    }
}