diff options
| author | Joas Schilling <nickvergessen@gmx.de> | 2012-10-02 12:46:44 +0200 |
|---|---|---|
| committer | Joas Schilling <nickvergessen@gmx.de> | 2012-10-02 12:51:59 +0200 |
| commit | a84e4029e4ecde691a0d34ef72ddab4fc56a07ee (patch) | |
| tree | 151eabda35bd6f9f8d49692cf7aa1af0461b6990 /phpBB/includes | |
| parent | b629b2cd95a9da67376f7a628c15199007e2ebd6 (diff) | |
| download | forums-a84e4029e4ecde691a0d34ef72ddab4fc56a07ee.tar forums-a84e4029e4ecde691a0d34ef72ddab4fc56a07ee.tar.gz forums-a84e4029e4ecde691a0d34ef72ddab4fc56a07ee.tar.bz2 forums-a84e4029e4ecde691a0d34ef72ddab4fc56a07ee.tar.xz forums-a84e4029e4ecde691a0d34ef72ddab4fc56a07ee.zip | |
[feature/soft-delete] Update doc blocks to proper format
PHPBB3-9657
Diffstat (limited to 'phpBB/includes')
| -rw-r--r-- | phpBB/includes/content_visibility.php | 39 |
1 files changed, 25 insertions, 14 deletions
diff --git a/phpBB/includes/content_visibility.php b/phpBB/includes/content_visibility.php index e927460a49..1aa2ad1a29 100644 --- a/phpBB/includes/content_visibility.php +++ b/phpBB/includes/content_visibility.php @@ -24,10 +24,13 @@ class phpbb_content_visibility { /** * Create topic/post visibility SQL for a given forum ID - * @param $mode string - either "topic" or "post" - * @param $forum_id int - current forum ID - * @param $table_alias string - Table alias to prefix in SQL queries - * @return string with the appropriate combination SQL logic for topic/post_visibility + * + * Note: Read permissions are not checked. + * + * @param $mode string Either "topic" or "post" + * @param $forum_id int The forum id is used for permission checks + * @param $table_alias string Table alias to prefix in SQL queries + * @return string The appropriate combination SQL logic for topic/post_visibility */ static public function get_visibility_sql($mode, $forum_id, $table_alias = '') { @@ -76,11 +79,15 @@ class phpbb_content_visibility } /** - * Fetch visibility SQL for a set of forums - * @param $mode string - either "topic" or "post" - * @param $forum_ids - int array - - * @param $table_alias string - Table alias to prefix in SQL queries - * @return string with the appropriate combination SQL logic for topic/post_visibility + * Create topic/post visibility SQL for a set of forums + * + * Note: Read permissions are not checked. Forums without read permissions + * should not be in $forum_ids + * + * @param $mode string Either "topic" or "post" + * @param $forum_ids array Array of forum ids which the posts/topics are limited to + * @param $table_alias string Table alias to prefix in SQL queries + * @return string The appropriate combination SQL logic for topic/post_visibility */ static public function get_forums_visibility_sql($mode, $forum_ids = array(), $table_alias = '') { @@ -129,11 +136,15 @@ class phpbb_content_visibility } /** - * Fetch visibility SQL for all forums on the board. - * @param $mode string - either "topic" or "post" - * @param $exclude_forum_ids - int array - - * @param $table_alias string - Table alias to prefix in SQL queries - * @return string with the appropriate combination SQL logic for topic/post_visibility + * Create topic/post visibility SQL for all forums on the board + * + * Note: Read permissions are not checked. Forums without read permissions + * should be in $exclude_forum_ids + * + * @param $mode string Either "topic" or "post" + * @param $exclude_forum_ids array Array of forum ids which are excluded + * @param $table_alias string Table alias to prefix in SQL queries + * @return string The appropriate combination SQL logic for topic/post_visibility */ static public function get_global_visibility_sql($mode, $exclude_forum_ids = array(), $table_alias = '') { |