kitodo /
kitodo-presentation
We could not synchronize checks via GitHub's checks API since Scrutinizer's GitHub App is not installed for this repository.
| Total Complexity | 53 |
| Total Lines | 511 |
| Duplicated Lines | 0 % |
| Changes | 19 | ||
| Bugs | 1 | Features | 1 |
Complex classes like tx_dlf_collection often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use tx_dlf_collection, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 20 | class tx_dlf_collection extends tx_dlf_plugin { |
||
| 21 | |||
| 22 | public $scriptRelPath = 'plugins/collection/class.tx_dlf_collection.php'; |
||
| 23 | |||
| 24 | /** |
||
| 25 | * This holds the hook objects |
||
| 26 | * |
||
| 27 | * @var array |
||
| 28 | * @access protected |
||
| 29 | */ |
||
| 30 | protected $hookObjects = array (); |
||
| 31 | |||
| 32 | /** |
||
| 33 | * The main method of the PlugIn |
||
| 34 | * |
||
| 35 | * @access public |
||
| 36 | * |
||
| 37 | * @param string $content: The PlugIn content |
||
| 38 | * @param array $conf: The PlugIn configuration |
||
| 39 | * |
||
| 40 | * @return string The content that is displayed on the website |
||
| 41 | */ |
||
| 42 | public function main($content, $conf) { |
||
| 87 | |||
| 88 | } |
||
| 89 | |||
| 90 | /** |
||
| 91 | * Builds a collection list |
||
| 92 | * |
||
| 93 | * @access protected |
||
| 94 | * |
||
| 95 | * @return string The list of collections ready to output |
||
| 96 | */ |
||
| 97 | protected function showCollectionList() { |
||
| 98 | |||
| 99 | $selectedCollections = 'tx_dlf_collections.uid != 0'; |
||
| 100 | |||
| 101 | $orderBy = 'tx_dlf_collections.label'; |
||
| 102 | |||
| 103 | $showUserDefinedColls = ''; |
||
| 104 | |||
| 105 | // Handle collections set by configuration. |
||
| 106 | if ($this->conf['collections']) { |
||
| 107 | |||
| 108 | if (count(explode(',', $this->conf['collections'])) == 1 && empty($this->conf['dont_show_single'])) { |
||
| 109 | |||
| 110 | $this->showSingleCollection(intval(trim($this->conf['collections'], ' ,'))); |
||
| 111 | |||
| 112 | } |
||
| 113 | |||
| 114 | $selectedCollections = 'tx_dlf_collections.uid IN ('.$GLOBALS['TYPO3_DB']->cleanIntList($this->conf['collections']).')'; |
||
| 115 | |||
| 116 | $orderBy = 'FIELD(tx_dlf_collections.uid,'.$GLOBALS['TYPO3_DB']->cleanIntList($this->conf['collections']).')'; |
||
| 117 | |||
| 118 | } |
||
| 119 | |||
| 120 | // Should user-defined collections be shown? |
||
| 121 | if (empty($this->conf['show_userdefined'])) { |
||
| 122 | |||
| 123 | $showUserDefinedColls = ' AND tx_dlf_collections.fe_cruser_id=0'; |
||
| 124 | |||
| 125 | } elseif ($this->conf['show_userdefined'] > 0) { |
||
| 126 | |||
| 127 | if (!empty($GLOBALS['TSFE']->fe_user->user['uid'])) { |
||
| 128 | |||
| 129 | $showUserDefinedColls = ' AND tx_dlf_collections.fe_cruser_id='.intval($GLOBALS['TSFE']->fe_user->user['uid']); |
||
| 130 | |||
| 131 | } else { |
||
| 132 | |||
| 133 | $showUserDefinedColls = ' AND NOT tx_dlf_collections.fe_cruser_id=0'; |
||
| 134 | |||
| 135 | } |
||
| 136 | |||
| 137 | } |
||
| 138 | |||
| 139 | // Get collections. |
||
| 140 | $result = $GLOBALS['TYPO3_DB']->exec_SELECTquery( |
||
| 141 | 'tx_dlf_collections.index_name AS index_name,tx_dlf_collections.index_search as index_query,tx_dlf_collections.uid AS uid,tx_dlf_collections.sys_language_uid AS sys_language_uid,tx_dlf_collections.label AS label,tx_dlf_collections.thumbnail AS thumbnail,tx_dlf_collections.description AS description,tx_dlf_collections.priority AS priority', |
||
| 142 | 'tx_dlf_collections', |
||
| 143 | $selectedCollections.$showUserDefinedColls.' AND tx_dlf_collections.pid='.intval($this->conf['pages']).' AND (tx_dlf_collections.sys_language_uid IN (-1,0) OR (tx_dlf_collections.sys_language_uid = '.$GLOBALS['TSFE']->sys_language_uid.' AND tx_dlf_collections.l18n_parent = 0))'.tx_dlf_helper::whereClause('tx_dlf_collections'), |
||
| 144 | '', |
||
| 145 | $orderBy, |
||
| 146 | '' |
||
| 147 | ); |
||
| 148 | |||
| 149 | $count = $GLOBALS['TYPO3_DB']->sql_num_rows($result); |
||
| 150 | |||
| 151 | $content = ''; |
||
| 152 | |||
| 153 | if ($count == 1 && empty($this->conf['dont_show_single'])) { |
||
| 154 | |||
| 155 | $resArray = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($result); |
||
| 156 | |||
| 157 | $this->showSingleCollection(intval($resArray['uid'])); |
||
| 158 | |||
| 159 | } |
||
| 160 | |||
| 161 | $solr = tx_dlf_solr::getInstance($this->conf['solrcore']); |
||
| 162 | |||
| 163 | // We only care about the UID and partOf in the results and want them sorted |
||
| 164 | $params['fields'] = 'uid,partof'; |
||
|
1 ignored issue
–
show
|
|||
| 165 | $params['sort'] = array ('uid' => 'asc'); |
||
| 166 | |||
| 167 | $collections = array (); |
||
| 168 | |||
| 169 | while ($collectionData = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($result)) { |
||
| 170 | |||
| 171 | if ($collectionData['sys_language_uid'] != $GLOBALS['TSFE']->sys_language_content && $GLOBALS['TSFE']->sys_language_contentOL) { |
||
| 172 | |||
| 173 | $collections[$collectionData['uid']] = $GLOBALS['TSFE']->sys_page->getRecordOverlay('tx_dlf_collections', $collectionData, $GLOBALS['TSFE']->sys_language_content, $GLOBALS['TSFE']->sys_language_contentOL); |
||
| 174 | |||
| 175 | } else { |
||
| 176 | |||
| 177 | $collections[$collectionData['uid']] = $collectionData; |
||
| 178 | |||
| 179 | } |
||
| 180 | |||
| 181 | } |
||
| 182 | |||
| 183 | $markerArray = array (); |
||
| 184 | |||
| 185 | // Process results. |
||
| 186 | foreach ($collections as $collection) { |
||
| 187 | |||
| 188 | $solr_query = ''; |
||
| 189 | |||
| 190 | if ($collection['index_query'] != '') { |
||
| 191 | |||
| 192 | $solr_query .= '('.$collection['index_query'].')'; |
||
| 193 | |||
| 194 | } else { |
||
| 195 | |||
| 196 | $solr_query .= 'collection:("'.$collection['index_name'].'")'; |
||
| 197 | |||
| 198 | } |
||
| 199 | |||
| 200 | $partOfNothing = $solr->search_raw($solr_query.' AND partof:0', $params); |
||
| 201 | |||
| 202 | $partOfSomething = $solr->search_raw($solr_query.' AND NOT partof:0', $params); |
||
| 203 | |||
| 204 | // Titles are all documents that are "root" elements i.e. partof == 0 |
||
| 205 | $collection['titles'] = array (); |
||
| 206 | |||
| 207 | foreach ($partOfNothing as $doc) { |
||
| 208 | |||
| 209 | $collection['titles'][$doc->uid] = $doc->uid; |
||
| 210 | |||
| 211 | } |
||
| 212 | |||
| 213 | // Volumes are documents that are both |
||
| 214 | // a) "leaf" elements i.e. partof != 0 |
||
| 215 | // b) "root" elements that are not referenced by other documents ("root" elements that have no descendants) |
||
| 216 | $collection['volumes'] = $collection['titles']; |
||
| 217 | |||
| 218 | foreach ($partOfSomething as $doc) { |
||
| 219 | |||
| 220 | $collection['volumes'][$doc->uid] = $doc->uid; |
||
| 221 | |||
| 222 | // If a document is referenced via partof, it’s not a volume anymore. |
||
| 223 | unset($collection['volumes'][$doc->partof]); |
||
| 224 | |||
| 225 | } |
||
| 226 | |||
| 227 | // Generate random but unique array key taking priority into account. |
||
| 228 | do { |
||
| 229 | |||
| 230 | $_key = ($collection['priority'] * 1000) + mt_rand(0, 1000); |
||
| 231 | |||
| 232 | } while (!empty($markerArray[$_key])); |
||
| 233 | |||
| 234 | // Merge plugin variables with new set of values. |
||
| 235 | $additionalParams = array ('collection' => $collection['uid']); |
||
| 236 | |||
| 237 | if (is_array($this->piVars)) { |
||
| 238 | |||
| 239 | $piVars = $this->piVars; |
||
| 240 | |||
| 241 | unset($piVars['DATA']); |
||
| 242 | |||
| 243 | $additionalParams = tx_dlf_helper::array_merge_recursive_overrule($piVars, $additionalParams); |
||
| 244 | |||
| 245 | } |
||
| 246 | |||
| 247 | // Build typolink configuration array. |
||
| 248 | $conf = array ( |
||
| 249 | 'useCacheHash' => 1, |
||
| 250 | 'parameter' => $GLOBALS['TSFE']->id, |
||
| 251 | 'additionalParams' => \TYPO3\CMS\Core\Utility\GeneralUtility::implodeArrayForUrl($this->prefixId, $additionalParams, '', TRUE, FALSE) |
||
| 252 | ); |
||
| 253 | |||
| 254 | // Link collection's title to list view. |
||
| 255 | $markerArray[$_key]['###TITLE###'] = $this->cObj->typoLink(htmlspecialchars($collection['label']), $conf); |
||
| 256 | |||
| 257 | // Add feed link if applicable. |
||
| 258 | if (!empty($this->conf['targetFeed'])) { |
||
| 259 | |||
| 260 | $img = '<img src="'.\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::siteRelPath($this->extKey).'res/icons/txdlffeeds.png" alt="'.$this->pi_getLL('feedAlt', '', TRUE).'" title="'.$this->pi_getLL('feedTitle', '', TRUE).'" />'; |
||
| 261 | |||
| 262 | $markerArray[$_key]['###FEED###'] = $this->pi_linkTP($img, array ($this->prefixId => array ('collection' => $collection['uid'])), FALSE, $this->conf['targetFeed']); |
||
| 263 | |||
| 264 | } else { |
||
| 265 | |||
| 266 | $markerArray[$_key]['###FEED###'] = ''; |
||
| 267 | |||
| 268 | } |
||
| 269 | |||
| 270 | // Add thumbnail. |
||
| 271 | if (!empty($collection['thumbnail'])) { |
||
| 272 | |||
| 273 | $markerArray[$_key]['###THUMBNAIL###'] = '<img alt="" title="'.htmlspecialchars($collection['label']).'" src="'.$collection['thumbnail'].'" />'; |
||
| 274 | |||
| 275 | } else { |
||
| 276 | |||
| 277 | $markerArray[$_key]['###THUMBNAIL###'] = ''; |
||
| 278 | |||
| 279 | } |
||
| 280 | |||
| 281 | // Add description. |
||
| 282 | $markerArray[$_key]['###DESCRIPTION###'] = $this->pi_RTEcssText($collection['description']); |
||
| 283 | |||
| 284 | // Build statistic's output. |
||
| 285 | $labelTitles = $this->pi_getLL((count($collection['titles']) > 1 ? 'titles' : 'title'), '', FALSE); |
||
| 286 | |||
| 287 | $markerArray[$_key]['###COUNT_TITLES###'] = htmlspecialchars(count($collection['titles']).$labelTitles); |
||
| 288 | |||
| 289 | $labelVolumes = $this->pi_getLL((count($collection['volumes']) > 1 ? 'volumes' : 'volume'), '', FALSE); |
||
| 290 | |||
| 291 | $markerArray[$_key]['###COUNT_VOLUMES###'] = htmlspecialchars(count($collection['volumes']).$labelVolumes); |
||
| 292 | |||
| 293 | } |
||
| 294 | |||
| 295 | // Randomize sorting? |
||
| 296 | if (!empty($this->conf['randomize'])) { |
||
| 297 | |||
| 298 | ksort($markerArray, SORT_NUMERIC); |
||
| 299 | |||
| 300 | // Don't cache the output. |
||
| 301 | $this->setCache(FALSE); |
||
| 302 | |||
| 303 | } |
||
| 304 | |||
| 305 | $entry = $this->cObj->getSubpart($this->template, '###ENTRY###'); |
||
| 306 | |||
| 307 | foreach ($markerArray as $marker) { |
||
| 308 | |||
| 309 | $content .= $this->cObj->substituteMarkerArray($entry, $marker); |
||
| 310 | |||
| 311 | } |
||
| 312 | |||
| 313 | // Hook for getting custom collection hierarchies/subentries (requested by SBB). |
||
| 314 | foreach ($this->hookObjects as $hookObj) { |
||
| 315 | |||
| 316 | if (method_exists($hookObj, 'showCollectionList_getCustomCollectionList')) { |
||
| 317 | |||
| 318 | $hookObj->showCollectionList_getCustomCollectionList($this, $this->conf['templateFile'], $content, $markerArray); |
||
| 319 | |||
| 320 | } |
||
| 321 | |||
| 322 | } |
||
| 323 | |||
| 324 | return $this->cObj->substituteSubpart($this->template, '###ENTRY###', $content, TRUE); |
||
| 325 | |||
| 326 | } |
||
| 327 | |||
| 328 | /** |
||
| 329 | * Builds a collection's list |
||
| 330 | * |
||
| 331 | * @access protected |
||
| 332 | * |
||
| 333 | * @param integer $id: The collection's UID |
||
| 334 | * |
||
| 335 | * @return void |
||
| 336 | */ |
||
| 337 | protected function showSingleCollection($id) { |
||
| 531 | |||
| 532 | } |
||
| 535 |
Loading history...
