Class: base_plugin

Quellcode Position: Program_Root/base_plugin.php

Class base_plugin

Class Overview
Class Overview | Ableitungen | Inherited Properties And Methods | Properties Summary | Property Details | Method Summary | Method Details

Basic objekt for all plugin object

Content modules and action buttons must inherit this class

Implementiert in Program_Root/base_plugin.php [Zeile 31] 

base_object
   |
   --base_plugin
Author(s): Information Tags:

Properties

Methods
[ Seitenanfang ]
Direct Derivates
Class Overview | Derivates | Inherited Properties And Methods | Properties Summary | Property Details | Method Summary | Method Details
Abgeleitete Class Description
base_crontime Basic object of all time calculation modules
base_module Basic objekt for all module objects
base_eventbox Basic object for all event box objects (Calendar)
base_cronjob Basic object für alle cronjobs
base_actionbox Base class of action box objects
base_content Basic class for page modules

[ Seitenanfang ]
Inherited Properties And Methods
Class Overview | Ableitungen | | Inherited Properties And Methods | Propertys Summary | Property Details | Method Summary | Method Details
Inherited Properties Inherited Methods

Abgeleitet von base_object

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

[ Seitenanfang ]
Properties Summary
Class Overview | Ableitungen | Inherited Properties And Methods | Properties Summary | Property Details | Method Summary | Method Details
string   $baselink   Default-link
boolean   $cacheable   Output of module cacheable?
mixed   $css_class_input  
array   $data   Buffer for content/configurations data
array   $editfields   name => (
mixed   $emptyerror  
mixed   $field_error  
mixed   $inputerror  
int   $msgs   Referenz on message-objekt
string   $paramname   Parameter name for html formulars
array   $params   Parameter for HTML-formulars
integer   $preview   Is preview possible?
string   $tagname   XML-tag-base
$usesXML   $usesXML   Create XML for debug messages

[ Seitenanfang ]
Method Summary
Class Overview | Ableitungen | Inherited Properties And Methods | Properties Summary | Property Details | Method Summary | Method Details
base_plugin   base_plugin()   Constructor PHP 4
boolean   checkData()   Change input
array   checkDialogInput()   Check user dialog input
boolean   checkSurferPerm()   Check sufer permissions
simple_xmlnode   createXMLTree()   Create XML-tree.
string   getData()   Write data array to xml string
string   getDialog()   Gibt den Dialog zurueck
string   getForm()   Edit output
void   getMediaTag()  
void   getParamName()   Returns given parameter
string   getParsedData()   XML for take-over in page
string   getPermsCombo()   Callback for Select-Box with rights
string   getXHTMLString()   Create XHTML-compliant string.
string   html_nl2br()   Callback-function - transform \r\n in <br />.
void   initializeDialog()   Initialize dialog
boolean   modified()   data changed?
void   onLoad()   place holder - overload von ihertited classes
void   parseImageFieldData()  
void   serializeArrayToXML()  
void   setData()   Load configuration data in object
void   unserializeArrayFromXML()  
string   _gt()   Phrase translator - fetch translation
void   __construct()   Constructor PHP 5

[ Seitenanfang ]
Properties
Class Overview | Ableitungen | Inherited Properties And Methods | Properties Summary | Property Details | Method Summary | Method Details
string   $baselink [Zeile 54]

Default-link


[ Seitenanfang ]
boolean   $cacheable = 1 [Zeile 92]

Output of module cacheable?

Neu definiert in folgenden Ableitungen:

[ Seitenanfang ]
mixed   $css_class_input = input [Zeile 104]
Neu definiert in folgenden Ableitungen:

[ Seitenanfang ]
array   $data = NULL [Zeile 36]

Buffer for content/configurations data


[ Seitenanfang ]
array   $editfields [Zeile 86]

name => (

inscription, check function, mandatory field (true/false), Type (input, combo, textarea) Type paramter(maximum length, value-hash, row) fast help)
[ Seitenanfang ]
mixed   $emptyerror = This field needs a value. [Zeile 102]

[ Seitenanfang ]
mixed   $field_error [Zeile 100]

[ Seitenanfang ]
mixed   $inputerror = The Input in this field contains errors. [Zeile 101]

[ Seitenanfang ]
int   $msgs [Zeile 60]

Referenz on message-objekt

Neudefinition von:
base_object::$msgs
Error message

[ Seitenanfang ]
string   $paramname [Zeile 42]

Parameter name for html formulars


[ Seitenanfang ]
array   $params [Zeile 48]

Parameter for HTML-formulars


[ Seitenanfang ]
integer   $preview = false [Zeile 98]

Is preview possible?


[ Seitenanfang ]
string   $tagname = data [Zeile 66]

XML-tag-base


[ Seitenanfang ]
$usesXML   $usesXML = false [Zeile 73]

Create XML for debug messages


[ Seitenanfang ]
Methods
Class Overview | Ableitungen | Inherited Properties And Methods | Properties Summary | Property Details Method Summary | Method Details
Constructor base_plugin  [Zeile 128]

  base_plugin base_plugin( object &$topic, [string $paramname = NULL]  )

Constructor PHP 4

Parameters:
string   $paramname:  Parametername
object   &$topic:  base_topic Topic object


[ Seitenanfang ]
checkData  [Zeile 217]

  boolean checkData( )

Change input



[ Seitenanfang ]
checkDialogInput  [Zeile 273]

  array checkDialogInput( )

Check user dialog input


API Tags:
Return:  $result


[ Seitenanfang ]
checkSurferPerm  [Zeile 404]

  boolean checkSurferPerm( integer $perm_id  )

Check sufer permissions

Parameters:
integer   $perm_id: 

API Tags:
Access:  public


[ Seitenanfang ]
createXMLTree  [Zeile 324]

  simple_xmlnode createXMLTree( string $xmldata  )

Create XML-tree.

Parameters:
string   $xmldata:  XML-string

API Tags:
Return:  $xmltree XML-tree


[ Seitenanfang ]
getData  [Zeile 157]

  string getData( )

Write data array to xml string


API Tags:
Return:  $result XML-data string


[ Seitenanfang ]
getDialog  [Zeile 260]

  string getDialog( )

Gibt den Dialog zurueck


API Tags:
Return:  $this->dialog->getDialogXML()


[ Seitenanfang ]
getForm  [Zeile 233]

  string getForm( )

Edit output


API Tags:
Return:  XML-string with Formular


[ Seitenanfang ]
getMediaTag  [Zeile 434]

  void getMediaTag( mixed $data, [mixed $width = 0], [mixed $height = 0], [mixed $resize = 'max']  )



[ Seitenanfang ]
getParamName  [Zeile 136]

  void getParamName( string $paramname  )

Returns given parameter

Parameters:
string   $paramname:  parameter name


[ Seitenanfang ]
getParsedData  [Zeile 225]

  string getParsedData( )

XML for take-over in page


Neu definiert in folgenden Ableitungen:

[ Seitenanfang ]
getPermsCombo  [Zeile 356]

  string getPermsCombo( string $name, array $field, mixed $data  )

Callback for Select-Box with rights

Parameters:
string   $name: 
array   $field: 
mixed   $data: 


[ Seitenanfang ]
getXHTMLString  [Zeile 301]

  string getXHTMLString( string $str, [boolean $nl2br = false]  )

Create XHTML-compliant string.

Parameters:
string   $str: 
boolean   $nl2br:  Convert line break in XHTML


[ Seitenanfang ]
html_nl2br  [Zeile 288]

  string html_nl2br( array $regs  )

Callback-function - transform \r\n in <br />.

Parameters:
array   $regs:  Trefferdaten

API Tags:
Return:  $result


[ Seitenanfang ]
initializeDialog  [Zeile 241]

  void initializeDialog( )

Initialize dialog


Neu definiert in folgenden Ableitungen:

[ Seitenanfang ]
modified  [Zeile 208]

  boolean modified( )

data changed?



[ Seitenanfang ]
onLoad  [Zeile 344]

  void onLoad( )

place holder - overload von ihertited classes



[ Seitenanfang ]
parseImageFieldData  [Zeile 412]

  void parseImageFieldData( mixed $datastr  )



[ Seitenanfang ]
serializeArrayToXML  [Zeile 166]

  void serializeArrayToXML( mixed &$data_arr  )



[ Seitenanfang ]
setData  [Zeile 144]

  void setData( string $xmldata  )

Load configuration data in object

Parameters:
string   $xmldata:  XML-data string


[ Seitenanfang ]
unserializeArrayFromXML  [Zeile 186]

  void unserializeArrayFromXML( mixed &$data_arr, mixed &$node  )



[ Seitenanfang ]
_gt  [Zeile 390]

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

Phrase translator - fetch translation

Parameters:
string   $phrase:  Phrase
mixed   $module:  Modul

API Tags:
Return:  $phrase

Neudefinition von:
base_object::_gt()
Phrasetranslator - Fetch translation for all phrase

[ Seitenanfang ]
__construct  [Zeile 112]

  void __construct( object &$topic, [string $paramname = NULL]  )

Constructor PHP 5

Parameters:
string   $paramname:  Parametername
object   &$topic:  base_topic Topic object


[ Seitenanfang ]