| [ Index ] |
PHP Cross Reference of phpBB-3.1.12-deutsch |
[Source view] [Print] [Project Stats]
This file is part of the phpBB Forum Software package.
| Copyright: | (c) phpBB Limited |
| License: | GNU General Public License, version 2 (GPL-2.0) |
| File Size: | 214 lines (5 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
type_interface:: (25 methods):
get_type()
set_initial_data()
get_item_id()
get_item_parent_id()
is_available()
find_users_for_notification()
users_to_query()
get_load_special()
load_special()
get_style_class()
get_title()
get_reference()
get_forum()
get_url()
get_redirect_url()
get_unsubscribe_url()
get_avatar()
prepare_for_display()
get_email_template()
get_email_template_variables()
pre_create_insert_array()
create_insert_array()
create_update_array()
mark_read()
mark_unread()
Interface: type_interface - X-Ref
Base notifications interface| get_type() X-Ref |
| Get notification type name return: string |
| set_initial_data($data) X-Ref |
| Set initial data from the database param: array $data Row directly from the database |
| get_item_id($type_data) X-Ref |
| Get the id of the item param: array $type_data The type specific data |
| get_item_parent_id($type_data) X-Ref |
| Get the id of the parent param: array $type_data The type specific data |
| is_available() X-Ref |
| Is this type available to the current user (defines whether or not it will be shown in the UCP Edit notification options) return: bool True/False whether or not this is available to the user |
| find_users_for_notification($type_data, $options) X-Ref |
| Find the users who want to receive notifications param: array $type_data The type specific data param: array $options Options for finding users for notification return: array |
| users_to_query() X-Ref |
| Users needed to query before this notification can be displayed return: array Array of user_ids |
| get_load_special() X-Ref |
| Get the special items to load return: array Data will be combined sent to load_special() so you can run a single query and get data required for this notification type |
| load_special($data, $notifications) X-Ref |
| Load the special items param: array $data Data from get_load_special() param: array $notifications Array of notifications (key is notification_id, value is the notification objects) |
| get_style_class() X-Ref |
| Get the CSS style class of the notification return: string |
| get_title() X-Ref |
| Get the HTML formatted title of this notification return: string |
| get_reference() X-Ref |
| Get the HTML formatted reference of the notification return: string |
| get_forum() X-Ref |
| Get the forum of the notification reference return: string |
| get_url() X-Ref |
| Get the url to this item return: string URL |
| get_redirect_url() X-Ref |
| Get the url to redirect after the item has been marked as read return: string URL |
| get_unsubscribe_url($method) X-Ref |
| URL to unsubscribe to this notification param: string|bool $method Method name to unsubscribe from (email|jabber|etc), False to unsubscribe from all notifications for this item |
| get_avatar() X-Ref |
| Get the user's avatar (the user who caused the notification typically) return: string |
| prepare_for_display() X-Ref |
| Prepare to output the notification to the template |
| get_email_template() X-Ref |
| Get email template return: string|bool |
| get_email_template_variables() X-Ref |
| Get email template variables return: array |
| pre_create_insert_array($type_data, $notify_users) X-Ref |
| Pre create insert array function This allows you to perform certain actions, like run a query and load data, before create_insert_array() is run. The data returned from this function will be sent to create_insert_array(). param: array $type_data The type specific data param: array $notify_users Notify users list return: array Whatever you want to send to create_insert_array(). |
| create_insert_array($type_data, $pre_create_data) X-Ref |
| Function for preparing the data for insertion in an SQL query (The service handles insertion) param: array $type_data The type specific data param: array $pre_create_data Data from pre_create_insert_array() return: array Array of data ready to be inserted into the database |
| create_update_array($type_data) X-Ref |
| Function for preparing the data for update in an SQL query (The service handles insertion) param: array $type_data Data unique to this notification type return: array Array of data ready to be updated in the database |
| mark_read($return) X-Ref |
| Mark this item read param: bool $return True to return a string containing the SQL code to update this item, False to execute it (Default: False) return: string |
| mark_unread($return) X-Ref |
| Mark this item unread param: bool $return True to return a string containing the SQL code to update this item, False to execute it (Default: False) return: string |
| Generated: Thu Jan 11 00:25:41 2018 | Cross-referenced by PHPXref 0.7.1 |