diff options
Diffstat (limited to 'phpBB/phpbb')
47 files changed, 125 insertions, 60 deletions
| diff --git a/phpBB/phpbb/auth/auth.php b/phpBB/phpbb/auth/auth.php index 65249275d4..38755ccf99 100644 --- a/phpBB/phpbb/auth/auth.php +++ b/phpBB/phpbb/auth/auth.php @@ -208,9 +208,12 @@ class auth  	/**  	* Get forums with the specified permission setting -	* if the option is prefixed with !, then the result becomes negated  	* -	* @param bool $clean set to true if only values needs to be returned which are set/unset +	* @param string $opt The permission name to lookup. If prefixed with !, the result is negated. +	* @param bool	$clean set to true if only values needs to be returned which are set/unset +	* +	* @return array Contains the forum ids with the specified permission set to true. +					This is a nested array: array => forum_id => permission => true  	*/  	function acl_getf($opt, $clean = false)  	{ diff --git a/phpBB/phpbb/auth/provider/apache.php b/phpBB/phpbb/auth/provider/apache.php index 4f44efe9af..9137a77210 100644 --- a/phpBB/phpbb/auth/provider/apache.php +++ b/phpBB/phpbb/auth/provider/apache.php @@ -28,13 +28,13 @@ class apache extends \phpbb\auth\provider\base  	/**  	 * Apache Authentication Constructor  	 * -	 * @param 	\phpbb\db\driver\driver_interface 	$db -	 * @param 	\phpbb\config\config 		$config -	 * @param	\phpbb\passwords\manager	$passwords_manager -	 * @param 	\phpbb\request\request 		$request -	 * @param 	\phpbb\user 			$user -	 * @param 	string 				$phpbb_root_path -	 * @param 	string 				$php_ext +	 * @param	\phpbb\db\driver\driver_interface 	$db		Database object +	 * @param	\phpbb\config\config 		$config		Config object +	 * @param	\phpbb\passwords\manager	$passwords_manager		Passwords Manager object +	 * @param	\phpbb\request\request 		$request		Request object +	 * @param	\phpbb\user 			$user		User object +	 * @param	string 				$phpbb_root_path		Relative path to phpBB root +	 * @param	string 				$php_ext		PHP file extension  	 */  	public function __construct(\phpbb\db\driver\driver_interface $db, \phpbb\config\config $config, \phpbb\passwords\manager $passwords_manager, \phpbb\request\request $request, \phpbb\user $user, $phpbb_root_path, $php_ext)  	{ diff --git a/phpBB/phpbb/auth/provider/ldap.php b/phpBB/phpbb/auth/provider/ldap.php index e7764b754b..d32e7504eb 100644 --- a/phpBB/phpbb/auth/provider/ldap.php +++ b/phpBB/phpbb/auth/provider/ldap.php @@ -29,10 +29,10 @@ class ldap extends \phpbb\auth\provider\base  	/**  	 * LDAP Authentication Constructor  	 * -	 * @param 	\phpbb\db\driver\driver_interface		$db -	 * @param 	\phpbb\config\config		$config -	 * @param	\phpbb\passwords\manager	$passwords_manager -	 * @param 	\phpbb\user			$user +	 * @param	\phpbb\db\driver\driver_interface		$db		Database object +	 * @param	\phpbb\config\config		$config		Config object +	 * @param	\phpbb\passwords\manager	$passwords_manager		Passwords manager object +	 * @param	\phpbb\user			$user		User object  	 */  	public function __construct(\phpbb\db\driver\driver_interface $db, \phpbb\config\config $config, \phpbb\passwords\manager $passwords_manager, \phpbb\user $user)  	{ diff --git a/phpBB/phpbb/cache/service.php b/phpBB/phpbb/cache/service.php index d6bf150384..b890d90558 100644 --- a/phpBB/phpbb/cache/service.php +++ b/phpBB/phpbb/cache/service.php @@ -47,7 +47,7 @@ class service  	protected $phpbb_root_path;  	/** -	* PHP extension. +	* PHP file extension.  	*  	* @var string  	*/ @@ -60,7 +60,7 @@ class service  	* @param \phpbb\config\config $config The config  	* @param \phpbb\db\driver\driver_interface $db Database connection  	* @param string $phpbb_root_path Root path -	* @param string $php_ext PHP extension +	* @param string $php_ext PHP file extension  	*/  	public function __construct(\phpbb\cache\driver\driver_interface $driver, \phpbb\config\config $config, \phpbb\db\driver\driver_interface $db, $phpbb_root_path, $php_ext)  	{ diff --git a/phpBB/phpbb/controller/helper.php b/phpBB/phpbb/controller/helper.php index e330fb5b6d..dd89d0504a 100644 --- a/phpBB/phpbb/controller/helper.php +++ b/phpBB/phpbb/controller/helper.php @@ -50,7 +50,7 @@ class helper  	protected $phpbb_root_path;  	/** -	* PHP extension +	* PHP file extension  	* @var string  	*/  	protected $php_ext; @@ -65,7 +65,7 @@ class helper  	* @param \phpbb\extension\manager $manager Extension manager object  	* @param \phpbb\symfony_request $symfony_request Symfony Request object  	* @param string $phpbb_root_path phpBB root path -	* @param string $php_ext PHP extension +	* @param string $php_ext PHP file extension  	*/  	public function __construct(\phpbb\template\template $template, \phpbb\user $user, \phpbb\config\config $config, \phpbb\controller\provider $provider, \phpbb\extension\manager $manager, \phpbb\symfony_request $symfony_request, $phpbb_root_path, $php_ext)  	{ @@ -82,9 +82,11 @@ class helper  	/**  	* Automate setting up the page and creating the response object.  	* -	* @param string $handle The template handle to render +	* @param string $template_file The template handle to render  	* @param string $page_title The title of the page to output  	* @param int $status_code The status code to be sent to the page header +	* @param bool $display_online_list Do we display online users list +	*  	* @return Response object containing rendered page  	*/  	public function render($template_file, $page_title = '', $status_code = 200, $display_online_list = false) diff --git a/phpBB/phpbb/cron/manager.php b/phpBB/phpbb/cron/manager.php index b0601e641a..5c8ac04b77 100644 --- a/phpBB/phpbb/cron/manager.php +++ b/phpBB/phpbb/cron/manager.php @@ -35,6 +35,8 @@ class manager  	* Constructor. Loads all available tasks.  	*  	* @param array|\Traversable $tasks Provides an iterable set of task names +	* @param string $phpbb_root_path Relative path to phpBB root +	* @param string $php_ext PHP file extension  	*/  	public function __construct($tasks, $phpbb_root_path, $php_ext)  	{ diff --git a/phpBB/phpbb/cron/task/core/prune_all_forums.php b/phpBB/phpbb/cron/task/core/prune_all_forums.php index 032ba1d2cc..b47939ccbe 100644 --- a/phpBB/phpbb/cron/task/core/prune_all_forums.php +++ b/phpBB/phpbb/cron/task/core/prune_all_forums.php @@ -31,7 +31,7 @@ class prune_all_forums extends \phpbb\cron\task\base  	* Constructor.  	*  	* @param string $phpbb_root_path The root path -	* @param string $php_ext The PHP extension +	* @param string $php_ext The PHP file extension  	* @param \phpbb\config\config $config The config  	* @param \phpbb\db\driver\driver_interface $db The db connection  	*/ diff --git a/phpBB/phpbb/cron/task/core/prune_forum.php b/phpBB/phpbb/cron/task/core/prune_forum.php index 8da0048baa..ba68565197 100644 --- a/phpBB/phpbb/cron/task/core/prune_forum.php +++ b/phpBB/phpbb/cron/task/core/prune_forum.php @@ -41,7 +41,7 @@ class prune_forum extends \phpbb\cron\task\base implements \phpbb\cron\task\para  	* Constructor.  	*  	* @param string $phpbb_root_path The root path -	* @param string $php_ext The PHP extension +	* @param string $php_ext PHP file extension  	* @param \phpbb\config\config $config The config  	* @param \phpbb\db\driver\driver_interface $db The db connection  	*/ diff --git a/phpBB/phpbb/cron/task/core/prune_shadow_topics.php b/phpBB/phpbb/cron/task/core/prune_shadow_topics.php index 83a2460454..97a4b0ea86 100644 --- a/phpBB/phpbb/cron/task/core/prune_shadow_topics.php +++ b/phpBB/phpbb/cron/task/core/prune_shadow_topics.php @@ -43,7 +43,7 @@ class prune_shadow_topics extends \phpbb\cron\task\base implements \phpbb\cron\t  	* Constructor.  	*  	* @param string $phpbb_root_path The root path -	* @param string $php_ext The PHP extension +	* @param string $php_ext PHP file extension  	* @param \phpbb\config\config $config The config  	* @param \phpbb\db\driver\driver_interface $db The db connection  	* @param \phpbb\log\log $log The phpBB log system diff --git a/phpBB/phpbb/cron/task/core/queue.php b/phpBB/phpbb/cron/task/core/queue.php index 553e424bd0..796a96d7f5 100644 --- a/phpBB/phpbb/cron/task/core/queue.php +++ b/phpBB/phpbb/cron/task/core/queue.php @@ -26,7 +26,7 @@ class queue extends \phpbb\cron\task\base  	* Constructor.  	*  	* @param string $phpbb_root_path The root path -	* @param string $php_ext The PHP extension +	* @param string $php_ext PHP file extension  	* @param \phpbb\config\config $config The config  	*/  	public function __construct($phpbb_root_path, $php_ext, \phpbb\config\config $config) diff --git a/phpBB/phpbb/cron/task/core/tidy_database.php b/phpBB/phpbb/cron/task/core/tidy_database.php index ec058b4a50..949bba8012 100644 --- a/phpBB/phpbb/cron/task/core/tidy_database.php +++ b/phpBB/phpbb/cron/task/core/tidy_database.php @@ -26,7 +26,7 @@ class tidy_database extends \phpbb\cron\task\base  	* Constructor.  	*  	* @param string $phpbb_root_path The root path -	* @param string $php_ext The PHP extension +	* @param string $php_ext The PHP file extension  	* @param \phpbb\config\config $config The config  	*/  	public function __construct($phpbb_root_path, $php_ext, \phpbb\config\config $config) diff --git a/phpBB/phpbb/cron/task/core/tidy_search.php b/phpBB/phpbb/cron/task/core/tidy_search.php index 2c30274dfa..ce16b3f988 100644 --- a/phpBB/phpbb/cron/task/core/tidy_search.php +++ b/phpBB/phpbb/cron/task/core/tidy_search.php @@ -31,7 +31,7 @@ class tidy_search extends \phpbb\cron\task\base  	* Constructor.  	*  	* @param string $phpbb_root_path The root path -	* @param string $php_ext The PHP extension +	* @param string $php_ext The PHP file extension  	* @param \phpbb\auth\auth $auth The auth  	* @param \phpbb\config\config $config The config  	* @param \phpbb\db\driver\driver_interface $db The db connection diff --git a/phpBB/phpbb/cron/task/core/tidy_warnings.php b/phpBB/phpbb/cron/task/core/tidy_warnings.php index 058288222c..7b67eae6ef 100644 --- a/phpBB/phpbb/cron/task/core/tidy_warnings.php +++ b/phpBB/phpbb/cron/task/core/tidy_warnings.php @@ -28,7 +28,7 @@ class tidy_warnings extends \phpbb\cron\task\base  	* Constructor.  	*  	* @param string $phpbb_root_path The root path -	* @param string $php_ext The PHP extension +	* @param string $php_ext PHP file extension  	* @param \phpbb\config\config $config The config  	*/  	public function __construct($phpbb_root_path, $php_ext, \phpbb\config\config $config) diff --git a/phpBB/phpbb/cron/task/wrapper.php b/phpBB/phpbb/cron/task/wrapper.php index 11399282d3..8a4a8b1f0c 100644 --- a/phpBB/phpbb/cron/task/wrapper.php +++ b/phpBB/phpbb/cron/task/wrapper.php @@ -29,6 +29,8 @@ class wrapper  	* Wraps a task $task, which must implement cron_task interface.  	*  	* @param \phpbb\cron\task\task $task The cron task to wrap. +	* @param string $phpbb_root_path Relative path to phpBB root +	* @param string $php_ext PHP file extension  	*/  	public function __construct(\phpbb\cron\task\task $task, $phpbb_root_path, $php_ext)  	{ diff --git a/phpBB/phpbb/datetime.php b/phpBB/phpbb/datetime.php index 9c9292a8e4..e674707883 100644 --- a/phpBB/phpbb/datetime.php +++ b/phpBB/phpbb/datetime.php @@ -38,9 +38,9 @@ class datetime extends \DateTime  	* Constructs a new instance of \phpbb\datetime, expanded to include an argument to inject  	* the user context and modify the timezone to the users selected timezone if one is not set.  	* +	* @param user $user object for context.  	* @param string $time String in a format accepted by strtotime().  	* @param \DateTimeZone $timezone Time zone of the time. -	* @param user $user object for context.  	*/  	public function __construct($user, $time = 'now', \DateTimeZone $timezone = null)  	{ diff --git a/phpBB/phpbb/db/migration/tool/permission.php b/phpBB/phpbb/db/migration/tool/permission.php index d2df27613a..5cfbc5ca00 100644 --- a/phpBB/phpbb/db/migration/tool/permission.php +++ b/phpBB/phpbb/db/migration/tool/permission.php @@ -105,6 +105,7 @@ class permission implements \phpbb\db\migration\tool\tool_interface  	* @param string $auth_option The name of the permission (auth) option  	* @param bool $global True for checking a global permission setting,  	* 	False for a local permission setting +	* @param int|false $copy_from If set, contains the id of the permission from which to copy the new one.  	* @return null  	*/  	public function add($auth_option, $global = true, $copy_from = false) @@ -243,7 +244,9 @@ class permission implements \phpbb\db\migration\tool\tool_interface  	* Add a new permission role  	*  	* @param string $role_name The new role name -	* @param sting $role_type The type (u_, m_, a_) +	* @param string $role_type The type (u_, m_, a_) +	* @param string $role_description Description of the new role +	*  	* @return null  	*/  	public function role_add($role_name, $role_type, $role_description = '') diff --git a/phpBB/phpbb/event/kernel_request_subscriber.php b/phpBB/phpbb/event/kernel_request_subscriber.php index 323dabb84c..ee9f29a59d 100644 --- a/phpBB/phpbb/event/kernel_request_subscriber.php +++ b/phpBB/phpbb/event/kernel_request_subscriber.php @@ -28,7 +28,7 @@ class kernel_request_subscriber implements EventSubscriberInterface  	protected $manager;  	/** -	* PHP extension +	* PHP file extension  	* @var string  	*/  	protected $php_ext; @@ -44,7 +44,7 @@ class kernel_request_subscriber implements EventSubscriberInterface  	*  	* @param \phpbb\extension\manager $manager Extension manager object  	* @param string $root_path Root path -	* @param string $php_ext PHP extension +	* @param string $php_ext PHP file extension  	*/  	public function __construct(\phpbb\extension\manager $manager, $root_path, $php_ext)  	{ diff --git a/phpBB/phpbb/extension/base.php b/phpBB/phpbb/extension/base.php index cbbd7bc622..53051ce881 100644 --- a/phpBB/phpbb/extension/base.php +++ b/phpBB/phpbb/extension/base.php @@ -40,6 +40,7 @@ class base implements \phpbb\extension\extension_interface  	*  	* @param ContainerInterface $container Container object  	* @param \phpbb\finder $extension_finder +	* @param \phpbb\db\migrator $migrator  	* @param string $extension_name Name of this extension (from ext.manager)  	* @param string $extension_path Relative path to this extension  	*/ diff --git a/phpBB/phpbb/feed/helper.php b/phpBB/phpbb/feed/helper.php index 9741b752af..198134cdcf 100644 --- a/phpBB/phpbb/feed/helper.php +++ b/phpBB/phpbb/feed/helper.php @@ -36,7 +36,7 @@ class helper  	* @param	\phpbb\config\config	$config		Config object  	* @param	\phpbb\user		$user		User object  	* @param	string	$phpbb_root_path	Root path -	* @param	string	$phpEx				PHP extension +	* @param	string	$phpEx				PHP file extension  	*/  	public function __construct(\phpbb\config\config $config, \phpbb\user $user, $phpbb_root_path, $phpEx)  	{ diff --git a/phpBB/phpbb/mimetype/guesser.php b/phpBB/phpbb/mimetype/guesser.php index 87b164b561..773a1f822a 100644 --- a/phpBB/phpbb/mimetype/guesser.php +++ b/phpBB/phpbb/mimetype/guesser.php @@ -99,6 +99,7 @@ class guesser  	* Guess mimetype of supplied file  	*  	* @param string $file Path to file +	* @param string $file_name The real file name  	*  	* @return string Guess for mimetype of file  	*/ 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  	*/ diff --git a/phpBB/phpbb/path_helper.php b/phpBB/phpbb/path_helper.php index a8592eac6c..38dbbab51e 100644 --- a/phpBB/phpbb/path_helper.php +++ b/phpBB/phpbb/path_helper.php @@ -46,7 +46,7 @@ class path_helper  	* @param \phpbb\filesystem $filesystem  	* @param \phpbb\request\request_interface $request  	* @param string $phpbb_root_path Relative path to phpBB root -	* @param string $php_ext PHP extension (php) +	* @param string $php_ext PHP file extension  	* @param mixed $adm_relative_path Relative path admin path to adm/ root  	*/  	public function __construct(\phpbb\symfony_request $symfony_request, \phpbb\filesystem $filesystem, \phpbb\request\request_interface $request, $phpbb_root_path, $php_ext, $adm_relative_path = null) diff --git a/phpBB/phpbb/profilefields/type/type_interface.php b/phpBB/phpbb/profilefields/type/type_interface.php index 2dd13fa480..ec770f9467 100644 --- a/phpBB/phpbb/profilefields/type/type_interface.php +++ b/phpBB/phpbb/profilefields/type/type_interface.php @@ -189,8 +189,8 @@ interface type_interface  	/**  	* Allows manipulating the intended variables if needed  	* -	* @param string	$key			Name of the option  	* @param int	$step			Step on which the option is hidden +	* @param string	$key			Name of the option  	* @param string	$action			Currently performed action (create|edit)  	* @param array	$field_data		Array with data for this field  	* @return mixed		Final value of the option diff --git a/phpBB/phpbb/search/base.php b/phpBB/phpbb/search/base.php index 9395b6a273..30781975d8 100644 --- a/phpBB/phpbb/search/base.php +++ b/phpBB/phpbb/search/base.php @@ -85,8 +85,12 @@ class base  	/**  	* Retrieves cached search results  	* -	* @param int &$result_count will contain the number of all results for the search (not only for the current page) -	* @param array &$id_ary is filled with the ids belonging to the requested page that are stored in the cache +	* @param string $search_key		an md5 string generated from all the passed search options to identify the results +	* @param int	&$result_count	will contain the number of all results for the search (not only for the current page) +	* @param array 	&$id_ary 		is filled with the ids belonging to the requested page that are stored in the cache +	* @param int 	&$start			indicates the first index of the page +	* @param int 	$per_page		number of ids each page is supposed to contain +	* @param string $sort_dir		is either a or d representing ASC and DESC  	*  	* @return int SEARCH_RESULT_NOT_IN_CACHE or SEARCH_RESULT_IN_CACHE or SEARCH_RESULT_INCOMPLETE  	*/ @@ -160,8 +164,16 @@ class base  	/**  	* Caches post/topic ids  	* -	* @param array &$id_ary contains a list of post or topic ids that shall be cached, the first element +	* @param string $search_key		an md5 string generated from all the passed search options to identify the results +	* @param string $keywords 		contains the keywords as entered by the user +	* @param array	$author_ary		an array of author ids, if the author should be ignored during the search the array is empty +	* @param int 	$result_count	contains the number of all results for the search (not only for the current page) +	* @param array	&$id_ary 		contains a list of post or topic ids that shall be cached, the first element  	* 	must have the absolute index $start in the result set. +	* @param int	$start			indicates the first index of the page +	* @param string $sort_dir		is either a or d representing ASC and DESC +	* +	* @return null  	*/  	function save_ids($search_key, $keywords, $author_ary, $result_count, &$id_ary, $start, $sort_dir)  	{ diff --git a/phpBB/phpbb/search/fulltext_mysql.php b/phpBB/phpbb/search/fulltext_mysql.php index d4e7de31e5..1a0aba096f 100644 --- a/phpBB/phpbb/search/fulltext_mysql.php +++ b/phpBB/phpbb/search/fulltext_mysql.php @@ -73,6 +73,12 @@ class fulltext_mysql extends \phpbb\search\base  	 * Creates a new \phpbb\search\fulltext_mysql, which is used as a search backend  	 *  	 * @param string|bool $error Any error that occurs is passed on through this reference variable otherwise false +	 * @param string $phpbb_root_path Relative path to phpBB root +	 * @param string $phpEx PHP file extension +	 * @param \phpbb\auth\auth $auth Auth object +	 * @param \phpbb\config\config $config Config object +	 * @param \phpbb\db\driver\driver_interface Database object +	 * @param \phpbb\user $user User object  	 */  	public function __construct(&$error, $phpbb_root_path, $phpEx, $auth, $config, $db, $user)  	{ diff --git a/phpBB/phpbb/search/fulltext_postgres.php b/phpBB/phpbb/search/fulltext_postgres.php index b3e7f51f87..b6af371d13 100644 --- a/phpBB/phpbb/search/fulltext_postgres.php +++ b/phpBB/phpbb/search/fulltext_postgres.php @@ -86,6 +86,12 @@ class fulltext_postgres extends \phpbb\search\base  	 * Creates a new \phpbb\search\fulltext_postgres, which is used as a search backend  	 *  	 * @param string|bool $error Any error that occurs is passed on through this reference variable otherwise false +	 * @param string $phpbb_root_path Relative path to phpBB root +	 * @param string $phpEx PHP file extension +	 * @param \phpbb\auth\auth $auth Auth object +	 * @param \phpbb\config\config $config Config object +	 * @param \phpbb\db\driver\driver_interface Database object +	 * @param \phpbb\user $user User object  	 */  	public function __construct(&$error, $phpbb_root_path, $phpEx, $auth, $config, $db, $user)  	{ diff --git a/phpBB/phpbb/search/fulltext_sphinx.php b/phpBB/phpbb/search/fulltext_sphinx.php index 78c11f1180..79d68d2ae1 100644 --- a/phpBB/phpbb/search/fulltext_sphinx.php +++ b/phpBB/phpbb/search/fulltext_sphinx.php @@ -119,6 +119,12 @@ class fulltext_sphinx  	 * Creates a new \phpbb\search\fulltext_postgres, which is used as a search backend  	 *  	 * @param string|bool $error Any error that occurs is passed on through this reference variable otherwise false +	 * @param string $phpbb_root_path Relative path to phpBB root +	 * @param string $phpEx PHP file extension +	 * @param \phpbb\auth\auth $auth Auth object +	 * @param \phpbb\config\config $config Config object +	 * @param \phpbb\db\driver\driver_interface Database object +	 * @param \phpbb\user $user User object  	 */  	public function __construct(&$error, $phpbb_root_path, $phpEx, $auth, $config, $db, $user)  	{ diff --git a/phpBB/phpbb/session.php b/phpBB/phpbb/session.php index 59b7ec2029..5a0d7c0031 100644 --- a/phpBB/phpbb/session.php +++ b/phpBB/phpbb/session.php @@ -1062,11 +1062,13 @@ class session  	* Check for banned user  	*  	* Checks whether the supplied user is banned by id, ip or email. If no parameters -	* are passed to the method pre-existing session data is used. If $return is false -	* this routine does not return on finding a banned user, it outputs a relevant -	* message and stops execution. +	* are passed to the method pre-existing session data is used.  	* -	* @param string|array	$user_ips	Can contain a string with one IP or an array of multiple IPs +	* @param int|false		$user_id		The user id +	* @param mixed			$user_ips		Can contain a string with one IP or an array of multiple IPs +	* @param string|false	$user_email		The user email +	* @param bool			$return			If $return is false this routine does not return on finding a banned user, +	*	it outputs a relevant message and stops execution.  	*/  	function check_ban($user_id = false, $user_ips = false, $user_email = false, $return = false)  	{ @@ -1254,12 +1256,14 @@ class session  	/**  	* Check if ip is blacklisted -	* This should be called only where absolutly necessary +	* This should be called only where absolutely necessary  	*  	* Only IPv4 (rbldns does not support AAAA records/IPv6 lookups)  	*  	* @author satmd (from the php manual) -	* @param string $mode register/post - spamcop for example is ommitted for posting +	* @param string 		$mode	register/post - spamcop for example is ommitted for posting +	* @param string|false	$ip		the IPv4 address to check +	*  	* @return false if ip is not blacklisted, else an array([checked server], [lookup])  	*/  	function check_dnsbl($mode, $ip = false) diff --git a/phpBB/phpbb/template/asset.php b/phpBB/phpbb/template/asset.php index 5a01ee3a93..67dbd7b357 100644 --- a/phpBB/phpbb/template/asset.php +++ b/phpBB/phpbb/template/asset.php @@ -24,6 +24,7 @@ class asset  	* Constructor  	*  	* @param string $url URL +	* @param \phpbb\path_helper $path_helper Path helper object  	*/  	public function __construct($url, \phpbb\path_helper $path_helper)  	{ diff --git a/phpBB/phpbb/template/twig/definition.php b/phpBB/phpbb/template/twig/definition.php index 39653f6d26..cb3c953692 100644 --- a/phpBB/phpbb/template/twig/definition.php +++ b/phpBB/phpbb/template/twig/definition.php @@ -25,6 +25,8 @@ class definition  	* Get a DEFINE'd variable  	*  	* @param string $name +	* @param array $arguments +	*  	* @return mixed Null if not found  	*/  	public function __call($name, $arguments) diff --git a/phpBB/phpbb/template/twig/environment.php b/phpBB/phpbb/template/twig/environment.php index 8d25153e14..476ffd935e 100644 --- a/phpBB/phpbb/template/twig/environment.php +++ b/phpBB/phpbb/template/twig/environment.php @@ -36,11 +36,10 @@ class environment extends \Twig_Environment  	/**  	* Constructor  	* -	* @param \phpbb\config\config $phpbb_config -	* @param \phpbb\path_helper -	* @param \phpbb\extension\manager -	* @param string $phpbb_root_path -	* @param \Twig_LoaderInterface $loader +	* @param \phpbb\config\config $phpbb_config The phpBB configuration +	* @param \phpbb\path_helper $path_helper phpBB path helper +	* @param \phpbb\extension\manager $extension_manager phpBB extension manager +	* @param \Twig_LoaderInterface $loader Twig loader interface  	* @param array $options Array of options to pass to Twig  	*/  	public function __construct($phpbb_config, \phpbb\path_helper $path_helper, \phpbb\extension\manager $extension_manager = null, \Twig_LoaderInterface $loader = null, $options = array()) diff --git a/phpBB/phpbb/template/twig/extension.php b/phpBB/phpbb/template/twig/extension.php index 8f523684dd..3a983491b9 100644 --- a/phpBB/phpbb/template/twig/extension.php +++ b/phpBB/phpbb/template/twig/extension.php @@ -162,7 +162,6 @@ class extension extends \Twig_Extension  	* (e.g. in the ACP, L_TITLE)  	* If not, we return the result of $user->lang()  	* -	* @param string $lang name  	* @return string  	*/  	function lang() diff --git a/phpBB/phpbb/tree/tree_interface.php b/phpBB/phpbb/tree/tree_interface.php index 8238a072ff..5df01a89cf 100644 --- a/phpBB/phpbb/tree/tree_interface.php +++ b/phpBB/phpbb/tree/tree_interface.php @@ -18,7 +18,7 @@ interface tree_interface  	/**  	* Inserts an item into the database table and into the tree.  	* -	* @param array	$item	The item to be added +	* @param array	$additional_data	The item to be added  	* @return array Array with item data as set in the database  	*/  	public function insert(array $additional_data); | 
