crumbs.debug.inc in Crumbs, the Breadcrumbs suite 7.2

File

admin/crumbs.debug.inc

<?php

/**
 * Page callback for 'admin/structure/crumbs/debug'.
 *
 * @return string
 *   The rendered HTML for the debug page.
 */
function crumbs_debug_page() {
  drupal_set_title('Crumbs debug');
  $path_to_test = '';
  if (isset($_GET['path_to_test'])) {
    $path_to_test = $_GET['path_to_test'];
  }
  elseif (!empty($_SESSION['crumbs.admin.debug.history'])) {
    foreach ($_SESSION['crumbs.admin.debug.history'] as $path => $true) {
      if ('admin' !== substr($path, 0, 5)) {
        $path_to_test = $path;
      }
      elseif ('admin/structure/crumbs' !== substr($path, 0, 22)) {
        $admin_path_to_test = $path;
      }
    }
    if (empty($path_to_test) && !empty($admin_path_to_test)) {
      $path_to_test = $admin_path_to_test;
    }
  }
  $path_checked = check_plain($path_to_test);
  $form_action = url('admin/structure/crumbs/debug');
  $input_html = <<<EOT
<input id="crumbs-admin-debug-path" type="text" class="form-text" size="40" name="path_to_test" value="{<span class="php-variable">$path_checked</span>}" />
<input type="submit" value="Go" class="form-submit" />
EOT;
  $input_html = t('Breadcrumb for: !text_field', array(
    '!text_field' => $input_html,
  ));
  $placeholders = array(
    '!plugin_weights' => l(t('Plugin weights'), 'admin/structure/crumbs'),
    '!display_settings' => l(t('Display settings'), 'admin/structure/crumbs/display'),
  );
  $paragraphs = array();
  $paragraphs[] = <<<EOT
This page allows to have a look "behind the scenes", so you can analyse which crumbs plugins and rules are responsible for the "crumbs parent" to a given system path.
EOT;
  $paragraphs[] = <<<EOT
For each breadcrumb item, the Crumbs plugins can suggest candidates for the parent path and the breadcrumb item title.
Crumbs assigns a weight to each candidate, depending on the !plugin_weights configuration.
The candidate with the smallest weight wins.
EOT;
  $paragraphs[] = <<<EOT
Please note that some items may still be hidden, depending on the !display_settings.
EOT;
  $text = '';
  foreach ($paragraphs as $paragraph) {
    $paragraph = str_replace("\n", '<br/>', $paragraph);
    $text .= '<p>' . t($paragraph, $placeholders) . '</p>' . "\n";
  }
  $html = <<<EOT
    <form method="get" action="{<span class="php-variable">$form_action</span>}">
      {<span class="php-variable">$text</span>}
      <label for="path">{<span class="php-variable">$input_html</span>}</label>
    </form>
EOT;
  if (strlen($path_to_test)) {
    $path_to_test = drupal_get_normal_path($path_to_test);
    $html .= _crumbs_admin_debug_matrix($path_to_test);
  }
  if (!empty($_SESSION['crumbs.admin.debug.history'])) {
    $recently_visited = '';
    foreach (array_reverse($_SESSION['crumbs.admin.debug.history']) as $path => $true) {
      if ('admin/structure/crumbs/debug' !== substr($path, 0, 28)) {

        // We can't use l() directly, since this would add an "active" class.
        $url = url('admin/structure/crumbs/debug', array(
          'query' => array(
            'path_to_test' => $path,
          ),
        ));
        $link = l($path, $url, array(
          'external' => TRUE,
        ));
        $recently_visited .= '<li>' . $link . '</li>';
      }
    }
    if ($recently_visited) {
      $html .= t('Recently visited') . ':<ol>' . $recently_visited . '</ol>';
    }
  }
  return $html;
}

/**
 * Helper function for crumbs_admin_debug_page().
 *
 * @param string $path_to_test
 *   Test path to build a Crumbs breadcrumb.
 * @return string
 *   The debug matrix as rendered html.
 */
