XOOPS /
XoopsCore25
Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like xos_opal_Theme 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. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
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 xos_opal_Theme, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 139 | class xos_opal_Theme |
||
| 140 | { |
||
| 141 | /** |
||
| 142 | * Should we render banner? Not for redirect pages or admin side |
||
| 143 | * |
||
| 144 | * @var bool |
||
| 145 | */ |
||
| 146 | public $renderBanner = true; |
||
| 147 | /** |
||
| 148 | * The name of this theme |
||
| 149 | * |
||
| 150 | * @var string |
||
| 151 | */ |
||
| 152 | public $folderName = ''; |
||
| 153 | /** |
||
| 154 | * Physical path of this theme folder |
||
| 155 | * |
||
| 156 | * @var string |
||
| 157 | */ |
||
| 158 | public $path = ''; |
||
| 159 | public $url = ''; |
||
| 160 | |||
| 161 | /** |
||
| 162 | * Whether or not the theme engine should include the output generated by php |
||
| 163 | * |
||
| 164 | * @var string |
||
| 165 | */ |
||
| 166 | public $bufferOutput = true; |
||
| 167 | /** |
||
| 168 | * Canvas-level template to use |
||
| 169 | * |
||
| 170 | * @var string |
||
| 171 | */ |
||
| 172 | public $canvasTemplate = 'theme.html'; |
||
| 173 | |||
| 174 | /** |
||
| 175 | * Theme folder path |
||
| 176 | * |
||
| 177 | * @var string |
||
| 178 | */ |
||
| 179 | public $themesPath = 'themes'; |
||
| 180 | |||
| 181 | /** |
||
| 182 | * Content-level template to use |
||
| 183 | * |
||
| 184 | * @var string |
||
| 185 | */ |
||
| 186 | public $contentTemplate = ''; |
||
| 187 | |||
| 188 | public $contentCacheLifetime = 0; |
||
| 189 | public $contentCacheId; |
||
| 190 | |||
| 191 | /** |
||
| 192 | * Text content to display right after the contentTemplate output |
||
| 193 | * |
||
| 194 | * @var string |
||
| 195 | */ |
||
| 196 | public $content = ''; |
||
| 197 | /** |
||
| 198 | * Page construction plug-ins to use |
||
| 199 | * |
||
| 200 | * @var array |
||
| 201 | * @access public |
||
| 202 | */ |
||
| 203 | public $plugins = array( |
||
| 204 | 'xos_logos_PageBuilder'); |
||
| 205 | public $renderCount = 0; |
||
| 206 | /** |
||
| 207 | * Pointer to the theme template engine |
||
| 208 | * |
||
| 209 | * @var XoopsTpl |
||
| 210 | */ |
||
| 211 | public $template = false; |
||
| 212 | |||
| 213 | /** |
||
| 214 | * Array containing the document meta-information |
||
| 215 | * |
||
| 216 | * @var array |
||
| 217 | */ |
||
| 218 | public $metas = array( |
||
| 219 | //'http' => array( |
||
| 220 | // 'Content-Script-Type' => 'text/javascript' , |
||
| 221 | // 'Content-Style-Type' => 'text/css') , |
||
| 222 | 'meta' => array(), |
||
| 223 | 'link' => array(), |
||
| 224 | 'script' => array()); |
||
| 225 | |||
| 226 | /** |
||
| 227 | * Array of strings to be inserted in the head tag of HTML documents |
||
| 228 | * |
||
| 229 | * @var array |
||
| 230 | */ |
||
| 231 | public $htmlHeadStrings = array(); |
||
| 232 | /** |
||
| 233 | * Custom variables that will always be assigned to the template |
||
| 234 | * |
||
| 235 | * @var array |
||
| 236 | */ |
||
| 237 | public $templateVars = array(); |
||
| 238 | |||
| 239 | /** |
||
| 240 | * User extra information for cache id, like language, user groups |
||
| 241 | * |
||
| 242 | * @var boolean |
||
| 243 | */ |
||
| 244 | public $use_extra_cache_id = true; |
||
| 245 | |||
| 246 | /** |
||
| 247 | * *#@- |
||
| 248 | */ |
||
| 249 | |||
| 250 | /** |
||
| 251 | * *#@+ |
||
| 252 | * |
||
| 253 | * @tasktype 10 Initialization |
||
| 254 | */ |
||
| 255 | /** |
||
| 256 | * Initializes this theme |
||
| 257 | * |
||
| 258 | * Upon initialization, the theme creates its template engine and instanciates the |
||
| 259 | * plug-ins from the specified {@link $plugins} list. If the theme is a 2.0 theme, that does not |
||
| 260 | * display redirection messages, the HTTP redirections system is disabled to ensure users will |
||
| 261 | * see the redirection screen. |
||
| 262 | * |
||
| 263 | * @param array $options |
||
| 264 | * @return bool |
||
| 265 | */ |
||
| 266 | public function xoInit($options = array()) |
||
| 352 | |||
| 353 | /** |
||
| 354 | * Generate cache id based on extra information of language and user groups |
||
| 355 | * |
||
| 356 | * User groups other than anonymous should be detected to avoid disclosing group sensitive contents |
||
| 357 | * |
||
| 358 | * @param string $cache_id raw cache id |
||
| 359 | * @param string $extraString extra string |
||
| 360 | * @return string complete cache id |
||
| 361 | */ |
||
| 362 | public function generateCacheId($cache_id, $extraString = '') |
||
| 390 | |||
| 391 | /** |
||
| 392 | * xos_opal_Theme::checkCache() |
||
| 393 | * |
||
| 394 | * @return bool |
||
| 395 | */ |
||
| 396 | public function checkCache() |
||
| 419 | |||
| 420 | /** |
||
| 421 | * Render the page |
||
| 422 | * |
||
| 423 | * The theme engine builds pages from 2 templates: canvas and content. |
||
| 424 | * |
||
| 425 | * A module can call this method directly and specify what templates the theme engine must use. |
||
| 426 | * If render() hasn't been called before, the theme defaults will be used for the canvas and |
||
| 427 | * page template (and xoopsOption['template_main'] for the content). |
||
| 428 | * |
||
| 429 | * @param string $canvasTpl The canvas template, if different from the theme default |
||
| 430 | * @param string $pageTpl The page template, if different from the theme default (unsupported, 2.3+ only) |
||
| 431 | * @param string $contentTpl The content template |
||
| 432 | * @param array $vars Template variables to send to the template engine |
||
| 433 | * |
||
| 434 | * @return bool |
||
| 435 | */ |
||
| 436 | public function render($canvasTpl = null, $pageTpl = null, $contentTpl = null, $vars = array()) |
||
| 524 | |||
| 525 | /** |
||
| 526 | * Load localization information |
||
| 527 | * |
||
| 528 | * Folder structure for localization: |
||
| 529 | * <ul>themes/themefolder/english |
||
| 530 | * <li>main.php - language definitions</li> |
||
| 531 | * <li>style.css - localization stylesheet</li> |
||
| 532 | * <li>script.js - localization script</li> |
||
| 533 | * </ul> |
||
| 534 | * @param string $type |
||
| 535 | * @return bool |
||
| 536 | */ |
||
| 537 | public function loadLocalization($type = 'main') |
||
| 555 | |||
| 556 | /** |
||
| 557 | * Load theme specific language constants |
||
| 558 | * |
||
| 559 | * @param string $type language type, like 'main', 'admin'; Needs to be declared in theme xo-info.php |
||
| 560 | * @param string $language specific language |
||
| 561 | * |
||
| 562 | * @return bool|mixed |
||
| 563 | */ |
||
| 564 | public function addLanguage($type = 'main', $language = null) |
||
| 576 | |||
| 577 | /** |
||
| 578 | * *#@+ |
||
| 579 | * |
||
| 580 | * @tasktype 20 Manipulating page meta-information |
||
| 581 | */ |
||
| 582 | /** |
||
| 583 | * Adds script code to the document head |
||
| 584 | * |
||
| 585 | * This methods allows the insertion of an external script file (if $src is provided), or |
||
| 586 | * of a script snippet. The file URI is parsed to take benefit of the theme resource |
||
| 587 | * overloading system. |
||
| 588 | * |
||
| 589 | * The $attributes parameter allows you to specify the attributes that will be added to the |
||
| 590 | * inserted <script> tag. If unspecified, the <var>type</var> attribute value will default to |
||
| 591 | * 'text/javascript'. |
||
| 592 | * |
||
| 593 | * <code> |
||
| 594 | * // Add an external script using a physical path |
||
| 595 | * $theme->addScript( 'www/script.js', null, '' ); |
||
| 596 | * $theme->addScript( 'modules/newbb/script.js', null, '' ); |
||
| 597 | * // Specify attributes for the <script> tag |
||
| 598 | * $theme->addScript( 'mod_xoops_SiteManager#common.js', array( 'type' => 'application/x-javascript' ), '', 'mod_xoops_Sitemanager' ); |
||
| 599 | * // Insert a code snippet |
||
| 600 | * $theme->addScript( null, array( 'type' => 'application/x-javascript' ), 'window.open("Hello world");', 'hello' ); |
||
| 601 | * </code> |
||
| 602 | * |
||
| 603 | * @param string $src path to an external script file |
||
| 604 | * @param array $attributes hash of attributes to add to the <script> tag |
||
| 605 | * @param string $content Code snippet to output within the <script> tag |
||
| 606 | * @param string $name Element Name in array scripts are stored in. |
||
| 607 | * @return void |
||
| 608 | */ |
||
| 609 | View Code Duplication | public function addScript($src = '', $attributes = array(), $content = '', $name = '') |
|
| 629 | |||
| 630 | /** |
||
| 631 | * Add StyleSheet or CSS code to the document head |
||
| 632 | * |
||
| 633 | * @param string $src path to .css file |
||
| 634 | * @param array $attributes name => value paired array of attributes such as title |
||
| 635 | * @param string $content CSS code to output between the <style> tags (in case $src is empty) |
||
| 636 | * @param string $name Element Name in array stylesheets are stored in. |
||
| 637 | * @return void |
||
| 638 | */ |
||
| 639 | View Code Duplication | public function addStylesheet($src = '', $attributes = array(), $content = '', $name = '') |
|
| 659 | |||
| 660 | /** |
||
| 661 | * Add a <link> to the header |
||
| 662 | * |
||
| 663 | * @param string $rel Relationship from the current doc to the anchored one |
||
| 664 | * @param string $href URI of the anchored document |
||
| 665 | * @param array $attributes Additional attributes to add to the <link> element |
||
| 666 | * @param string $name Element Name in array links are stored in. |
||
| 667 | */ |
||
| 668 | public function addLink($rel, $href = '', $attributes = array(), $name = '') |
||
| 682 | |||
| 683 | /** |
||
| 684 | * Set a meta http-equiv value |
||
| 685 | * @param $name |
||
| 686 | * @param null $value |
||
| 687 | * @return string |
||
| 688 | */ |
||
| 689 | public function addHttpMeta($name, $value = null) |
||
| 697 | |||
| 698 | /** |
||
| 699 | * Change output page meta-information |
||
| 700 | * @param string $type |
||
| 701 | * @param string $name |
||
| 702 | * @param string $value |
||
| 703 | * @return string |
||
| 704 | */ |
||
| 705 | public function addMeta($type = 'meta', $name = '', $value = '') |
||
| 718 | |||
| 719 | /** |
||
| 720 | * xos_opal_Theme::headContent() |
||
| 721 | * |
||
| 722 | * @param mixed $params |
||
| 723 | * @param mixed $content |
||
| 724 | * @param mixed $smarty |
||
| 725 | * @param mixed $repeat |
||
| 726 | * |
||
| 727 | * @return void |
||
| 728 | */ |
||
| 729 | public function headContent($params, $content, &$smarty, &$repeat) |
||
| 735 | |||
| 736 | /** |
||
| 737 | * xos_opal_Theme::renderMetas() |
||
| 738 | * |
||
| 739 | * @param mixed $type |
||
| 740 | * @param mixed $return |
||
| 741 | * @return bool|string |
||
| 742 | */ |
||
| 743 | public function renderMetas($type = null, $return = false) |
||
| 797 | |||
| 798 | /** |
||
| 799 | * Generates a unique element ID |
||
| 800 | * |
||
| 801 | * @param string $tagName |
||
| 802 | * @return string |
||
| 803 | */ |
||
| 804 | public function genElementId($tagName = 'xos') |
||
| 813 | |||
| 814 | /** |
||
| 815 | * Transform an attributes collection to an XML string |
||
| 816 | * |
||
| 817 | * @param array $coll |
||
| 818 | * @return string |
||
| 819 | */ |
||
| 820 | public function renderAttributes($coll) |
||
| 831 | |||
| 832 | /** |
||
| 833 | * Return a themable file resource path |
||
| 834 | * |
||
| 835 | * @param string $path |
||
| 836 | * @return string |
||
| 837 | */ |
||
| 838 | public function resourcePath($path) |
||
| 854 | } |
||
| 855 |
Loading history...
The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file.
The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place.
To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1.