Private Method Details |
getIcon |
|
private string getIcon( )
|
| |
Returns a complete img-tag for the searchresult
|
| Returns |
string $html |
|
createAdminInterface |
|
private void createAdminInterface( int &$AdminInterface )
|
| |
sets the editable properties in the AdminInterface
|
| Parameter |
|
| int |
&$AdminInterface |
|
|
erface &$AdminInterface |
|
| Returns |
void |
|
getFields |
|
private array getFields( )
|
| |
returns all the fields of the database table associated with the object.
therefore is it necessary to name these fields (in the Globals section on top of the page)in a special way, f.i. in the class jpeto_article all the FIELDS should be namedarticle_FIELDNAME
|
| Returns |
array $fields |
|
getSubtype |
|
private string getSubtype( )
|
| |
This function returns a SubObject (if there's just one)
|
| Returns |
string $SubObject |
|
getJpetoTypeDetails |
|
private void getJpetoTypeDetails( integer $JpetoType )
|
| |
loads the details for the given JpetoType
|
| Parameter |
|
|
| Returns |
void |
|
getJpetoType |
|
private integer getJpetoType( integer $UniqueID )
|
| |
gets the JpetoType for a specified UniqueID
|
| Parameter |
|
|
| Returns |
integer $JpetoType |
|
getJoin |
|
private string getJoin( )
|
| |
returns a sql string for joining the object-table with the [JpetoType]-table
|
| Returns |
string $where |
|
isOnline |
|
private Boolean isOnline( object jpeto_object $Object )
|
| |
returns the online status of an object (depending on the isOnline Flag, the OnlineStart & OnlineEnd)
|
| Parameter |
|
| object jpeto_object |
$Object |
|
|
|
|
| Returns |
Boolean $isOnline the status of the object |
|
get_jpeto_object |
|
private void get_jpeto_object( integer $UniqueID, [ Boolean $follow ] )
|
| |
Gets one object identified by it's UniqueID
and calls mapFields
|
| Parameter |
|
| integer |
$UniqueID |
|
|
the UniqueID of the object to fetch from the database |
|
|
| Boolean |
$follow |
= >>true<< |
|
follow the object to it's leaves |
|
| Returns |
void |
|
numChildren |
|
private integer numChildren( )
|
| |
Returns the number of Child Objects
|
| Returns |
integer $numChildren |
|
isExpired |
|
private boolean isExpired( )
|
| |
Boolean is Expired
|
| Returns |
boolean $isExpired |
|
isLocked |
|
private boolean isLocked( )
|
| |
Boolean is Locked
|
| Returns |
boolean $isLocked |
|
lock |
|
private boolean lock( )
|
| |
Locks the current object
|
| Returns |
boolean $success |
|
unlock |
|
private boolean unlock( )
|
| |
Unlocks all objects locked by a specific user
|
| Returns |
boolean $success |
|
assignContent |
|
private void assignContent( object jpeto_object $Object )
|
| |
This function assigns the content (by default into one column, with line-breaks as seperator)
For more complex objects, please overwrite this function in the subclass and assignthe Content identified by it's JpetoType to different Slots/etc.
|
| Parameter |
|
| object jpeto_object |
$Object |
|
|
|
|
| Returns |
void |
|
stripLastLinebreak |
|
private void stripLastLinebreak( )
|
| |
removes the linebreak after the last object
|
| Returns |
void |
|
mapFields |
|
private void mapFields( array $Recordset )
|
| |
Maps the fields of the given recordset to the object variables
|
| Parameter |
|
| array |
$Recordset |
|
|
the Recordset given to map to the variables |
|
| Returns |
void |
|
mapTypeFields |
|
private void mapTypeFields( array $Recordset )
|
| |
Maps the type-specific fields of the given recordset to the object-type variables
|
| Parameter |
|
| array |
$Recordset |
|
|
the Recordset given to map to the variables |
|
| Returns |
void |
|
mapObjectFields |
|
private void mapObjectFields( array $Recordset )
|
| |
Maps the fields of the given recordset to the object variables
This is just a dummy that should be overwritten by the extending class,if the object has got any data-fields beside the meta-data
|
| Parameter |
|
| array |
$Recordset |
|
|
the Recordset given to map to the variables |
|
| Returns |
void |
|
newUniqueID |
|
private int newUniqueID( )
|
| |
gets an unused UniqueID
|
| Returns |
int $newUniqueID |
|
debug |
|
private void debug( )
|
| |
returns the elements of the object as a html table
overwrite function debugObject in extending class
|
| Returns |
void |
|
delete |
|
private boolean delete( [ integer $UniqueID ] )
|
| |
deletes the current object identified by its UniqueID, Language, Version
|
| Parameter |
|
| integer |
$UniqueID |
= >>0<< |
|
|
|
| Returns |
boolean $success |
|
getOnlineStatusImage |
|
private string getOnlineStatusImage( )
|
| |
Returns a image-tag to display the online status of an object
|
| Returns |
string $String |
|
getFromURLKey |
|
private String getFromURLKey( )
|
| |
returns the primary key of the current object as From QueryString
|
| Returns |
String $key |
|
getToURLKey |
|
private String getToURLKey( )
|
| |
returns the primary key of the current object as To QueryString
|
| Returns |
String $key |
|
addAdminLink |
|
private string addAdminLink( string $Content )
|
| |
returns a link to the admin interface of the current object
|
| Parameter |
|
|
| Returns |
string $AdminLink |
|
isCached |
|
private boolean isCached( )
|
| |
Checks if the current object is already in cache
|
| Returns |
boolean $isCached |
|
getCacheFileName |
|
private String getCacheFileName( )
|
| |
Returns a cache filename
|
| Returns |
String $CacheFile |
|
toCache |
|
private void toCache( string $Content )
|
| |
Writes the given Content-String to the Cache Directory
|
| Parameter |
|
|
| Returns |
void |
|
getCache |
|
private string getCache( )
|
| |
returns the Cached Object
|
| Returns |
string $Cache |
|
purgeCache |
|
private boolean purgeCache( )
|
| |
removes the object from the Cache
|
| Returns |
boolean $success |
|
store |
|
private boolean store( )
|
| |
stores the current object
please overwrite updateObject() and insertObject()
|
| Returns |
boolean $success |
|
getDefaultValues |
|
private void getDefaultValues( )
|
| |
gets default Values for (not set) parameters
This is just a dummy that should be overwritten by the extending class (optional)
|
| Returns |
void |
|
updateObject |
|
private void updateObject( )
|
| |
updates the current object in the subtable
This is just a dummy that has to be overwritten by the extending class,depending on the fields of the extension
|
| Returns |
void |
|
insertObject |
|
private void insertObject( )
|
| |
inserts the current object in the subtable
This is just a dummy that has to be overwritten by the extending class,depending on the fields of the extension
|
| Returns |
void |
|
addSubObject |
|
private void addSubObject( object jpeto_object $SubObject )
|
| |
maps a given Subobject to the current Object
|
| Parameter |
|
| object jpeto_object |
$SubObject |
|
|
|
|
| Returns |
void |
|
isRestricted |
|
private boolean isRestricted( )
|
| |
returns whether the access of the current object is restricted or not
|
| Returns |
boolean $isRestricted |
|
toHTML |
|
private void toHTML( )
|
| |
returns the current object rendered as html
This is just a dummy that has to be overwritten by the extending class,depending on the way of presentation
|
| Returns |
void |
|
toDetailHTML |
|
private void toDetailHTML( )
|
| |
returns the current object rendered in detail as html
This is just a dummy that should be overwritten by the extending class,depending on the way of presentation (optional)
|
| Returns |
void |
|
xmlFormat |
|
private string xmlFormat( string $String )
|
| |
formats a string with xml entities
|
| Parameter |
|
|
| Returns |
string $String |
|
xmlElement |
|
private string xmlElement( string $elementName )
|
| |
renders a string to xml
|
| Parameter |
|
|
| Returns |
string $xmlE |
|
toXML |
|
private String toXML( )
|
| |
converts the current object into xml data
|
| Returns |
String $xml |
|
getBoundary |
|
private String getBoundary( )
|
| |
returns a Unique Boundary ID for the current object
|
| Returns |
String $Boundary |
|
getContentID |
|
private String getContentID( )
|
| |
returns a Unique Content ID for the current object
|
| Returns |
String $ContentID |
|
toPlainText |
|
private string toPlainText( )
|
| |
returns a "stupid" plain text conversion of the current object.
if you've got a rather complex object, overwrite this function to get better results
|
| Returns |
string $PlainText |
|
getMailData |
|
private String getMailData( )
|
| |
Converts HTML Code to Mail-conform HTML Code
Overwrite this function for Non-Text Objects like Images
|
| Returns |
String $MailData |
|
upgrade |
|
private void upgrade( )
|
| |
upgrades an object of an unknown type to the complete object
example:$object = new jpeto_object ("", "DE", "O"); // we don't know which type of object!$object->j_UniqueID = 1234;$object->upgrade(); // now we have the complete object
|
| Returns |
void |
|
getOrigin |
|
private String getOrigin( [ Integer $excludeJpetoType ] )
|
| |
this function returns the original URL of the current object. (the node to which the current object was mapped first)
|
| Parameter |
|
| Integer |
$excludeJpetoType |
= >>0<< |
|
the jpeto_type to exclude |
|
| Returns |
String $URL the URL of the original node (or false) |
|