pr2/layout/TutorialsLayout.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 TutorialsLayout extends SLayout2
{

    public function msBuild ($page, $ms, $layout)
    {
        //print('building metaslot ' . $ms . '<br />');
        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 'Content':
                return $this->layoutContent($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);
    }

    function getMetaSlotDivider () {
        return <<<END
<div class="PR2-MetaSlotDivider">
    <hr />
</div>

END;
    }


    /*-----------------------------------------------------*/
    /* Layout Flash Well MetaSlot -- where "flash" messages
    /* to the user appear
    /*-----------------------------------------------------*/
    public function layoutFlashWell ($page, $ms, $dl)
    {
        $flash = $page->getSlot('Flash');
        if ($flash == "") return;
        $msd = $this->getMetaSlotDivider();
        $html =<<<END_HTML
<!--************************************
    Flash
    ************************************-->
<div class="PR2-MetaSlot-FlashWell">
    $flash
</div>
$msd
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";

        $msd = $this->getMetaSlotDivider();

        $tabs = $page->getSlot('TabsBar1');
        $topLinks = $page->getSlot('TopBarLinks');
        if ($topLinks == '') {
            $topLinks = "<a href='$homeURL/sitemap/' >SITE MAP</a> |
                        <a href='$homeURL/about/contact/' >CONTACT US</a>";
        }
        $topBarExtra = $page->getSlot('TopBarExtra');   
        $html =<<<END_HTML

    <!--************************************
        TopBar
    ************************************-->
    <div id="topBar">
        <a href="$homeURL" style="display:none">HOME</a>
        <a href="$homeURL" id="logoBar">&nbsp;</a>
        $topBarExtra
    </div>
END_HTML;
        $page->setMetaSlot('TopBar', $html);
    }

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

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

        $msd = $this->getMetaSlotDivider();

        $html =<<<END_HTML

<!--************************************
    PageTitle
    ************************************-->
<div id="PR2-MetaSlot-PageTitle">
$rightSide
$ptitle
</div>
END_HTML;
        $page->setMetaSlot('PageTitle', $html);
    }

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

        $fullPath = ($path != '') ? ($path . ' &gt; ' . $ptitle) : '';


        $html =<<<END_HTML

<!--************************************
    PathBar
    ************************************-->
<div id="PR2-MetaSlot-PathBar">
$fullPath
</div>

END_HTML;
        return($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)
    {
        global $COMMON_URL, $PATH;
                //$this->layoutWell('ContentWell', $page, $ms, $l);
            $main = $page->getSlot('Main');
            if ($this->parent->getOption('HidePageName')) {
                $pageName = '';
            } else {
                $pageName = $page->getSlot('PageName');
            }
            $sideBar = $page->getSlot('SideBar');

            $msd = $this->getMetaSlotDivider();
            $pathBar = '';
            if ($this->parent->getPageTemplate()->getDisplayForMetaSlot('PathBar'))
                $pathBar = $this->layoutPathBar($page, $ms, $l);
            $subTitle = $page->getSlot('SubTitle');
        $html =<<<END


    <div class="breadcrumbs">$pathBar</div>
    
    <div id="contentContainer">
        <div id="menu">
            <img src="$PATH[root]/..$COMMON_URL/ui/TutorialsLayout/images/menuBgTop.png" />
            <div id="menuItems">
                $sideBar
            </div>
            <img src="$PATH[root]/..$COMMON_URL/ui/TutorialsLayout/images/menuBgBottom.png" />
        </div>
            
        <div id="pr2ContentContainer">
            <img src="$PATH[root]/..$COMMON_URL/ui/TutorialsLayout/images/contentBgTop.png" />
            <div id="pr2Content">
                <div class="title">
                    $pageName
                </div>
                <div id="pr2Add">
                    $main
                </div>
            </div>
            <img src="$PATH[root]/..$COMMON_URL/ui/TutorialsLayout/images/contentBgBottom.png" />
        
            <div id="copyright">
                &copy; 2010 - Shodor
            </div>
        </div>
    
    </div>
END;
        $page->setMetaSlot('ContentWell', $html);
    }


    public function layoutContent ($page, $ms, $l)
    {
        $msd = $this->getMetaSlotDivider();

        $html =<<<END
This is the content zone

$msd
END;
        $page->setMetaSlot('Content', $html);
    }


    /*-----------------------------------------------------*/
    /* 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)
    {

    }

    public function layoutBottomTags ($page, $ms, $layout)
    {
        $width = $this->parent->getOption('minPageWidth');
        $analytics = $page->getSlot('Analytics');
        
        $bottomLinks = <<<LINKS
        &nbsp;
LINKS
;       

        if ($page->getSlot('BottomBarLinks') != '')
            $bottomLinks = $page->getSlot('BottomBarLinks');
        
        $page->setMetaSlot('BottomTags', <<<END_TAGS

</div>

            <div id="footer">
                $bottomLinks
            </div>

$analytics
</body>
</html>
END_TAGS
);
    }

    public function layoutStartBodyTags($page, $ms, $layout)
    {
        $barHTML = <<<END_CONTENT
<div class="PR2-MetaSlot-UniversalBar">
    <div class="PR2-UniversalBarLinks">
        <a class="PR2-UniversalBarLink" style="left: 245px;width: 75px;" href='/'></a>
        <a class="PR2-UniversalBarLink" style="left: 325px;width: 75px;" href='/about'></a>
        <a class="PR2-UniversalBarLink" style="left: 400px;width: 75px;" href='/students'></a>
        <a class="PR2-UniversalBarLink" style="left: 480px;width: 75px;" href='/parents'></a>
        <a class="PR2-UniversalBarLink" style="left: 558px;width: 75px;" href='/educators'></a>
        <a class="PR2-UniversalBarLink" style="left: 635px;width: 133px;" href='/activities'></a>
    </div>
</div>
END_CONTENT;
        $onload = $page->getSlot('OnLoad');
        $bodyId = $page->getSlot('BodyId');
        if ($bodyId != ""){ $bodyId = "id=\"$bodyId\""; }
        if ($onload != ""){ $onload = "javascript:" . $onload; }
        $showUniversalBar = SConfig::getOption('pr2.showUniversalBar');
        $universalBar = ($showUniversalBar) ? $barHTML : '';

        $isMainPage = SConfig::getOption('pr2.mainPage');
        $extraClass = ($isMainPage?' PR2-MainPage':'');

        $page->setMetaSlot('StartBodyTags', <<<END_TAGS

<body $bodyId class="PR2-Body{$extraClass}" onload="$onload">
    $universalBar
<div class="PR2-Page">

END_TAGS
);

    }

}
//##

?>

---