This repository has been archived by the owner on Nov 26, 2017. It is now read-only.
/
adapter.php
173 lines (148 loc) · 3.62 KB
/
adapter.php
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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
<?php
/**
* @package Joomla.Platform
* @subpackage Base
*
* @copyright Copyright (C) 2005 - 2011 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
jimport('joomla.filesystem.file');
jimport('joomla.filesystem.folder');
/**
* Adapter Class
* Retains common adapter pattern functions
* Class harvested from joomla.installer.installer
*
* @package Joomla.Platform
* @subpackage Base
* @since 11.1
*/
class JAdapter extends JObject
{
/**
* @var array Associative array of adapters
* @since 11.1
*/
protected $_adapters = array();
/**
* @var string Adapter Folder
* @since 11.1
*/
protected $_adapterfolder = 'adapters';
/**
* @var string Adapter Class Prefix
* @since 11.1
*/
protected $_classprefix = 'J';
/**
* @var string Base Path for the adapter instance
* @since 11.1
*/
protected $_basepath = null;
/**
* @var object Database Connector Object
* @since 11.1
*/
protected $_db;
/**
* Constructor
*
* @param string $basepath Base Path of the adapters
* @param string $classprefix Class prefix of adapters
* @param string $adapterfolder Name of folder to append to base path
*
* @return JAdapter
* @since 11.1
*/
public function __construct($basepath, $classprefix = null, $adapterfolder = null)
{
$this->_basepath = $basepath;
$this->_classprefix = $classprefix ? $classprefix : 'J';
$this->_adapterfolder = $adapterfolder ? $adapterfolder : 'adapters';
$this->_db = JFactory::getDBO();
}
/**
* Get the database connector object
*
* @return object Database connector object
* @since 11.1
*/
public function getDBO()
{
return $this->_db;
}
/**
* Set an adapter by name
*
* @param string $name Adapter name
* @param object $adapter Adapter object
* @param array $options Adapter options
*
* @return boolean True if successful
* @since 11.1
*/
public function setAdapter($name, &$adapter = null, $options = Array())
{
if (!is_object($adapter)) {
$fullpath = $this->_basepath.DS.$this->_adapterfolder.DS.strtolower($name).'.php';
if (!file_exists($fullpath)) {
return false;
}
// Try to load the adapter object
require_once $fullpath;
$class = $this->_classprefix.ucfirst($name);
if (!class_exists($class)) {
return false;
}
$adapter = new $class($this, $this->_db, $options);
}
$this->_adapters[$name] = &$adapter;
return true;
}
/**
* Return an adapter.
*
* @param string $name Name of adapter to return
* @param array $options Adapter options
*
* @return object Adapter of type 'name' or false
* @since 11.1
*/
public function getAdapter($name, $options = Array())
{
if (!array_key_exists($name, $this->_adapters)) {
if (!$this->setAdapter($name, $options)) {
$false = false;
return $false;
}
}
return $this->_adapters[$name];
}
/**
* Loads all adapters.
*
* @params array $options Adapter options
*
* @return void
* @since 11.1
*/
public function loadAllAdapters($options = array())
{
$list = JFolder::files($this->_basepath.DS.$this->_adapterfolder);
foreach ($list as $filename)
{
if (JFile::getExt($filename) == 'php') {
// Try to load the adapter object
require_once $this->_basepath.DS.$this->_adapterfolder.DS.$filename;
$name = JFile::stripExt($filename);
$class = $this->_classprefix.ucfirst($name);
if (!class_exists($class)) {
continue; // skip to next one
}
$adapter = new $class($this, $this->_db, $options);
$this->_adapters[$name] = clone $adapter;
}
}
}
}