Docs For Class class

Class class_model

Description

Top-level class for all model-classes

Located in /system/class_model.php (line 15)

class_root
   |
   --class_model

Direct descendents

Class	Description
class_modul_dashboard_widget	Class to represent a single adminwidget
class_modul_downloads_archive	Class to represent an archive, used to store download-files and folders
class_modul_downloads_file	Model for files & folders of the downloads
class_modul_downloads_logbook	Model for the downloads-logbook
class_modul_faqs_category	Model for a faqscategory
class_modul_faqs_faq	Model for a faq itself
class_modul_filemanager_repo	Model for a filemanager repo
class_modul_gallery_gallery	Model for glleries itself
class_modul_gallery_pic	Model for pic & folders of the gallery
class_modul_guestbook_guestbook	Class to represent a guestbook book
class_modul_guestbook_post	Class to represent a guestbook post
class_modul_kajonabase_common	Class to provide methods used by the system for general issues
class_modul_languages_language	Model for a language
class_modul_languages_languageset	A languageset connects a set of systemrecords and assigns every single one to defined set.
class_modul_navigation_point	Model for a navigation point itself
class_modul_navigation_tree	Model for a navigation tree itself
class_modul_news_category	Model for a newscategory
class_modul_news_feed	Model for a newsfeed itself
class_modul_news_news	Model for a news itself
class_modul_pages_element	Model for a element. This is the "raw"-element, not the element on a page Elements DON'T have systemids!
class_modul_pages_folder	This class manages all stuff related with folders, used by pages. Folders just exist in the database, not in the filesystem
class_modul_pages_page	Model for a page
class_modul_pages_pageelement	Model for a element assigned to a page. NOT the raw-element!
class_modul_postacomment_post	Model for comment itself
class_modul_rating_rate	Model for rating itself
class_modul_search_commons	This class contains a few methods used by the search as little helpers
class_modul_search_log	This class contains a few methods used by the search as little helpers
class_modul_stats_worker	Model for a stats-worker
class_modul_system_adminwidget	Class to represent a single adminwidget
class_modul_system_common	Class to provide methods used by the system for general issues
class_modul_system_module	Model for a single system-module Modules are not represented in the system-table directly. so a moduleid is being used instead
class_modul_system_session	Model for a single session. Session are managed by class_session, so there should be no need to create instances directly.
class_modul_system_setting	Model for a single system-setting Setting are not represented by a record in the system-table
class_modul_system_worker	Class to provide methods used by the system for db tasks as a db check
class_modul_user_group	Model for a user-group Groups are not represented in the system-table
class_modul_user_log	Model for a user-login-log
class_modul_user_user	Model for a user Note: Users do not use the classical system-id relation, so no entry in the system-table

Method Summary

static bool rightDelete ()

static bool rightEdit ()

static bool rightRight ()

static bool rightRight1 ()

static bool rightRight2 ()

static bool rightRight3 ()

static bool rightRight4 ()

static bool rightRight5 ()

static bool rightView ()

class_model __construct ( $arrModule, $strSystemid)

void doAdditionalCleanupsOnDeletion ( $strSystemid)

float getFloatRating ([$bitRound $bitRound = true])

int getIntRatingHits ()

string getObjectDescription ()

array getObjectTables ()

bool isRateableByUser ()

void loadDataFromDb ()

bool onInsertToDb ()

bool updateObjectToDb ([string $strPrevId = false], string $strComment)

bool updateStateToDb ()

Variables

Inherited Variables

Inherited from class_root

class_root::$arrModule
class_root::$objConfig
class_root::$objDB
class_root::$objRights
class_root::$objSession
class_root::$objTemplate
class_root::$objToolkit
class_root::$strTemplateArea

Methods

static rightDelete (line 216)

Returns the bool-value for the right to delete this record, Systemid MUST be given, otherwise false

final:
access: public

static bool rightDelete ()

static rightEdit (line 201)

Returns the bool-value for the right to edit this record, Systemid MUST be given, otherwise false

final:
access: public

static bool rightEdit ()

