[ Index ]

PHP Cross Reference of phpBB-3.2.8-deutsch

title

Body

[close]

/phpbb/notification/type/ -> post.php (summary)

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: 467 lines (12 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

post:: (19 methods):
  get_type()
  set_config()
  set_user_loader()
  is_available()
  get_item_id()
  get_item_parent_id()
  find_users_for_notification()
  get_avatar()
  get_title()
  get_reference()
  get_email_template()
  get_email_template_variables()
  get_url()
  get_redirect_url()
  users_to_query()
  trim_user_ary()
  pre_create_insert_array()
  create_insert_array()
  add_responders()


Class: post  - X-Ref

Post notifications class
This class handles notifications for replies to a topic

get_type()   X-Ref
Get notification type name

return: string

set_config(\phpbb\config\config $config)   X-Ref
No description

set_user_loader(\phpbb\user_loader $user_loader)   X-Ref
No description

is_available()   X-Ref
Is available


get_item_id($post)   X-Ref
Get the id of the item

param: array $post The data from the post
return: int The post id

get_item_parent_id($post)   X-Ref
Get the id of the parent

param: array $post The data from the post
return: int The topic id

find_users_for_notification($post, $options = array()   X-Ref
Find the users who want to receive notifications

param: array $post Data from submit_post
param: array $options Options for finding users for notification
return: array

get_avatar()   X-Ref
Get the user's avatar


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_email_template()   X-Ref
Get email template

return: string|bool

get_email_template_variables()   X-Ref
Get email template variables

return: array

get_url()   X-Ref
Get the url to this item

return: string URL

get_redirect_url()   X-Ref
{inheritDoc}


users_to_query()   X-Ref
Users needed to query before this notification can be displayed

return: array Array of user_ids

trim_user_ary($users)   X-Ref
Trim the user array passed down to 3 users if the array contains
more than 4 users.

param: array $users Array of users
return: array Trimmed array of user_ids

pre_create_insert_array($post, $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 $post Post data from submit_post
param: array $notify_users Notify users list
return: array Whatever you want to send to create_insert_array().

create_insert_array($post, $pre_create_data = array()   X-Ref
{@inheritdoc}


add_responders($post)   X-Ref
Add responders to the notification

param: mixed $post
return: array Array of responder data



Generated: Sat Oct 26 11:28:42 2019 Cross-referenced by PHPXref 0.7.1