UCMType.php
6.1 KB
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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
<?php
/**
* Joomla! Content Management System
*
* @copyright Copyright (C) 2005 - 2019 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
namespace Joomla\CMS\UCM;
defined('JPATH_PLATFORM') or die;
use Joomla\CMS\Application\BaseApplication;
/**
* UCM Class for handling content types
*
* @property-read string $core_content_id
* @property-read string $core_type_alias
* @property-read string $core_title
* @property-read string $core_alias
* @property-read string $core_body
* @property-read string $core_state
*
* @property-read string $core_checked_out_time
* @property-read string $core_checked_out_user_id
* @property-read string $core_access
* @property-read string $core_params
* @property-read string $core_featured
* @property-read string $core_metadata
* @property-read string $core_created_user_id
* @property-read string $core_created_by_alias
* @property-read string $core_created_time
* @property-read string $core_modified_user_id
* @property-read string $core_modified_time
* @property-read string $core_language
* @property-read string $core_publish_up
* @property-read string $core_publish_down
* @property-read string $core_content_item_id
* @property-read string $asset_id
* @property-read string $core_images
* @property-read string $core_urls
* @property-read string $core_hits
* @property-read string $core_version
* @property-read string $core_ordering
* @property-read string $core_metakey
* @property-read string $core_metadesc
* @property-read string $core_catid
* @property-read string $core_xreference
* @property-read string $core_typeid
*
* @since 3.1
*/
class UCMType implements UCM
{
/**
* The UCM Type
*
* @var UCMType
* @since 3.1
*/
public $type;
/**
* The Database object
*
* @var \JDatabaseDriver
* @since 3.1
*/
protected $db;
/**
* The alias for the content type
*
* @var string
* @since 3.1
*/
protected $alias;
/**
* Class constructor
*
* @param string $alias The alias for the item
* @param \JDatabaseDriver $database The database object
* @param BaseApplication $application The application object
*
* @since 3.1
*/
public function __construct($alias = null, \JDatabaseDriver $database = null, BaseApplication $application = null)
{
$this->db = $database ?: \JFactory::getDbo();
$app = $application ?: \JFactory::getApplication();
// Make the best guess we can in the absence of information.
$this->alias = $alias ?: $app->input->get('option') . '.' . $app->input->get('view');
$this->type = $this->getTypeByAlias($this->alias);
}
/**
* Get the Content Type
*
* @param integer $pk The primary key of the alias type
*
* @return object The UCM Type data
*
* @since 3.1
*/
public function getType($pk = null)
{
if (!$pk)
{
return $this->getTypeByAlias($this->alias);
}
$query = $this->db->getQuery(true);
$query->select('ct.*');
$query->from($this->db->quoteName('#__content_types', 'ct'));
$query->where($this->db->quoteName('ct.type_id') . ' = ' . (int) $pk);
$this->db->setQuery($query);
return $this->db->loadObject();
}
/**
* Get the Content Type from the alias
*
* @param string $typeAlias The alias for the type
*
* @return object The UCM Type data
*
* @since 3.2
*/
public function getTypeByAlias($typeAlias = null)
{
$query = $this->db->getQuery(true);
$query->select('ct.*');
$query->from($this->db->quoteName('#__content_types', 'ct'));
$query->where($this->db->quoteName('ct.type_alias') . ' = ' . $this->db->quote($typeAlias));
$this->db->setQuery($query);
return $this->db->loadObject();
}
/**
* Get the Content Type from the table class name
*
* @param string $tableName The table for the type
*
* @return mixed The UCM Type data if found, false if no match is found
*
* @since 3.2
*/
public function getTypeByTable($tableName)
{
$query = $this->db->getQuery(true);
$query->select('ct.*');
$query->from($this->db->quoteName('#__content_types', 'ct'));
// $query->where($this->db->quoteName('ct.type_alias') . ' = ' . (int) $typeAlias);
$this->db->setQuery($query);
$types = $this->db->loadObjectList();
foreach ($types as $type)
{
$tableFromType = json_decode($type->table);
$tableNameFromType = $tableFromType->special->prefix . $tableFromType->special->type;
if ($tableNameFromType === $tableName)
{
return $type;
}
}
return false;
}
/**
* Retrieves the UCM type ID
*
* @param string $alias The string of the type alias
*
* @return mixed The ID of the requested type or false if type is not found
*
* @since 3.1
*/
public function getTypeId($alias = null)
{
if (!$alias)
{
$alias = $this->alias;
}
$query = $this->db->getQuery(true);
$query->select('ct.type_id');
$query->from($this->db->quoteName('#__content_types', 'ct'));
$query->where($this->db->quoteName('ct.type_alias') . ' = ' . $this->db->q($alias));
$this->db->setQuery($query);
$id = $this->db->loadResult();
if (!$id)
{
return false;
}
return $id;
}
/**
* Method to expand the field mapping
*
* @param boolean $assoc True to return an associative array.
*
* @return mixed Array or object with field mappings. Defaults to object.
*
* @since 3.2
*/
public function fieldmapExpand($assoc = false)
{
if (!empty($this->type->field_mappings))
{
return $this->fieldmap = json_decode($this->type->field_mappings, $assoc);
}
else
{
return false;
}
}
/**
* Magic method to get the name of the field mapped to a ucm field (core_something).
*
* @param string $ucmField The name of the field in JTableCorecontent
*
* @return string The name mapped to the $ucmField for a given content type
*
* @since 3.2
*/
public function __get($ucmField)
{
if (!isset($this->fieldmap))
{
$this->fieldmapExpand(false);
}
return isset($this->fieldmap->common->$ucmField) ? $this->fieldmap->common->$ucmField : null;
}
}