removeAttachments

Description

Removes attachments or avatars based on a given query condition.

Syntax

mixed removeAttachments (string $condition[, string $query_type[, bool $return_affected_messages]])


Parameter $condition

Expected type: String
Description: A MySQL WHERE condition (a.attachmentSize < x, etc.).


Parameter $query_type

Expected type: Enumerated String
Description:

Possible string values
Allowed values Description
'members' Remvoes attachments based on member ID ($condition will be something like "mem.ID_MEMBER=x")
'messages' Removes attachments based on message ID ($condition will be "m.ID_MSG=x")
'{empty}' An empty string ('') - default value ($condition includes other information on the attachments to remove)


Parameter $return_affected_messages

Expected type: Boolean
Description: Whether or not to return an array of affected messages. Default is false.


Return value

Expected type: Mixed
Description:

Possible types
Allowed values Description
Void If return_affected_messages is false, function returns no values
Array of Integers If return_affected_messages is true, function returns an array with the IDs of the affected messages


Notes

  • Called by several functions in this file.
  • Removes attachments based that match the $condition.
  • Allows query_types 'messages' and 'members', whichever is need by the $condition parameter
View all versions of this function
Advertisement: