pr2/layout/SShodorLayout.php5

<?php

/* ------------------------------------------------------ */
/* SShodorLayout
/* ------------------------------------------------------ */
/* Author: jwsm@shodor.org
/* Date: 10-17-06
/* Description: SShodorLayout extendes SLayout to provide
/* a customized layout class for Shodor web pages. This
/* is where the "shodorific page" layout template is
/* actually applied to the content.
/* ------------------------------------------------------ */

class SShodorLayout extends SLayout
{

    public function msBuild ($page, $ms, $layout)
    {
        switch($ms)
        {
            case 'TopBar':
                return $this->layoutTopBar($page, $ms, $layout);
            case 'PathBar':
                return $this->layoutPathBar($page, $ms, $layout);
            case 'PageTitle':
                return $this->layoutPageTitle($page, $ms, $layout);
            case 'ContentWell':
                return $this->layoutContentWell($page, $ms, $layout);
            case 'BottomBar':
                return $this->layoutBottomBar($page, $ms, $layout);
            case 'TabsBar1':
                return $this->layoutTabsBar1($page, $ms, $layout);
            case 'TabsBar2':
                return $this->layoutTabsBar2($page, $ms, $layout);
            case 'UpperFeatureWell':
                return $this->layoutUpperFeatureWell($page, $ms, $layout);
            case 'LowerFeatureWell':
                return $this->layoutLowerFeatureWell($page, $ms, $layout);
            case 'FlashWell':
                return $this->layoutFlashWell($page, $ms, $layout);
            default:
                return parent::msBuild($page, $ms, $layout);
        }
    }

    function layoutHead($page, $ms, $dl)
    {
        $page->setSlot('WindowTitle', $page->getSlot('CollName') . ": " . $page->getSlot('PageName'));
        parent::layoutHead($page, $ms, $dl);
    }


    /*-----------------------------------------------------*/
    /* Layout Flash Well MetaSlot -- where "flash" messages
    /* to the user appear
    /*-----------------------------------------------------*/
    public function layoutFlashWell ($page, $ms, $dl)
    {
        $flash = $page->getSlot('Flash');
        if ($flash == "") return;
        $html =<<<END_HTML

<!--************************************
    Flash
    ************************************-->

<tbody id="FlashWell">
<tr>
  <td class="pageLeftBorder pageRightBorder">
    $flash
  </td>
</tr>
<tr class="metaSlotDivider">
  <td><hr /></td>
</tr>
</tbody>
END_HTML;
        $page->setMetaSlot('FlashWell', $html);
    }


    /*-----------------------------------------------------*/
    /* Layout the TopBar MetaSlot
    /*-----------------------------------------------------*/
    function layoutTopBar($page, $ms, $dl)
    {
        $ctitle = $page->getSlot('CollName');
        $nw1 = $nw2 = $nw3 = "&nbsp;";
        switch($dl){
            case 'ThreeNavWells':$nw1 = $page->getSlot('TopBarNavWell1');
            case 'TwoNavWells':$nw2 = $page->getSlot('TopBarNavWell2');
            case 'OneNavWell': $nw3 = $page->getSlot('TopBarNavWell3');
            default: break;
        }
        if ($nw2 == ""){ $nw2 = $nw1; $nw1 = "&nbsp;"; }
        if ($nw3 == ""){ $nw3 = $nw2; $nw2 = "&nbsp;"; }

        $homeURL = SPath::getFullPath('Project');

        $ss = ($page->getSlot('SearchScript')) ? $page->getSlot('SearchScript') : "Search";

        $html =<<<END_HTML

<!--************************************
    TopBar
    ************************************-->

<tbody id="TopBar">
<tr>
  <td>
    <form id="TopBarSearch" style="display:inline" method="get" action="$ss" target="_top" name="search">
      <table border="0" width="100%" cellpadding="0" cellspacing="0" id="TopBarTable">
        <tr>
          <td id="TopBarLogoWell" class="pageLeftBorder" >
            <a href="$homeURL" target="_top"><span id="Logo"></span></a><h2 id="LogoText">$ctitle</h2>
          </td>
          <td id="TopBarFlexSpace"></td>
          <td id="TopBarNavWell1" align="right">$nw1</td>
          <td id="TopBarDivider1"><span></span></td>
          <td id="TopBarNavWell2" width="50">$nw2</td>
          <td id="TopBarDivider2"><span></span></td>
          <td id="TopBarNavWell3" class="pageRightBorder" width="50">$nw3</td>
        </tr>
      </table>
    </form>
  </td>
</tr>
<tr class="metaSlotDivider">
  <td><hr /></td>
</tr>
</tbody>
END_HTML;
        $page->setMetaSlot('TopBar', $html);
    }

