Class: base_object

Quellcode Position: Program_Root/sys_base_object.php

Class base_object

Class Overview

Implementation super class

Provides basic functionality for all other classes

Implementiert in Program_Root/sys_base_object.php [Zeile 48]

Author(s):

Thomas Weinert <weinert@papaya-cms.com>

Information Tags:

Properties

$msgs

Methods

[ Seitenanfang ]

Direct Derivates

Abgeleitete Class	Description
base_db	Object class for database access
base_msgdialog	Delegation-class for Message-Boxen
base_authnavigation	Navigation object with dependencies to user object
db_simple	DB - abstraction layer
rewrite_session	Automatic url-decoding for seassion processing
base_dialog	Delegation-class for dialogs
base_formdesigner_xml	formular designer
base_btnbuilder	Button bar delegation-class
base_dynamic_form	Dynamic formular contains of XML-data
base_plugin	Basic objekt for all plugin object
dbcon_base	DB-abstraction layer - connection objekt
dbresult_base	DB-abstraction layer - result objekt
papaya_rpc	Control particular activities (example: for flash)
base_errors	Error Object, here you can output all errors on demand

[ Seitenanfang ]

Properties Summary

base_errors

$msgs

Error message

[ Seitenanfang ]

Method Summary

void	addmsg()	Adds a message in the message object.
mixed	&createPluginObject()	Create plugin object
void	debug()	Show the debug of the variable &$var
string	encodeQueryString()	Encode query string
string	escapeForFilename()	Escape chars in a string to use it in a filename
string	getAbsoluteURL()	Return absolute URL
string	getBaseLink()	Get base link
string	getBasePath()	get base path to current script
string	getLink()	Get link
void	getSessionValue()
string	getWebLink()	Get web link
mixed	getWebMediaLink()	Get web media link
boolean	includePluginFile()	Include plugin file
void	initializeParams()	Parameter initialisation
void	initializeSessionParam()	Initialisation of session-parameter
void	logMsg()	Log events
array	parseRequestURI()	Parse request URI to filter data out of it
void	setSessionValue()
void	stripslashes()
string	_gt()	Phrasetranslator - Fetch translation for all phrase
string	_gtf()	Phrasetranslator - Fetch translation of one phrase and insert variable
string	_gtfile()	Phrases - Locate files

[ Seitenanfang ]

Properties

base_errors $msgs = null [Zeile 53]

Error message

Neu definiert in folgenden Ableitungen:

base_db::$msgs : Message for user
base_log::$msgs
base_viewlist::$msgs
base_surferlinks::$msgs
base_auth::$msgs
base_boxes::$msgs
base_boxeslinks::$msgs
base_plugin::$msgs : Referenz on message-objekt

[ Seitenanfang ]

Methods

addmsg [Zeile 147]

void addmsg(
integer
$level, string
$text, [mixed
$log = false], [mixed
$type = PAPAYA_LOGTYPE_SYSTEM] 
)

Adds a message in the message object.

All messages will be displayed in programm run

Parameters:

integer	$level:	message priority
string	$text:	message

[ Seitenanfang ]

createPluginObject [Zeile 542]

mixed &createPluginObject(
string
$filename, mixed
$classname, string
$guid, mixed
&$parent, [mixed
$data = NULL], string
$class 
)

Create plugin object

Parameters:

string	$filename:	plugin filename
string	$class:	plugin classname
string	$guid:	Unique Identifier of the object class

API Tags:

Return:	object or null
Access:	public

[ Seitenanfang ]

debug [Zeile 584]

void debug(
mixed
&$var 
)

Show the debug of the variable &$var

Parameters:

mixed

$var:

auszugebende Variable

[ Seitenanfang ]

encodeQueryString [Zeile 367]

string encodeQueryString(
mixed
$params, [string
$paramname = NULL], [integer
$maxdepth = 5], array
&$params 
)

Encode query string

Parameters:

array	&$params:	array of params
string	$paramname:	optional param name
integer	$maxdepth:	optional default 5

API Tags:

Access:

public

[ Seitenanfang ]

escapeForFilename [Zeile 430]

string escapeForFilename(
string
$str, [string
$default = 'index'] 
)

Escape chars in a string to use it in a filename

Parameters:

string	$str:
string	$default:	returned if str is empty

API Tags:

Access:

public

[ Seitenanfang ]

getAbsoluteURL [Zeile 482]

string getAbsoluteURL(
string
$url, [string
$text = ''], [boolean
$sid = true] 
)

Return absolute URL

Parameters:

string	$url:
string	$text:	optional, default value ''
boolean	$sid:	optional, default value true

API Tags:

Return:	URL
Access:	public

[ Seitenanfang ]

getBaseLink [Zeile 232]

string getBaseLink(
[integer
$page_id = 0] 
)

Get base link

Parameters:

integer

$page_id:

API Tags:

Return:

$baselink URL

[ Seitenanfang ]

getBasePath [Zeile 259]

string getBasePath(
[boolean
$with_document_root = false] 
)

get base path to current script

Parameters:

boolean

$with_document_root:

optional, default value false

API Tags:

Access:

public

[ Seitenanfang ]

getLink [Zeile 520]

string getLink(
string
$filename, integer
$page_id, [mixed
$params = NULL], [mixed
$paramname = NULL] 
)

Get link

Parameters:

string	$filename:
integer	$page_id:
mixed	$params:	optional, default value NULL
mixed	$paramname:	optional, default value NULL

API Tags:

Access:

public

[ Seitenanfang ]

getSessionValue [Zeile 55]

void getSessionValue(
mixed
$name 
)

[ Seitenanfang ]

getWebLink [Zeile 321]

string getWebLink(
[mixed
$pid = NULL], [string
$mode = 'page'], [mixed
$params = NULL], [mixed
$paramname = NULL], [mixed
$text = ''], boolean
$sid 
)

Get web link

Parameters:

mixed	$pid:	optional, default value NULL
string	$mode:	optional, default value 'page'
mixed	$params:	optional, default value NULL
mixed	$paramname:	optional, default value NULL
boolean	$sid:	optional, default value TRUE

API Tags:

Return:	Weblink
Access:	public

[ Seitenanfang ]

getWebMediaLink [Zeile 458]

mixed getWebMediaLink(
mixed
$mid, [string
$mode = 'media'], [mixed
$text = ''] 
)

Get web media link

Parameters:

mixed	$mid:
string	$mode:	optional, default value 'media'

API Tags:

Access:

public

[ Seitenanfang ]

includePluginFile [Zeile 566]

boolean includePluginFile(
string
$filename, string
$classname 
)

Include plugin file

Parameters:

string	$filename:
string	$classname:

API Tags:

Access:

public

[ Seitenanfang ]

initializeParams [Zeile 168]

void initializeParams(
[mixed
$sessionparamname = NULL] 
)

Parameter initialisation

All global parameters for the object will be read out of the global namespace and put in $this->params. The current will script filename is stored in the $this->baselink. If here is a parameter $sessionparamname or a property $this->sessionparamname, the value will be registered in the session object.

Parameters:

mixed

$sessionparamname:

optional, default value NULL

API Tags:

Access:

public

[ Seitenanfang ]

initializeSessionParam [Zeile 208]

void initializeSessionParam(
string
$name, [array
$resetparams = NULL] 
)

Initialisation of session-parameter

If the parameter this->params[name] is set all variables within $resetparams get reset. Otherwise if $this->sessionparams[$name] is set the parameter will replace this->params[$name]. If there is no parameter set with name $name, this->params set to NULL

Parameters:

string	$name:	name of the parameter
array	$resetparams:	array parameter

Neu definiert in folgenden Ableitungen:

base_messages::initializeSessionParam() : Initialize session parameters

[ Seitenanfang ]

logMsg [Zeile 130]

void logMsg(
integer
$level, integer
$type, string
$short, [string
$long = ''] 
)

Log events

Parameters:

integer	$level:	message priority
integer	$type:	message typ (Gruppe)
string	$short:	message short (für Liste)
string	$long:	message detailed

Neu definiert in folgenden Ableitungen:

base_log::logMsg()

[ Seitenanfang ]

parseRequestURI [Zeile 278]

array parseRequestURI(
)

Parse request URI to filter data out of it

[ Seitenanfang ]

setSessionValue [Zeile 62]

void setSessionValue(
mixed
$name, mixed
$value 
)

[ Seitenanfang ]

stripslashes [Zeile 184]

void stripslashes(
mixed
$var 
)

[ Seitenanfang ]

_gt [Zeile 75]

string _gt(
string
$phrase, [mixed
$module = NULL] 
)

Phrasetranslator - Fetch translation for all phrase

Parameters:

string	$phrase:	Phrase
mixed	$module:	Modul

Neu definiert in folgenden Ableitungen:

base_plugin::_gt() : Phrase translator - fetch translation

[ Seitenanfang ]

_gtf [Zeile 90]

string _gtf(
string
$phrase, array
$vals, [mixed
$module = NULL] 
)

Phrasetranslator - Fetch translation of one phrase and insert variable

Parameters:

string	$phrase:	Phrase
array	$vals:	Parameter
mixed	$module:	Modul

[ Seitenanfang ]

_gtfile [Zeile 103]

string _gtfile(
string
$filename 
)

Phrases - Locate files

Parameters:

string

$filename:

filename

API Tags:

Return:

file content

[ Seitenanfang ]