static rightRight (line 231)

Returns the bool-value for the right to change rights of this record, Systemid MUST be given, otherwise false

final:
access: public

static bool rightRight ()

static rightRight1 (line 246)

Returns the bool-value for the right1 of this record, Systemid MUST be given, otherwise false

final:
access: public

static bool rightRight1 ()

static rightRight2 (line 261)

Returns the bool-value for the right2 of this record, Systemid MUST be given, otherwise false

final:
access: public

static bool rightRight2 ()

static rightRight3 (line 276)

Returns the bool-value for the right3 of this record, Systemid MUST be given, otherwise false

final:
access: public

static bool rightRight3 ()

static rightRight4 (line 291)

Returns the bool-value for the right4 of this record, Systemid MUST be given, otherwise false

final:
access: public

static bool rightRight4 ()

static rightRight5 (line 306)

Returns the bool-value for the right5 of this record, Systemid MUST be given, otherwise false

final:
access: public

static bool rightRight5 ()

static rightView (line 186)

Returns the bool-value for the right to view this record, Systemid MUST be given, otherwise false

final:
access: public

static bool rightView ()

Constructor __construct (line 17)

access: public

class_model __construct ( $arrModule, $strSystemid)

$arrModule
$strSystemid

Redefinition of:

class_root::__construct(): Constructor

Redefined in descendants as:

class_modul_dashboard_widget::__construct() : Constructor to create a valid object
class_modul_downloads_archive::__construct() : Constructor to create a valid object
class_modul_downloads_file::__construct() : Constructor to create a valid object
class_modul_downloads_logbook::__construct() : Constructor to create a valid object
class_modul_faqs_category::__construct() : Constructor to create a valid object
class_modul_faqs_faq::__construct() : Constructor to create a valid object
class_modul_filemanager_repo::__construct() : Constructor to create a valid object
class_modul_gallery_gallery::__construct() : Constructor to create a valid object
class_modul_gallery_pic::__construct() : Constructor to create a valid object
class_modul_guestbook_guestbook::__construct() : Constructor to create a valid object
class_modul_guestbook_post::__construct() : Constructor to create a valid object
class_modul_kajonabase_common::__construct() : Constructor to create a valid object
class_modul_languages_language::__construct() : Constructor to create a valid object
class_modul_languages_languageset::__construct() : Constructor to create a valid object
class_modul_navigation_point::__construct() : Constructor to create a valid object
class_modul_navigation_tree::__construct() : Constructor to create a valid object
class_modul_news_category::__construct() : Constructor to create a valid object
class_modul_news_feed::__construct() : Constructor to create a valid object
class_modul_news_news::__construct() : Constructor to create a valid object
class_modul_pages_element::__construct() : Constructor to create a valid object
class_modul_pages_folder::__construct() : Constructor to create a valid object
class_modul_pages_page::__construct() : Constructor to create a valid object
class_modul_pages_pageelement::__construct() : Constructor to create a valid object
class_modul_postacomment_post::__construct() : Constructor to create a valid object
class_modul_rating_rate::__construct() : Constructor to create a valid object
class_modul_search_commons::__construct() : Constructor to create a valid object
class_modul_search_log::__construct() : Constructor to create a valid object
class_modul_stats_worker::__construct() : Constructor to create a valid object
class_modul_system_adminwidget::__construct() : Constructor to create a valid object
class_modul_system_common::__construct() : Constructor to create a valid object
class_modul_system_module::__construct() : Constructor to create a valid object
class_modul_system_session::__construct() : Constructor to create a valid object
class_modul_system_setting::__construct() : Constructor to create a valid object
class_modul_system_worker::__construct() : Constructor to create a valid object
class_modul_user_group::__construct() : Constructor to create a valid object
class_modul_user_log::__construct() : Constructor to create a valid object
class_modul_user_user::__construct() : Constructor to create a valid object

doAdditionalCleanupsOnDeletion (line 319)

Overwrite this method, if an object should be notified in case of deleting a systemrecord.

This can be useful to delete other records being dependent on the record to be deleted

access: public

