Class TableMessage

TableAccess

Extended by

TableMessage

Copyright: 2004-2016 The Admidio Team
License: GNU General Public License v2.0 only **********************************************************************************************
Class:

TableMessage This class manages the set, update and delete in the table adm_messages

Located at tablemessage.php

Methods summary

`public`	# `__construct( Database & $database, integer $msg_id = 0 )` Constructor that will create an object of a recordset of the table adm_messages. If the id is set than the specific message will be loaded. Constructor that will create an object of a recordset of the table adm_messages. If the id is set than the specific message will be loaded. Parameters `$database` Object of the class Database. This should be the default global object @b $gDb. `$msg_id` The recordset of the message with this conversation id will be loaded. If id isn't set than an empty object of the table is created. Overrides `TableAccess::__construct`
`public integer`	# `countUnreadMessageRecords( integer $usrId )` Reads the number of all unread messages of this table Reads the number of all unread messages of this table Parameters `$usrId` Returns integer Number of unread messages of this table
`public integer`	# `countMessageConversations( )` Reads the number of all conversations in this table Reads the number of all conversations in this table Returns integer Number of conversations in this table
`public integer`	# `countMessageParts( )` Reads the number of all messages in actual conversation Reads the number of all messages in actual conversation Returns integer Number of all messages in actual conversation
`public PDOStatement`	# `setReadValue( integer $usrId )` Set a new value for a column of the database table. Set a new value for a column of the database table. Parameters `$usrId` of the receiver - just for security reasons. Returns PDOStatement Returns @b answer of the SQL execution
`public PDOStatement`	# `getConversation( integer $msgId )` get a list with all messages of an conversation. get a list with all messages of an conversation. Parameters `$msgId` of the conversation - just for security reasons. Returns PDOStatement Returns @b answer of the SQL execution
`public integer`	# `getConversationPartner( integer $usrId )` Set a new value for a column of the database table. The value is only saved in the object. You must call the method @b save to store the new value to the database Set a new value for a column of the database table. The value is only saved in the object. You must call the method @b save to store the new value to the database Parameters `$usrId` Returns integer Returns @b ID of the user that is partner in the actual conversation
`public boolean`	# `delete( )` Deletes the selected message with all associated fields. After that the class will be initialize. Deletes the selected message with all associated fields. After that the class will be initialize. Returns boolean @b true if message is deleted or message with additional information if it is marked for other user to delete. On error it is false Overrides `TableAccess::delete`

Methods inherited from TableAccess

__sleep(), clear(), connectAdditionalTable(), countAllRecords(), getValue(), hasColumnsValueChanged(), isNewRecord(), readData(), readDataByColumns(), readDataById(), save(), setArray(), setDatabase(), setValue()

Properties summary

`protected`	`$msg_id`	#

Properties inherited from TableAccess

$additionalTables, $columnPrefix, $columnsInfos, $columnsValueChanged, $db, $dbColumns, $keyColumnName, $new_record, $tableName