1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 <?php
/**
***********************************************************************************************
* @copyright 2004-2016 The Admidio Team
* @see http://www.admidio.org/
* @license https://www.gnu.org/licenses/gpl-2.0.html GNU General Public License v2.0 only
***********************************************************************************************
*/
/**
* @class HtmlDiv
* @brief Create html div elements
*
* This class creates html div elements.
* Create an instance of an div element and nest the inline elements.
* The class supports nesting of several div elements and allows you to configure all attributes programatically.
* The parsed div object with inline elements is returned as string.
*
* @par Example: Creating a div element
* @code
* $testArray = array('Test_1', 'Test_2','Test_3');
* // Get the Instance for a new division element
* $div = new HtmlDiv('ID_Wrapper', 'Class_Wrapper');
* // add a headline
* $div->addInline('h1', '', '', 'Headline');
* // add a paragraph
* $div->addInline('p', 'ID_P', 'CLASS_TEXT', 'This is a demo of a pargraph element in the division block');
* // add a paragraph
* $div->addInline('p', '', 'CLASS_TEXT_ARRAY', $testArray);
* // very often you need to nest several div elements for styling, etc.
* // so just add a next div, or further divs
* $div->addDivElement('ID_PAGE', 'DIV_2');
* // now the inline element or elements
* $div->addInline('p', '', '', 'This is a demo of a pargraph element in a nested division block');
* // Example nesting more div elements.
* $div->addDivElement('ID_SECOND_LEVEL', 'DIV');
* $div->addDivElement('ID_THIRD_LEVEL', 'DIV');
* $div->addDivElement('ID_FOURTH_LEVEL', 'DIV');
* // now the inline element in fourth div element
* $div->addInline('p', '', '', 'This is a demo of a pargraph element nested in the fourth level');
* // If you want to close a div in the current level,...
* $div->closeParentElement('div');
* // now the current div is closed and the current level jumps to the third div element
* // here we can go on adding the inline elments
* $div->addInline('p', '', 'P_IN_3RD-DIVLEVEL', $testArray);
* // get the parsed block element -> all opened divs are closed automatically !
* echo $div->getHtmlDiv();
* @endcode
*/
class HtmlDiv extends HtmlElement
{
protected $level; ///< Integer value for the depth of nested div elements starting with level 1 for the main element
/**
* Constructor creates the element
*
* @param string $id Id of the main div
* @param string $class Class name of the main div
*/
public function __construct($id = null, $class = null)
{
parent::__construct('div', true);
if ($id !== null)
{
$this->addAttribute('id', $id);
}
if ($class !== null)
{
$this->addAttribute('class', $class);
}
// set div level to 1
$this->level = 1;
}
/**
* Add a datalist (dl).
* @param string $id Id Attribute
* @param string $class Class Attribute
*/
public function addDivElement($id = null, $class = null)
{
// Div elements do not need having child elements an can be nested straight forward.
// For this exception in html we have to take care that the flag of the parent class is always reseted, otherwise the
// attributes are not parsed, because parent class htmlElement() determines that the attributes of the
// parent element are already parsed if flag has value true and the next element is a child with optional attributes and closing tag.
// So we must overwrite the protected parent variable
$this->parentFlag = false;
// Define new div element
$this->addParentElement('div');
if ($id !== null)
{
$this->addAttribute('id', $id);
}
if ($class !== null)
{
$this->addAttribute('class', $class);
}
// raise level
++$this->level;
}
/**
* Add inline element into current division.
* @param string $element The inline element
* @param string $id Id Attribute
* @param string $class Class Attribute
* @param string $data Data of the element (optional)
*/
public function addInline($element, $id = null, $class = null, $data = null)
{
$this->addElement($element);
if ($id !== null)
{
$this->addAttribute('id', $id);
}
if ($class !== null)
{
$this->addAttribute('class', $class);
}
if ($data !== null)
{
$this->addData($data);
}
}
/**
* This method sets the endtag of the selected element and removes the entry from log array.
* If nesting mode is not used, the methods looks for the entry in the array and determines that all setted elements after the selected element must be closed as well.
* All end tags to position are closed automatically starting with last setted element tag.
*
* @param string $parentElement Parent element to be closed
* @return bool
*/
public function closeParentElement($parentElement)
{
// initialize position and count entries in array
$position = null;
$totalCount = count($this->arrParentElements);
if ($totalCount === 0)
{
return false;
}
if (in_array($parentElement, $this->arrParentElements, true))
{
// find position in log array
foreach ($this->arrParentElements as $key => $value)
{
if ($value === $parentElement)
{
$position = $key;
break;
}
}
// if last position set Endtag in string and remove from array
if ($position === $totalCount)
{
$this->htmlString .= '</' . $this->arrParentElements[$totalCount] . '>';
unset($this->arrParentElements[$position]);
}
else
{
// all elements setted later must also be closed and removed from array
for ($i = $totalCount - 1; $i >= $position; --$i)
{
$this->htmlString .= '</' . $this->arrParentElements[$i] . '>';
unset($this->arrParentElements[$i]);
}
}
}
if ($parentElement === 'div')
{
// set new level
--$this->level;
}
return true;
}
/**
* Get the parsed html division (div)
*
* @return string Returns the validated html div as string
*/
public function getHtmlDiv()
{
// first check if open div elements exists and set all endtags if needed
for ($this->level; $this->level > 2; --$this->level)
{
$this->closeParentElement('div');
}
return $this->getHtmlElement();
}
}