    /*-----------------------------------------------------*/
    /* Layout the PageTitle MetaSlot
    /*-----------------------------------------------------*/
    public function layoutPageTitle ($page, $ms, $dl)
    {
        if ($page->getSlot('PageTitleRightText') != "") {
            $rightSide = "<div class=\"PageTitleRightText\">" . $page->getSlot('PageTitleRightText')
                    . "</div>";
        } else {
            $rightSide = "";
        }

        $ptitle = $page->getSlot('PageName');
        $html =<<<END_HTML

<!--************************************
    PageTitle
    ************************************-->

<tbody id="PageTitle">
<tr>
  <td class="pageLeftBorder pageRightBorder">
    $rightSide
    <h1>$ptitle</h1>
  </td>
</tr>
<tr class="metaSlotDivider">
  <td><hr /></td>
</tr>
</tbody>
END_HTML;
        $page->setMetaSlot('PageTitle', $html);
    }

    /*-----------------------------------------------------*/
    /* Layout the PathBar MetaSlot
    /*-----------------------------------------------------*/
    public function layoutPathBar ($page, $ms, $l)
    {
        $ptitle = $page->getSlot('PageName');
        $path = $page->getSlot('Path');

        $html =<<<END_HTML

<!--************************************
    PathBar
    ************************************-->

<tbody id="PathBar">
<tr>
  <td class="pageLeftBorder pageRightBorder" id="PathBarTd">
    $path &gt; $ptitle
  </td>
</tr>
<tr class="metaSlotDivider">
  <td><hr /></td>
</tr>
</tbody>
END_HTML;
        $page->setMetaSlot('PathBar', $html);
    }

    /*-----------------------------------------------------*/
    /* Layout Well Functions
    /*-----------------------------------------------------*/

    public function layoutUpperFeatureWell($page, $ms, $l)
    {
        $this->layoutWell('UpperFeatureWell', $page, $ms, $l);
    }

    public function layoutLowerFeatureWell($page, $ms, $l)
    {
        $this->layoutWell('LowerFeatureWell', $page, $ms, $l);
    }

    public function layoutContentWell ($page, $ms, $l)
    {
        $this->layoutWell('ContentWell', $page, $ms, $l);
    }

    /*-----------------------------------------------------*/
    /* Engine for all Well Layout
    /*-----------------------------------------------------*/

    public function layoutWell ($wellname, $page, $ms, $l)
    {
        // Start the HTML
        $html =<<<END_HTML

<!--************************************
    $wellname
    ************************************-->
  <tbody id="$wellname">
  <tr>
END_HTML;

        $col2 = $col3 = $leftSideBar = $rightSideBar = "";
        $wrapperId = $wellname . "Wrapper";

        // build the first (and possibly only) column from the slots
        $wnc1 = $wellname . "Column1";
        $mainContent = ($wellname == "ContentWell") ? $page->getSlot('Main') : $page->getSlot("$wellname");
        $col1 = $this->packageColumn($mainContent, $wellname, '1');
        $wellTdName = $wellname . "Td";

        $wellStart = <<<ENDSTART
<td class="pageLeftBorder pageRightBorder" id="$wellTdName">
  <div align="center">
    <table class="WellWrapper" id="$wrapperId" border="0" cellspacing="0" cellpadding="0">
      <tr>
ENDSTART;
        $wellEnd = <<<ENDEND
      </tr>
    </table>
  </div>
</td>
ENDEND;
        // finish the HTML
        $wellEnd .=<<<END_HTML
</tr>
<tr class="metaSlotDivider">
  <td><hr /></td>
</tr>
END_HTML;

        $wellEnd .= "</tbody>";


        // switch based on the layout: do we want one or more columns? sidebars?
        switch($l){
            case 'Start':
                $page->setMetaSlot("$wellname", $html . $wellStart);
                return;
            case 'End':
                $page->setMetaSlot("$wellname", $wellEnd);
                return;
            case 'LeftSideBarOnly':
                $leftSideBar = $this->packageSideBar($page->getSlot($wellname . 'SideBar'), 'Left');
                $rightSideBar = "";
                break;
            case 'RightSideBarOnly':
                $leftSideBar = "";
                $rightSideBar = $this->packageSideBar($page->getSlot($wellname . 'SideBar'), 'Right');
                break;
            case 'BothSideBars':
                $leftSideBar = $this->packageSideBar($page->getSlot($wellname . 'SideBar'), 'Left');
                $rightSideBar = $this->packageSideBar($page->getSlot($wellname .'SideBar2'), 'Right');
                break;
            case 'ThreeColumns':
                $col3 = $this->packageColumn($page->getSlot($wellname . "Column3"), $wellname, '3');
                // for three columns, we also want the second, so no break here.
            case 'TwoColumns':
                $col2 = $this->packageColumn($page->getSlot($wellname . "Column2"), $wellname, '2');
                break;
            case 'OneColumn':
            case 'NoSideBars':
            default:
                break;
        }

            // build the final HTML, based on all the preceeding variable fills
            $html .=<<<END_HTML
$wellStart
        $leftSideBar
        $col1
        $col2
        $col3
        $rightSideBar
$wellEnd
END_HTML;


        $page->setMetaSlot("$wellname", $html);
    }

