Developing (v7+)

Changing parent page with prev/next nav?

Permalink September 04, 2013 at 12:57 PM

Hi Community,

I need to add next/prev nav that will change not only pages on same level, but also will allow to change the category (parent page). This will look i.e. like that:

<< < 123 > >>

where << and >> change category (switch to next parent), and inside of them is regular next/prev nav. Can anyone help me to create the custom template (or is there other way?)?

MysteriousCleon replied on Sep 5, 2013 at 2:49 pm Permalink Reply

Bump

bbeng89 replied on Sep 5, 2013 at 3:50 pm Permalink Best Answer Reply

So your question got me kind of curious, so I decided to give it a shot. I created a custom template, but in order to get the correct functionality I had to also override the controller for the next/previous block. Anyway, here is how I did it:

Create an override directory for the next_previous block like normal by adding a folder /blocks/next_previous. In this folder create a file called controller.php.

Inside controller I just override the getNextCollection() and getPreviousCollection() methods so that they take a parameter that is the page to get the next/previous page of. By default it just always does the current page, so by adding this extra parameter we can specify the page. I also override the view() function in order to set variables containing the parents next page (parentNext) and parent's previous page (parentPrev). So this is why my controller looks like:

<?php   defined('C5_EXECUTE') or die("Access Denied."); 
class NextPreviousBlockController extends Concrete5_Controller_Block_NextPrevious { 
   function view(){
      $this->excludeSystemPages = true;
      parent::view();
      $parent = $this->get('parentCollection');
      $parentNext = $this->getNextCollection($parent);
      $parentPrev = $this->getPreviousCollection($parent);
      $this->set('parentNext', $parentNext);
      $this->set('parentPrev', $parentPrev);
   }
   function getNextCollection($p = null){
      if(empty($p)){
         $currentPage = Page::getCurrentPage();
      }

Viewing 15 lines of 102 lines. View entire code block.

 
<?php   defined('C5_EXECUTE') or die("Access Denied."); 
 
class NextPreviousBlockController extends Concrete5_Controller_Block_NextPrevious { 
 
   function view(){
      $this->excludeSystemPages = true;
      parent::view();
      $parent = $this->get('parentCollection');
      $parentNext = $this->getNextCollection($parent);
      $parentPrev = $this->getPreviousCollection($parent);
      $this->set('parentNext', $parentNext);
      $this->set('parentPrev', $parentPrev);
   }
 
   function getNextCollection($p = null){
      if(empty($p)){
         $currentPage = Page::getCurrentPage();
      }
      else{
         $currentPage = $p;
      }
      $page = false;
      $db = Loader::db();
 
      $systemPages = '';
      if ($this->excludeSystemPages) {
         $systemPages = 'and cIsSystemPage = 0';
      }
      $cID = 1;
      while ($cID > 0) {
         if ($this->orderBy == 'display_asc') {
            $cID = $db->GetOne('select cID from Pages where cDisplayOrder > ? and cParentID = ? ' . $systemPages . ' order by cDisplayOrder asc', array($currentPage->getCollectionDisplayOrder(), $currentPage->getCollectionParentID()));
         } else {
            $cID = $db->GetOne('select Pages.cID from Pages inner join CollectionVersions cv on Pages.cID = cv.cID where cvIsApproved = 1 and cvDatePublic > ? and cParentID = ? ' . $systemPages . ' order by cvDatePublic asc', array($currentPage->getCollectionDatePublic(), $currentPage->getCollectionParentID()));
         }
         if ($cID > 0) {
            $page = Page::getByID($cID, 'RECENT');
            $currentPage = $page;
            $cp = new Permissions($page);
            if ($cp->canRead() && $page->getAttribute('exclude_nav') != 1) {
               break;
            }
         }
      }
      if (!is_object($page) && $this->loopSequence) {
         if(empty($p)){
            $c = Page::getCurrentPage();
         }
         else{
            $c = $p;
         }
         $parent = Page::getByID($c->getCollectionParentID(), 'ACTIVE');
         if ($this->orderBy == 'display_asc') {
            return $parent->getFirstChild('cDisplayOrder asc', $this->excludeSystemPages);
         } else {
            return $parent->getFirstChild('cvDatePublic asc', $this->excludeSystemPages);
         }
      }
      return $page;
   }
 
   function getPreviousCollection($p = null){
      if(empty($p)){
         $currentPage = Page::getCurrentPage();
      }
      else{
         $currentPage = $p;
      }
      $page = false;
      $db = Loader::db();
      $systemPages = '';
      if ($this->excludeSystemPages) {
         $systemPages = 'and cIsSystemPage = 0';
      }
      $cID = 1;
      while ($cID > 0) {
         if ($this->orderBy == 'display_asc') {
            $cID = $db->GetOne('select cID from Pages where cDisplayOrder < ? and cParentID = ? ' . $systemPages . ' order by cDisplayOrder desc', array($currentPage->getCollectionDisplayOrder(), $currentPage->getCollectionParentID()));
         } else {
            $cID = $db->GetOne('select Pages.cID from Pages inner join CollectionVersions cv on Pages.cID = cv.cID where cvIsApproved = 1 and cvDatePublic < ? and cParentID = ? ' . $systemPages . ' order by cvDatePublic desc', array($currentPage->getCollectionDatePublic(), $currentPage->getCollectionParentID()));
         }
         if ($cID > 0) {
            $page = Page::getByID($cID, 'RECENT');
            $currentPage = $page;
            $cp = new Permissions($page);
            if ($cp->canRead() && $page->getAttribute('exclude_nav') != 1) {
               break;
            }
         }
      }
      if (!is_object($page) && $this->loopSequence) {
         if(empty($p)){
            $c = Page::getCurrentPage();
         }
         else{
            $c = $p;
         }
         $parent = Page::getByID($c->getCollectionParentID(), 'ACTIVE');
         if ($this->orderBy == 'display_asc') {
            return $parent->getFirstChild('cDisplayOrder desc');
         } else {
            return $parent->getFirstChild('cvDatePublic desc');
         }
      }
 
      return $page;
   }
}

Next you need to create a template. So just make a folder /blocks/next_previous/templates then add your template file (i called mine parent_nav.php but that's not a very good name).

The template can now use the $parentNext and $parentPrev variables we set in our custom view() function. So as an example, my template looks like this (the links just display the name of the parent's next and previous pages):

<?php 
defined('C5_EXECUTE') or die("Access Denied.");
$ih = Loader::helper('image');
?>
<div id="ccm-next-previous-<?php  echo intval($bID)?>" class="ccm-next-previous-wrapper">
    <?php   if( strlen($previousLinkText) > 0){ ?>
      <div class="ccm-next-previous-previouslink">
        <?php   if( is_object($previousCollection) ){ ?>
          <a href="<?php  echo Loader::helper('navigation')->getLinkToCollection($previousCollection)?>"><?php  echo $previousLinkText ?></a>
        <?php   } else { ?>
           
        <?php   } ?>
      </div>
    <?php  } ?>
    <?php //This prints out a link to the parent's previous page ?>

Viewing 15 lines of 46 lines. View entire code block.

 
<?php 
defined('C5_EXECUTE') or die("Access Denied.");
$ih = Loader::helper('image');
?>
 
<div id="ccm-next-previous-<?php  echo intval($bID)?>" class="ccm-next-previous-wrapper">
 
    <?php   if( strlen($previousLinkText) > 0){ ?>
      <div class="ccm-next-previous-previouslink">
        <?php   if( is_object($previousCollection) ){ ?>
          <a href="<?php  echo Loader::helper('navigation')->getLinkToCollection($previousCollection)?>"><?php  echo $previousLinkText ?></a>
        <?php   } else { ?>
           
        <?php   } ?>
      </div>
    <?php  } ?>
 
    <?php //This prints out a link to the parent's previous page ?>
    <?php   if( is_object($parentPrev) ){ ?>
      <div class="ccm-next-previous-previouslink">
          <a href="<?php  echo Loader::helper('navigation')->getLinkToCollection($parentPrev)?>"><?php  echo $parentPrev->getCollectionName(); ?></a>
      </div>
    <?php  } ?>
 
    <?php   if( strlen($parentLinkText) > 0){ ?>
      <div class="ccm-next-previous-parentlink">
        <?php   if( is_object($parentCollection) && $parentLinkText){ ?>
          <a href="<?php  echo Loader::helper('navigation')->getLinkToCollection($parentCollection)?>"><?php  echo $parentLinkText ?></a>
        <?php   } else { ?>
           
        <?php   } ?>
      </div>
    <?php  } ?>
 
    <?php //This prints out a link to the parent's next page ?>
    <?php   if( is_object($parentNext) ){ ?>
      <div class="ccm-next-previous-previouslink">
          <a href="<?php  echo Loader::helper('navigation')->getLinkToCollection($parentNext)?>"><?php  echo $parentNext->getCollectionName(); ?></a>
      </div>
    <?php  } ?>
 
    <?php   if( strlen($nextLinkText) > 0){ ?>
      <div class="ccm-next-previous-nextlink">
        <?php   if( is_object($nextCollection) ){ ?>
          <a href="<?php  echo Loader::helper('navigation')->getLinkToCollection($nextCollection)?>"><?php  echo $nextLinkText ?></a>
        <?php   } else { ?>
           
        <?php   } ?>
      </div>
    <?php  } ?>
 
    <div class="spacer"></div>
</div>

Like I said, this is just the solution I came up with and there could definitely be better ways of doing it. Hopefully it helps you out though. Good luck!

MysteriousCleon replied on Sep 5, 2013 at 5:16 pm Permalink Reply

Thank you veeery much. I'll test it and then come back. I really appreciate your effort.

bbeng89 replied on Sep 6, 2013 at 12:23 pm Permalink Reply

Hey MysteriousCleon, were you ever able to get this working?

MysteriousCleon replied on Sep 6, 2013 at 1:54 pm Permalink Reply

Yes,I've just checked it - it's brilliant. For my use I just changed order of those links becouse you gave:
prev parent_prev up parent_next next
and I need
parent_prev prev up next parent_next
but this is obviesly only cosmetics.

There is one issue though, when there is no prevoius parent (I mean in all subpages of first parent page in the sitemap) it's not looping properly - instead of showing link to last parent it gives last child of first parent. And the same situation with all children of last parent - there is no next parent, so instead of looping into first parent it loops to first child of that last parent.

If looping is off everything is ok.

bbeng89 replied on Sep 6, 2013 at 2:13 pm Permalink Reply

Ah, I know what the issue is. At the bottom of the getNextCollection() and getPreviousCollection() you need to modify the last if statement to be:

//...in getNextCollection()
if (!is_object($page) && $this->loopSequence) {
         if(empty($p)){ //need to check the $p param
            $c = Page::getCurrentPage();
         }
         else{
            $c = $p;
         }
         $parent = Page::getByID($c->getCollectionParentID(), 'ACTIVE');
         if ($this->orderBy == 'display_asc') {
            return $parent->getFirstChild('cDisplayOrder asc', $this->excludeSystemPages);
         } else {
            return $parent->getFirstChild('cvDatePublic asc', $this->excludeSystemPages);
         }
      }

//... in getPreviousCollection()
if (!is_object($page) && $this->loopSequence) {
         if(empty($p)){ //need to check the $p param
            $c = Page::getCurrentPage();
         }
         else{
            $c = $p;
         }
         $parent = Page::getByID($c->getCollectionParentID(), 'ACTIVE');
         if ($this->orderBy == 'display_asc') {
            return $parent->getFirstChild('cDisplayOrder desc');
         } else {
            return $parent->getFirstChild('cvDatePublic desc');
         }
      }

Also I noticed that this was causing some of the system pages to show up for me (may not be an issue for you) so in my view() function i just added the line:

$this->excludeSystemPages = true;

I hope that fixes your problem!

MysteriousCleon replied on Sep 6, 2013 at 3:50 pm Permalink Reply

Exectly! Thank you. It works perfect.

bbeng89 replied on Sep 6, 2013 at 3:54 pm Permalink Reply

Awesome! Glad you were able to get it working. I went ahead and updated the code in my original post in case anyone else stumbles across this thread.

MysteriousCleon replied on Sep 6, 2013 at 4:49 pm Permalink Reply

BTW - as you are doing this, maybe it would be good idea to improve this template by adding pagination for those child pages? I mean links to all child pages from current cathegory but with names swoped with 1 2 3 4 etc... to put in the middle of that nav. What do you think?

bbeng89 replied on Sep 6, 2013 at 5:00 pm Permalink Reply

I'm sure it would be possible. I think you would probably achieve the pagination by using another block like the page list or autonav. Either way, I was really just trying to find a way to achieve what you were asking for in your original question out of curiosity. Unfortunately I don't personally have a use for this functionality yet, but if it ever comes up I would be glad to share my code. For now I'll leave the custom templating to you ;)

MysteriousCleon replied on Sep 6, 2013 at 5:13 pm Permalink Reply

Of course, no problem. This functionality is not necessary for me for now, but I thought that this may be good idea to have this ideas in one place. I'll try to figure this out, or maybe someone else has it alredy done...
Thank you one more time. :)

hdocwra replied on Aug 21, 2014 at 6:22 pm Permalink Reply

-Deleted-

Forums

Developing (v7+)

Changing parent page with prev/next nav?

Code

Post Reply

Delete Post

Mark Post as Spam

Destroy Spammer

Sign In?