[ Index ]

PHP Cross Reference of Unnamed Project

title

Body

[close]

/message/output/ -> lib.php (summary)

Contains a base class for extension by message processors

Copyright: Luis Rodrigues
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 108 lines (4 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 4 functions

  is_system_configured()
  is_user_configured()
  get_default_messaging_settings()
  can_send_to_any_users()

Functions
Functions that are not part of a class:

is_system_configured()   X-Ref
Are the message processor's system settings configured?

return: bool True if all necessary config settings been entered

is_user_configured($user = null)   X-Ref
Are the message processor's user specific settings configured?

param: stdClass $user the user object, defaults to $USER.
return: bool True if the user has all necessary settings in their messaging preferences

get_default_messaging_settings()   X-Ref
Returns the message processors default settings
Should the processor be enabled for logged in users by default?
Should the processor be enabled for logged off users by default?
Is enabling it disallowed, permitted or forced?

return: int The Default message output settings expressed as a bit mask

can_send_to_any_users()   X-Ref
Returns true if message can be sent to fake/internal user as well.
If message_output support message to be sent to fake user, then it should return true, like email.

return: bool



Generated: Thu Aug 11 10:00:09 2016 Cross-referenced by PHPXref 0.7.1