PHP Класс PHPePub\Core\Structure\NCX\NavPoint

Автор: A. Grandt ([email protected])
Наследование: extends PHPePub\Core\Structure\NCX\AbstractNavEntry
Показать файл Открыть проект

Открытые методы

Метод Описание
__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.

Описание методов

__construct() публичный Метод

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() публичный Метод

Class destructor
public __destruct ( ) : void
Результат void

addNavPoint() публичный Метод

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

finalize() публичный Метод

..
public finalize ( string &$nav = "", integer &$playOrder, integer $level ) : integer
$nav string
$playOrder integer
$level integer
Результат integer

finalizeEPub3() публичный Метод

..
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
Результат integer

getContentSrc() публичный Метод

Get the src reference for the NavPoint.
public getContentSrc ( ) : string
Результат string content src url.

getLabel() публичный Метод

Get the Text label for the NavPoint.
public getLabel ( ) : string
Результат string Label

getLevel() публичный Метод

Get the current level. 1 = document root.
public getLevel ( ) : integer
Результат integer level

getParent() публичный Метод

Get the parent to this NavPoint.
public getParent ( ) : PHPePub\Core\Structure\NCX\AbstractNavEntry
Результат PHPePub\Core\Structure\NCX\AbstractNavEntry if the parent is the root.

getWritingDirection() публичный Метод

public getWritingDirection ( )

setContentSrc() публичный Метод

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

setId() публичный Метод

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

setLabel() публичный Метод

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

setNavClass() публичный Метод

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

setNavHidden() публичный Метод

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

setParent() публичный Метод

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

setWritingDirection() публичный Метод

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