void doAdditionalCleanupsOnDeletion ( $strSystemid)

$strSystemid

Redefined in descendants as:

class_modul_postacomment_post::doAdditionalCleanupsOnDeletion() : Searches for comments belonging to the systemid to be deleted.
class_modul_rating_rate::doAdditionalCleanupsOnDeletion() : Searches for ratings belonging to the systemid to be deleted.

getFloatRating (line 332)

Rating of the current file, if module rating is installed.

see: interface_sortable_rating
access: public

float getFloatRating ([$bitRound $bitRound = true])

$bitRound $bitRound: Rounds the rating or disables rounding

Redefined in descendants as:

class_modul_rating_rate::getFloatRating()

getIntRatingHits (line 374)

Number of rating for the current file

see: interface_sortable_rating
access: public

int getIntRatingHits ()

getObjectDescription (line 174)

Returns a human-readable description of the current record.

To be used within the system-table as a comment

todo: will become abstract before 3.3.0, please update your implementations of interface_model
abstract:
access: protected

string getObjectDescription ()

Redefined in descendants as:

getObjectTables (line 164)

Returns the tables being used to store the current objects' state.

The array should contain the name of the table as the key and the name of the primary-key (so the column name) as the matching value. E.g.: array(_dbprefix_."pages" => "page_id)

return: tablename => table-primary-key-column
todo: will become abstract before 3.3.0, please update your implementations of interface_model
abstract:
access: protected

array getObjectTables ()

Redefined in descendants as:

isRateableByUser (line 354)

Checks if the current user is allowed to rate the file

access: public

bool isRateableByUser ()

loadDataFromDb (line 26)

Forces to reinit the object from the database

access: public

void loadDataFromDb ()

onInsertToDb (line 139)

Overwrite this method if you want to trigger additional commands during the insert of an object, e.g. to create additional objects / relations

access: protected

bool onInsertToDb ()

Redefined in descendants as:

class_modul_downloads_archive::onInsertToDb()
class_modul_gallery_gallery::onInsertToDb()
class_modul_guestbook_guestbook::onInsertToDb() : Adds the right of the guest to sign the book
class_modul_navigation_point::onInsertToDb() : saves the current object as a new object to the database
class_modul_news_news::onInsertToDb() : saves the current object as a new object to the database
class_modul_pages_page::onInsertToDb() : saves the current object as a new object to the database
class_modul_pages_pageelement::onInsertToDb() : saves the current object as a new object to the database

updateObjectToDb (line 50)

Saves the current object to the database. Determins, whether the current object has to be inserted or updated to the database.

In case of an update, the objects' updateStateToDb() method is being called (as required by class_model). In the case of a new object, a blank record is being created. Thererfore, all tables returned by the objects' getObjectTables() method will be filled with a new record (using the same new systemid as the primary key). The newly created systemid is being set as the current objects' one and can be used in the afterwards called updateStateToDb() method to reference the correct rows.

see: interface_model
todo: will become final before 3.3.0, please update your implementations of interface_model
since: 3.3.0
throws: class_exception
access: public

bool updateObjectToDb ([string $strPrevId = false], string $strComment)

string $strPrevId: The prev-id of the records, either to be used for the insert or to be used during the update of the record
string $strComment: Comment to describe the record in the systemtable

Redefined in descendants as:

class_modul_languages_languageset::updateObjectToDb() : Updates the current state to the database
class_modul_pages_element::updateObjectToDb() : Updates the current object to the database
class_modul_system_session::updateObjectToDb() : saves the current object with all its params back to the database
class_modul_system_setting::updateObjectToDb() : Updates the current object to the database.
class_modul_user_group::updateObjectToDb() : Updates the current object to the database
class_modul_user_user::updateObjectToDb() : Updates the current object to the database ATTENTION If you don't want to update the password, set it to "" before!

updateStateToDb (line 152)

Updates the current object to the database.

Use this method in order to synchronize the objects' internal state to the database.

todo: will become abstract before 3.3.0, please update your implementations of interface_model
abstract:
access: protected

bool updateStateToDb ()

Redefined in descendants as:

class_modul_dashboard_widget::updateStateToDb() : Updates the current widget to the db
class_modul_downloads_archive::updateStateToDb()
class_modul_downloads_file::updateStateToDb() : Updates the object to the database
class_modul_downloads_logbook::updateStateToDb() : not implemented
class_modul_faqs_category::updateStateToDb() : saves the current object with all its params back to the database
class_modul_faqs_faq::updateStateToDb() : saves the current object with all its params back to the database
class_modul_filemanager_repo::updateStateToDb()
class_modul_gallery_gallery::updateStateToDb() : Transfers the current state back to the database
class_modul_gallery_pic::updateStateToDb()
class_modul_guestbook_guestbook::updateStateToDb() : Updates the corresponding record in the database with the values of the current object
class_modul_guestbook_post::updateStateToDb() : Update the current object in the db
class_modul_kajonabase_common::updateStateToDb()
class_modul_languages_language::updateStateToDb() : saves the current object with all its params back to the database
class_modul_navigation_point::updateStateToDb() : saves the current object with all its params back to the database
class_modul_navigation_tree::updateStateToDb() : saves the current object with all its params back to the database
class_modul_news_category::updateStateToDb() : saves the current object with all its params back to the database
class_modul_news_feed::updateStateToDb() : saves the current object with all its params back to the database
class_modul_news_news::updateStateToDb() : saves the current object with all its params back to the database
class_modul_pages_folder::updateStateToDb() : Updates the current object to the database
class_modul_pages_page::updateStateToDb() : Updates the current object to the database
class_modul_pages_pageelement::updateStateToDb() : Updates the current object to the database currently just updateing the internal title and the language
class_modul_postacomment_post::updateStateToDb() : saves the current object with all its params back to the database
class_modul_rating_rate::updateStateToDb() : saves the current object with all its params back to the database
class_modul_search_commons::updateStateToDb() : Updates the current object to the database
class_modul_search_log::updateStateToDb() : Updates the current object to the database
class_modul_stats_worker::updateStateToDb() : Updates the current object to the database
class_modul_system_adminwidget::updateStateToDb() : Updates the values of the current widget to the db
class_modul_system_common::updateStateToDb() : Updates the current object to the database
class_modul_system_module::updateStateToDb() : Updates the current object to the database
class_modul_system_worker::updateStateToDb() : Updates the current object to the database

Inherited Methods

Inherited From class_root

class_root::__construct()
class_root::additionalCallsOnDeletion()
class_root::createDateRecord()
class_root::createSystemRecord()
class_root::deleteRight()
class_root::deleteSystemRecord()
class_root::flushCompletePagesCache()
class_root::flushPageFromPagesCache()
class_root::generateSystemid()
class_root::getAction()
class_root::getAllParams()
class_root::getArrModule()
class_root::getChildNodesAsIdArray()
class_root::getEditDate()
class_root::getLastEditUser()
class_root::getLastEditUserId()
class_root::getLockManager()
class_root::getModuleData()
class_root::getModuleSystemid()
class_root::getNumberOfSiblings()
class_root::getObjRights()
class_root::getObjText()
class_root::getOwnerId()
class_root::getParam()
class_root::getPathArray()
class_root::getPrevId()
class_root::getRecordComment()
class_root::getRecordModuleNr()
class_root::getStatus()
class_root::getStrAdminLanguageToWorkOn()
class_root::getStrPortalLanguage()
class_root::getSystemid()
class_root::getSystemRecord()
class_root::getText()
class_root::setAbsolutePosition()
class_root::setEditDate()
class_root::setLastEditUser()
class_root::setOwnerId()
class_root::setParam()
class_root::setPosition()
class_root::setPrevId()
class_root::setRecordComment()
class_root::setStatus()
class_root::setSystemid()
class_root::setTemplateArea()
class_root::unsetSystemid()
class_root::updateDateRecord()
class_root::validateSystemid()

Documentation generated on Mon, 12 Apr 2010 21:20:40 +0200 by phpDocumentor 1.4.3