Docs For Class frontend

Methods

Constructor frontend [line 69]

void frontend(
object
$db 
)

frontend::frontend()

// purpose: constructor

Parameters:

object

$db:

[ Top ]

Constructor __construct [line 46]

void __construct(
object
$db 
)

frontend::__construct()

// purpose: constructor for php 5

Parameters:

object

$db:

Redefined in descendants as:

comment::__construct() : comment::__construct()

[ Top ]

clearGet [line 97]

array clearGet(
)

frontend::clearGet()

// purpose: create $_GET array from url

[ Top ]

debug [line 1342]

void debug(
mixed
$data, [string
$title = NULL], [int
$pre = 0] 
)

frontend::debug()

purpose: print data as debug statement using print_R()

Parameters:

mixed	$data:
string	$title:
int	$pre:

[ Top ]

delObject [line 931]

void delObject(
int
$oid 
)

spunq::delObject()

// purpose: deletes an object from table object

Parameters:

int

$oid:

// object id as stored in database

API Tags:

Return:

pear-db result object

[ Top ]

delObjectData [line 790]

void delObjectData(
array
$GET 
)

spunq::delObjectData()

// purpose: deletes an object from data-class, object, struct and _relation

Parameters:

array

$GET:

// given GET array

API Tags:

Return:

TRUE or pear-db error object

[ Top ]

doSearch [line 1004]

object doSearch(
string
$query, array
$searchclasses 
)

frontend::doSearch()

// purpose: returns results from needed classes by given search string

Parameters:

string	$query:
array	$searchclasses:

[ Top ]

getBrowserLang [line 1099]

string getBrowserLang(
)

frontend::getBrowserLang

// purpose: read browser language from client

[ Top ]

getCategory [line 1296]

string getCategory(
)

frontend::getCategory()

// purpose: returns productsgategory name

[ Top ]

getClassStructure [line 236]

mixed getClassStructure(
int
$class_id, int
$parent, [int
$limit = 0] 
)

frontend::getClassStructure()

// purpose: return class structure

Parameters:

int	$class_id:	// class
int	$parent:	// parent folders
int	$limit:	// limiter for select-results

[ Top ]

getCookieValues [line 1085]

array getCookieValues(
)

frontend::getCookieValues

// purpose: create an array from a given cookie .. to be extended for different projects

[ Top ]

getDBStatus [line 1221]

date getDBStatus(
)

frontend::getDBStatus()

// read status from database

[ Top ]

getEditCalls [line 167]

string getEditCalls(

$class, 
$object, int
$classid 
)

frontend::getEditCalls()

// purpose: returns an array of classid, oid and version for frontendend editing

Parameters:

int	$classid:
	$class:
	$object:

[ Top ]

getGetArray [line 136]

string getGetArray(
)

frontend::getGetArray()

// purpose: returns the server name

[ Top ]

getLang [line 1072]

string getLang(
array
$versions 
)

frontend::getLANG

// purpose: get a readable language version from array $versions

Parameters:

array

$versions:

[ Top ]

getLastObjectId [line 987]

int getLastObjectId(
)

spunq::getLastObjectId()

// purpose: returns the last objectid inserted in table object

API Tags:

Return:

object id

[ Top ]

getParentFolder [line 223]

object getParentFolder(
int
$parent, int
$classid 
)

frontend::getParentFolder()

// purpose: returns the parent of a folder

Parameters:

int	$parent:
int	$classid:

[ Top ]

getParentFolderIdForRef [line 625]

object getParentFolderIdForRef(
int
$ref, int
$classid 
)

frontend::getParentFolderIdForRef()

// purpose: returns a single Lecture Item

Parameters:

int	$ref:
int	$classid:

[ Top ]

getPureObject [line 209]

object getPureObject(
[int
$oid = 0], [int
$ref = 0], [int
$classid = 0] 
)

frontend::getPureObject()

// purpose: returns a pure object by object_id or object-ref and object-class-ref

Parameters:

