b2evolution

Multilingual multiuser multiblog engine

b2evolution Technical Documentation (CVS HEAD) [ class tree: evocore ] [ index: evocore ] [ all elements ]

Procedural File: _skin.funcs.php

Source Location: /blogs/inc/skins/_skin.funcs.php

Page Details

This file implements Template tags for use withing skins.

This file is part of the b2evolution/evocms project - http://b2evolution.net/. See also http://sourceforge.net/projects/evocms/.

Author:  blueyed: Daniel HAHLER.
Author:  fplanque: Francois PLANQUE.
Version:  $Id: _skin.funcs.php,v 1.83 2010/02/08 17:53:55 efy-yury Exp $
Copyright:  (c)2003-2010 by Francois PLANQUE - http://fplanque.net/. Parts of this file are copyright (c)2004-2005 by Daniel HAHLER - http://thequod.de/contact.
Filesource:  Source Code for this file
License:  GNU General Public License (GPL)
Functions
is_default_page  [line 402]

boolean is_default_page( )

Tells if we are on the default blog page



[ Top ]
skin_404_header  [line 661]

void skin_404_header( )

Sends the desired HTTP response header in case of a "404".



[ Top ]
skin_base_tag  [line 535]

void skin_base_tag( )

Template tag. Output HTML base tag to current skin.

This is needed for relative css and img includes.



[ Top ]
skin_container  [line 764]

void skin_container( string $sco_name, [array $params = array()]  )

Display a container

Parameters:
string   $sco_name: 
array   $params: 


[ Top ]
skin_content_header  [line 699]

void skin_content_header( [string $type = 'text/html']  )

Template tag. Output content-type header For backward compatibility

Parameters:
string   $type:  content-type; override for RSS feeds

API Tags:
See:  skin_content_meta()


[ Top ]
skin_content_meta  [line 712]

void skin_content_meta( [string $type = 'text/html']  )

Template tag. Output content-type http_equiv meta tag

Parameters:
string   $type:  content-type; override for RSS feeds

API Tags:
See:  skin_content_header()


[ Top ]
skin_description_tag  [line 571]

void skin_description_tag( )

Template tag

Note for future mods: we do NOT want to repeat identical content on multiple pages.



[ Top ]
skin_exists  [line 830]

boolean skin_exists( skin $name, [ $filename = 'index.main.php']  )

Checks if a skin exists. This can either be a regular skin directory or can be in the list Plugin::GetProvidedSkins().

Used by front-end.

Parameters:
skin   $name:  name (directory name)
   $filename: 

API Tags:
Return:  true is exists, false if not


[ Top ]
skin_file_exists  [line 856]

boolean skin_file_exists( skin $name, [file $filename = 'index.main.php']  )

Checks if a specific file exists for a skin.

Parameters:
skin   $name:  name (directory name)
file   $filename:  name

API Tags:
Return:  true is exists, false if not


[ Top ]
skin_include  [line 413]

void skin_include( $template_name, [ $params = array()]  )

Template tag. Include a sub-template at the current position

Parameters:
   $template_name: 
   $params: 


[ Top ]
skin_init  [line 42]

void skin_init( string $disp  )

Template tag. Initializes internal states for the most common skin displays.

For more specific skins, this function should not be called and equivalent code should be customized within the skin.

Parameters:
string   $disp:  What are we going to display. Most of the time the global $disp should be passed.


[ Top ]
skin_install  [line 780]

Skin &skin_install( string $skin_folder  )

Install a skin

Parameters:
string   $skin_folder:  Skin folder

Information Tags:
Todo:  do not install if skin doesn't exist. Important for upgrade. Need to NOT fail if ZERO skins installed though :/

[ Top ]
skin_installed  [line 877]

boolean skin_installed( Skin $name  )

Check if a skin is installed.

This can either be a regular skin or a skin provided by a plugin.

Parameters:
Skin   $name:  name (directory name)

API Tags:
Return:  True if the skin is installed, false otherwise.


[ Top ]
skin_keywords_tag  [line 620]

void skin_keywords_tag( )

Template tag

Note for future mods: we do NOT want to repeat identical content on multiple pages.



[ Top ]
skin_provided_by_plugin  [line 799]

false|integer skin_provided_by_plugin( $name  )

Checks if a skin is provided by a plugin.

Used by front-end.

Parameters:
   $name: 

API Tags:
Return:  False in case no plugin provides the skin or ID of the first plugin that provides it.
Uses:  Plugin::GetProvidedSkins()


[ Top ]
skin_widget  [line 727]

void skin_widget( array $params  )

Template tag. Display a Widget.

This load the widget class, instantiates it, and displays it.

Parameters:
array   $params: 


[ Top ]


Documentation generated on Sat, 06 Mar 2010 04:23:26 +0100 by phpDocumentor 1.4.2. This site is hosted and maintained by Daniel HAHLER (Contact).