symphonycms /
symphony-2
| Total Complexity | 128 |
| Total Lines | 955 |
| Duplicated Lines | 0 % |
| Changes | 0 | ||
Complex classes like contentBlueprintsPages 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 contentBlueprintsPages, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 13 | class contentBlueprintsPages extends AdministrationPage |
||
| 14 | { |
||
| 15 | public $_errors = array(); |
||
| 16 | protected $_hilights = array(); |
||
| 17 | |||
| 18 | public function insertBreadcrumbsUsingPageIdentifier($page_id, $preserve_last = true) |
||
| 19 | { |
||
| 20 | if ($page_id == 0) { |
||
| 21 | return $this->insertBreadcrumbs( |
||
|
|
|||
| 22 | array(Widget::Anchor(__('Pages'), SYMPHONY_URL . '/blueprints/pages/')) |
||
| 23 | ); |
||
| 24 | } |
||
| 25 | |||
| 26 | $pages = PageManager::resolvePage($page_id, 'handle'); |
||
| 27 | |||
| 28 | foreach ($pages as &$page) { |
||
| 29 | // If we are viewing the Page Editor, the Breadcrumbs should link |
||
| 30 | // to the parent's Page Editor. |
||
| 31 | if ($this->_context[0] == 'edit') { |
||
| 32 | $page = Widget::Anchor( |
||
| 33 | PageManager::fetchTitleFromHandle($page), |
||
| 34 | SYMPHONY_URL . '/blueprints/pages/edit/' . PageManager::fetchIDFromHandle($page) . '/' |
||
| 35 | ); |
||
| 36 | |||
| 37 | // If the pages index is nested, the Breadcrumb should link to the |
||
| 38 | // Pages Index filtered by parent |
||
| 39 | } elseif (Symphony::Configuration()->get('pages_table_nest_children', 'symphony') == 'yes') { |
||
| 40 | $page = Widget::Anchor( |
||
| 41 | PageManager::fetchTitleFromHandle($page), |
||
| 42 | SYMPHONY_URL . '/blueprints/pages/?parent=' . PageManager::fetchIDFromHandle($page) |
||
| 43 | ); |
||
| 44 | |||
| 45 | // If there is no nesting on the Pages Index, the breadcrumb is |
||
| 46 | // not a link, just plain text |
||
| 47 | } else { |
||
| 48 | $page = new XMLElement('span', PageManager::fetchTitleFromHandle($page)); |
||
| 49 | } |
||
| 50 | } |
||
| 51 | |||
| 52 | if (!$preserve_last) { |
||
| 53 | array_pop($pages); |
||
| 54 | } |
||
| 55 | |||
| 56 | $this->insertBreadcrumbs(array_merge( |
||
| 57 | array(Widget::Anchor(__('Pages'), SYMPHONY_URL . '/blueprints/pages/')), |
||
| 58 | $pages |
||
| 59 | )); |
||
| 60 | } |
||
| 61 | |||
| 62 | public function __viewIndex() |
||
| 206 | } |
||
| 207 | } |
||
| 208 | |||
| 209 | public function __viewNew() |
||
| 210 | { |
||
| 211 | $this->__viewEdit(); |
||
| 212 | } |
||
| 213 | |||
| 214 | public function __viewEdit() |
||
| 215 | { |
||
| 216 | $this->setPageType('form'); |
||
| 217 | $fields = array("title"=>null, "handle"=>null, "parent"=>null, "params"=>null, "type"=>null, "data_sources"=>null); |
||
| 218 | $existing = $fields; |
||
| 219 | $canonical_link = '/blueprints/pages/'; |
||
| 220 | $nesting = (Symphony::Configuration()->get('pages_table_nest_children', 'symphony') == 'yes'); |
||
| 221 | |||
| 222 | // Verify page exists: |
||
| 223 | if ($this->_context[0] === 'edit') { |
||
| 224 | if (!$page_id = (int)$this->_context[1]) { |
||
| 225 | redirect(SYMPHONY_URL . '/blueprints/pages/'); |
||
| 226 | } |
||
| 227 | |||
| 228 | $existing = PageManager::fetchPageByID($page_id); |
||
| 229 | $canonical_link .= 'edit/' . $page_id . '/'; |
||
| 230 | |||
| 231 | if (!$existing) { |
||
| 232 | Administration::instance()->errorPageNotFound(); |
||
| 233 | } else { |
||
| 234 | $existing['type'] = PageManager::fetchPageTypes($page_id); |
||
| 235 | } |
||
| 236 | } else { |
||
| 237 | $canonical_link .= 'new/'; |
||
| 238 | } |
||
| 239 | |||
| 240 | // Status message: |
||
| 241 | if (isset($this->_context[2])) { |
||
| 242 | $flag = $this->_context[2]; |
||
| 243 | $parent_link_suffix = $message = ''; |
||
| 244 | $time = Widget::Time(); |
||
| 245 | |||
| 246 | if (isset($_REQUEST['parent']) && is_numeric($_REQUEST['parent'])) { |
||
| 247 | $parent_link_suffix = "?parent=" . $_REQUEST['parent']; |
||
| 248 | } elseif ($nesting && isset($existing) && !is_null($existing['parent'])) { |
||
| 249 | $parent_link_suffix = '?parent=' . $existing['parent']; |
||
| 250 | } |
||
| 251 | |||
| 252 | switch ($flag) { |
||
| 253 | case 'saved': |
||
| 254 | $message = __('Page updated at %s.', array($time->generate())); |
||
| 255 | break; |
||
| 256 | case 'created': |
||
| 257 | $message = __('Page created at %s.', array($time->generate())); |
||
| 258 | } |
||
| 259 | |||
| 260 | $this->pageAlert( |
||
| 261 | $message |
||
| 262 | . ' <a href="' . SYMPHONY_URL . '/blueprints/pages/new/' . $parent_link_suffix . '" accesskey="c">' |
||
| 263 | . __('Create another?') |
||
| 264 | . '</a> <a href="' . SYMPHONY_URL . '/blueprints/pages/" accesskey="a">' |
||
| 265 | . __('View all Pages') |
||
| 266 | . '</a>', |
||
| 267 | Alert::SUCCESS |
||
| 268 | ); |
||
| 269 | } |
||
| 270 | |||
| 271 | // Find values: |
||
| 272 | if (isset($_POST['fields'])) { |
||
| 273 | $fields = $_POST['fields']; |
||
| 274 | } elseif ($this->_context[0] == 'edit') { |
||
| 275 | $fields = $existing; |
||
| 276 | |||
| 277 | if (!is_null($fields['type'])) { |
||
| 278 | $fields['type'] = implode(', ', $fields['type']); |
||
| 279 | } |
||
| 280 | |||
| 281 | $fields['data_sources'] = preg_split('/,/i', $fields['data_sources'], -1, PREG_SPLIT_NO_EMPTY); |
||
| 282 | $fields['events'] = preg_split('/,/i', $fields['events'], -1, PREG_SPLIT_NO_EMPTY); |
||
| 283 | } elseif (isset($_REQUEST['parent']) && is_numeric($_REQUEST['parent'])) { |
||
| 284 | $fields['parent'] = $_REQUEST['parent']; |
||
| 285 | $canonical_link .= '?parent=' . urlencode($_REQUEST['parent']); |
||
| 286 | } |
||
| 287 | |||
| 288 | $title = $fields['title']; |
||
| 289 | |||
| 290 | if (trim($title) == '') { |
||
| 291 | $title = $existing['title']; |
||
| 292 | } |
||
| 293 | |||
| 294 | $this->setTitle(__( |
||
| 295 | ($title ? '%1$s – %2$s – %3$s' : '%2$s – %3$s'), |
||
| 296 | array( |
||
| 297 | $title, |
||
| 298 | __('Pages'), |
||
| 299 | __('Symphony') |
||
| 300 | ) |
||
| 301 | )); |
||
| 302 | $this->addElementToHead(new XMLElement('link', null, array( |
||
| 303 | 'rel' => 'canonical', |
||
| 304 | 'href' => SYMPHONY_URL . $canonical_link, |
||
| 305 | ))); |
||
| 306 | |||
| 307 | $page_id = isset($page_id) ? $page_id : null; |
||
| 308 | |||
| 309 | if (!empty($title)) { |
||
| 310 | $page_url = URL . '/' . PageManager::resolvePagePath($page_id) . '/'; |
||
| 311 | |||
| 312 | $this->appendSubheading($title, array( |
||
| 313 | Widget::Anchor(__('View Page'), $page_url, __('View Page on Frontend'), 'button', null, array('target' => '_blank', 'accesskey' => 'v')) |
||
| 314 | )); |
||
| 315 | } else { |
||
| 316 | $this->appendSubheading(!empty($title) ? $title : __('Untitled')); |
||
| 317 | } |
||
| 318 | |||
| 319 | if (isset($page_id)) { |
||
| 320 | $this->insertBreadcrumbsUsingPageIdentifier($page_id, false); |
||
| 321 | } else { |
||
| 322 | $_GET['parent'] = isset($_GET['parent']) ? $_GET['parent'] : null; |
||
| 323 | $this->insertBreadcrumbsUsingPageIdentifier((int)$_GET['parent'], true); |
||
| 324 | } |
||
| 325 | |||
| 326 | // Title -------------------------------------------------------------- |
||
| 327 | |||
| 328 | $fieldset = new XMLElement('fieldset'); |
||
| 329 | $fieldset->setAttribute('class', 'settings'); |
||
| 330 | $fieldset->appendChild(new XMLElement('legend', __('Page Settings'))); |
||
| 331 | |||
| 332 | $label = Widget::Label(__('Name')); |
||
| 333 | $label->appendChild(Widget::Input( |
||
| 334 | 'fields[title]', General::sanitize($fields['title']) |
||
| 335 | )); |
||
| 336 | |||
| 337 | if (isset($this->_errors['title'])) { |
||
| 338 | $label = Widget::Error($label, $this->_errors['title']); |
||
| 339 | } |
||
| 340 | |||
| 341 | $fieldset->appendChild($label); |
||
| 342 | |||
| 343 | // Handle ------------------------------------------------------------- |
||
| 344 | |||
| 345 | $group = new XMLElement('div'); |
||
| 346 | $group->setAttribute('class', 'two columns'); |
||
| 347 | $column = new XMLElement('div'); |
||
| 348 | $column->setAttribute('class', 'column'); |
||
| 349 | |||
| 350 | $label = Widget::Label(__('Handle')); |
||
| 351 | $label->appendChild(Widget::Input( |
||
| 352 | 'fields[handle]', $fields['handle'] |
||
| 353 | )); |
||
| 354 | |||
| 355 | if (isset($this->_errors['handle'])) { |
||
| 356 | $label = Widget::Error($label, $this->_errors['handle']); |
||
| 357 | } |
||
| 358 | |||
| 359 | $column->appendChild($label); |
||
| 360 | |||
| 361 | // Parent --------------------------------------------------------- |
||
| 362 | |||
| 363 | $label = Widget::Label(__('Parent Page')); |
||
| 364 | |||
| 365 | $pages = (new PageManager) |
||
| 366 | ->select(['id']) |
||
| 367 | ->where(['id' => ['!=' => General::intval($page_id)]]) |
||
| 368 | ->sort('title') |
||
| 369 | ->execute() |
||
| 370 | ->rows(); |
||
| 371 | |||
| 372 | $options = array( |
||
| 373 | array('', false, '/') |
||
| 374 | ); |
||
| 375 | |||
| 376 | if (!empty($pages)) { |
||
| 377 | foreach ($pages as $page) { |
||
| 378 | $options[] = array( |
||
| 379 | $page['id'], $fields['parent'] == $page['id'], |
||
| 380 | '/' . PageManager::resolvePagePath($page['id']) |
||
| 381 | ); |
||
| 382 | } |
||
| 383 | |||
| 384 | usort($options, array($this, '__compare_pages')); |
||
| 385 | } |
||
| 386 | |||
| 387 | $label->appendChild(Widget::Select( |
||
| 388 | 'fields[parent]', $options |
||
| 389 | )); |
||
| 390 | $column->appendChild($label); |
||
| 391 | $group->appendChild($column); |
||
| 392 | |||
| 393 | // Parameters --------------------------------------------------------- |
||
| 394 | |||
| 395 | $column = new XMLElement('div'); |
||
| 396 | $column->setAttribute('class', 'column'); |
||
| 397 | |||
| 398 | $label = Widget::Label(__('Parameters')); |
||
| 399 | $label->appendChild(Widget::Input( |
||
| 400 | 'fields[params]', $fields['params'], 'text', array('placeholder' => 'param1/param2') |
||
| 401 | )); |
||
| 402 | $column->appendChild($label); |
||
| 403 | |||
| 404 | // Type ----------------------------------------------------------- |
||
| 405 | |||
| 406 | $label = Widget::Label(__('Type')); |
||
| 407 | $label->appendChild(Widget::Input('fields[type]', $fields['type'])); |
||
| 408 | |||
| 409 | if (isset($this->_errors['type'])) { |
||
| 410 | $label = Widget::Error($label, $this->_errors['type']); |
||
| 411 | } |
||
| 412 | |||
| 413 | $column->appendChild($label); |
||
| 414 | |||
| 415 | $tags = new XMLElement('ul'); |
||
| 416 | $tags->setAttribute('class', 'tags'); |
||
| 417 | $tags->setAttribute('data-interactive', 'data-interactive'); |
||
| 418 | |||
| 419 | $types = PageManager::fetchAvailablePageTypes(); |
||
| 420 | |||
| 421 | foreach ($types as $type) { |
||
| 422 | $tags->appendChild(new XMLElement('li', $type)); |
||
| 423 | } |
||
| 424 | |||
| 425 | $column->appendChild($tags); |
||
| 426 | $group->appendChild($column); |
||
| 427 | $fieldset->appendChild($group); |
||
| 428 | $this->Form->appendChild($fieldset); |
||
| 429 | |||
| 430 | // Events ------------------------------------------------------------- |
||
| 431 | |||
| 432 | $fieldset = new XMLElement('fieldset'); |
||
| 433 | $fieldset->setAttribute('class', 'settings'); |
||
| 434 | $fieldset->appendChild(new XMLElement('legend', __('Page Resources'))); |
||
| 435 | |||
| 436 | $group = new XMLElement('div'); |
||
| 437 | $group->setAttribute('class', 'two columns'); |
||
| 438 | |||
| 439 | $label = Widget::Label(__('Events')); |
||
| 440 | $label->setAttribute('class', 'column'); |
||
| 441 | |||
| 442 | $events = ResourceManager::fetch(ResourceManager::RESOURCE_TYPE_EVENT, array(), array(), 'name ASC'); |
||
| 443 | $options = array(); |
||
| 444 | |||
| 445 | if (is_array($events) && !empty($events)) { |
||
| 446 | if (!isset($fields['events'])) { |
||
| 447 | $fields['events'] = array(); |
||
| 448 | } |
||
| 449 | |||
| 450 | foreach ($events as $name => $about) { |
||
| 451 | $options[] = array( |
||
| 452 | $name, in_array($name, $fields['events']), $about['name'] |
||
| 453 | ); |
||
| 454 | } |
||
| 455 | } |
||
| 456 | |||
| 457 | $label->appendChild(Widget::Select('fields[events][]', $options, array('multiple' => 'multiple'))); |
||
| 458 | $group->appendChild($label); |
||
| 459 | |||
| 460 | // Data Sources ------------------------------------------------------- |
||
| 461 | |||
| 462 | $label = Widget::Label(__('Data Sources')); |
||
| 463 | $label->setAttribute('class', 'column'); |
||
| 464 | |||
| 465 | $datasources = ResourceManager::fetch(ResourceManager::RESOURCE_TYPE_DS, array(), array(), 'name ASC'); |
||
| 466 | $options = array(); |
||
| 467 | |||
| 468 | if (is_array($datasources) && !empty($datasources)) { |
||
| 469 | if (!isset($fields['data_sources'])) { |
||
| 470 | $fields['data_sources'] = array(); |
||
| 471 | } |
||
| 472 | |||
| 473 | foreach ($datasources as $name => $about) { |
||
| 474 | $options[] = array( |
||
| 475 | $name, in_array($name, $fields['data_sources']), $about['name'] |
||
| 476 | ); |
||
| 477 | } |
||
| 478 | } |
||
| 479 | |||
| 480 | $label->appendChild(Widget::Select('fields[data_sources][]', $options, array('multiple' => 'multiple'))); |
||
| 481 | $group->appendChild($label); |
||
| 482 | $fieldset->appendChild($group); |
||
| 483 | $this->Form->appendChild($fieldset); |
||
| 484 | |||
| 485 | // Controls ----------------------------------------------------------- |
||
| 486 | |||
| 487 | /** |
||
| 488 | * After all Page related Fields have been added to the DOM, just before the |
||
| 489 | * actions. |
||
| 490 | * |
||
| 491 | * @delegate AppendPageContent |
||
| 492 | * @param string $context |
||
| 493 | * '/blueprints/pages/' |
||
| 494 | * @param XMLElement $form |
||
| 495 | * @param array $fields |
||
| 496 | * @param array $errors |
||
| 497 | */ |
||
| 498 | Symphony::ExtensionManager()->notifyMembers( |
||
| 499 | 'AppendPageContent', |
||
| 500 | '/blueprints/pages/', |
||
| 501 | array( |
||
| 502 | 'form' => &$this->Form, |
||
| 503 | 'fields' => &$fields, |
||
| 504 | 'errors' => $this->_errors |
||
| 505 | ) |
||
| 506 | ); |
||
| 507 | |||
| 508 | $div = new XMLElement('div'); |
||
| 509 | $div->setAttribute('class', 'actions'); |
||
| 510 | $div->appendChild(Widget::Input( |
||
| 511 | 'action[save]', ($this->_context[0] == 'edit' ? __('Save Changes') : __('Create Page')), |
||
| 512 | 'submit', array('accesskey' => 's') |
||
| 513 | )); |
||
| 514 | |||
| 515 | if ($this->_context[0] == 'edit') { |
||
| 516 | $button = new XMLElement('button', __('Delete')); |
||
| 517 | $button->setAttributeArray(array('name' => 'action[delete]', 'class' => 'button confirm delete', 'title' => __('Delete this page'), 'accesskey' => 'd', 'data-message' => __('Are you sure you want to delete this page?'))); |
||
| 518 | $div->appendChild($button); |
||
| 519 | } |
||
| 520 | |||
| 521 | $this->Form->appendChild($div); |
||
| 522 | |||
| 523 | if (isset($_REQUEST['parent']) && is_numeric($_REQUEST['parent'])) { |
||
| 524 | $this->Form->appendChild(new XMLElement('input', null, array('type' => 'hidden', 'name' => 'parent', 'value' => $_REQUEST['parent']))); |
||
| 525 | } |
||
| 526 | } |
||
| 527 | |||
| 528 | public function __compare_pages($a, $b) |
||
| 529 | { |
||
| 530 | return strnatcasecmp($a[2], $b[2]); |
||
| 531 | } |
||
| 532 | |||
| 533 | public function __actionIndex() |
||
| 559 | } |
||
| 560 | } |
||
| 561 | } |
||
| 562 | |||
| 563 | public function __actionTemplate() |
||
| 564 | { |
||
| 565 | $filename = $this->_context[1] . '.xsl'; |
||
| 566 | $file_abs = PAGES . '/' . $filename; |
||
| 567 | $fields = $_POST['fields']; |
||
| 568 | $this->_errors = array(); |
||
| 569 | |||
| 570 | if (!isset($fields['body']) || trim($fields['body']) == '') { |
||
| 571 | $this->_errors['body'] = __('This is a required field.'); |
||
| 572 | } elseif (!General::validateXML($fields['body'], $errors, false, new XSLTProcess())) { |
||
| 573 | $this->_errors['body'] = __('This document is not well formed.') . ' ' . __('The following error was returned:') . ' <code>' . $errors[0]['message'] . '</code>'; |
||
| 574 | } |
||
| 575 | |||
| 576 | if (empty($this->_errors)) { |
||
| 577 | /** |
||
| 578 | * Just before a Page Template is about to written to disk |
||
| 579 | * |
||
| 580 | * @delegate PageTemplatePreEdit |
||
| 581 | * @since Symphony 2.2.2 |
||
| 582 | * @param string $context |
||
| 583 | * '/blueprints/pages/template/' |
||
| 584 | * @param string $file |
||
| 585 | * The path to the Page Template file |
||
| 586 | * @param string $contents |
||
| 587 | * The contents of the `$fields['body']`, passed by reference |
||
| 588 | */ |
||
| 589 | Symphony::ExtensionManager()->notifyMembers('PageTemplatePreEdit', '/blueprints/pages/template/', array('file' => $file_abs, 'contents' => &$fields['body'])); |
||
| 590 | |||
| 591 | if (!PageManager::writePageFiles($file_abs, $fields['body'])) { |
||
| 592 | $this->pageAlert( |
||
| 593 | __('Page Template could not be written to disk.') |
||
| 594 | . ' ' . __('Please check permissions on %s.', array('<code>/workspace/pages</code>')), |
||
| 595 | Alert::ERROR |
||
| 596 | ); |
||
| 597 | } else { |
||
| 598 | /** |
||
| 599 | * Just after a Page Template has been edited and written to disk |
||
| 600 | * |
||
| 601 | * @delegate PageTemplatePostEdit |
||
| 602 | * @since Symphony 2.2.2 |
||
| 603 | * @param string $context |
||
| 604 | * '/blueprints/pages/template/' |
||
| 605 | * @param string $file |
||
| 606 | * The path to the Page Template file |
||
| 607 | */ |
||
| 608 | Symphony::ExtensionManager()->notifyMembers('PageTemplatePostEdit', '/blueprints/pages/template/', array('file' => $file_abs)); |
||
| 609 | |||
| 610 | redirect(SYMPHONY_URL . '/blueprints/pages/template/' . $this->_context[1] . '/saved/'); |
||
| 611 | } |
||
| 612 | } |
||
| 613 | } |
||
| 614 | |||
| 615 | public function __actionNew() |
||
| 616 | { |
||
| 617 | $this->__actionEdit(); |
||
| 618 | } |
||
| 619 | |||
| 620 | public function __actionEdit() |
||
| 884 | ); |
||
| 885 | } |
||
| 886 | } |
||
| 887 | } |
||
| 888 | |||
| 889 | public function __actionDelete($pages, $redirect) |
||
| 968 | } |
||
| 969 | } |
||
| 970 | } |
||
| 971 |
Loading history...
This check looks for function or method calls that always return null and whose return value is used.
The method
getObject()can return nothing but null, so it makes no sense to use the return value.The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes.