160 lines
2.8 KiB
PHP
160 lines
2.8 KiB
PHP
<?php
|
|
/* Icinga Web 2 | (c) 2014 Icinga Development Team | GPLv2+ */
|
|
|
|
namespace Icinga\Module\Doc;
|
|
|
|
use Icinga\Data\Tree\TreeNode;
|
|
|
|
/**
|
|
* A section of a documentation
|
|
*/
|
|
class DocSection extends TreeNode
|
|
{
|
|
/**
|
|
* Chapter the section belongs to
|
|
*
|
|
* @var DocSection
|
|
*/
|
|
protected $chapter;
|
|
|
|
/**
|
|
* Content of the section
|
|
*
|
|
* @var array
|
|
*/
|
|
protected $content = array();
|
|
|
|
/**
|
|
* Header level
|
|
*
|
|
* @var int
|
|
*/
|
|
protected $level;
|
|
|
|
/**
|
|
* Whether to instruct search engines to not index the link to the section
|
|
*
|
|
* @var bool
|
|
*/
|
|
protected $noFollow;
|
|
|
|
/**
|
|
* Title of the section
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $title;
|
|
|
|
/**
|
|
* Set the chapter the section belongs to
|
|
*
|
|
* @param DocSection $section
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setChapter(DocSection $section)
|
|
{
|
|
$this->chapter = $section;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Get the chapter the section belongs to
|
|
*
|
|
* @return DocSection
|
|
*/
|
|
public function getChapter()
|
|
{
|
|
return $this->chapter;
|
|
}
|
|
|
|
/**
|
|
* Append content
|
|
*
|
|
* @param string $content
|
|
*/
|
|
public function appendContent($content)
|
|
{
|
|
$this->content[] = $content;
|
|
}
|
|
|
|
/**
|
|
* Get the content of the section
|
|
*
|
|
* @return array
|
|
*/
|
|
public function getContent()
|
|
{
|
|
return $this->content;
|
|
}
|
|
|
|
/**
|
|
* Set the header level
|
|
*
|
|
* @param int $level Header level
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setLevel($level)
|
|
{
|
|
$this->level = (int) $level;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Get the header level
|
|
*
|
|
* @return int
|
|
*/
|
|
public function getLevel()
|
|
{
|
|
return $this->level;
|
|
}
|
|
|
|
/**
|
|
* Set whether to instruct search engines to not index the link to the section
|
|
*
|
|
* @param bool $noFollow Whether to instruct search engines to not index the link to the section
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setNoFollow($noFollow = true)
|
|
{
|
|
$this->noFollow = (bool) $noFollow;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Get whether to instruct search engines to not index the link to the section
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function getNoFollow()
|
|
{
|
|
return $this->noFollow;
|
|
}
|
|
|
|
/**
|
|
* Set the title of the section
|
|
*
|
|
* @param string $title Title of the section
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setTitle($title)
|
|
{
|
|
$this->title = (string) $title;
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Get the title of the section
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getTitle()
|
|
{
|
|
return $this->title;
|
|
}
|
|
}
|