Class Controller

The controller for the Auto-Nav block.

Concrete\Core\Controller\AbstractController implements Concrete\Core\Application\ApplicationAwareInterface
Extended by Concrete\Core\Block\BlockController
Extended by Concrete\Block\Autonav\Controller
Namespace: Concrete\Block\Autonav
Package: Blocks\Auto-Nav
Copyright: Copyright (c) 2003-2012 Concrete5. (http://www.concrete5.org)
License: MIT License
Author: Andrew Embler andrew@concrete5.org
Author: Jordan Lev
Located at blocks/autonav/controller.php

Methods summary

public
# __construct( BlockType $obj = null )

Instantiates the block controller.

public
public string
# getBlockTypeDescription( )

Returns the description of the block type.

public string
# getBlockTypeName( )

Returns the name of the block type.

public
# save( array $args )

Run when a block is added or edited. Automatically saves block data against the block's database table. If a block needs to do more than this (save to multiple tables, upload files, etc... it should override this.

public
public
public
# getNavItems( $ignore_exclude_nav = false )

New and improved version of "generateNav()" function. Use this unless you need to maintain backwards compatibility with older custom templates.

public
# generateNav( )

This function is used by the getNavItems() method to generate the raw "pre-processed" nav items array. It also must exist as a separate function to preserve backwards-compatibility with older autonav templates. Warning: this function has side-effects -- if this gets called twice, items will be duplicated in the nav structure!

public
# getParentParentID( )

heh. probably should've gone the simpler route and named this getGrandparentID().

public
# getParentAtLevel( $level )
public
# populateParentIDArray( integer $cID )

Pupulates the $cParentIDArray instance property.

public
# getNavigationArray( $cParentID, $orderBy, $currentLevel )
protected
# displayPage( $tc )
public

Properties summary

public $collection
#
public array $navArray
# array()
public array $cParentIDArray
# array()
public array $sorted_array
# array()
public array $navSort
# array()
public array $navObjectNames
# array()
public $displayPages
#
public $displayPagesCID
#
public $displayPagesIncludeSelf
#
public $displaySubPages
#
public $displaySubPageLevels
#
public $displaySubPageLevelsNum
#
public $orderBy
#
public $displayUnavailablePages
#
public boolean $haveRetrievedSelf
# false
public boolean $haveRetrievedSelfPlus1
# false
public boolean $displaySystemPages
# false
public boolean $displayUnapproved
# false
protected string $btTable
# 'btNavigation'
protected string $btInterfaceWidth
# "800"
protected string $btInterfaceHeight
# "350"
protected boolean $btCacheBlockRecord
# true
protected boolean $btCacheBlockOutput
# true
protected boolean $btCacheBlockOutputOnPost
# true
protected boolean $btCacheBlockOutputForRegisteredUsers
# false
protected integer $btCacheBlockOutputLifetime
# 300
protected string $btWrapperClass
# 'ccm-ui'
protected array $btExportPageColumns
# array('displayPagesCID')