Graphe d'héritage de JDocumentOpensearch:

Graphe de collaboration de JDocumentOpensearch:

Fonctions membres publiques
	__construct ($options=array())
	render ($cache=false, $params=array())
	setShortName ($name)
	addUrl (JOpenSearchUrl $url)
	addImage (JOpenSearchImage $image)
Fonctions membres publiques inherited from JDocument
	setType ($type)
	getType ()
	getBuffer ()
	setBuffer ($content, $options=array())
	getMetaData ($name, $httpEquiv=false)
	setMetaData ($name, $content, $http_equiv=false)
	addScript ($url, $type="text/javascript", $defer=false, $async=false)
	addScriptVersion ($url, $version=null, $type="text/javascript", $defer=false, $async=false)
	addScriptDeclaration ($content, $type= 'text/javascript')
	addStyleSheet ($url, $type= 'text/css', $media=null, $attribs=array())
	addStyleSheetVersion ($url, $version=null, $type="text/css", $media=null, $attribs=array())
	addStyleDeclaration ($content, $type= 'text/css')
	setCharset ($type= 'utf-8')
	getCharset ()
	setLanguage ($lang="en-gb")
	getLanguage ()
	setDirection ($dir="ltr")
	getDirection ()
	setTitle ($title)
	getTitle ()
	setMediaVersion ($mediaVersion)
	getMediaVersion ()
	setBase ($base)
	getBase ()
	setDescription ($description)
	getDescription ()
	setLink ($url)
	getLink ()
	setGenerator ($generator)
	getGenerator ()
	setModifiedDate ($date)
	getModifiedDate ()
	setMimeEncoding ($type= 'text/html', $sync=true)
	getMimeEncoding ()
	setLineEnd ($style)
	_getLineEnd ()
	setTab ($string)
	_getTab ()
	loadRenderer ($type)
	parse ($params=array())

Attributs privés
	$_shortName = ""
	$_images = array()
	$_urls = array()

Additional Inherited Members
Fonctions membres publiques statiques inherited from JDocument
static	getInstance ($type= 'html', $attributes=array())
Attributs publics inherited from JDocument
	$title = ''
	$description = ''
	$link = ''
	$base = ''
	$language = 'en-gb'
	$direction = 'ltr'
	$_generator = 'Joomla! - Open Source Content Management'
	$_mdate = ''
	$_tab = "\11"
	$_lineEnd = "\12"
	$_charset = 'utf-8'
	$_mime = ''
	$_namespace = ''
	$_profile = ''
	$_scripts = array()
	$_script = array()
	$_styleSheets = array()
	$_style = array()
	$_metaTags = array()
	$_engine = null
	$_type = null
Attributs publics statiques inherited from JDocument
static	$_buffer = null
Attributs protégés inherited from JDocument
	$mediaVersion = null
Attributs protégés statiques inherited from JDocument
static	$instances = array()

Description détaillée

Définition à la ligne 20 du fichier opensearch.php.

Documentation des constructeurs et destructeur

JDocumentOpensearch::__construct ( $options = array() )

Class constructor

Paramètres:

array $options Associative array of options

Depuis:: 11.1

Réimplémentée à partir de JDocument.

Définition à la ligne 57 du fichier opensearch.php.

Références JRoute\_(), JUri\base(), JFactory\getApplication(), et JUri\getInstance().

        {
                parent::__construct($options);
                // Set document type
                $this->_type = 'opensearch';
                // Set mime type
                $this->_mime = 'application/opensearchdescription+xml';
                // Add the URL for self updating
                $update = new JOpenSearchUrl;
                $update->type = 'application/opensearchdescription+xml';
                $update->rel = 'self';
                $update->template = JRoute::_(JUri::getInstance());
                $this->addUrl($update);
                // Add the favicon as the default image
                // Try to find a favicon by checking the template and root folder
                $app = JFactory::getApplication();
                $dirs = array(JPATH_THEMES . '/' . $app->getTemplate(), JPATH_BASE);
                foreach ($dirs as $dir)
                {
                        if (file_exists($dir . '/favicon.ico'))
                        {
                                $path = str_replace(JPATH_BASE . '/', '', $dir);
                                $path = str_replace('\\', '/', $path);
                                $favicon = new JOpenSearchImage;
                                $favicon->data = JUri::base() . $path . '/favicon.ico';
                                $favicon->height = '16';
                                $favicon->width = '16';
                                $favicon->type = 'image/vnd.microsoft.icon';
                                $this->addImage($favicon);
                                break;
                        }
                }
        }

