Phenotype CMS | API Documentation Class PhenotypeStandard | PHP MySQL Smarty Open Source CMS Application Framework

Phenotype API Documentation

Class PhenotypeStandard

Description

Description | Descendents | Vars (details) | Methods (details) Constants (details)

Located in /class/Phenotype.class.php (line 27)

PhenotypeBase
   |
   --PhenotypeStandard

Direct descendents

Description | Descendents | Vars (details) | Methods (details) Constants (details)

Class	Description
Phenotype

Class Constant Summary

Description | Descendants | Constants (details) Vars (details) | | Methods (details)

INCLUDE_CACHE_TIME = 3600

Variable Summary

Description | Descendents | Vars (details) | Methods (details) Constants (details)

unknown_type $phpwarnings

mixed $subversion

mixed $version

mixed $_debughints

Method Summary

Description | Descendents | Constants (details) Vars (details) | Methods (details)

static void cutString ( $s, $pos, [ $maxlen = 0])

static void handleError ( $errno, $errstr, $errfile, $errline)

static void handleException (unknown_type $e)

PhenotypeStandard __construct ()

void __destruct ()

void appendfile ( $file, $buffer)

void buildOptionsByNamedArray ( $options, [ $selectedKey = ""])

void buildOptionsBySQL ( $sql, [ $selectedKey = ""])

void buildPreferencesArray ()

void checkPref ( $token)

void clearCache ()

void clearcache_page (unknown_type $id, [unknown_type $silent = 1])

void clearcache_subpages ( $id, [ $silent = 1])

void colorcodeHTML ( $html)

void colorcodePHP ( $buffer)

void createFolder ( $path)

void customizeToolkit ( $cog_id)

void cutLeft ( $s, $n)

void debugPrint ( $_a)

string description_of_page (integer $pag_id, [integer $lng_id = null], array[mixed] $_params)

void displayCO ( $con_id, $dat_id, $skin, [ $count = 0])

void displayContentXML ( $con_id, [ $mode = ""])

void displayDebugInfo ()

void displayErrorPage ( $headline, $message, [ $file = ""], [ $line = 0], [ $sql = ""], [ $e = false])

void displaySequence ( $pag_id, $ver_id, $dat_id_content, $block_nr, [ $editbuffer = 0], [ $usr_id = 0])

void executeFrontend ()

void executeInclude (integer $inc_id, [boolean $use_include_cache = false], [integer $context = 1], [ $silent = false])

void firstDayinMonth ( $datum, [ $mode = 0])

null gaGetPreferencesArray ([string $sSearchKey = ""])

null gaXMLToArray (string $sXML)

null gBuildPreferencesArray ()

void german2Timestamp ( $date)

void germanDT2Timestamp ( $date)

void getContentClassName ( $con_id)

void getContentClassNameByDatId ( $dat_id)

void getFilenameOutOfPath ( $s)

void getIPref ( $token)

void getPage ([ $id = -1])

void getPref ( $token, [ $default = ""])

string getTemplateFileName (type $type, obj_id $obj_id, tpl_id $tpl_id, [base $basePath = "-"])

void getValidationError ()

void get_co ( $con_id, $dat_id)

void get_image ( $img_id, [ $alt = null], [ $style = ""], [ $class = ""])

void isValidEmail ( $email)

void isValidInteger ( $value, [ $min = null], [ $max = null])

void isValidSelection ( $value, $_options)

void isValidString ( $value, [ $allowedchars = PT_ALPHA])

void lastDayinMonth ( $datum, [ $mode = 0])

void loadTMX ( $section, [ $locale = PT_LOCALE])

void locale ( $token, [ $_params = array()])

void localeDate ( $timestamp)

void localeFulltime ( $timestamp)

void localeH ( $token, [ $_params = array()])

void localeHBR ( $token, [ $_params = array()])

void localeShortDate ( $timestamp)

void nextFriday ( $datum, [ $mode = 0])

void nextMonday ( $datum, [ $mode = 0])

void nextMonth ( $datum, [ $mode = 0])

void nextWeekDay ( $datum, [ $mode = 0])

void printH ( $text)

void printHTML ( $text)

string registerController (unknown_type $smartURL, unknown_type $inc_id, [unknown_type $_params = array()], [unknown_type $symbol = ""])

void registerSmartURL (unknown_type $smartURL, unknown_type $pag_id, [unknown_type $_params = array()], [unknown_type $symbol = ""])

void registerSymbol (unknown_type $symbol, unknown_type $smartURL, [unknown_type $_params = array()])

void renderCO ( $con_id, $dat_id, $skin, [ $count = 0])

void respectPHPWarnings ()

void setNoValidationError ()

void setValidationError ( $number, $string)

void startBuffer ()

void stopBuffer ()

void strip_tags ( $s)

void suppressPHPWarnings ()

string title_of_page (integer $pag_id, [integer $lng_id = null], array[mixed] $_params)

void uid ()

void url_for_co ( $myCO, $action, [ $lng_id = null], [ $_params = null], [ $smartUID = ""], [ $fullUrl = false])

void url_for_content ( $dat_id, $action, [ $lng_id = null], [ $_params = null], [ $smartUID = ""], [ $fullUrl = false])

string url_for_page (integer $pag_id, [array[mixed] $_params = null], [integer $lng_id = null], [string $smartUID = ""], [boolean $fullUrl = false])

void writefile ( $file, $buffer)

Variables

Description | Descendents | Vars (details) Constants (details) | Methods (details)

unknown_type $phpwarnings = true (line 42)

indicates if PHP warnings are to be caught

(only relevant if PT_DEBUG ==1)

access: public

mixed $subversion = "r376" (line 30)

access: public

mixed $version = "2.9" (line 29)

access: public

mixed $_debughints = array() (line 44)

access: public

Inherited Variables

Inherited from PhenotypeBase

PhenotypeBase::$charset
PhenotypeBase::$_props

Methods

Description | Descendents | Vars (details) Constants (details) Methods (details)

static cutString (line 440)

static void cutString ( $s, $pos, [ $maxlen = 0])

$s
$pos
$maxlen

static handleError (line 992)

Enter description here...

access: public

static void handleError ( $errno, $errstr, $errfile, $errline)

$errno
$errstr
$errfile
$errline

static handleException (line 1056)

Enter description here...

access: public

static void handleException (unknown_type $e)

unknown_type $e

Constructor __construct (line 88)

PhenotypeStandard __construct ()

Redefinition of:

PhenotypeBase::__construct()

Redefined in descendants as:

PhenotypeActionStandard::__construct()

Destructor __destruct (line 101)

access: public

void __destruct ()

appendfile (line 725)

void appendfile ( $file, $buffer)

$file
$buffer

buildOptionsByNamedArray (line 594)

void buildOptionsByNamedArray ( $options, [ $selectedKey = ""])

$options
$selectedKey

buildOptionsBySQL (line 576)

void buildOptionsBySQL ( $sql, [ $selectedKey = ""])

$sql
$selectedKey

buildPreferencesArray (line 746)

void buildPreferencesArray ()

checkPref (line 806)

void checkPref ( $token)

$token

clearCache (line 490)

clear every object / page which might be in any cache (pagecache, contentcache, includecache)

void clearCache ()

clearcache_page (line 514)

deprecated:

void clearcache_page (unknown_type $id, [unknown_type $silent = 1])

unknown_type $id
unknown_type $silent

clearcache_subpages (line 533)

void clearcache_subpages ( $id, [ $silent = 1])

$id
$silent

colorcodeHTML (line 960)

access: public

void colorcodeHTML ( $html)

$html

colorcodePHP (line 978)

access: public

void colorcodePHP ( $buffer)

$buffer

createFolder (line 733)

void createFolder ( $path)

$path

customizeToolkit (line 199)

void customizeToolkit ( $cog_id)

$cog_id

cutLeft (line 314)

void cutLeft ( $s, $n)

debugPrint (line 632)

void debugPrint ( $_a)

description_of_page (line 2023)

retrieve (language dependent) page description of a page page description ("page_bez" in DB page)

This function uses a system dao cache to reduce database load. This cache is cleared upon backend edit.

This function is also used from the helper functions for page title retrieval. It it a vital function for url management, if you create/build urls you should always use this function in any (inherited) way.

added 2008/05/19 by Dominique Bös

access: public

string description_of_page (integer $pag_id, [integer $lng_id = null], array[mixed] $_params)

integer $pag_id
array[mixed] $_params
integer $lng_id

displayCO (line 610)

void displayCO ( $con_id, $dat_id, $skin, [ $count = 0])

$con_id
$dat_id
$skin
$count

displayContentXML (line 848)

void displayContentXML ( $con_id, [ $mode = ""])

$con_id
$mode

displayDebugInfo (line 1416)

access: public

void displayDebugInfo ()

displayErrorPage (line 1073)

access: public

void displayErrorPage ( $headline, $message, [ $file = ""], [ $line = 0], [ $sql = ""], [ $e = false])

$headline
$message
$file
$line
$sql
$e

displaySequence (line 218)

void displaySequence ( $pag_id, $ver_id, $dat_id_content, $block_nr, [ $editbuffer = 0], [ $usr_id = 0])

$pag_id
$ver_id
$dat_id_content
$block_nr
$editbuffer
$usr_id

executeFrontend (line 129)

access: public

void executeFrontend ()

executeInclude (line 265)

Enter description here...

void executeInclude (integer $inc_id, [boolean $use_include_cache = false], [integer $context = 1], [ $silent = false])

integer $inc_id: ID of the include to be executed
boolean $use_include_cache: should the include cache be used (which means paying attention to the request parameters)
integer $context: can be used to forward the rendering context (1-9) of a component block from the layout
$silent

firstDayinMonth (line 392)

void firstDayinMonth ( $datum, [ $mode = 0])

$datum
$mode

gaGetPreferencesArray (line 891)

Get Preferences Array added 07/08/23 by Dominique Bös

access: public

null gaGetPreferencesArray ([string $sSearchKey = ""])

string $sSearchKey: String width array keys, separator is "." Example: "preferences.section_cache"

gaXMLToArray (line 927)

Write XML childs into an array added 07/08/23 by Dominique Bös

access: public

null gaXMLToArray (string $sXML)

string $sXML: XML-file

gBuildPreferencesArray (line 877)

Build Preferences Array added 07/08/23 by Dominique Bös

access: public

null gBuildPreferencesArray ()

german2Timestamp (line 401)

void german2Timestamp ( $date)

$date

germanDT2Timestamp (line 420)

void germanDT2Timestamp ( $date)

$date

getContentClassName (line 640)

void getContentClassName ( $con_id)

$con_id

getContentClassNameByDatId (line 646)

void getContentClassNameByDatId ( $dat_id)

$dat_id

getFilenameOutOfPath (line 480)

access: public

void getFilenameOutOfPath ( $s)

getIPref (line 801)

void getIPref ( $token)

$token

getPage (line 174)

void getPage ([ $id = -1])

getPref (line 783)

void getPref ( $token, [ $default = ""])

$token
$default

getTemplateFileName (line 668)

calcs the filename of a template

return: the absolute filename of the template file

string getTemplateFileName (type $type, obj_id $obj_id, tpl_id $tpl_id, [base $basePath = "-"])

type $type: use constants for type (see switch statement below)
obj_id $obj_id: the id of the include, contentobject, component
tpl_id $tpl_id: the template id, or in case of page templates "normal" or "print"
base $basePath: the base path. if empty, absolute path is used

getValidationError (line 2261)

access: public

void getValidationError ()

Redefinition of:

PhenotypeBase::getValidationError()

get_co (line 2089)

access: public

void get_co ( $con_id, $dat_id)

$con_id
$dat_id

get_image (line 2056)

access: public

void get_image ( $img_id, [ $alt = null], [ $style = ""], [ $class = ""])

$img_id
$alt
$style
$class

isValidEmail (line 2326)

access: public

void isValidEmail ( $email)

$email

Redefinition of:

PhenotypeBase::isValidEmail()

isValidInteger (line 2271)

access: public

void isValidInteger ( $value, [ $min = null], [ $max = null])

$value
$min
$max

Redefinition of:

PhenotypeBase::isValidInteger()

isValidSelection (line 2302)

access: public

void isValidSelection ( $value, $_options)

$value
$_options

Redefinition of:

PhenotypeBase::isValidSelection()

isValidString (line 2313)

access: public

void isValidString ( $value, [ $allowedchars = PT_ALPHA])

$value
$allowedchars

Redefinition of:

PhenotypeBase::isValidString()

lastDayinMonth (line 382)

void lastDayinMonth ( $datum, [ $mode = 0])

$datum
$mode

loadTMX (line 2157)

access: public

void loadTMX ( $section, [ $locale = PT_LOCALE])

$section
$locale

locale (line 2165)

access: public

void locale ( $token, [ $_params = array()])

$token
$_params

localeDate (line 2216)

access: public

void localeDate ( $timestamp)

$timestamp

localeFulltime (line 2242)

access: public

void localeFulltime ( $timestamp)

$timestamp

localeH (line 2202)

access: public

void localeH ( $token, [ $_params = array()])

$token
$_params

localeHBR (line 2209)

access: public

void localeHBR ( $token, [ $_params = array()])

$token
$_params

localeShortDate (line 2229)

access: public

void localeShortDate ( $timestamp)

$timestamp

nextFriday (line 356)

void nextFriday ( $datum, [ $mode = 0])

$datum
$mode

nextMonday (line 343)

void nextMonday ( $datum, [ $mode = 0])

$datum
$mode

nextMonth (line 369)

void nextMonth ( $datum, [ $mode = 0])

$datum
$mode

nextWeekDay (line 330)

void nextWeekDay ( $datum, [ $mode = 0])

$datum
$mode

printH (line 570)

void printH ( $text)

$text

printHTML (line 566)

void printHTML ( $text)

$text

registerController (line 2126)

reserved

access: public

string registerController (unknown_type $smartURL, unknown_type $inc_id, [unknown_type $_params = array()], [unknown_type $symbol = ""])

