phpDocumentor skin
[ class tree: skin ] [ index: skin ] [ all elements ]

Class: skin

Source Location: /lib/skin.inc.php

Class skin

Class Overview

Located in /lib/skin.inc.php [line 11]

ipbwi
   |
   --skin
Author(s):
  • Matthias Reuter ($LastChangedBy: matthias $)
Information Tags:
Version:  $LastChangedDate: 2008-10-31 23:53:28 +0000 (Fr, 31 Okt 2008) $
Copyright:  2007-2008 IPBWI development team
Link:  http://ipbwi.com/examples/skin.php
Since:  2.0
License:  GNU General Public License

Methods

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From ipbwi

ipbwi::$DB
ipbwi::$ips

Inherited From ipbwi

ipbwi::addSystemMessage()
adds a system message
ipbwi::date()
Returns textual/timestamp offsetted date by board and by member offset and DST setting.
ipbwi::getBoardVar()
gets the requested board-var
ipbwi::getLibLang()
gets the language-var from actual requested native language-bit
ipbwi::info()
informations about the current IPBWI and PHP installation
ipbwi::makeSafe()
filtering html-strings, e.g. for db-queries
ipbwi::printSystemMessages()
prints system messages
ipbwi::properXHTML()
filtering HTML strings
ipbwi::setLang()
Set's current SDK language
ipbwi::updateSession()
Update Member Session Informations

Inherited From ipbwi

ipbwi::DEV_TEAM
ipbwi::PROJECT_LEADER
ipbwi::TITLE
ipbwi::VERSION
ipbwi::WEBSITE

[ Top ]
Method Summary
string   css()   Pulls and displays CSS from forums depending on user's skin.
array   getList()   Grabs the IDs of all the avaliable skins.
int   id()   Returns the Skin ID of the skin used by a member.
array   info()   Gets information on a skin.
bool   set()   Changes the current user's skin.

[ Top ]
Methods
css  [line 91]

  string css( [bool $return = false], [bool $addTag = true]  )

Pulls and displays CSS from forums depending on user's skin.

Parameters:
bool   $return:  Whether to return CSS instead of sending it to the browser. Default: false
bool   $addTag:  Whether to wrap the CSS with the html style-tag. Default: true

API Tags:
Return:  The Style sheet if $return was set, else true
Access:  public

Information Tags:
Author:  Scyth <scyth@wewub.com>
Author:  Matthias Reuter
Author:  Pita <peter@randomnity.com>
Since:  2.0
Sample:  
  1.  $ipbwi->skin->css();
  2.  $ipbwi->skin->css(true,false);

[ Top ]
getList  [line 136]

  array getList( )

Grabs the IDs of all the avaliable skins.


API Tags:
Return:  Skin IDs
Access:  public

Information Tags:
Author:  Cow <khlo@global-centre.com>
Author:  Matthias Reuter
Author:  Pita <peter@randomnity.com>
Since:  2.0
Sample:  
  1.  $ipbwi->skin->getList();

[ Top ]
id  [line 36]

  int id( [int $memberID = false]  )

Returns the Skin ID of the skin used by a member.

Parameters:
int   $memberID:  Member ID. If Member ID is ommitted, the current User will be used.

API Tags:
Return:  Skin ID or false on failure
Access:  public

Information Tags:
Author:  Cow <khlo@global-centre.com>
Author:  Matthias Reuter
Author:  Pita <peter@randomnity.com>
Since:  2.0
Sample:  
  1.  $ipbwi->skin->id($memberID);

[ Top ]
info  [line 63]

  array info( int $skinID  )

Gets information on a skin.

Parameters:
int   $skinID:  ID of the Skin

API Tags:
Return:  Information on Skin or false on failure
Access:  public

Information Tags:
Author:  Cow <khlo@global-centre.com>
Author:  Pita <peter@randomnity.com>
Author:  Matthias Reuter
Author:  Ripper
Since:  2.0
Sample:  
  1.  $ipbwi->skin->info($skinID);

Redefinition of:
ipbwi::info()
informations about the current IPBWI and PHP installation

[ Top ]
set  [line 159]

  bool set( int $skinID, [int $memberID = false]  )

Changes the current user's skin.

Parameters:
int   $skinID:  Skin ID
int   $memberID:  Member ID. If Member ID is ommitted, the current User will be used.

API Tags:
Return:  true on success, otherwise false
Access:  public

Information Tags:
Author:  Cow <khlo@global-centre.com>
Author:  Matthias Reuter
Author:  Pita <peter@randomnity.com>
Since:  2.0
Sample:  
  1.  $ipbwi->skin->set();

[ Top ]

Documentation generated on Mon, 02 Mar 2009 23:51:11 +0100 by phpDocumentor 1.4.0