aboutsummaryrefslogtreecommitdiffstats
path: root/phpBB/phpbb/notification
diff options
context:
space:
mode:
Diffstat (limited to 'phpBB/phpbb/notification')
-rw-r--r--phpBB/phpbb/notification/manager.php4
-rw-r--r--phpBB/phpbb/notification/type/approve_post.php3
-rw-r--r--phpBB/phpbb/notification/type/approve_topic.php3
-rw-r--r--phpBB/phpbb/notification/type/base.php3
-rw-r--r--phpBB/phpbb/notification/type/bookmark.php3
-rw-r--r--phpBB/phpbb/notification/type/pm.php5
-rw-r--r--phpBB/phpbb/notification/type/post.php3
-rw-r--r--phpBB/phpbb/notification/type/post_in_queue.php1
-rw-r--r--phpBB/phpbb/notification/type/quote.php5
-rw-r--r--phpBB/phpbb/notification/type/report_pm.php1
-rw-r--r--phpBB/phpbb/notification/type/report_pm_closed.php3
-rw-r--r--phpBB/phpbb/notification/type/report_post.php1
-rw-r--r--phpBB/phpbb/notification/type/report_post_closed.php3
-rw-r--r--phpBB/phpbb/notification/type/topic.php1
-rw-r--r--phpBB/phpbb/notification/type/topic_in_queue.php1
15 files changed, 28 insertions, 12 deletions
diff --git a/phpBB/phpbb/notification/manager.php b/phpBB/phpbb/notification/manager.php
index 74ef980445..5e4bab1530 100644
--- a/phpBB/phpbb/notification/manager.php
+++ b/phpBB/phpbb/notification/manager.php
@@ -68,12 +68,14 @@ class manager
* @param \phpbb\user_loader $user_loader
* @param \phpbb\config\config $config
* @param \phpbb\db\driver\driver_interface $db
+ * @param \phpbb\cache\service $cache
* @param \phpbb\user $user
* @param string $phpbb_root_path
* @param string $php_ext
* @param string $notification_types_table
* @param string $notifications_table
* @param string $user_notifications_table
+ *
* @return \phpbb\notification\manager
*/
public function __construct($notification_types, $notification_methods, ContainerInterface $phpbb_container, \phpbb\user_loader $user_loader, \phpbb\config\config $config, \phpbb\db\driver\driver_interface $db, \phpbb\cache\service $cache, $user, $phpbb_root_path, $php_ext, $notification_types_table, $notifications_table, $user_notifications_table)
@@ -832,7 +834,7 @@ class manager
* Delete all notifications older than a certain time
*
* @param int $timestamp Unix timestamp to delete all notifications that were created before
- * @param bool $only_unread True (default) to only prune read notifications
+ * @param bool $only_read True (default) to only prune read notifications
*/
public function prune_notifications($timestamp, $only_read = true)
{
diff --git a/phpBB/phpbb/notification/type/approve_post.php b/phpBB/phpbb/notification/type/approve_post.php
index a6735dc793..0aad19d6bf 100644
--- a/phpBB/phpbb/notification/type/approve_post.php
+++ b/phpBB/phpbb/notification/type/approve_post.php
@@ -67,7 +67,8 @@ class approve_post extends \phpbb\notification\type\post
/**
* Find the users who want to receive notifications
*
- * @param array $post Data from
+ * @param array $post Data from submit_post
+ * @param array $options Options for finding users for notification
*
* @return array
*/
diff --git a/phpBB/phpbb/notification/type/approve_topic.php b/phpBB/phpbb/notification/type/approve_topic.php
index 459a0ec348..e649f3920e 100644
--- a/phpBB/phpbb/notification/type/approve_topic.php
+++ b/phpBB/phpbb/notification/type/approve_topic.php
@@ -67,7 +67,8 @@ class approve_topic extends \phpbb\notification\type\topic
/**
* Find the users who want to receive notifications
*
- * @param array $post Data from
+ * @param array $post Data from submit_post
+ * @param array $options Options for finding users for notification
*
* @return array
*/
diff --git a/phpBB/phpbb/notification/type/base.php b/phpBB/phpbb/notification/type/base.php
index 910f51b3a6..a11ad76db9 100644
--- a/phpBB/phpbb/notification/type/base.php
+++ b/phpBB/phpbb/notification/type/base.php
@@ -161,6 +161,8 @@ abstract class base implements \phpbb\notification\type\type_interface
* Magic method to set data on this notification
*
* @param mixed $name
+ * @param mixed $value
+ *
* @return null
*/
public function __set($name, $value)
@@ -174,7 +176,6 @@ abstract class base implements \phpbb\notification\type\type_interface
*
* Primarily for testing
*
- * @param string $name
* @return mixed
*/
public function __toString()
diff --git a/phpBB/phpbb/notification/type/bookmark.php b/phpBB/phpbb/notification/type/bookmark.php
index f4870e8a52..c83288cfb8 100644
--- a/phpBB/phpbb/notification/type/bookmark.php
+++ b/phpBB/phpbb/notification/type/bookmark.php
@@ -59,7 +59,8 @@ class bookmark extends \phpbb\notification\type\post
/**
* Find the users who want to receive notifications
*
- * @param array $post Data from
+ * @param array $post Data from submit_post
+ * @param array $options Options for finding users for notification
*
* @return array
*/
diff --git a/phpBB/phpbb/notification/type/pm.php b/phpBB/phpbb/notification/type/pm.php
index 4f54e93e06..8445ca4b22 100644
--- a/phpBB/phpbb/notification/type/pm.php
+++ b/phpBB/phpbb/notification/type/pm.php
@@ -72,7 +72,8 @@ class pm extends \phpbb\notification\type\base
/**
* Find the users who want to receive notifications
*
- * @param array $pm Data from
+ * @param array $pm Data from submit_pm
+ * @param array $options Options for finding users for notification
*
* @return array
*/
@@ -178,7 +179,7 @@ class pm extends \phpbb\notification\type\base
* Function for preparing the data for insertion in an SQL query
* (The service handles insertion)
*
- * @param array $post Data from submit_post
+ * @param array $pm Data from submit_post
* @param array $pre_create_data Data from pre_create_insert_array()
*
* @return array Array of data ready to be inserted into the database
diff --git a/phpBB/phpbb/notification/type/post.php b/phpBB/phpbb/notification/type/post.php
index ee3a253e0f..357176ec35 100644
--- a/phpBB/phpbb/notification/type/post.php
+++ b/phpBB/phpbb/notification/type/post.php
@@ -86,7 +86,8 @@ class post extends \phpbb\notification\type\base
/**
* Find the users who want to receive notifications
*
- * @param array $post Data from
+ * @param array $post Data from submit_post
+ * @param array $options Options for finding users for notification
*
* @return array
*/
diff --git a/phpBB/phpbb/notification/type/post_in_queue.php b/phpBB/phpbb/notification/type/post_in_queue.php
index b893ad0d15..3bb1028619 100644
--- a/phpBB/phpbb/notification/type/post_in_queue.php
+++ b/phpBB/phpbb/notification/type/post_in_queue.php
@@ -70,6 +70,7 @@ class post_in_queue extends \phpbb\notification\type\post
* Find the users who want to receive notifications
*
* @param array $post Data from the post
+ * @param array $options Options for finding users for notification
*
* @return array
*/
diff --git a/phpBB/phpbb/notification/type/quote.php b/phpBB/phpbb/notification/type/quote.php
index 7c61b76b58..6e672e6fbd 100644
--- a/phpBB/phpbb/notification/type/quote.php
+++ b/phpBB/phpbb/notification/type/quote.php
@@ -66,7 +66,8 @@ class quote extends \phpbb\notification\type\post
/**
* Find the users who want to receive notifications
*
- * @param array $post Data from
+ * @param array $post Data from submit_post
+ * @param array $options Options for finding users for notification
*
* @return array
*/
@@ -122,7 +123,7 @@ class quote extends \phpbb\notification\type\post
/**
* Update a notification
*
- * @param array $data Data specific for this type that will be updated
+ * @param array $post Data specific for this type that will be updated
*/
public function update_notifications($post)
{
diff --git a/phpBB/phpbb/notification/type/report_pm.php b/phpBB/phpbb/notification/type/report_pm.php
index 2eb802eb4b..14a328e104 100644
--- a/phpBB/phpbb/notification/type/report_pm.php
+++ b/phpBB/phpbb/notification/type/report_pm.php
@@ -94,6 +94,7 @@ class report_pm extends \phpbb\notification\type\pm
* (copied from post_in_queue)
*
* @param array $post Data from the post
+ * @param array $options Options for finding users for notification
*
* @return array
*/
diff --git a/phpBB/phpbb/notification/type/report_pm_closed.php b/phpBB/phpbb/notification/type/report_pm_closed.php
index ed40df67f3..de7bf74a97 100644
--- a/phpBB/phpbb/notification/type/report_pm_closed.php
+++ b/phpBB/phpbb/notification/type/report_pm_closed.php
@@ -52,7 +52,8 @@ class report_pm_closed extends \phpbb\notification\type\pm
/**
* Find the users who want to receive notifications
*
- * @param array $pm Data from
+ * @param array $pm Data from submit_pm
+ * @param array $options Options for finding users for notification
*
* @return array
*/
diff --git a/phpBB/phpbb/notification/type/report_post.php b/phpBB/phpbb/notification/type/report_post.php
index 024c8d9d42..bec59df9d5 100644
--- a/phpBB/phpbb/notification/type/report_post.php
+++ b/phpBB/phpbb/notification/type/report_post.php
@@ -76,6 +76,7 @@ class report_post extends \phpbb\notification\type\post_in_queue
* Find the users who want to receive notifications
*
* @param array $post Data from the post
+ * @param array $options Options for finding users for notification
*
* @return array
*/
diff --git a/phpBB/phpbb/notification/type/report_post_closed.php b/phpBB/phpbb/notification/type/report_post_closed.php
index a979af1fb0..cd1400f8fa 100644
--- a/phpBB/phpbb/notification/type/report_post_closed.php
+++ b/phpBB/phpbb/notification/type/report_post_closed.php
@@ -59,7 +59,8 @@ class report_post_closed extends \phpbb\notification\type\post
/**
* Find the users who want to receive notifications
*
- * @param array $post Data from
+ * @param array $post Data from submit_post
+ * @param array $options Options for finding users for notification
*
* @return array
*/
diff --git a/phpBB/phpbb/notification/type/topic.php b/phpBB/phpbb/notification/type/topic.php
index a512a12f20..289e45bedb 100644
--- a/phpBB/phpbb/notification/type/topic.php
+++ b/phpBB/phpbb/notification/type/topic.php
@@ -87,6 +87,7 @@ class topic extends \phpbb\notification\type\base
* Find the users who want to receive notifications
*
* @param array $topic Data from the topic
+ * @param array $options Options for finding users for notification
*
* @return array
*/
diff --git a/phpBB/phpbb/notification/type/topic_in_queue.php b/phpBB/phpbb/notification/type/topic_in_queue.php
index 2d54a68648..aef1487d77 100644
--- a/phpBB/phpbb/notification/type/topic_in_queue.php
+++ b/phpBB/phpbb/notification/type/topic_in_queue.php
@@ -70,6 +70,7 @@ class topic_in_queue extends \phpbb\notification\type\topic
* Find the users who want to receive notifications
*
* @param array $topic Data from the topic
+ * @param array $options Options for finding users for notification
*
* @return array
*/
generated by cgit v1.2.1 (git 2.21.0) at 2025-10-30 00:57:45 +0000
/usr/lib/libDrakX); #- > use interactive; #- > my $in = interactive->vnew; #- > $in->ask_okcancel('title', 'question'); #- > $in->exit; #- ask_from_ takes global options ($common): #- title => window title #- messages => message displayed in the upper part of the window #- ok => force the name of the "Ok"/"Next" button #- cancel => force the name of the "Cancel"/"Previous" button #- focus_cancel => force focus on the "Cancel" button #- focus_first => (deprecated) force focus on the first entry #- ok_disabled => function returning wether {ok} should be disabled (grayed) #- validate => function called when {ok} is pressed. If it returns false, the first entry is focused, otherwise it quits #- advanced => (deprecated) function called when the "advanced" expander is toggled #- advanced_messages => (deprecated) message displayed when "Advanced" is pressed #- advanced_label => (deprecated) force the name of the "Advanced" button #- advanced_label_close => (deprecated) force the name of the "Basic" button #- advanced_state => (deprecated) if set to 1, force the "Advanced" part of the dialog to be opened initially #- callbacks => (deprecated) functions called when something happen: complete advanced ok_disabled #- ask_from_ takes a list of entries with fields: #- val => reference to the value #- label => description #- title => a boolean: whether the label should be displayed as a title (see GNOME's HIG) #- icon => icon to put before the description #- help => tooltip #- advanced => (deprecated) wether it is shown in by default or only in advanced mode #- focus_out => function called when the entry is focused out #- changed => function called when the entry is modified #- validate => function called when "Ok" is pressed. If it returns false, this entry is focused, otherwise it quits #- disabled => function returning wether it should be disabled (grayed) #- focus => function returning wether it should be focused #- alignment => preferred alignment #- do_not_expand => do not eat all horizontal space #- install_button => if possible, use improved graphical style #- gtk => gtk preferences #- type => #- button => (with clicked or clicked_may_quit) #- (type defaults to button if clicked or clicked_may_quit is there) #- (val need not be a reference) (if clicked_may_quit return true, it's as if "Ok" was pressed) #- label => (val need not be a reference) (type defaults to label if val is not a reference) #- bool (with "text" or "image" (which overrides text) giving an image filename) #- range (with min, max, SpinButton) #- combo (with list, not_edit, format) #- list (with list, icon2f (aka icon), separator (aka tree), format (aka pre_format function), #- help can be a hash or a function, #- tree_expanded boolean telling wether the tree should be wide open by default #- quit_if_double_click boolean #- allow_empty_list disables the special cases for 0 and 1 element lists #- image2f is a subroutine which takes a value of the list as parameter, and returns image_file_name #- entry (the default) (with hidden) #- expander (with text, expanded, message, children(a list of sub entries)) # #- heritate from this class and you'll get all made interactivity for same steps. #- for this you need to provide #- - ask_from_listW(o, title, messages, arrayref, default) returns one string of arrayref #- #- where #- - o is the object #- - title is a string #- - messages is an refarray of strings #- - default is an optional string (default is in arrayref) #- - arrayref is an arrayref of strings #- - arrayref2 contains booleans telling the default state, #- #- ask_from_list and ask_from_list_ are wrappers around ask_from_biglist and ask_from_smalllist #- #- ask_from_list_ just translate arrayref before calling ask_from_list and untranslate the result #- #- ask_from_listW should handle differently small lists and big ones. #- #-###################################################################################### #- OO Stuff #-###################################################################################### our @ISA = qw(do_pkgs); sub new($) { my ($type) = @_; bless {}, ref($type) || $type; } sub vnew { my ($_type, $o_su, $o_icon) = @_; my $su = $o_su eq "su"; if ($ENV{INTERACTIVE_HTTP}) { require interactive::http; return interactive::http->new; } require c; if ($su) { $ENV{PATH} = "/sbin:/usr/sbin:$ENV{PATH}"; $su = '' if $::testing || $ENV{TESTING}; } require_root_capability() if $su; if (check_for_xserver()) { eval { require interactive::gtk }; if (!$@) { my $o = interactive::gtk->new; if ($o_icon && $o_icon ne 'default' && !$::isWizard) { $o->{icon} = $o_icon } else { undef $o->{icon} } return $o; } elsif ($::testing) { die; } } require interactive::curses; interactive::curses->new; } sub ok { N_("Ok") } sub cancel { N_("Cancel") } sub markup_parse { my ($s) = @_; my @l; my @attrs; while ($s) { if ($s =~ s!^<(\w+)(\s+[^>]*?)?>!!s) { push @attrs, [ $1, $2 ]; } elsif ($s =~ s!^</(\w+)>!!) { my $previous = pop @attrs; $previous->[0] eq $1 or return; } elsif ($s =~ s!^(&(amp|lt|gt);)!!) { push @l, [ $1, @attrs ]; } elsif ($s =~ s!^([^<>&]+)!!s) { push @l, [ $1, @attrs ]; } else { return; } } markup_simplify(\@l); \@l; } sub markup_simplify { my ($l) = @_; foreach (@$l) { my ($s, @attrs) = @$_; my %attrs = map { my ($tag, $attrs) = @$_; my $long = { b => { weight => "bold" }, i => { style => "italic" }, big => { size => 'larger' }, }->{$tag}; $long ? %$long : map { /^(.*?)=['"]?(.*?)['"]?$/ } split(' ', $attrs); } @attrs; $s = +{ '&amp;' => '&', '&lt;' => '<', '&gt;' => '>' }->{$s} || $s; @$_ = ($s, if_(%attrs, \%attrs)); } } sub markup_remove { my ($s) = @_; if (my $l = markup_parse($s)) { join('', map { $_->[0] } @$l); } else { $s; } } #- drop markup as fallback sub adapt_markup { my ($_o, $s) = @_; markup_remove($s); } sub enter_console {} sub leave_console {} sub suspend {} sub resume {} sub end {} sub exit { if ($::isStandalone) { require standalone; standalone::exit($_[0]); } else { exit($_[0]); } } #-###################################################################################### #- Interactive functions #-###################################################################################### sub ask_warn { my ($o, $title, $message, $o_icon) = @_; ask_warn_($o, { title => $title, messages => $message, icon => $o_icon }); } sub ask_yesorno { my ($o, $title, $message, $b_def) = @_; ask_yesorno_($o, { title => $title, messages => $message }, $b_def); } sub ask_okcancel { my ($o, $title, $message, $b_def, $o_icon) = @_; ask_okcancel_($o, { title => $title, messages => $message, icon => $o_icon }, $b_def); } sub ask_warn_ { my ($o, $common) = @_; local $o->{modal} = $o->{modal} || $::isInstall; # make these popup at install time ask_from_listf_raw_no_check($o, $common, \&translate, [ $o->ok ]); } sub ask_yesorno_ { my ($o, $common, $b_def) = @_; $common->{cancel} = ''; ask_from_listf_raw($o, $common, \&translate, [ N_("Yes"), N_("No") ], $b_def ? "Yes" : "No") eq "Yes"; } sub ask_okcancel_ { my ($o, $common, $b_def) = @_; if ($::isWizard) { $common->{focus_cancel} = !$b_def; ask_from_no_check($o, $common, []); } else { ask_from_listf_raw($o, $common, \&translate, [ $o->ok, $o->cancel ], $b_def ? $o->ok : $o->cancel) eq $o->ok; } } sub ask_filename { my ($o, $common) = @_; $common->{want_a_dir} = 0; $o->ask_fileW($common); } sub ask_directory { my ($o, $common) = @_; $common->{want_a_dir} = 1; $o->ask_fileW($common); } #- predecated sub ask_file { my ($o, $title, $o_dir) = @_; $o->ask_fileW({ title => $title, want_a_dir => 0, directory => $o_dir }); } sub ask_fileW { my ($o, $common) = @_; $o->ask_from_entry($common->{title}, $common->{message} || N("Choose a file")); } sub ask_from_list { my ($o, $title, $message, $l, $o_def) = @_; ask_from_listf($o, $title, $message, undef, $l, $o_def); } sub ask_from_list_ { my ($o, $title, $message, $l, $o_def) = @_; ask_from_listf($o, $title, $message, \&translate, $l, $o_def); } sub ask_from_listf_ { my ($o, $title, $message, $f, $l, $o_def) = @_; ask_from_listf($o, $title, $message, sub { translate($f->(@_)) }, $l, $o_def); } sub ask_from_listf { my ($o, $title, $message, $f, $l, $o_def) = @_; ask_from_listf_raw($o, { title => $title, messages => $message }, $f, $l, $o_def); } sub ask_from_listf_raw { my ($_o, $_common, $_f, $l, $_o_def) = @_; @$l == 0 and die "ask_from_list: empty list\n" . backtrace(); @$l == 1 and return $l->[0]; goto &ask_from_listf_raw_no_check; } sub ask_from_listf_raw_no_check { my ($o, $common, $f, $l, $o_def) = @_; if (@$l <= ($::isWizard ? 1 : 2)) { my ($ok, $cancel) = map { $_ && may_apply($f, $_) } @$l; if (length "$ok$cancel" < 70) { my $ret = eval { put_in_hash($common, { ok => $ok, if_($cancel, cancel => $cancel, focus_cancel => $o_def eq $l->[1]) }); ask_from_no_check($o, $common, []) ? $l->[0] : $l->[1]; }; die if $@ && $@ !~ /^wizcancel/; return $@ ? undef : $ret; } } ask_from_no_check($o, $common, [ { val => \$o_def, type => 'list', list => $l, format => $f } ]) && $o_def; } sub ask_from_treelist { my ($o, $title, $message, $separator, $l, $o_def) = @_; ask_from_treelistf($o, $title, $message, $separator, undef, $l, $o_def); } sub ask_from_treelist_ { my ($o, $title, $message, $separator, $l, $o_def) = @_; my $transl = sub { join '|', map { translate($_) } split(quotemeta($separator), $_[0]) }; ask_from_treelistf($o, $title, $message, $separator, $transl, $l, $o_def); } sub ask_from_treelistf { my ($o, $title, $message, $separator, $f, $l, $o_def) = @_; ask_from($o, $title, $message, [ { val => \$o_def, separator => $separator, list => $l, format => $f, sort => 1 } ]) or return; $o_def; } sub ask_many_from_list { my ($o, $title, $message, @l) = @_; @l = grep { @{$_->{list}} } @l or return ''; foreach my $h (@l) { $h->{e}{$_} = { text => may_apply($h->{label}, $_), val => $h->{val} ? $h->{val}->($_) : do { my $i =