that contains the note
*
* @return nothing
*/
protected function addNote($text_codes, $replacements = null, $terminate = true)
{
echo $this->addAdmonition('note', 'ATTACH_HELP_NOTE', $text_codes, $replacements, $terminate);
}
/**
* Add a 'warning' admonition
*
* @param array $text_codes Array of Language tokens for the body text (as separate paragraphs in the admonition)
* @param array $replacements Array of replacements to be applied to the body text (see replace functin)
* @param bool $terminate Whether to terminatate the
that contains the note
*
* @return nothing
*/
protected function addWarning($text_codes, $replacements = null, $terminate = true)
{
echo $this->addAdmonition('warning', 'ATTACH_HELP_WARNING', $text_codes, $replacements, $terminate);
}
/**
* Add a paragraph
*
* @param array $text_codes Array of Language tokens for the body text (as separate paragraphs)
* @param array $replacements Array of replacements to be applied to the text (see replace functin)
* @param string $pclass The class for the paragraph HTML
element
*
* @return nothing
*/
protected function addParagraph($text_codes, $replacements = null, $pclass = null)
{
if (!is_array($text_codes))
{
$text_codes = Array($text_codes);
}
$html = '';
foreach ($text_codes as $text_code)
{
$text = $this->replace(JText::_($text_code), $replacements);
$tooltip = $this->constructTooltip($text_code);
if ($pclass)
{
$html .= "
" . $text . "
\n";
}
else
{
$html .= "
" . $text . "
\n";
}
}
echo $html;
}
/**
* Add a preformatted block
*
* @param string $text The raw string to print literally
* @param string $class The class for the HTML
block
*
* @return nothing
*/
protected function addPreBlock($text, $class='literal-block')
{
$html = "\n";
$html .= $text . "\n";
$html .= "
\n";
echo $html;
}
/**
* Start an a list (unordered by default)
*
* @param string $type The type of list (defaults to unordered )
* @param string $class The class for the HTML or element
*
* @return nothing
*/
protected function startList($type = 'ul', $class='simple')
{
echo "<$type class=\"$class\">\n";
}
/**
* Add a list element
*
* @param array $text_codes Array of Language tokens for the body text (as separate paragraphs inside the list element)
* @param array $replacements Array of replacements to be applied to the text (see replace function)
* @param bool $terminate Whether to terminatate the - that contains the text
*
* @return nothing
*/
protected function addListElement($text_codes, $replacements = null, $terminate = true)
{
$html = '
- ';
if (!is_array($text_codes))
{
$text_codes = Array($text_codes);
}
foreach ($text_codes as $text_code)
{
$text = $this->replace(JText::_($text_code), $replacements);
$tooltip = $this->constructTooltip($text_code);
$html .= "
$text
\n";
}
if ($terminate)
{
$html .= " \n";
}
echo $html;
}
/**
* Add a list element for a definition for a term (a word or phrase)
*
* @param array $text_codes Array of Language tokens for the body text (as separate paragraphs inside the list element)
* @param array $replacements Array of replacements to be applied to the text (see replace function)
* @param bool $terminate Whether to terminatate the - that contains the text
*
* @return nothing
*/
protected function addDefinitionListElement($term_code, $definition_codes,
$replacements = null, $terminate = true)
{
// Set up the term
$term_tooltip = $this->constructTooltip($term_code);
if ($term_tooltip)
{
$term_tooltip = " class=\"hasTip\" ".$term_tooltip;
}
$html = "
- ".JText::_($term_code).': ';
// Add the definition
if (!is_array($definition_codes))
{
$definition_codes = Array($definition_codes);
}
foreach ($definition_codes as $text_code)
{
$text = $this->replace(JText::_($text_code), $replacements);
$tooltip = $this->constructTooltip($text_code);
$html .= "
$text
\n";
}
if ($terminate)
{
$html .= " \n";
}
echo $html;
}
/**
* Add the ending of a list element (use with unterminated list element)
*
* @return nothing
*/
protected function endListElement()
{
echo "\n";
}
/**
* Add a link as a list element
*
* @param string $url the URL of the link
* @param string $text_code the language token for the text of the link
*
* @return nothing
*/
protected function addListElementLink($url, $text_code)
{
$text = $this->replace(JText::_($text_code), Array('{LINK}' => $url));
$tooltip = $this->constructTooltip($text_code);
echo "- $text
\n";
}
/**
* Add a list elment with raw HTML
*
* @param string $html The HTML to insert into the list element
*
* @return nothing
*/
protected function addListElementHtml($html)
{
echo "- $html
\n";
}
/**
* Add the end of a list
*
* @param string $type The class for the HTML
or element
*
* @return nothing
*/
protected function endList($type = 'ul')
{
echo "\n";
}
/**
* Add a line break
*
* @return nothing
*/
protected function addLineBreak()
{
echo "
\n";
}
/**
* Add a figure: and image with an optional caption
*
* @param string $filename Filename for the image (full path)
* @param string $alt_code Language token for the text to be use for the 'alt' attribute
* @param string $caption_code Language token for the text to use for the caption (OPTIONAL)
* @param string $dclass Class for the figure div
* @param string $img_attribs attributes for the 'img' html tag
*
* @return nothing
*/
protected function addFigure($filename, $alt_code, $caption_code = null, $dclass = 'figure', $img_attribs=array())
{
$html = "\n";
$html .= $this->image($filename, $alt_code, $img_attribs) . "\n";
if ( $caption_code )
{
$html .= "
" . JText::_($caption_code) . "
\n";
}
$html .= '