int	$oid:	// object id stored as object.object_id
int	$ref:	// object reference stored as object.object_ref
int	$classid:	// classid stored as object.object_class_ref

[ Top ]

getRelatedObjects [line 396]

mixed getRelatedObjects(
int
$class_ref1, int
$class_ref2, int
$object_ref1, [int
$limit = 0] 
)

frontend::getRelatedObjects()

// purpose: searches for m:n relations for an object in other classes

Parameters:

int	$class_ref1:
int	$class_ref2:
int	$object_ref1:
int	$limit:

[ Top ]

getRelatedObjectsReverse [line 453]

object all getRelatedObjectsReverse(
int
$class_ref1, int
$class_ref2, int
$object_ref2, [int
$class_table1 = ""], [int
$sort_field = ""] 
)

frontend::getRelatedObjectsReverse()

// purpose: searches for objects relating to given object with optional sorting function

Parameters:

int	$class_ref1:	// class reference for class 1
int	$class_ref2:	// class reference for class 2
int	$object_ref2:	// object id for object 2
int	$class_table1:	// table for sorting
int	$sort_field:	// field for sorting

API Tags:

Return:

objects for given parameters in a defined class (class_ref2)

[ Top ]

getServerName [line 121]

string getServerName(
)

frontend::getServerName()

// purpose: returns the server name

[ Top ]

getStructureObjects [line 300]

array getStructureObjects(
int
$class, int
$folder, [int
$limit = 0] 
)

frontend::getStructureObjects()

// purpose: returns menu entries for text

Parameters:

int	$class:	// class_id
int	$folder:	// folder_id
int	$limit:

[ Top ]

getStructureObjectsPure [line 348]

object getStructureObjectsPure(
int
$class, int
$folder, [int
$limit = 0] 
)

frontend::getStructureObjectsPure() // purpose: returns all objects for given struct and class, without metadata ...

Parameters:

int	$class:	//class_id
int	$folder:	// folder_id
int	$limit:

[ Top ]

getTableName [line 196]

string getTableName(
int
$classid 
)

frontend::getTableName()

// purpose: returns the table name by a given classid

Parameters:

int

$classid:

[ Top ]

getTextById [line 518]

array getTextById(
int
$id, int
$classid, [int
$rel = 1] 
)

frontend::getTextById()

// purpose: returns object with all its metadata by a given id

Parameters:

int	$id:	// object_id
int	$classid:	// class_id
int	$rel:

[ Top ]

getTextByRef [line 584]

void getTextByRef(

$ref, 
$classid, string
$name 
)

frontend::getTextByRef()

// purpose: returns object by a given reference

Parameters:

string	$name:
	$ref:
	$classid:

[ Top ]

getTextByUnixName [line 1265]

object getTextByUnixName(

$class 
)

frontend::getTextByUnixName()

// purpose: returns an object by a given unixname. this function is not abstracted yet. please make sure all values are right for your project. this function dependes on a class strg used in strg.at frontend

Parameters:

$class:

[ Top ]

getTree [line 1233]

mixed getTree(

$class_id, [
$parent = 0], [
$depth = 0], int
$folder 
)

frontend::getTree()

// purpose: returns Tree and content of given class

Parameters:

int	$folder:
	$class_id:
	$parent:
	$depth:

[ Top ]

insertObject [line 846]

object // insertObject(
)

spunq::insertObject()

// purpose: insertes a new object in table object

API Tags:

Return:

pear-db result object

[ Top ]

insertObjectData [line 701]

void insertObjectData(
)

spunq::insertObjectData()

purpose: saves a new object in object und class-table

[ Top ]

insertPureObject [line 947]

object pear-db insertPureObject(
int
$class_ref, int
$object_ref, string
$name, int
$user, int
$group, int
$perm, int
$sort 
)

spunq::insertPureObject()

// purpose: inserts an object in table object by given parameters

Parameters:

