From 3e02d5aff85babc3ffbfcf52313f2108e313aa23 Mon Sep 17 00:00:00 2001
From: Daniel Baumann <daniel.baumann@progress-linux.org>
Date: Sat, 13 Apr 2024 13:46:43 +0200
Subject: Adding upstream version 2.12.1.

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
---
 modules/doc/library/Doc/DocSection.php | 159 +++++++++++++++++++++++++++++++++
 1 file changed, 159 insertions(+)
 create mode 100644 modules/doc/library/Doc/DocSection.php

(limited to 'modules/doc/library/Doc/DocSection.php')

diff --git a/modules/doc/library/Doc/DocSection.php b/modules/doc/library/Doc/DocSection.php
new file mode 100644
index 0000000..ce5297e
--- /dev/null
+++ b/modules/doc/library/Doc/DocSection.php
@@ -0,0 +1,159 @@
+<?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;
+    }
+}
-- 
cgit v1.2.3