1. interface
  2. Cable8mm
  3. \
  4. Toc
  5. \
  6. Contracts
  7. \
  8. ItemInterface

ItemInterface

interface ItemInterface

Methods

string
getTitle()

Get the title of the navigation item

string|null
getLink()

Get the link of the navigation item

ItemEnum
getType()

Get the type of the navigation item

int
getDepth(string|null $indent = ' ', string|null $symbol = '-', int|null $depth = 0, int|null $initialHCount = 0, int|null $initialIndentCount = 0)

Get the depth of the navigation item

Details

at line 14
string getTitle()

Get the title of the navigation item

Return Value

string

The method returns the title of the navigation item

Get the link of the navigation item

Return Value

string|null

The method returns the link of the navigation item

at line 28
ItemEnum getType()

Get the type of the navigation item

Return Value

ItemEnum

The method returns the type of the navigation item

at line 42
int getDepth(string|null $indent = ' ', string|null $symbol = '-', int|null $depth = 0, int|null $initialHCount = 0, int|null $initialIndentCount = 0)

Get the depth of the navigation item

Parameters

string|null $indent

The indent e.g. "-" or "*"
string|null $symbol

The symbol e.g. "-" or "*"
int|null $depth

The depth e.g. 1, 2, 3, 4
int|null $initialHCount

The initial # count
int|null $initialIndentCount

The initial indent count

Return Value

int

The method returns the depth of the navigation item

Exceptions

InvalidArgumentException