int	$class_ref:	// class reference
int	$object_ref:	// object reference
string	$name:	// object name
int	$user:	// userid
int	$group:	// groupid
int	$perm:	// permissions for object
int	$sort:	// sort value for object

API Tags:

Return:

result object

[ Top ]

saveObject [line 648]

int saveObject(
array
$rights 
)

frontend::saveObject()

// purpose: decides if object is updated or newly inserted and calls necessary method

Parameters:

array

$rights:

// general rights array for object save action

API Tags:

Return:

structid to display interface after save-action

[ Top ]

saveObjectVersion [line 673]

int saveObjectVersion(
array
$rights 
)

frontend::saveObjectVersion()

// purpose: decides if object is updated or newly inserted and calls necessary method

Parameters:

array

$rights:

// general rights array for object save action

API Tags:

Return:

structid to display interface after save-action

[ Top ]

sendmail [line 1176]

void sendmail(
array
$POST 
)

frontend::sendmail()

// purpose: send mail from contactform

Parameters:

array

$POST:

// post array

[ Top ]

setBrowserLang [line 1110]

string setBrowserLang(

$version 
)

frontend::setBrowserLang

// purpose: set temprarily browser lang without cookie

Parameters:

$version:

[ Top ]

splitRows [line 1323]

string splitRows(

$data 
)

frontend::splitRows()

// purpose: returns productsgategory name

Parameters:

$data:

[ Top ]

stripstring [line 1395]

void stripstring(
string
$data 
)

frontend::stripstring()

// purpose: strips a string for better writing in logfile

Parameters:

string

$data:

// data for logging

[ Top ]

switchLanguage [line 1127]

string switchLanguage(
string
$lang, int
$version 
)

frontend::switchLanguage

// purpose: writes session values for used content-version

Parameters:

string	$lang:	// language identfier from browser
int	$version:	// version identifier

API Tags:

Return:

// URL for redirect

[ Top ]

switchStyle [line 1144]

string switchStyle(
int
$size 
)

frontend::SwitchStyle

// purpose: switch the used css use values in session

Parameters:

int

$size:

// size id

API Tags:

Return:

// URL for redirect

[ Top ]

updateObject [line 825]

object // updateObject(
)

spunq::updateObject()

// purpose: updates an object in table object

API Tags:

Return:

pear-db result object

[ Top ]

updateObjectData [line 746]

mixed updateObjectData(
)

spunq::updateObjectData()

purpose: updates a new object in object und class-table

[ Top ]

updatePureObject [line 966]

object pear-db updatePureObject(

$id, int
$class_ref, int
$object_ref, string
$name, int
$user, int
$group, int
$perm, int
$sort, int
$object_id 
)

spunq::updatePureObject()

// purpose: updates an object in table object by given parameters

Parameters:

int	$object_id:	// object id
int	$class_ref:	// class reference
int	$object_ref:	// object reference
string	$name:	// object name
int	$user:	// userid
int	$group:	// groupid
int	$perm:	// permissions for object
int	$sort:	// sort value for object
	$id:

API Tags:

Return:

result object

[ Top ]

writedebug [line 1375]

void writedebug(
array
$logdata, string
$title 
)

frontend::writedebug()

// purpose: writes debug data to the debugfile

Parameters:

array	$logdata:	// data for logging
string	$title:

[ Top ]

writeFile [line 149]

array writeFile(
string
$content, string
$path, string
$filename 
)

frontend::writeFile()

// purpose: writes a file into the filesystem by filename, path and content

Parameters:

string	$content:
string	$path:
string	$filename:

API Tags:

Return:

all existing backup files

[ Top ]

writeSessionValues [line 1159]

void writeSessionValues(
int
$langid, int
$size 
)

frontend::writeSession()

// purpose: write session values for frontend

Parameters:

int	$langid:	// language id
int	$size:	// css size id

[ Top ]

	spunq-frontend

[ class tree: spunq-frontend ] [ index: spunq-frontend ] [ all elements ]

Class: frontend

Class frontend