function _crumbs_admin_debug_matrix($path_to_test) {

  // Create a local version of the service container.
  $services = new crumbs_DIC_ServiceContainer();
  $page_info = $services->page;
  $page_info->path = $path_to_test;

  // Change the settings so that all breadcrumb items are visible.
  $page_info->minTrailItems = 1;
  $page_info->showFrontPage = TRUE;
  $page_info->showCurrentPage = TRUE;
  $unfilteredPluginBag = new crumbs_PluginSystem_PluginBag($services->pluginInfo->plugins, $services->pluginInfo->routelessPluginMethodsUnsorted, $services->pluginInfo->routePluginMethodsUnsorted);
  $unfilteredPluginEngine = new crumbs_PluginSystem_PluginEngine($unfilteredPluginBag, $services->router, $services->pluginInfo->weightMap);
  $table = new crumbs_Admin_DebugTable();
  $table
    ->setTrail($page_info->trail, $page_info->rawBreadcrumbItems);
  $table
    ->addPluginResults($unfilteredPluginEngine, $services->pluginInfo->weightMap);
  $html = $table
    ->render();
  return '<div style="overflow-x: auto;">' . $html . '</div>';
}
function _crumbs_debug_devel_page() {
  drupal_set_title('Crumbs debug - devel');
  $path_to_test = '';
  if (isset($_GET['path_to_test'])) {
    $path_to_test = $_GET['path_to_test'];
  }
  elseif (!empty($_SESSION['crumbs.admin.debug.history'])) {
    foreach ($_SESSION['crumbs.admin.debug.history'] as $path => $true) {
      if ('admin' !== substr($path, 0, 5)) {
        $path_to_test = $path;
      }
      elseif ('admin/structure/crumbs' !== substr($path, 0, 22)) {
        $admin_path_to_test = $path;
      }
    }
    if (empty($path_to_test) && !empty($admin_path_to_test)) {
      $path_to_test = $admin_path_to_test;
    }
  }
  $path_checked = check_plain($path_to_test);
  $form_action = url('admin/structure/crumbs/debug/devel');
  $input_html = <<<EOT
<input id="crumbs-admin-debug-path" type="text" class="form-text" size="40" name="path_to_test" value="{<span class="php-variable">$path_checked</span>}" />
<input type="submit" value="Go" class="form-submit" />
EOT;
  $input_html = t('Internal data for: !text_field', array(
    '!text_field' => $input_html,
  ));
  $placeholders = array(
    '!plugin_weights' => l(t('Plugin weights'), 'admin/structure/crumbs'),
    '!display_settings' => l(t('Display settings'), 'admin/structure/crumbs/display'),
  );
  $paragraphs = array();
  $paragraphs[] = <<<EOT
This page shows the data internally generated by Crumbs to create a breadcrumb for the given path.
EOT;
  $paragraphs[] = <<<EOT
The behavior depends on the !plugin_weights, !display_settings and the current theme.
EOT;
  $paragraphs[] = <<<EOT
The theme is the one active for this administration page, which is not necessarily the same as for the page where you want the breadcrumb to appear.
EOT;
  $text = '';
  foreach ($paragraphs as $paragraph) {
    $paragraph = str_replace("\n", '<br/>', $paragraph);
    $text .= '<p>' . t($paragraph, $placeholders) . '</p>' . "\n";
  }
  $html = <<<EOT
    <form method="get" action="{<span class="php-variable">$form_action</span>}">
      {<span class="php-variable">$text</span>}
      <label for="path">{<span class="php-variable">$input_html</span>}</label>
    </form>
EOT;
  if (strlen($path_to_test)) {
    $path_to_test = drupal_get_normal_path($path_to_test);
    $html .= _crumbs_admin_debug_devel_data($path_to_test);
  }
  if (!empty($_SESSION['crumbs.admin.debug.history'])) {
    $recently_visited = '';
    foreach (array_reverse($_SESSION['crumbs.admin.debug.history']) as $path => $true) {
      if ('admin/structure/crumbs/debug' !== substr($path, 0, 28)) {

        // We can't use l() directly, since this would add an "active" class.
        $url = url('admin/structure/crumbs/debug/devel', array(
          'query' => array(
            'path_to_test' => $path,
          ),
        ));
        $link = l($path, $url, array(
          'external' => TRUE,
        ));
        $recently_visited .= '<li>' . $link . '</li>';
      }
    }
    if ($recently_visited) {
      $html .= t('Recently visited') . ':<ol>' . $recently_visited . '</ol>';
    }
  }
  return $html;
}
function _crumbs_admin_debug_devel_data($path_to_test) {

  // Create a local version of the service container.
  $services = new crumbs_DIC_ServiceContainer();
  $page_info = $services->page;
  $page_info->path = $path_to_test;
  $data = crumbs_Container_ContainerUtil::getAllProperties($page_info);
  return kprint_r($data, TRUE);
}

Functions

Name	Description
crumbs_debug_page	Page callback for 'admin/structure/crumbs/debug'.
_crumbs_admin_debug_devel_data
_crumbs_admin_debug_matrix	Helper function for crumbs_admin_debug_page().
_crumbs_debug_devel_page