    protected function packageColumn ($content, $wellname, $number)
    {
        $id = $wellname . "Column" . $number;

        return <<<END_RETURN

    <td id="$id" valign="top">
      <div class="$wellname tdFillDiv">
        <div class="contentDiv">
        $content
        </div>
      </div>
    </td>

END_RETURN;
    }

    protected function packageSideBar ($sidebar, $side)
    {
        $class = $side . "SideBarTd";
        return <<<END_RETURN

    <td class="$class" valign="top">
      <div class="SideBar tdFillDiv">
      $sidebar
      </div>
    </td>
END_RETURN;
    }

    /*-----------------------------------------------------*/
    /* Layout the BottomBar MetaSlot
    /*-----------------------------------------------------*/
    public function layoutBottomBar ($page, $ms, $l)
    {
        $leftText = $page->getSlot('BottomBarLeftText');
        $rightText = $page->getSlot('BottomBarRightText');
        $bbrt = ($rightText == "") ? "" :
                "<div style=\"float:right\" id=\"BottomBarRightText\">$rightText</div>";
        $yearNow = date('Y');
        $homeURL = SPath::getFullPath('Project');
        $html =<<<END_HTML

<!--************************************
    BottomBar
    ************************************-->
<tbody id="BottomBar"><tr>
<td class="pageLeftBorder pageRightBorder contentTd">
  $bbrt
  <div ID="BottomBarLeftText"><a href="$homeURL/licensing">&copy;1994-$yearNow Shodor</a>&nbsp;&nbsp; $leftText</div>
</td></tr></tbody>

END_HTML;
        $page->setMetaSlot('BottomBar', $html);
    }

    /*-----------------------------------------------------*/
    /* Layout the TabsBar1 MetaSlot
    /*-----------------------------------------------------*/
    public function layoutTabsBar1 ($page, $ms, $l)
    {
        $tabs = $page->getSlot('TabsBar1');
        if ($tabs == "" | $tabs == "<ul></ul>") return "";
        $html =<<<END_HTML

<!--************************************
    TabsBar Level 1
    ************************************-->

<tbody id="TabsBar1">
<tr>
  <td class="pageLeftBorder pageRightBorder" id="TabsBar1Td">
  $tabs
  </td>
</tr>
<tr class="metaSlotDivider">
  <td><hr /></td>
</tr>
</tbody>
END_HTML;
        $page->setMetaSlot('TabsBar1', $html);
    }

    /*-----------------------------------------------------*/
    /* Layout the TabsBar2 MetaSlot
    /*-----------------------------------------------------*/
    public function layoutTabsBar2 ($page, $ms, $l)
    {
        $tabs = $page->getSlot('TabsBar2');
        if ($tabs == "" || $tabs == "<ul></ul>") return "";
        $html =<<<END_HTML

<!--************************************
    TabsBar Level 2
    ************************************-->

<tbody id="TabsBar2">
<tr>
  <td class="pageLeftBorder pageRightBorder" id="TabsBar2Td">
  $tabs
  </td>
</tr>
<tr class="metaSlotDivider">
  <td><hr /></td>
</tr>
</tbody>
END_HTML;
        $page->setMetaSlot('TabsBar2', $html);
    }
}
//##

?>

---