Voici le graphe d'appel pour cette fonction :

Documentation des fonctions membres

JDocumentOpensearch::addImage ( JOpenSearchImage $image )

Adds an image to the OpenSearch description.

Paramètres:

JOpenSearchImage $image The image to add to the description.

Renvoie:: JDocumentOpensearch instance of $this to allow chaining

Depuis:: 11.1

Définition à la ligne 207 du fichier opensearch.php.

        {
                $this->_images[] = $image;
                return $this;
        }

JDocumentOpensearch::addUrl ( JOpenSearchUrl $url )

Adds an URL to the OpenSearch description.

Paramètres:

JOpenSearchUrl $url The url to add to the description.

Renvoie:: JDocumentOpensearch instance of $this to allow chaining

Depuis:: 11.1

Définition à la ligne 191 du fichier opensearch.php.

        {
                $this->_urls[] = $url;
                return $this;
        }

JDocumentOpensearch::render	(	$cache = `false`,
		$params = `array()`
	)

Render the document

Paramètres:

boolean	$cache	If true, cache the output
array	$params	Associative array of attributes

Renvoie:: The rendered data

Depuis:: 11.1

Réimplémentée à partir de JDocument.

Définition à la ligne 110 du fichier opensearch.php.

        {
                $xml = new DOMDocument('1.0', 'utf-8');
                if (defined('JDEBUG') && JDEBUG)
                {
                        $xml->formatOutput = true;
                }
                // The OpenSearch Namespace
                $osns = 'http://a9.com/-/spec/opensearch/1.1/';
                // Create the root element
                $elOs = $xml->createElementNS($osns, 'OpenSearchDescription');
                $elShortName = $xml->createElementNS($osns, 'ShortName');
                $elShortName->appendChild($xml->createTextNode(htmlspecialchars($this->_shortName)));
                $elOs->appendChild($elShortName);
                $elDescription = $xml->createElementNS($osns, 'Description');
                $elDescription->appendChild($xml->createTextNode(htmlspecialchars($this->description)));
                $elOs->appendChild($elDescription);
                // Always set the accepted input encoding to UTF-8
                $elInputEncoding = $xml->createElementNS($osns, 'InputEncoding');
                $elInputEncoding->appendChild($xml->createTextNode('UTF-8'));
                $elOs->appendChild($elInputEncoding);
                foreach ($this->_images as $image)
                {
                        $elImage = $xml->createElementNS($osns, 'Image');
                        $elImage->setAttribute('type', $image->type);
                        $elImage->setAttribute('width', $image->width);
                        $elImage->setAttribute('height', $image->height);
                        $elImage->appendChild($xml->createTextNode(htmlspecialchars($image->data)));
                        $elOs->appendChild($elImage);
                }
                foreach ($this->_urls as $url)
                {
                        $elUrl = $xml->createElementNS($osns, 'Url');
                        $elUrl->setAttribute('type', $url->type);
                        // Results is the default value so we don't need to add it
                        if ($url->rel != 'results')
                        {
                                $elUrl->setAttribute('rel', $url->rel);
                        }
                        $elUrl->setAttribute('template', $url->template);
                        $elOs->appendChild($elUrl);
                }
                $xml->appendChild($elOs);
                parent::render();
                return $xml->saveXML();
        }

JDocumentOpensearch::setShortName ( $name )

Sets the short name

Paramètres:

string $name The name.

Renvoie:: JDocumentOpensearch instance of $this to allow chaining

Depuis:: 11.1

Définition à la ligne 175 du fichier opensearch.php.

        {
                $this->_shortName = $name;
                return $this;
        }

Documentation des données membres

JDocumentOpensearch::$_images = array()

private

Définition à la ligne 40 du fichier opensearch.php.

JDocumentOpensearch::$_shortName = ""

private

Définition à la ligne 30 du fichier opensearch.php.

JDocumentOpensearch::$_urls = array()

private

Définition à la ligne 48 du fichier opensearch.php.

La documentation de cette classe a été générée à partir du fichier suivant :

jplatform-13.1/joomla/document/opensearch/opensearch.php

Fonctions membres publiques

Attributs privés

Additional Inherited Members

Description détaillée

Documentation des constructeurs et destructeur

Documentation des fonctions membres

Documentation des données membres