PHP Class PHPePub\Core\Structure\NCX\NavPoint

Author: A. Grandt ([email protected])
Inheritance: extends PHPePub\Core\Structure\NCX\AbstractNavEntry
Datei anzeigen Open project: grandt/phpepub

Public Methods

Method Description
__construct ( string $label, string $contentSrc = null, string $id = null, string $navClass = null, boolean $isNavHidden = false, string $writingDirection = null ) Class constructor.
__destruct ( ) : void Class destructor
addNavPoint ( $navPoint ) Add child NavPoints for multi level NavMaps.
finalize ( string &$nav = "", integer &$playOrder, integer $level ) : integer Enter description here .
finalizeEPub3 ( string &$nav = "", integer &$playOrder, integer $level, null $subLevelClass = null, boolean $subLevelHidden = false ) : integer Enter description here .
getContentSrc ( ) : string Get the src reference for the NavPoint.
getLabel ( ) : string Get the Text label for the NavPoint.
getLevel ( ) : integer Get the current level. 1 = document root.
getParent ( ) : PHPePub\Core\Structure\NCX\AbstractNavEntry Get the parent to this NavPoint.
getWritingDirection ( )
setContentSrc ( string $contentSrc ) Set the src reference for the NavPoint.
setId ( string $id ) Set the id for the NavPoint.
setLabel ( string $label ) Set the Text label for the NavPoint.
setNavClass ( string $navClass ) Set the class to be used for this NavPoint.
setNavHidden ( $isNavHidden ) Set the class to be used for this NavPoint.
setParent ( NavPoint | PHPePub\Core\Structure\NCX\NavMap $parent ) Set the parent for this NavPoint.
setWritingDirection ( string $writingDirection ) Set the writing direction to be used for this NavPoint.

Method Details

__construct() public method

All three attributes are mandatory, though if ID is set to null (default) the value will be generated.
public __construct ( string $label, string $contentSrc = null, string $id = null, string $navClass = null, boolean $isNavHidden = false, string $writingDirection = null )
$label string
$contentSrc string
$id string
$navClass string
$isNavHidden boolean
$writingDirection string

__destruct() public method

Class destructor
public __destruct ( ) : void
return void

addNavPoint() public method

Add child NavPoints for multi level NavMaps.
public addNavPoint ( $navPoint )
$navPoint

finalize() public method

..
public finalize ( string &$nav = "", integer &$playOrder, integer $level ) : integer
$nav string
$playOrder integer
$level integer
return integer

finalizeEPub3() public method

..
public finalizeEPub3 ( string &$nav = "", integer &$playOrder, integer $level, null $subLevelClass = null, boolean $subLevelHidden = false ) : integer
$nav string
$playOrder integer
$level integer
$subLevelClass null
$subLevelHidden boolean
return integer

getContentSrc() public method

Get the src reference for the NavPoint.
public getContentSrc ( ) : string
return string content src url.

getLabel() public method

Get the Text label for the NavPoint.
public getLabel ( ) : string
return string Label

getLevel() public method

Get the current level. 1 = document root.
public getLevel ( ) : integer
return integer level

getParent() public method

Get the parent to this NavPoint.
public getParent ( ) : PHPePub\Core\Structure\NCX\AbstractNavEntry
return PHPePub\Core\Structure\NCX\AbstractNavEntry if the parent is the root.

getWritingDirection() public method

public getWritingDirection ( )

setContentSrc() public method

The src is mandatory for ePub 2.
public setContentSrc ( string $contentSrc )
$contentSrc string

setId() public method

The id must be unique, and is mandatory.
public setId ( string $id )
$id string

setLabel() public method

The label is mandatory.
public setLabel ( string $label )
$label string

setNavClass() public method

Set the class to be used for this NavPoint.
public setNavClass ( string $navClass )
$navClass string

setNavHidden() public method

Set the class to be used for this NavPoint.
public setNavHidden ( $isNavHidden )
$isNavHidden

setParent() public method

Set the parent for this NavPoint.
public setParent ( NavPoint | PHPePub\Core\Structure\NCX\NavMap $parent )
$parent NavPoint | PHPePub\Core\Structure\NCX\NavMap

setWritingDirection() public method

Set the writing direction to be used for this NavPoint.
public setWritingDirection ( string $writingDirection )
$writingDirection string