Référence de la classe xos_opal_Theme

Fonctions membres publiques
	generateCacheId ($cache_id, $extraString='')
	checkCache ()
	render ($canvasTpl=null, $pageTpl=null, $contentTpl=null, $vars=array())
	loadLocalization ($type='main')
	addLanguage ($type='main', $language=null)
	addScript ($src='', $attributes=array(), $content='', $name='')
	addStylesheet ($src='', $attributes=array(), $content='', $name='')
	addLink ($rel, $href='', $attributes=array(), $name='')
	addHttpMeta ($name, $value=null)
	addMeta ($type='meta', $name='', $value='')
	headContent ($params, $content, &$smarty, &$repeat)
	renderMetas ($type=null, $return=false)
	genElementId ($tagName='xos')
	renderAttributes ($coll)
	resourcePath ($path)

Champs de données
	$renderBanner = true
	$folderName = ''
	$path = ''
	$url = ''
	$bufferOutput = true
	$canvasTemplate = 'theme.tpl'
	$themesPath = 'themes'
	$contentTemplate = ''
	$contentCacheLifetime = 0
	$contentCacheId
	$content = ''
	$plugins
	$renderCount = 0
	$template = false
	$metas
	$htmlHeadStrings = array()
	$templateVars = array()
	$use_extra_cache_id = true

Description détaillée

Class xos_opal_Theme

Documentation des fonctions membres

addHttpMeta()

addHttpMeta	(		$name,
			$value = null
	)

Set a meta http-equiv value

Paramètres

	$name
null	$value

Renvoie

string

Voici le graphe d'appel pour cette fonction :

addLanguage()

addLanguage	(		$type = 'main',
			$language = null
	)

Load theme specific language constants

Paramètres

string	$type	language type, like 'main', 'admin'; Needs to be declared in theme xo-info.php
string	$language	specific language

Renvoie

bool|mixed

Voici le graphe des appelants de cette fonction :

addLink()

addLink	(		$rel,
			$href = '',
			$attributes = array(),
			$name = ''
	)

Add a <link> to the header

Paramètres

string	$rel	Relationship from the current doc to the anchored one
string	$href	URI of the anchored document
array	$attributes	Additional attributes to add to the <link> element
string	$name	Element Name in array links are stored in.

Voici le graphe d'appel pour cette fonction :

addMeta()

addMeta	(		$type = 'meta',
			$name = '',
			$value = ''
	)

Change output page meta-information

Paramètres

string	$type
string	$name
string	$value

Renvoie

string

Voici le graphe des appelants de cette fonction :

addScript()

addScript	(		$src = '',
			$attributes = array(),
			$content = '',
			$name = ''
	)

*#+

@tasktype 20 Manipulating page meta-information Adds script code to the document head

This methods allows the insertion of an external script file (if $src is provided), or of a script snippet. The file URI is parsed to take benefit of the theme resource overloading system.

The $attributes parameter allows you to specify the attributes that will be added to the inserted <script> tag. If unspecified, the type attribute value will default to 'text/javascript'.

// Add an external script using a physical path $theme->addScript( 'www/script.js', null, '' ); $theme->addScript( 'modules/newbb/script.js', null, '' ); // Specify attributes for the <script> tag $theme->addScript( 'mod_xoops_SiteManager::common.js', array( 'type' => 'application/x-javascript' ), '', 'mod_xoops_Sitemanager' ); // Insert a code snippet $theme->addScript( null, array( 'type' => 'application/x-javascript' ), 'window.open("Hello world");', 'hello' );

Paramètres

string	$src	path to an external script file
array	$attributes	hash of attributes to add to the <script> tag
string	$content	Code snippet to output within the <script> tag
string	$name	Element Name in array scripts are stored in.

Renvoie

void

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

addStylesheet()

addStylesheet	(		$src = '',
			$attributes = array(),
			$content = '',
			$name = ''
	)

Add StyleSheet or CSS code to the document head

Paramètres

string	$src	path to .css file
array	$attributes	name => value paired array of attributes such as title
string	$content	CSS code to output between the <style> tags (in case $src is empty)
string	$name	Element Name in array stylesheets are stored in.

Renvoie

void

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

checkCache()

checkCache

(

)

xos_opal_Theme::checkCache()

Renvoie

bool

Voici le graphe d'appel pour cette fonction :

genElementId()

genElementId

(

$tagName = 'xos'

)

Generates a unique element ID

Paramètres

string

$tagName

Renvoie

string

generateCacheId()

generateCacheId	(		$cache_id,
			$extraString = ''
	)

Generate cache id based on extra information of language and user groups

User groups other than anonymous should be detected to avoid disclosing group sensitive contents

Paramètres

string	$cache_id	raw cache id
string	$extraString	extra string

Renvoie

string complete cache id

Voici le graphe des appelants de cette fonction :

headContent()

headContent	(		$params,
			$content,
		&	$smarty,
		&	$repeat
	)

xos_opal_Theme::headContent()

Paramètres

mixed	$params
mixed	$content
mixed	$smarty
mixed	$repeat

Renvoie

void

loadLocalization()

loadLocalization

(

$type = 'main'

)

Load localization information

Folder structure for localization:

main.php - language definitions style.css - localization stylesheet script.js - localization script

Paramètres

string

$type

Renvoie

bool

Voici le graphe d'appel pour cette fonction :

render()

render	(		$canvasTpl = null,
			$pageTpl = null,
			$contentTpl = null,
			$vars = array()
	)

Render the page

The theme engine builds pages from 2 templates: canvas and content.

A module can call this method directly and specify what templates the theme engine must use. If render() hasn't been called before, the theme defaults will be used for the canvas and page template (and xoopsOption['template_main'] for the content).

Paramètres

string	$canvasTpl	The canvas template, if different from the theme default
string	$pageTpl	The page template, if different from the theme default (unsupported, 2.3+ only)
string	$contentTpl	The content template
array	$vars	Template variables to send to the template engine

Renvoie

bool

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

renderAttributes()

renderAttributes

(

$coll

)

Transform an attributes collection to an XML string

Paramètres

array

$coll

Renvoie

string

Voici le graphe des appelants de cette fonction :

renderMetas()

renderMetas	(		$type = null,
			$return = false
	)

xos_opal_Theme::renderMetas()

Paramètres

mixed	$type
mixed	$return

Renvoie

bool|string

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

resourcePath()

resourcePath

(

$path

)

Return a themeable file resource path

Paramètres

string

$path

Renvoie

string

Voici le graphe des appelants de cette fonction :

Documentation des champs

$bufferOutput

$bufferOutput = true

$canvasTemplate

$canvasTemplate = 'theme.tpl'

$content

$content = ''

$contentCacheId

$contentCacheId

$contentCacheLifetime

$contentCacheLifetime = 0

$contentTemplate

$contentTemplate = ''

$folderName

$folderName = ''

$htmlHeadStrings

$htmlHeadStrings = array()

$metas

$metas

Valeur initiale :

= array(
        
        
        
        'meta'   => array(),
        'link'   => array(),
        'script' => array())

$path

$path = ''

$plugins

$plugins

Valeur initiale :

= array(
        'xos_logos_PageBuilder')

$renderBanner

$renderBanner = true

$renderCount

$renderCount = 0

$template

$template = false

$templateVars

$templateVars = array()

$themesPath

$themesPath = 'themes'

$url

$url = ''

$use_extra_cache_id

$use_extra_cache_id = true

---

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

• XoopsCore25-2.5.11-Beta1/htdocs/class/theme.php