unknown_type $smartURL
unknown_type $inc_id
unknown_type $_params
unknown_type $symbol

registerSmartURL (line 2139)

reserved

access: public

void registerSmartURL (unknown_type $smartURL, unknown_type $pag_id, [unknown_type $_params = array()], [unknown_type $symbol = ""])

unknown_type $smartURL
unknown_type $pag_id
unknown_type $_params
unknown_type $symbol

registerSymbol (line 2151)

reserved

access: public

void registerSymbol (unknown_type $symbol, unknown_type $smartURL, [unknown_type $_params = array()])

unknown_type $symbol
unknown_type $smartURL
unknown_type $_params

renderCO (line 619)

void renderCO ( $con_id, $dat_id, $skin, [ $count = 0])

$con_id
$dat_id
$skin
$count

respectPHPWarnings (line 1045)

access: public

void respectPHPWarnings ()

setNoValidationError (line 2265)

access: public

void setNoValidationError ()

Redefinition of:

PhenotypeBase::setNoValidationError()

setValidationError (line 2256)

access: public

void setValidationError ( $number, $string)

$number
$string

Redefinition of:

PhenotypeBase::setValidationError()

startBuffer (line 182)

void startBuffer ()

stopBuffer (line 187)

void stopBuffer ()

strip_tags (line 559)

void strip_tags ( $s)

suppressPHPWarnings (line 1040)

access: public

void suppressPHPWarnings ()

title_of_page (line 1974)

retrieve (language dependent) title of a page

This function uses a system dao cache to reduce database load. This cache is cleared upon backend edit.

access: public

string title_of_page (integer $pag_id, [integer $lng_id = null], array[mixed] $_params)

integer $pag_id
array[mixed] $_params
integer $lng_id

uid (line 626)

void uid ()

url_for_co (line 1810)

access: public

void url_for_co ( $myCO, $action, [ $lng_id = null], [ $_params = null], [ $smartUID = ""], [ $fullUrl = false])

$myCO
$action
$lng_id
$_params
$smartUID
$fullUrl

url_for_content (line 1878)

access: public

void url_for_content ( $dat_id, $action, [ $lng_id = null], [ $_params = null], [ $smartUID = ""], [ $fullUrl = false])

$dat_id
$action
$lng_id
$_params
$smartUID
$fullUrl

url_for_page (line 1733)

retrieve (language dependent) url of a page

This function uses a system dao cache to reduce database load. This cache is cleared upon backend edit.

This function is also used from the helper functions for url generation. It it a vital function for url management, if you create/build urls you should always use this function in any (inherited) way.

access: public

string url_for_page (integer $pag_id, [array[mixed] $_params = null], [integer $lng_id = null], [string $smartUID = ""], [boolean $fullUrl = false])

integer $pag_id
array[mixed] $_params: optional, defaults to null
integer $lng_id
string $smartUID: smartUID
boolean $fullUrl: fullUrl should the function return a fully qualified url including hostname? optional, defaults to false

writefile (line 717)

void writefile ( $file, $buffer)

$file
$buffer

Inherited Methods

Inherited From PhenotypeBase

PhenotypeBase::__construct()
PhenotypeBase::check()
PhenotypeBase::clear()
PhenotypeBase::codeA()
PhenotypeBase::codeAH()
PhenotypeBase::codeH()
PhenotypeBase::codeHBR()
PhenotypeBase::codeHKT()
PhenotypeBase::codeI()
PhenotypeBase::codeSQL()
PhenotypeBase::codeX()
PhenotypeBase::get()
PhenotypeBase::getA()
PhenotypeBase::getAH()
PhenotypeBase::getD()
PhenotypeBase::getH()
PhenotypeBase::getHBR()
PhenotypeBase::getHTML()
PhenotypeBase::getI()
PhenotypeBase::getQ()
PhenotypeBase::getS()
PhenotypeBase::getSQL()
PhenotypeBase::getU()
PhenotypeBase::getURL()
PhenotypeBase::getValidationError()
PhenotypeBase::getX()
PhenotypeBase::isValidEmail()
PhenotypeBase::isValidInteger()
PhenotypeBase::isValidProperty()
PhenotypeBase::isValidSelection()
PhenotypeBase::isValidString()
PhenotypeBase::printProperties()
PhenotypeBase::set()
PhenotypeBase::setNoValidationError()
PhenotypeBase::setValidationError()
PhenotypeBase::urlencode()

Class Constants

Description | Descendants | Constants (details) Vars (details) | Methods (details)

INCLUDE_CACHE_TIME = 3600 (line 32)

Documentation generated on Fri, 17 Jul 2009 16:41:59 +0200 by phpDocumentor 1.4.2

Phenotype

Class PhenotypeStandard

Inherited Variables

Inherited Methods

Recent Blog Posts