n2n Page Rocket 1 API

­Nav­Branch

Methods summary

Methods in detail

• __construct

  public __construct ( NavTree navTree , string id = null )

• getNavTree

  NavTree public getNavTree ( )

  return

  NavTree

• setId

  public setId ( string id = null )

  param

  string id

• getId

  string|null public getId ( )

  return

  page\model\nav\string|null

• setObjAffiliationTester

  public setObjAffiliationTester ( Closure objAffiliationTester = null )

  param

  Closure objAffiliationTester

• isAffiliatedWith

  boolean public isAffiliatedWith ( object obj )

  param

  object obj

  return

  boolean

• containsTagNames

  bool public containsTagNames ( array tagNames )

  param

  array tagNames

  return

  bool

• setTagNames

  public setTagNames ( array tagNames )

• getTagNames

  public getTagNames ( )

• containsHookKeys

  boolean public containsHookKeys ( array hookKeys )

  param

  string hookKey

  return

  boolean

• getHookKeys

  string public getHookKeys ( )

  return

  string

• setHookKeys

  public setHookKeys ( string hookKeys )

  param

  string hookKeys

• setInPath

  public setInPath ( bool inPath )

• isInPath

  public isInPath ( )

• addLeaf

  public addLeaf ( Leaf leaf )

  param

  Leaf

• removeLeafByN2nLocale

  public removeLeafByN2nLocale ( N2nLocale n2nLocale )

  param

  N2nLocale

• containsLeafN2nLocale

  bool public containsLeafN2nLocale ( N2nLocale n2nLocale )

  param

  N2nLocale

  return

  bool

• getLeafByN2nLocale

  Leaf public getLeafByN2nLocale ( N2nLocale n2nLocale )

  param

  N2nLocale

  throws

  UnavailableLeafException

  return

  Leaf

• getLeafs

  Leaf public getLeafs ( )

  return

  Leaf

• getParent

  public getParent ( )

• getRoot

  public getRoot ( )

• setParent

  protected setParent ( NavBranch navBranch = null )

• getLevel

  public getLevel ( )

• setLevel

  protected setLevel ( int level = null )

• appendChild

  public appendChild ( NavBranch navBranch )

• prependChild

  public prependChild ( NavBranch navBranch )

• removeChild

  public removeChild ( NavBranch navBranch )

• hasChildren

  public hasChildren ( )

• getChildren

  public getChildren ( )

• findChild

  NavBranch public findChild ( object affiliatedObj = null , array tagNames = null , array hookKeys = null )

  param

  object affiliatedObj

  array tagNames

  array hookKeys

  return

  NavBranch

• find

  NavBranch public find ( object affiliatedObj = null , array tagNames = null , array hookKeys = null )

  param

  object affiliatedObj

  array tagNames

  array hookKeys

  return

  NavBranch

• findAncestor

  NavBranch public findAncestor ( object affiliatedObj = null , array tagNames = null , array hookKeys = null )

  param

  object affiliatedObj

  array tagNames

  array hookKeys

  return

  NavBranch

• equals

  boolean public equals ( mixed obj )

  param

  mixed obj

  return

  boolean

• containsDescendant

  boolean public containsDescendant ( NavBranch navBranch )

  param

  NavBranch

  return

  boolean

• __toString

  public __toString ( )