JHelp/createSiteList

The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

The "API16" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.

Description[edit]

Builds a list of the help sites which can be used in a select option

<! removed transcluded page call, red link never existed >

Syntax[edit]

static createSiteList($pathToXml, $selected=null)

Parameter Name	Default Value	Description
$pathToXml		Path to an xml file
$selected	null	Language tag to select (if exists)

Defined in[edit]

libraries/joomla/language/help.php

Importing[edit]

jimport( 'joomla.language.help' );

Source Body[edit]

static function createSiteList($pathToXml, $selected = null)
{
        $list   = array ();
        $data   = null;
        $xml = false;

        if (!empty($pathToXml)) {
                $xml = JFactory::getXML($pathToXml);
        }

        if( ! $xml)
        {
                $option['text'] = 'English (GB) help.joomla.org';
                $option['value'] = 'http://help.joomla.org';
                $list[] = $option;
        }
        else
        {
                $option = array ();

                foreach ($xml->sites->site as $site)
                {
                        $option['text'] = (string)$site;
                        $option['value'] = (string)$site->attributes()->url;

                        $list[] = $option;
                }
        }

        return $list;
}

<! removed transcluded page call, red link never existed >

Examples[edit]

Code Examples[edit]

API16