Merge branch 'develop-ascraeus' into develop

* develop-ascraeus: (30 commits)
  [ticket/12715] Add missing new line in the notification manager
  [ticket/12715] Cleanup comments in \phpbb\symfony_request
  [ticket/12715] Cleanup comments in \phpbb\permissions
  [ticket/12715] Cleanup comments in \phpbb\path_helper
  [ticket/12715] Cleanup comments in \phpbb\pagination
  [ticket/12715] Cleanup comments in \phpbb\datetime
  [ticket/12715] Cleanup comments in \phpbb\content_visibility
  [ticket/12715] Cleanup comments in \phpbb\tree\*
  [ticket/12715] Cleanup comments in \phpbb\template\*
  [ticket/12715] Cleanup comments in \phpbb\plupload\*
  [ticket/12715] Cleanup comments in \phpbb\profilefields\*
  [ticket/12715] Cleanup comments in \phpbb\passwords\*
  [ticket/12715] Cleanup comments in \phpbb\notification\*
  [ticket/12715] Cleanup comments in \phpbb\mimetype\*
  [ticket/12715] Cleanup comments in \phpbb\message\*
  [ticket/12715] Cleanup comments in \phpbb\log\*
  [ticket/12715] Cleanup comments in \phpbb\lock\*
  [ticket/12715] Cleanup comments in \phpbb\groupposition\*
  [ticket/12715] Cleanup comments in \phpbb\feed\*
  [ticket/12715] Cleanup comments in \phpbb\extension\*
  ...
This commit is contained in:
Andreas Fischer 2014-06-16 01:12:04 +02:00
commit fbbd835b2c
102 changed files with 521 additions and 402 deletions

View file

@ -14,7 +14,6 @@
namespace phpbb\auth\provider\oauth;
use OAuth\Common\Consumer\Credentials;
use OAuth\Common\Http\Uri\Uri;
/**
* OAuth authentication provider for phpBB3
@ -224,7 +223,7 @@ class oauth extends \phpbb\auth\provider\base
if (!$row)
{
throw new Exception('AUTH_PROVIDER_OAUTH_ERROR_INVALID_ENTRY');
throw new \Exception('AUTH_PROVIDER_OAUTH_ERROR_INVALID_ENTRY');
}
// Update token storage to store the user_id
@ -278,9 +277,10 @@ class oauth extends \phpbb\auth\provider\base
* @param array $service_credentials {@see \phpbb\auth\provider\oauth\oauth::get_service_credentials}
* @param string $query The query string of the
* current_uri used in redirection
* @param array $scope The scope of the request against
* @param array $scopes The scope of the request against
* the api.
* @return \OAuth\Common\Service\ServiceInterface
* @throws \Exception
*/
protected function get_service($service_name, \phpbb\auth\provider\oauth\token_storage $storage, array $service_credentials, $query, array $scopes = array())
{
@ -298,7 +298,7 @@ class oauth extends \phpbb\auth\provider\base
if (!$service)
{
throw new Exception('AUTH_PROVIDER_OAUTH_ERROR_SERVICE_NOT_CREATED');
throw new \Exception('AUTH_PROVIDER_OAUTH_ERROR_SERVICE_NOT_CREATED');
}
return $service;
@ -617,7 +617,5 @@ class oauth extends \phpbb\auth\provider\base
$service_name = 'auth.provider.oauth.service.' . strtolower($link_data['oauth_service']);
$storage = new \phpbb\auth\provider\oauth\token_storage($this->db, $this->user, $this->auth_provider_oauth_token_storage_table);
$storage->clearToken($service_name);
return;
}
}

View file

@ -21,22 +21,22 @@ class facebook extends base
/**
* phpBB config
*
* @var phpbb\config\config
* @var \phpbb\config\config
*/
protected $config;
/**
* phpBB request
*
* @var phpbb\request\request_interface
* @var \phpbb\request\request_interface
*/
protected $request;
/**
* Constructor
*
* @param phpbb\config\config $config
* @param phpbb\request\request_interface $request
* @param \phpbb\config\config $config
* @param \phpbb\request\request_interface $request
*/
public function __construct(\phpbb\config\config $config, \phpbb\request\request_interface $request)
{

View file

@ -21,22 +21,22 @@ class google extends base
/**
* phpBB config
*
* @var phpbb\config\config
* @var \phpbb\config\config
*/
protected $config;
/**
* phpBB request
*
* @var phpbb\request\request_interface
* @var \phpbb\request\request_interface
*/
protected $request;
/**
* Constructor
*
* @param phpbb\config\config $config
* @param phpbb\request\request_interface $request
* @param \phpbb\config\config $config
* @param \phpbb\request\request_interface $request
*/
public function __construct(\phpbb\config\config $config, \phpbb\request\request_interface $request)
{

View file

@ -67,7 +67,7 @@ interface service_interface
/**
* Sets the external library service provider
*
* @param \OAuth\Common\Service\ServiceInterface $service
* @param \OAuth\Common\Service\ServiceInterface $service_provider
*/
public function set_external_service_provider(\OAuth\Common\Service\ServiceInterface $service_provider);
}

View file

@ -17,7 +17,6 @@ namespace phpbb\auth\provider\oauth;
use OAuth\OAuth1\Token\StdOAuth1Token;
use OAuth\Common\Token\TokenInterface;
use OAuth\Common\Storage\TokenStorageInterface;
use OAuth\Common\Storage\Exception\StorageException;
use OAuth\Common\Storage\Exception\TokenNotFoundException;
/**
@ -198,6 +197,7 @@ class token_storage implements TokenStorageInterface
/**
* Checks to see if an access token exists solely by the session_id of the user
*
* @param string $service The name of the OAuth service
* @return bool true if they have token, false if they don't
*/
public function has_access_token_by_session($service)
@ -250,6 +250,7 @@ class token_storage implements TokenStorageInterface
*
* @param array $data
* @return mixed
* @throws \OAuth\Common\Storage\Exception\TokenNotFoundException
*/
protected function _retrieve_access_token($data)
{

View file

@ -148,7 +148,7 @@ interface provider_interface
* user_id of an account needed to successfully link an external account to
* a forum account.
*
* @param array $link_data Any data needed to link a phpBB account to
* @param array $login_link_data Any data needed to link a phpBB account to
* an external account.
* @return string|null Returns a string with a language constant if there
* is data missing or null if there is no error.

View file

@ -73,10 +73,9 @@ abstract class driver implements \phpbb\avatar\driver\driver_interface
* Construct a driver object
*
* @param \phpbb\config\config $config phpBB configuration
* @param \phpbb\request\request $request Request object
* @param string $phpbb_root_path Path to the phpBB root
* @param string $php_ext PHP file extension
* @param \phpbb_path_helper $path_helper phpBB path helper
* @param \phpbb\path_helper $path_helper phpBB path helper
* @param \phpbb\cache\driver\driver_interface $cache Cache driver
*/
public function __construct(\phpbb\config\config $config, $phpbb_root_path, $php_ext, \phpbb\path_helper $path_helper, \phpbb\cache\driver\driver_interface $cache = null)
@ -89,7 +88,7 @@ abstract class driver implements \phpbb\avatar\driver\driver_interface
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function get_custom_html($user, $row, $alt = '')
{
@ -97,7 +96,7 @@ abstract class driver implements \phpbb\avatar\driver\driver_interface
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function prepare_form_acp($user)
{
@ -105,7 +104,7 @@ abstract class driver implements \phpbb\avatar\driver\driver_interface
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function delete($row)
{
@ -113,7 +112,7 @@ abstract class driver implements \phpbb\avatar\driver\driver_interface
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function get_name()
{

View file

@ -24,7 +24,7 @@ class gravatar extends \phpbb\avatar\driver\driver
const GRAVATAR_URL = '//secure.gravatar.com/avatar/';
/**
* @inheritdoc
* {@inheritdoc}
*/
public function get_data($row)
{
@ -36,7 +36,7 @@ class gravatar extends \phpbb\avatar\driver\driver
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function get_custom_html($user, $row, $alt = '')
{
@ -47,7 +47,7 @@ class gravatar extends \phpbb\avatar\driver\driver
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function prepare_form($request, $template, $user, $row, &$error)
{
@ -61,7 +61,7 @@ class gravatar extends \phpbb\avatar\driver\driver
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function process_form($request, $template, $user, $row, &$error)
{
@ -151,7 +151,7 @@ class gravatar extends \phpbb\avatar\driver\driver
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function get_template_name()
{
@ -161,6 +161,8 @@ class gravatar extends \phpbb\avatar\driver\driver
/**
* Build gravatar URL for output on page
*
* @param array $row User data or group data that has been cleaned with
* \phpbb\avatar\manager::clean_row
* @return string Gravatar URL
*/
protected function get_gravatar_url($row)

View file

@ -19,7 +19,7 @@ namespace phpbb\avatar\driver;
class local extends \phpbb\avatar\driver\driver
{
/**
* @inheritdoc
* {@inheritdoc}
*/
public function get_data($row)
{
@ -31,7 +31,7 @@ class local extends \phpbb\avatar\driver\driver
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function prepare_form($request, $template, $user, $row, &$error)
{
@ -99,7 +99,7 @@ class local extends \phpbb\avatar\driver\driver
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function prepare_form_acp($user)
{
@ -109,7 +109,7 @@ class local extends \phpbb\avatar\driver\driver
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function process_form($request, $template, $user, $row, &$error)
{
@ -138,7 +138,7 @@ class local extends \phpbb\avatar\driver\driver
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function get_template_name()
{

View file

@ -19,7 +19,7 @@ namespace phpbb\avatar\driver;
class remote extends \phpbb\avatar\driver\driver
{
/**
* @inheritdoc
* {@inheritdoc}
*/
public function get_data($row)
{
@ -31,7 +31,7 @@ class remote extends \phpbb\avatar\driver\driver
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function prepare_form($request, $template, $user, $row, &$error)
{
@ -45,7 +45,7 @@ class remote extends \phpbb\avatar\driver\driver
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function process_form($request, $template, $user, $row, &$error)
{
@ -191,7 +191,7 @@ class remote extends \phpbb\avatar\driver\driver
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function get_template_name()
{

View file

@ -19,7 +19,7 @@ namespace phpbb\avatar\driver;
class upload extends \phpbb\avatar\driver\driver
{
/**
* @inheritdoc
* {@inheritdoc}
*/
public function get_data($row, $ignore_config = false)
{
@ -31,7 +31,7 @@ class upload extends \phpbb\avatar\driver\driver
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function prepare_form($request, $template, $user, $row, &$error)
{
@ -49,7 +49,7 @@ class upload extends \phpbb\avatar\driver\driver
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function process_form($request, $template, $user, $row, &$error)
{
@ -143,7 +143,7 @@ class upload extends \phpbb\avatar\driver\driver
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function prepare_form_acp($user)
{
@ -155,7 +155,7 @@ class upload extends \phpbb\avatar\driver\driver
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function delete($row)
{
@ -171,7 +171,7 @@ class upload extends \phpbb\avatar\driver\driver
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function get_template_name()
{

View file

@ -142,7 +142,7 @@ interface driver_interface
* Fetch a field from the current row of a cached database result (database)
*
* @param int $query_id
* @param $field The name of the column.
* @param string $field The name of the column.
* @return string|bool The field of the query result if found in the cache,
* otherwise false.
*/

View file

@ -28,6 +28,8 @@ class file extends \phpbb\cache\driver\base
/**
* Set cache path
*
* @param string $cache_dir Define the path to the cache directory (default: $phpbb_root_path . 'cache/')
*/
function __construct($cache_dir = null)
{

View file

@ -35,6 +35,16 @@ class purge extends \phpbb\console\command\command
/** @var \phpbb\config\config */
protected $config;
/**
* Constructor
*
* @param \phpbb\cache\driver\driver_interface $cache Cache instance
* @param \phpbb\db\driver\driver_interface $db Database connection
* @param \phpbb\auth\auth $auth Auth instance
* @param \phpbb\log\log $log Logger instance
* @param \phpbb\user $user User instance
* @param \phpbb\config\config $config Config instance
*/
public function __construct(\phpbb\cache\driver\driver_interface $cache, \phpbb\db\driver\driver_interface $db, \phpbb\auth\auth $auth, \phpbb\log\log $log, \phpbb\user $user, \phpbb\config\config $config)
{
$this->cache = $cache;
@ -46,6 +56,9 @@ class purge extends \phpbb\console\command\command
parent::__construct();
}
/**
* {@inheritdoc}
*/
protected function configure()
{
$this
@ -54,6 +67,16 @@ class purge extends \phpbb\console\command\command
;
}
/**
* Executes the command cache:purge.
*
* Purge the cache (including permissions) and increment the asset_version number
*
* @param InputInterface $input An InputInterface instance
* @param OutputInterface $output An OutputInterface instance
*
* @return null
*/
protected function execute(InputInterface $input, OutputInterface $output)
{
$this->config->increment('assets_version', 1);

View file

@ -14,11 +14,13 @@ namespace phpbb\console\command\config;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
class delete extends command
{
/**
* {@inheritdoc}
*/
protected function configure()
{
$this
@ -32,6 +34,17 @@ class delete extends command
;
}
/**
* Executes the command config:delete.
*
* Removes a configuration option
*
* @param InputInterface $input An InputInterface instance
* @param OutputInterface $output An OutputInterface instance
*
* @return null
* @see \phpbb\config\config::delete()
*/
protected function execute(InputInterface $input, OutputInterface $output)
{
$key = $input->getArgument('key');

View file

@ -19,6 +19,9 @@ use Symfony\Component\Console\Output\OutputInterface;
class get extends command
{
/**
* {@inheritdoc}
*/
protected function configure()
{
$this
@ -38,6 +41,17 @@ class get extends command
;
}
/**
* Executes the command config:get.
*
* Retrieves a configuration value.
*
* @param InputInterface $input An InputInterface instance
* @param OutputInterface $output An OutputInterface instance
*
* @return null
* @see \phpbb\config\config::offsetGet()
*/
protected function execute(InputInterface $input, OutputInterface $output)
{
$key = $input->getArgument('key');

View file

@ -19,6 +19,9 @@ use Symfony\Component\Console\Output\OutputInterface;
class increment extends command
{
/**
* {@inheritdoc}
*/
protected function configure()
{
$this
@ -43,6 +46,17 @@ class increment extends command
;
}
/**
* Executes the command config:increment.
*
* Increments an integer configuration value.
*
* @param InputInterface $input An InputInterface instance
* @param OutputInterface $output An OutputInterface instance
*
* @return null
* @see \phpbb\config\config::increment()
*/
protected function execute(InputInterface $input, OutputInterface $output)
{
$key = $input->getArgument('key');

View file

@ -19,6 +19,9 @@ use Symfony\Component\Console\Output\OutputInterface;
class set extends command
{
/**
* {@inheritdoc}
*/
protected function configure()
{
$this
@ -43,6 +46,17 @@ class set extends command
;
}
/**
* Executes the command config:set.
*
* Sets a configuration option's value.
*
* @param InputInterface $input An InputInterface instance
* @param OutputInterface $output An OutputInterface instance
*
* @return null
* @see \phpbb\config\config::set()
*/
protected function execute(InputInterface $input, OutputInterface $output)
{
$key = $input->getArgument('key');

View file

@ -19,6 +19,9 @@ use Symfony\Component\Console\Output\OutputInterface;
class set_atomic extends command
{
/**
* {@inheritdoc}
*/
protected function configure()
{
$this
@ -48,6 +51,18 @@ class set_atomic extends command
;
}
/**
* Executes the command config:set-atomic.
*
* Sets a configuration option's value only if the old_value matches the
* current configuration value or the configuration value does not exist yet.
*
* @param InputInterface $input An InputInterface instance
* @param OutputInterface $output An OutputInterface instance
*
* @return bool True if the value was changed, false otherwise.
* @see \phpbb\config\config::set_atomic()
*/
protected function execute(InputInterface $input, OutputInterface $output)
{
$key = $input->getArgument('key');

View file

@ -23,6 +23,12 @@ class cron_list extends \phpbb\console\command\command
/** @var \phpbb\user */
protected $user;
/**
* Constructor
*
* @param \phpbb\cron\manager $cron_manager Cron manager
* @param \phpbb\user $user User instance
*/
public function __construct(\phpbb\cron\manager $cron_manager, \phpbb\user $user)
{
$this->cron_manager = $cron_manager;
@ -30,6 +36,9 @@ class cron_list extends \phpbb\console\command\command
parent::__construct();
}
/**
* {@inheritdoc}
*/
protected function configure()
{
$this
@ -38,6 +47,16 @@ class cron_list extends \phpbb\console\command\command
;
}
/**
* Executes the command cron:list.
*
* Prints a list of ready and unready cron jobs.
*
* @param InputInterface $input An InputInterface instance
* @param OutputInterface $output An OutputInterface instance
*
* @return null
*/
protected function execute(InputInterface $input, OutputInterface $output)
{
$tasks = $this->cron_manager->get_tasks();
@ -80,6 +99,12 @@ class cron_list extends \phpbb\console\command\command
}
}
/**
* Print a list of cron jobs
*
* @param array $tasks A list of task to display
* @param OutputInterface $output An OutputInterface instance
*/
protected function print_tasks_names(array $tasks, OutputInterface $output)
{
foreach ($tasks as $task)

View file

@ -15,7 +15,6 @@ namespace phpbb\console\command\cron;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
class run extends \phpbb\console\command\command
@ -35,7 +34,7 @@ class run extends \phpbb\console\command\command
* @param \phpbb\cron\manager $cron_manager The cron manager containing
* the cron tasks to be executed.
* @param \phpbb\lock\db $lock_db The lock for accessing database.
* @param \phobb\user $user The user object (used to get language information)
* @param \phpbb\user $user The user object (used to get language information)
*/
public function __construct(\phpbb\cron\manager $cron_manager, \phpbb\lock\db $lock_db, \phpbb\user $user)
{
@ -102,7 +101,7 @@ class run extends \phpbb\console\command\command
}
}
/*
/**
* Executes all ready cron tasks.
*
* If verbose mode is set, an info message will be printed if there is no task to
@ -140,7 +139,7 @@ class run extends \phpbb\console\command\command
return 0;
}
/*
/**
* Executes a given cron task, if it is ready.
*
* If there is a task whose name matches $task_name, it is run and 0 is returned.

View file

@ -57,7 +57,10 @@ class content_visibility
* @param \phpbb\user $user User object
* @param string $phpbb_root_path Root path
* @param string $php_ext PHP Extension
* @return null
* @param string $forums_table Forums table name
* @param string $posts_table Posts table name
* @param string $topics_table Topics table name
* @param string $users_table Users table name
*/
public function __construct(\phpbb\auth\auth $auth, \phpbb\db\driver\driver_interface $db, \phpbb\user $user, $phpbb_root_path, $php_ext, $forums_table, $posts_table, $topics_table, $users_table)
{

View file

@ -101,7 +101,7 @@ class helper
* @param string $route Name of the route to travel
* @param array $params String or array of additional url parameters
* @param bool $is_amp Is url using & (true) or & (false)
* @param string $session_id Possibility to use a custom session id instead of the global one
* @param string|bool $session_id Possibility to use a custom session id instead of the global one
* @return string The URL already passed through append_sid()
*/
public function route($route, array $params = array(), $is_amp = true, $session_id = false)
@ -139,8 +139,8 @@ class helper
* Output an error, effectively the same thing as trigger_error
*
* @param string $message The error message
* @param string $code The error code (e.g. 404, 500, 503, etc.)
* @return Response A Reponse instance
* @param int $code The error code (e.g. 404, 500, 503, etc.)
* @return Response A Response instance
*/
public function error($message, $code = 500)
{

View file

@ -37,7 +37,7 @@ class provider
/**
* Construct method
*
* @param array() $routing_files Array of strings containing paths
* @param array $routing_files Array of strings containing paths
* to YAML files holding route information
*/
public function __construct($routing_files = array())
@ -46,6 +46,8 @@ class provider
}
/**
* Find the list of routing files
*
* @param \phpbb\finder $finder
* @return null
*/
@ -61,10 +63,10 @@ class provider
}
/**
* Find a list of controllers and return it
* Find a list of controllers
*
* @param string $base_path Base path to prepend to file paths
* @return null
* @return provider
*/
public function find($base_path = '')
{

View file

@ -122,7 +122,7 @@ class resolver implements ControllerResolverInterface
*
* @param \Symfony\Component\HttpFoundation\Request $request Symfony Request object
* @param mixed $controller A callable (controller class, method)
* @return bool False
* @return array An array of arguments to pass to the controller
* @throws \phpbb\controller\exception
*/
public function getArguments(Request $request, $controller)

View file

@ -34,7 +34,7 @@ class manager
/**
* Constructor. Loads all available tasks.
*
* @param array|Traversable $tasks Provides an iterable set of task names
* @param array|\Traversable $tasks Provides an iterable set of task names
*/
public function __construct($tasks, $phpbb_root_path, $php_ext)
{
@ -48,7 +48,7 @@ class manager
* Loads tasks given by name, wraps them
* and puts them into $this->tasks.
*
* @param array|Traversable $tasks Array of instances of \phpbb\cron\task\task
* @param array|\Traversable $tasks Array of instances of \phpbb\cron\task\task
*
* @return null
*/

View file

@ -164,6 +164,7 @@ class prune_shadow_topics extends \phpbb\cron\task\base implements \phpbb\cron\t
* @param int $forum_id Forum ID of forum that should be pruned
* @param string $prune_mode Prune mode
* @param int $prune_flags Prune flags
* @param int $prune_days Prune date in days
* @param int $prune_freq Prune frequency
* @return null
*/

View file

@ -39,8 +39,8 @@ class datetime extends \DateTime
* the user context and modify the timezone to the users selected timezone if one is not set.
*
* @param string $time String in a format accepted by strtotime().
* @param DateTimeZone $timezone Time zone of the time.
* @param user User object for context.
* @param \DateTimeZone $timezone Time zone of the time.
* @param user $user object for context.
*/
public function __construct($user, $time = 'now', \DateTimeZone $timezone = null)
{
@ -120,7 +120,7 @@ class datetime extends \DateTime
/**
* Magic method to convert DateTime object to string
*
* @return Formatted date time, according to the users default settings.
* @return string Formatted date time, according to the users default settings.
*/
public function __toString()
{

View file

@ -217,7 +217,7 @@ class schema_generator
* Check if one of the migrations files' dependencies can't be resolved
* by the supplied list of migrations
*
* @throws UnexpectedValueException If a dependency can't be resolved
* @throws \UnexpectedValueException If a dependency can't be resolved
*/
protected function check_dependencies()
{

View file

@ -66,6 +66,7 @@ class config implements \phpbb\db\migration\tool\tool_interface
* like to update
* @param mixed $config_value The value of the config setting
* @return null
* @throws \phpbb\db\migration\exception
*/
public function update($config_name, $config_value)
{
@ -87,6 +88,7 @@ class config implements \phpbb\db\migration\tool\tool_interface
* like to update
* @param mixed $config_value The value of the config setting
* @return null
* @throws \phpbb\db\migration\exception
*/
public function update_if_equals($compare, $config_name, $config_value)
{

View file

@ -167,6 +167,7 @@ class module implements \phpbb\db\migration\tool\tool_interface
* modules in that info file.
* path, specify that here
* @return null
* @throws \phpbb\db\migration\exception
*/
public function add($class, $parent = 0, $data = array())
{
@ -331,6 +332,7 @@ class module implements \phpbb\db\migration\tool\tool_interface
* @param int|string $module The module id|module_langname
* specify that here
* @return null
* @throws \phpbb\db\migration\exception
*/
public function remove($class, $parent = 0, $module = '')
{
@ -466,6 +468,7 @@ class module implements \phpbb\db\migration\tool\tool_interface
* @param string $class Module Class
* @param string $basename Module Basename
* @return array Module Information
* @throws \phpbb\db\migration\exception
*/
protected function get_module_info($class, $basename)
{

View file

@ -283,6 +283,7 @@ class permission implements \phpbb\db\migration\tool\tool_interface
* @param string $old_role_name The old role name
* @param string $new_role_name The new role name
* @return null
* @throws \phpbb\db\migration\exception
*/
public function role_update($old_role_name, $new_role_name)
{
@ -345,6 +346,7 @@ class permission implements \phpbb\db\migration\tool\tool_interface
* @param bool $has_permission True if you want to give them permission,
* false if you want to deny them permission
* @return null
* @throws \phpbb\db\migration\exception
*/
public function permission_set($name, $auth_option, $type = 'role', $has_permission = true)
{
@ -490,6 +492,7 @@ class permission implements \phpbb\db\migration\tool\tool_interface
* auth_options you would like to set
* @param string $type The type (role|group)
* @return null
* @throws \phpbb\db\migration\exception
*/
public function permission_unset($name, $auth_option, $type = 'role')
{

View file

@ -167,8 +167,9 @@ class migrator
/**
* Attempts to apply a step of the given migration or one of its dependencies
*
* @param string The class name of the migration
* @param string $name The class name of the migration
* @return bool Whether any update step was successfully run
* @throws \phpbb\db\migration\exception
*/
protected function try_apply($name)
{
@ -302,7 +303,7 @@ class migrator
/**
* Attempts to revert a step of the given migration or one of its dependencies
*
* @param string The class name of the migration
* @param string $name The class name of the migration
* @return bool Whether any update step was successfully run
*/
protected function try_revert($name)
@ -368,6 +369,7 @@ class migrator
* @param bool|string $state Current state of the migration
* @param bool $revert true to revert a data step
* @return bool|string migration state. True if completed, serialized array if not finished
* @throws \phpbb\db\migration\exception
*/
protected function process_data_step($steps, $state, $revert = false)
{
@ -464,6 +466,7 @@ class migrator
* @param mixed $last_result Result to pass to the callable (only for 'custom' method)
* @param bool $reverse False to install, True to attempt uninstallation by reversing the call
* @return array Array with parameters for call_user_func_array(), 0 is the callable, 1 is parameters
* @throws \phpbb\db\migration\exception
*/
protected function get_callable_from_step(array $step, $last_result = 0, $reverse = false)
{
@ -722,6 +725,7 @@ class migrator
* to prevent errors (if including multiple directories, check
* with the last call to prevent throwing errors unnecessarily).
* @return array Array of migration names
* @throws \phpbb\db\migration\exception
*/
public function load_migrations(\phpbb\finder $finder, $path, $check_fulfillable = true)
{

View file

@ -15,8 +15,6 @@ namespace phpbb\di\extension;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\HttpKernel\DependencyInjection\Extension;
use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
use Symfony\Component\Config\FileLocator;
/**
* Container config extension
@ -34,7 +32,7 @@ class config extends Extension
* @param array $config An array of configuration values
* @param ContainerBuilder $container A ContainerBuilder instance
*
* @throws InvalidArgumentException When provided tag is not defined in this extension
* @throws \InvalidArgumentException When provided tag is not defined in this extension
*/
public function load(array $config, ContainerBuilder $container)
{
@ -68,7 +66,7 @@ class config extends Extension
* Convert 3.0 ACM type to 3.1 cache driver class name
*
* @param string $acm_type ACM type
* @return cache driver class
* @return string cache driver class
*/
protected function convert_30_acm_type($acm_type)
{

View file

@ -45,7 +45,7 @@ class core extends Extension
* @param array $config An array of configuration values
* @param ContainerBuilder $container A ContainerBuilder instance
*
* @throws InvalidArgumentException When provided tag is not defined in this extension
* @throws \InvalidArgumentException When provided tag is not defined in this extension
*/
public function load(array $config, ContainerBuilder $container)
{

View file

@ -39,7 +39,7 @@ class ext extends Extension
* @param array $config An array of configuration values
* @param ContainerBuilder $container A ContainerBuilder instance
*
* @throws InvalidArgumentException When provided tag is not defined in this extension
* @throws \InvalidArgumentException When provided tag is not defined in this extension
*/
public function load(array $config, ContainerBuilder $container)
{

View file

@ -23,6 +23,7 @@ class kernel_pass implements CompilerPassInterface
*
* @param ContainerBuilder $container ContainerBuilder object
* @return null
* @throws \InvalidArgumentException
*/
public function process(ContainerBuilder $container)
{

View file

@ -148,7 +148,7 @@ class manager
* Instantiates the metadata manager for the extension with the given name
*
* @param string $name The extension name
* @param string $template The template manager
* @param \phpbb\template\template $template The template manager
* @return \phpbb\extension\metadata_manager Instance of the metadata manager
*/
public function create_extension_metadata_manager($name, \phpbb\template\template $template)

View file

@ -138,7 +138,7 @@ class metadata_manager
/**
* Sets the filepath of the metadata file
*
* @return boolean Set to true if it exists, throws an exception on failure
* @throws \phpbb\extension\exception
*/
private function set_metadata_file()
{
@ -157,6 +157,7 @@ class metadata_manager
* Gets the contents of the composer.json file
*
* @return bool True if success, throws an exception on failure
* @throws \phpbb\extension\exception
*/
private function fetch_metadata()
{
@ -199,6 +200,7 @@ class metadata_manager
* "display" for name, type, and authors
* "name", "type")
* @return Bool True if valid, throws an exception if invalid
* @throws \phpbb\extension\exception
*/
public function validate($name = 'display')
{
@ -250,6 +252,7 @@ class metadata_manager
* Validates the contents of the authors field
*
* @return boolean True when passes validation, throws exception if invalid
* @throws \phpbb\extension\exception
*/
public function validate_authors()
{

View file

@ -58,7 +58,7 @@ abstract class provider implements \IteratorAggregate
/**
* Retrieve an iterator over all items
*
* @return ArrayIterator An iterator for the array of template paths
* @return \ArrayIterator An iterator for the array of template paths
*/
public function getIterator()
{

View file

@ -78,7 +78,6 @@ abstract class base
* @param \phpbb\auth\auth $auth Auth object
* @param \phpbb\content_visibility $content_visibility Auth object
* @param string $phpEx php file extension
* @return null
*/
function __construct(\phpbb\feed\helper $helper, \phpbb\config\config $config, \phpbb\db\driver\driver_interface $db, \phpbb\cache\driver\driver_interface $cache, \phpbb\user $user, \phpbb\auth\auth $auth, \phpbb\content_visibility $content_visibility, $phpEx)
{
@ -133,6 +132,9 @@ abstract class base
/**
* Set key
*
* @param string $key Key
* @param mixed $value Value
*/
function set($key, $value)
{
@ -141,6 +143,9 @@ abstract class base
/**
* Get key
*
* @param string $key Key
* @return mixed
*/
function get($key)
{

View file

@ -13,6 +13,8 @@
namespace phpbb\feed;
use Symfony\Component\DependencyInjection\ContainerInterface;
/**
* Factory class to return correct object
*/
@ -20,7 +22,7 @@ class factory
{
/**
* Service container object
* @var object
* @var ContainerInterface
*/
protected $container;
@ -33,12 +35,11 @@ class factory
/**
* Constructor
*
* @param objec $container Container object
* @param ContainerInterface $container Container object
* @param \phpbb\config\config $config Config object
* @param \phpbb\db\driver\driver_interface $db Database connection
* @return null
*/
public function __construct($container, \phpbb\config\config $config, \phpbb\db\driver\driver_interface $db)
public function __construct(ContainerInterface $container, \phpbb\config\config $config, \phpbb\db\driver\driver_interface $db)
{
$this->container = $container;
$this->config = $config;

View file

@ -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
* @return null
* @param string $phpEx PHP extension
*/
public function __construct(\phpbb\config\config $config, \phpbb\user $user, $phpbb_root_path, $phpEx)
{

View file

@ -53,7 +53,9 @@ class legend implements \phpbb\groupposition\groupposition_interface
/**
* Returns the group_legend for a given group, if the group exists.
*
* {@inheritDoc}
* @param int $group_id group_id of the group to be selected
* @return int position of the group
* @throws \phpbb\groupposition\exception
*/
public function get_group_value($group_id)
{
@ -76,7 +78,7 @@ class legend implements \phpbb\groupposition\groupposition_interface
/**
* Get number of groups, displayed on the legend
*
* {@inheritDoc}
* @return int value of the last item displayed
*/
public function get_group_count()
{
@ -91,8 +93,6 @@ class legend implements \phpbb\groupposition\groupposition_interface
}
/**
* Adds a group by group_id
*
* {@inheritDoc}
*/
public function add_group($group_id)
@ -118,7 +118,9 @@ class legend implements \phpbb\groupposition\groupposition_interface
/**
* Deletes a group by setting the field to self::GROUP_DISABLED and closing the gap in the list.
*
* {@inheritDoc}
* @param int $group_id group_id of the group to be deleted
* @param bool $skip_group Skip setting the value for this group, to save the query, when you need to update it anyway.
* @return bool True if the group was deleted successfully
*/
public function delete_group($group_id, $skip_group = false)
{
@ -150,8 +152,6 @@ class legend implements \phpbb\groupposition\groupposition_interface
}
/**
* Moves a group up by group_id
*
* {@inheritDoc}
*/
public function move_up($group_id)
@ -160,8 +160,6 @@ class legend implements \phpbb\groupposition\groupposition_interface
}
/**
* Moves a group down by group_id
*
* {@inheritDoc}
*/
public function move_down($group_id)
@ -170,8 +168,6 @@ class legend implements \phpbb\groupposition\groupposition_interface
}
/**
* Moves a group up/down
*
* {@inheritDoc}
*/
public function move($group_id, $delta)

View file

@ -65,7 +65,9 @@ class teampage implements \phpbb\groupposition\groupposition_interface
/**
* Returns the teampage position for a given group, if the group exists.
*
* {@inheritDoc}
* @param int $group_id group_id of the group to be selected
* @return int position of the group
* @throws \phpbb\groupposition\exception
*/
public function get_group_value($group_id)
{
@ -93,6 +95,7 @@ class teampage implements \phpbb\groupposition\groupposition_interface
*
* @param int $group_id group_id of the group to be selected
* @return array Data row of the group
* @throws \phpbb\groupposition\exception
*/
public function get_group_values($group_id)
{
@ -120,6 +123,7 @@ class teampage implements \phpbb\groupposition\groupposition_interface
*
* @param int $teampage_id Teampage_id of the selected item
* @return int Teampage position of the item
* @throws \phpbb\groupposition\exception
*/
public function get_teampage_value($teampage_id)
{
@ -144,6 +148,7 @@ class teampage implements \phpbb\groupposition\groupposition_interface
*
* @param int $teampage_id Teampage_id of the selected item
* @return array Teampage row of the item
* @throws \phpbb\groupposition\exception
*/
public function get_teampage_values($teampage_id)
{
@ -165,8 +170,6 @@ class teampage implements \phpbb\groupposition\groupposition_interface
/**
* Get number of items displayed
*
* {@inheritDoc}
*/
public function get_group_count()
@ -182,8 +185,6 @@ class teampage implements \phpbb\groupposition\groupposition_interface
}
/**
* Adds a group by group_id
*
* {@inheritDoc}
*/
public function add_group($group_id)
@ -288,7 +289,9 @@ class teampage implements \phpbb\groupposition\groupposition_interface
/**
* Deletes a group from the list and closes the gap in the position list.
*
* {@inheritDoc}
* @param int $group_id group_id of the group to be deleted
* @param bool $skip_group Skip setting the value for this group, to save the query, when you need to update it anyway.
* @return bool True if the group was deleted successfully
*/
public function delete_group($group_id, $skip_group = false)
{
@ -347,8 +350,6 @@ class teampage implements \phpbb\groupposition\groupposition_interface
}
/**
* Moves a group up by group_id
*
* {@inheritDoc}
*/
public function move_up($group_id)
@ -359,7 +360,7 @@ class teampage implements \phpbb\groupposition\groupposition_interface
/**
* Moves an item up by teampage_id
*
* @param int $group_id group_id of the group to be moved
* @param int $teampage_id teampage_id of the item to be move
* @return bool True if the group was moved successfully
*/
public function move_up_teampage($teampage_id)
@ -368,8 +369,6 @@ class teampage implements \phpbb\groupposition\groupposition_interface
}
/**
* Moves a group down by group_id
*
* {@inheritDoc}
*/
public function move_down($group_id)
@ -380,7 +379,7 @@ class teampage implements \phpbb\groupposition\groupposition_interface
/**
* Moves an item down by teampage_id
*
* @param int $group_id group_id of the group to be moved
* @param int $teampage_id teampage_id of the item to be moved
* @return bool True if the group was moved successfully
*/
public function move_down_teampage($teampage_id)
@ -389,8 +388,6 @@ class teampage implements \phpbb\groupposition\groupposition_interface
}
/**
* Moves a group up/down
*
* {@inheritDoc}
*/
public function move($group_id, $delta)

View file

@ -55,7 +55,7 @@ class db
* You have to call acquire() to actually create the lock.
*
* @param string $config_name A config variable to be used for locking
* @param array $config The phpBB configuration
* @param \phpbb\config\config $config The phpBB configuration
* @param \phpbb\db\driver\driver_interface $db A database connection
*/
public function __construct($config_name, \phpbb\config\config $config, \phpbb\db\driver\driver_interface $db)

View file

@ -70,7 +70,7 @@ class log implements \phpbb\log\log_interface
/**
* Event dispatcher object
* @var phpbb_dispatcher
* @var \phpbb\event\dispatcher
*/
protected $dispatcher;
@ -103,7 +103,6 @@ class log implements \phpbb\log\log_interface
* @param string $relative_admin_path Relative admin root path
* @param string $php_ext PHP Extension
* @param string $log_table Name of the table we use to store our logs
* @return null
*/
public function __construct($db, $user, $auth, $phpbb_dispatcher, $phpbb_root_path, $relative_admin_path, $php_ext, $log_table)
{
@ -159,8 +158,6 @@ class log implements \phpbb\log\log_interface
}
/**
* This function returns the state of the log system.
*
* {@inheritDoc}
*/
public function is_enabled($type = '')
@ -173,12 +170,6 @@ class log implements \phpbb\log\log_interface
}
/**
* Disable log
*
* This function allows disabling the log system or parts of it, for this
* page call. When add_log is called and the type is disabled,
* the log will not be added to the database.
*
* {@inheritDoc}
*/
public function disable($type = '')
@ -201,10 +192,6 @@ class log implements \phpbb\log\log_interface
}
/**
* Enable log
*
* This function allows re-enabling the log system.
*
* {@inheritDoc}
*/
public function enable($type = '')
@ -227,8 +214,6 @@ class log implements \phpbb\log\log_interface
}
/**
* Adds a log to the database
*
* {@inheritDoc}
*/
public function add($mode, $user_id, $log_ip, $log_operation, $log_time = false, $additional_data = array())
@ -425,8 +410,6 @@ class log implements \phpbb\log\log_interface
}
/**
* Grab the logs from the database
*
* {@inheritDoc}
*/
public function get_logs($mode, $count_logs = true, $limit = 0, $offset = 0, $forum_id = 0, $topic_id = 0, $user_id = 0, $log_time = 0, $sort_by = 'l.log_time DESC', $keywords = '')
@ -863,8 +846,6 @@ class log implements \phpbb\log\log_interface
}
/**
* Get total log count
*
* {@inheritDoc}
*/
public function get_log_count()
@ -873,8 +854,6 @@ class log implements \phpbb\log\log_interface
}
/**
* Get offset of the last valid log page
*
* {@inheritDoc}
*/
public function get_valid_offset()

View file

@ -106,7 +106,7 @@ class message
/**
* Add a recipient from \phpbb\user
*
* @param \phpbb\user $user
* @param array $user
* @return null
*/
public function add_recipient_from_user_row(array $user)
@ -231,7 +231,7 @@ class message
* Send the email
*
* @param \messenger $messenger
* @param string $phpEx
* @param string $contact
* @return null
*/
public function send(\messenger $messenger, $contact)

View file

@ -16,7 +16,7 @@ namespace phpbb\mimetype;
class content_guesser extends guesser_base
{
/**
* @inheritdoc
* {@inheritdoc}
*/
public function is_supported()
{
@ -24,7 +24,7 @@ class content_guesser extends guesser_base
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function guess($file, $file_name = '')
{

View file

@ -470,7 +470,7 @@ class extension_guesser extends guesser_base
);
/**
* @inheritdoc
* {@inheritdoc}
*/
public function is_supported()
{
@ -478,7 +478,7 @@ class extension_guesser extends guesser_base
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function guess($file, $file_name = '')
{

View file

@ -21,7 +21,7 @@ class guesser
const PRIORITY_DEFAULT = 0;
/**
* @var mimetype guessers
* @var array guessers
*/
protected $guessers;

View file

@ -21,7 +21,7 @@ abstract class guesser_base implements guesser_interface
protected $priority;
/**
* @inheritdoc
* {@inheritdoc}
*/
public function get_priority()
{
@ -29,7 +29,7 @@ abstract class guesser_base implements guesser_interface
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function set_priority($priority)
{

View file

@ -13,6 +13,8 @@
namespace phpbb\notification;
use Symfony\Component\DependencyInjection\ContainerInterface;
/**
* Notifications service class
*/
@ -24,7 +26,7 @@ class manager
/** @var array */
protected $notification_methods;
/** @var ContainerBuilder */
/** @var ContainerInterface */
protected $phpbb_container;
/** @var \phpbb\user_loader */
@ -62,7 +64,7 @@ class manager
*
* @param array $notification_types
* @param array $notification_methods
* @param ContainerBuilder $phpbb_container
* @param ContainerInterface $phpbb_container
* @param \phpbb\user_loader $user_loader
* @param \phpbb\config\config $config
* @param \phpbb\db\driver\driver_interface $db
@ -74,7 +76,7 @@ class manager
* @param string $user_notifications_table
* @return \phpbb\notification\manager
*/
public function __construct($notification_types, $notification_methods, $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)
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)
{
$this->notification_types = $notification_types;
$this->notification_methods = $notification_methods;
@ -886,6 +888,7 @@ class manager
*
* @param string $notification_type_name The name
* @return int the notification_type_id
* @throws \phpbb\notification\exception
*/
public function get_notification_type_id($notification_type_name)
{

View file

@ -46,7 +46,7 @@ class pagination
* If you use page numbers inside your controller route, start name should be the string
* that should be removed for the first page (example: /page/%d)
* @param int $per_page the number of items, posts, etc. to display per page, used to determine the number of pages to produce
* @return URL for the requested page
* @return string URL for the requested page
*/
protected function generate_page_link($base_url, $on_page, $start_name, $per_page)
{

View file

@ -15,10 +15,10 @@ namespace phpbb\passwords\driver;
abstract class base implements driver_interface
{
/** @var phpbb\config\config */
/** @var \phpbb\config\config */
protected $config;
/** @var phpbb\passwords\driver\helper */
/** @var \phpbb\passwords\driver\helper */
protected $helper;
/** @var driver name */
@ -37,7 +37,7 @@ abstract class base implements driver_interface
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function is_supported()
{
@ -45,7 +45,7 @@ abstract class base implements driver_interface
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function is_legacy()
{
@ -53,7 +53,7 @@ abstract class base implements driver_interface
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function get_settings_only($hash, $full = false)
{

View file

@ -18,7 +18,7 @@ class bcrypt extends base
const PREFIX = '$2a$';
/**
* @inheritdoc
* {@inheritdoc}
*/
public function get_prefix()
{
@ -26,7 +26,7 @@ class bcrypt extends base
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function hash($password, $salt = '')
{
@ -58,7 +58,7 @@ class bcrypt extends base
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function check($password, $hash, $user_row = array())
{
@ -86,7 +86,7 @@ class bcrypt extends base
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function get_settings_only($hash, $full = false)
{

View file

@ -18,7 +18,7 @@ class bcrypt_2y extends bcrypt
const PREFIX = '$2y$';
/**
* @inheritdoc
* {@inheritdoc}
*/
public function get_prefix()
{
@ -26,7 +26,7 @@ class bcrypt_2y extends bcrypt
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function is_supported()
{

View file

@ -20,7 +20,7 @@ class bcrypt_wcf2 extends base
/** @var \phpbb\passwords\driver\bcrypt */
protected $bcrypt;
/** @var phpbb\passwords\driver\helper */
/** @var \phpbb\passwords\driver\helper */
protected $helper;
/**
@ -36,7 +36,7 @@ class bcrypt_wcf2 extends base
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function get_prefix()
{
@ -44,7 +44,7 @@ class bcrypt_wcf2 extends base
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function is_legacy()
{
@ -52,7 +52,7 @@ class bcrypt_wcf2 extends base
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function hash($password, $user_row = '')
{
@ -61,7 +61,7 @@ class bcrypt_wcf2 extends base
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function check($password, $hash, $user_row = array())
{

View file

@ -18,7 +18,7 @@ class convert_password extends base
const PREFIX = '$CP$';
/**
* @inheritdoc
* {@inheritdoc}
*/
public function get_prefix()
{
@ -26,7 +26,7 @@ class convert_password extends base
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function hash($password, $user_row = '')
{
@ -34,7 +34,7 @@ class convert_password extends base
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function check($password, $hash, $user_row = array())
{

View file

@ -51,7 +51,7 @@ interface driver_interface
*
* @param string $password The password to check
* @param string $hash The password hash to check against
* @param string $user_row User's row in users table
* @param array $user_row User's row in users table
*
* @return bool True if password is correct, else false
*/

View file

@ -16,7 +16,7 @@ namespace phpbb\passwords\driver;
class helper
{
/**
* @var phpbb\config\config
* @var \phpbb\config\config
*/
protected $config;
@ -29,7 +29,7 @@ class helper
/**
* Construct a driver helper object
*
* @param phpbb\config\config $config phpBB configuration
* @param \phpbb\config\config $config phpBB configuration
*/
public function __construct(\phpbb\config\config $config)
{

View file

@ -18,7 +18,7 @@ class md5_mybb extends base
const PREFIX = '$md5_mybb$';
/**
* @inheritdoc
* {@inheritdoc}
*/
public function get_prefix()
{
@ -26,7 +26,7 @@ class md5_mybb extends base
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function is_legacy()
{
@ -34,7 +34,7 @@ class md5_mybb extends base
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function hash($password, $user_row = '')
{
@ -43,7 +43,7 @@ class md5_mybb extends base
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function check($password, $hash, $user_row = array())
{

View file

@ -23,10 +23,10 @@ class md5_phpbb2 extends base
/** @var \phpbb\passwords\driver\salted_md5 */
protected $salted_md5;
/** @var phpBB root path */
/** @var string phpBB root path */
protected $phpbb_root_path;
/** @var php file extension */
/** @var string php file extension */
protected $php_ext;
/**
@ -46,7 +46,7 @@ class md5_phpbb2 extends base
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function get_prefix()
{
@ -54,7 +54,7 @@ class md5_phpbb2 extends base
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function is_legacy()
{
@ -62,7 +62,7 @@ class md5_phpbb2 extends base
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function hash($password, $user_row = '')
{
@ -71,7 +71,7 @@ class md5_phpbb2 extends base
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function check($password, $hash, $user_row = array())
{

View file

@ -18,7 +18,7 @@ class md5_vb extends base
const PREFIX = '$md5_vb$';
/**
* @inheritdoc
* {@inheritdoc}
*/
public function get_prefix()
{
@ -26,7 +26,7 @@ class md5_vb extends base
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function is_legacy()
{
@ -34,7 +34,7 @@ class md5_vb extends base
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function hash($password, $user_row = '')
{
@ -43,7 +43,7 @@ class md5_vb extends base
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function check($password, $hash, $user_row = array())
{

View file

@ -18,7 +18,7 @@ class phpass extends salted_md5
const PREFIX = '$P$';
/**
* @inheritdoc
* {@inheritdoc}
*/
public function get_prefix()
{

View file

@ -46,7 +46,7 @@ class salted_md5 extends base
const PREFIX = '$H$';
/**
* @inheritdoc
* {@inheritdoc}
*/
public function get_prefix()
{
@ -54,7 +54,7 @@ class salted_md5 extends base
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function is_legacy()
{
@ -62,7 +62,7 @@ class salted_md5 extends base
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function hash($password, $setting = '')
{
@ -98,7 +98,7 @@ class salted_md5 extends base
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function check($password, $hash, $user_row = array())
{
@ -160,7 +160,7 @@ class salted_md5 extends base
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function get_settings_only($hash, $full = false)
{

View file

@ -18,7 +18,7 @@ class sha1 extends base
const PREFIX = '$sha1$';
/**
* @inheritdoc
* {@inheritdoc}
*/
public function get_prefix()
{
@ -26,7 +26,7 @@ class sha1 extends base
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function is_legacy()
{
@ -34,7 +34,7 @@ class sha1 extends base
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function hash($password, $user_row = '')
{
@ -43,7 +43,7 @@ class sha1 extends base
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function check($password, $hash, $user_row = array())
{

View file

@ -18,7 +18,7 @@ class sha1_smf extends base
const PREFIX = '$smf$';
/**
* @inheritdoc
* {@inheritdoc}
*/
public function get_prefix()
{
@ -26,7 +26,7 @@ class sha1_smf extends base
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function is_legacy()
{
@ -34,7 +34,7 @@ class sha1_smf extends base
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function hash($password, $user_row = '')
{
@ -42,7 +42,7 @@ class sha1_smf extends base
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function check($password, $hash, $user_row = array())
{

View file

@ -18,7 +18,7 @@ class sha1_wcf1 extends base
const PREFIX = '$wcf1$';
/**
* @inheritdoc
* {@inheritdoc}
*/
public function get_prefix()
{
@ -26,7 +26,7 @@ class sha1_wcf1 extends base
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function is_legacy()
{
@ -34,7 +34,7 @@ class sha1_wcf1 extends base
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function hash($password, $user_row = '')
{
@ -43,7 +43,7 @@ class sha1_wcf1 extends base
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function check($password, $hash, $user_row = array())
{

View file

@ -18,7 +18,7 @@ class sha_xf1 extends base
const PREFIX = '$xf1$';
/**
* @inheritdoc
* {@inheritdoc}
*/
public function get_prefix()
{
@ -26,7 +26,7 @@ class sha_xf1 extends base
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function is_legacy()
{
@ -34,7 +34,7 @@ class sha_xf1 extends base
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function hash($password, $user_row = '')
{
@ -43,7 +43,7 @@ class sha_xf1 extends base
}
/**
* @inheritdoc
* {@inheritdoc}
*/
public function check($password, $hash, $user_row = array())
{

View file

@ -39,23 +39,23 @@ class manager
/**
* Passwords helper
* @var phpbb\passwords\helper
* @var \phpbb\passwords\helper
*/
protected $helper;
/**
* phpBB configuration
* @var phpbb\config\config
* @var \phpbb\config\config
*/
protected $config;
/**
* Construct a passwords object
*
* @param phpbb\config\config $config phpBB configuration
* @param \phpbb\config\config $config phpBB configuration
* @param array $hashing_algorithms Hashing driver
* service collection
* @param phpbb\passwords\helper $helper Passwords helper object
* @param \phpbb\passwords\helper $helper Passwords helper object
* @param string $defaults List of default driver types
*/
public function __construct(\phpbb\config\config $config, $hashing_algorithms, helper $helper, $defaults)
@ -89,7 +89,7 @@ class manager
/**
* Fill algorithm type map
*
* @param phpbb\di\service_collection $hashing_algorithms
* @param \phpbb\di\service_collection $hashing_algorithms
*/
protected function fill_type_map($hashing_algorithms)
{

View file

@ -317,7 +317,7 @@ class path_helper
*
* @param string $url URL to append parameters to
* @param array $new_params Parameters to add in the form of array(name => value)
* @param string $is_amp Is the parameter separator &. Defaults to true.
* @param bool $is_amp Is the parameter separator &. Defaults to true.
* @return string Returns the new URL.
*/
public function append_url_params($url, $new_params, $is_amp = true)

View file

@ -32,7 +32,6 @@ class permissions
*
* @param \phpbb\event\dispatcher $phpbb_dispatcher Event dispatcher
* @param \phpbb\user $user User Object
* @return null
*/
public function __construct(\phpbb\event\dispatcher $phpbb_dispatcher, \phpbb\user $user)
{

View file

@ -69,8 +69,6 @@ class plupload
* @param \phpbb\user $user
* @param \phpbb\php\ini $php_ini
* @param \phpbb\mimetype\guesser $mimetype_guesser
*
* @return null
*/
public function __construct($phpbb_root_path, \phpbb\config\config $config, \phpbb\request\request_interface $request, \phpbb\user $user, \phpbb\php\ini $php_ini, \phpbb\mimetype\guesser $mimetype_guesser)
{

View file

@ -39,7 +39,6 @@ abstract class type_base implements type_interface
* @param \phpbb\request\request $request Request object
* @param \phpbb\template\template $template Template object
* @param \phpbb\user $user User object
* @param string $language_table Table where the language strings are stored
*/
public function __construct(\phpbb\request\request $request, \phpbb\template\template $template, \phpbb\user $user)
{

View file

@ -46,7 +46,6 @@ class type_bool extends type_base
* @param \phpbb\request\request $request Request object
* @param \phpbb\template\template $template Template object
* @param \phpbb\user $user User object
* @param string $language_table Table where the language strings are stored
*/
public function __construct(\phpbb\profilefields\lang_helper $lang_helper, \phpbb\request\request $request, \phpbb\template\template $template, \phpbb\user $user)
{

View file

@ -39,7 +39,6 @@ class type_date extends type_base
* @param \phpbb\request\request $request Request object
* @param \phpbb\template\template $template Template object
* @param \phpbb\user $user User object
* @param string $language_table Table where the language strings are stored
*/
public function __construct(\phpbb\request\request $request, \phpbb\template\template $template, \phpbb\user $user)
{

View file

@ -46,7 +46,6 @@ class type_dropdown extends type_base
* @param \phpbb\request\request $request Request object
* @param \phpbb\template\template $template Template object
* @param \phpbb\user $user User object
* @param string $language_table Table where the language strings are stored
*/
public function __construct(\phpbb\profilefields\lang_helper $lang_helper, \phpbb\request\request $request, \phpbb\template\template $template, \phpbb\user $user)
{

View file

@ -39,7 +39,6 @@ class type_int extends type_base
* @param \phpbb\request\request $request Request object
* @param \phpbb\template\template $template Template object
* @param \phpbb\user $user User object
* @param string $language_table Table where the language strings are stored
*/
public function __construct(\phpbb\request\request $request, \phpbb\template\template $template, \phpbb\user $user)
{

View file

@ -39,7 +39,6 @@ class type_string extends type_string_common
* @param \phpbb\request\request $request Request object
* @param \phpbb\template\template $template Template object
* @param \phpbb\user $user User object
* @param string $language_table Table where the language strings are stored
*/
public function __construct(\phpbb\request\request $request, \phpbb\template\template $template, \phpbb\user $user)
{

View file

@ -39,7 +39,6 @@ class type_text extends type_string_common
* @param \phpbb\request\request $request Request object
* @param \phpbb\template\template $template Template object
* @param \phpbb\user $user User object
* @param string $language_table Table where the language strings are stored
*/
public function __construct(\phpbb\request\request $request, \phpbb\template\template $template, \phpbb\user $user)
{

View file

@ -20,7 +20,7 @@ class symfony_request extends Request
/**
* Constructor
*
* @param phpbb\request\request_interface $phpbb_request
* @param \phpbb\request\request_interface $phpbb_request
*/
public function __construct(\phpbb\request\request_interface $phpbb_request)
{

View file

@ -55,6 +55,7 @@ class context
*
* @param string $varname Variable name
* @param string $varval Value to assign to variable
* @return true
*/
public function assign_var($varname, $varval)
{
@ -70,6 +71,7 @@ class context
*
* @param string $varname Variable name
* @param string $varval Value to append to variable
* @return true
*/
public function append_var($varname, $varval)
{
@ -117,6 +119,7 @@ class context
*
* @param string $blockname Name of block to assign $vararray to
* @param array $vararray A hash of variable name => value pairs
* @return true
*/
public function assign_block_vars($blockname, array $vararray)
{
@ -206,6 +209,7 @@ class context
*
* @param string $blockname Name of block to assign $block_vars_array to
* @param array $block_vars_array An array of hashes of variable name => value pairs
* @return true
*/
public function assign_block_vars_array($blockname, array $block_vars_array)
{
@ -374,6 +378,7 @@ class context
* Reset/empty complete block
*
* @param string $blockname Name of block to destroy
* @return true
*/
public function destroy_block_vars($blockname)
{

View file

@ -175,6 +175,7 @@ interface template
/**
* Get path to template for handle (required for BBCode parser)
*
* @param string $handle Handle to retrieve the source file
* @return string
*/
public function get_source_file_for_handle($handle);

View file

@ -40,7 +40,7 @@ class environment extends \Twig_Environment
* @param \phpbb\path_helper
* @param \phpbb\extension\manager
* @param string $phpbb_root_path
* @param Twig_LoaderInterface $loader
* @param \Twig_LoaderInterface $loader
* @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())
@ -122,7 +122,7 @@ class environment extends \Twig_Environment
* Set the namespace look up order to load templates from
*
* @param array $namespace
* @return Twig_Environment
* @return \Twig_Environment
*/
public function setNamespaceLookUpOrder($namespace)
{
@ -136,7 +136,8 @@ class environment extends \Twig_Environment
*
* @param string $name The template name
* @param integer $index The index if it is an embedded template
* @return Twig_TemplateInterface A template instance representing the given template name
* @return \Twig_TemplateInterface A template instance representing the given template name
* @throws \Twig_Error_Loader
*/
public function loadTemplate($name, $index = null)
{
@ -172,6 +173,7 @@ class environment extends \Twig_Environment
*
* @param string $name The template name
* @return string
* @throws \Twig_Error_Loader
*/
public function findTemplate($name)
{
@ -188,7 +190,7 @@ class environment extends \Twig_Environment
return parent::getLoader()->getCacheKey('@' . $namespace . '/' . $name);
}
catch (Twig_Error_Loader $e)
catch (\Twig_Error_Loader $e)
{
}
}

View file

@ -127,7 +127,7 @@ class extension extends \Twig_Extension
/**
* Grabs a subset of a loop
*
* @param Twig_Environment $env A Twig_Environment instance
* @param \Twig_Environment $env A Twig_Environment instance
* @param mixed $item A variable
* @param integer $start Start of the subset
* @param integer $end End of the subset

View file

@ -24,7 +24,7 @@ class loader extends \Twig_Loader_Filesystem
* Set safe directories
*
* @param array $directories Array of directories that are safe (empty to clear)
* @return Twig_Loader_Filesystem
* @return \Twig_Loader_Filesystem
*/
public function setSafeDirectories($directories = array())
{
@ -45,7 +45,7 @@ class loader extends \Twig_Loader_Filesystem
* Add safe directory
*
* @param string $directory Directory that should be added
* @return Twig_Loader_Filesystem
* @return \Twig_Loader_Filesystem
*/
public function addSafeDirectory($directory)
{
@ -110,7 +110,7 @@ class loader extends \Twig_Loader_Filesystem
// Try validating the name (which may throw an exception)
parent::validateName($name);
}
catch (Twig_Error_Loader $e)
catch (\Twig_Error_Loader $e)
{
if (strpos($e->getRawMessage(), 'Looks like you try to load a template outside configured directories') === 0)
{

View file

@ -25,7 +25,7 @@ class definenode extends \Twig_Node
/**
* Compiles the node to PHP.
*
* @param Twig_Compiler A Twig_Compiler instance
* @param \Twig_Compiler A Twig_Compiler instance
*/
public function compile(\Twig_Compiler $compiler)
{

View file

@ -22,7 +22,7 @@ class event extends \Twig_Node
*/
protected $listener_directory = 'event/';
/** @var Twig_Environment */
/** @var \Twig_Environment */
protected $environment;
public function __construct(\Twig_Node_Expression $expr, \phpbb\template\twig\environment $environment, $lineno, $tag = null)
@ -35,7 +35,7 @@ class event extends \Twig_Node
/**
* Compiles the node to PHP.
*
* @param Twig_Compiler A Twig_Compiler instance
* @param \Twig_Compiler A Twig_Compiler instance
*/
public function compile(\Twig_Compiler $compiler)
{

View file

@ -15,7 +15,7 @@ namespace phpbb\template\twig\node;
abstract class includeasset extends \Twig_Node
{
/** @var Twig_Environment */
/** @var \Twig_Environment */
protected $environment;
public function __construct(\Twig_Node_Expression $expr, \phpbb\template\twig\environment $environment, $lineno, $tag = null)
@ -27,7 +27,7 @@ abstract class includeasset extends \Twig_Node
/**
* Compiles the node to PHP.
*
* @param Twig_Compiler A Twig_Compiler instance
* @param \Twig_Compiler A Twig_Compiler instance
*/
public function compile(\Twig_Compiler $compiler)
{
@ -74,7 +74,7 @@ abstract class includeasset extends \Twig_Node
/**
* Append the output code for the asset
*
* @param Twig_Compiler A Twig_Compiler instance
* @param \Twig_Compiler A Twig_Compiler instance
* @return null
*/
abstract protected function append_asset(\Twig_Compiler $compiler);

View file

@ -19,7 +19,7 @@ class includenode extends \Twig_Node_Include
/**
* Compiles the node to PHP.
*
* @param Twig_Compiler A Twig_Compiler instance
* @param \Twig_Compiler A Twig_Compiler instance
*/
public function compile(\Twig_Compiler $compiler)
{

View file

@ -17,7 +17,7 @@ namespace phpbb\template\twig\node;
class includephp extends \Twig_Node
{
/** @var Twig_Environment */
/** @var \Twig_Environment */
protected $environment;
public function __construct(\Twig_Node_Expression $expr, \phpbb\template\twig\environment $environment, $lineno, $ignoreMissing = false, $tag = null)
@ -30,7 +30,7 @@ class includephp extends \Twig_Node
/**
* Compiles the node to PHP.
*
* @param Twig_Compiler A Twig_Compiler instance
* @param \Twig_Compiler A Twig_Compiler instance
*/
public function compile(\Twig_Compiler $compiler)
{

View file

@ -16,7 +16,7 @@ namespace phpbb\template\twig\node;
class php extends \Twig_Node
{
/** @var Twig_Environment */
/** @var \Twig_Environment */
protected $environment;
public function __construct(\Twig_Node_Text $text, \phpbb\template\twig\environment $environment, $lineno, $tag = null)
@ -29,7 +29,7 @@ class php extends \Twig_Node
/**
* Compiles the node to PHP.
*
* @param Twig_Compiler A Twig_Compiler instance
* @param \Twig_Compiler A Twig_Compiler instance
*/
public function compile(\Twig_Compiler $compiler)
{

View file

@ -20,9 +20,11 @@ class defineparser extends \Twig_TokenParser
/**
* Parses a token and returns a node.
*
* @param Twig_Token $token A Twig_Token instance
* @param \Twig_Token $token A Twig_Token instance
*
* @return Twig_NodeInterface A Twig_NodeInterface instance
* @return \Twig_NodeInterface A Twig_NodeInterface instance
* @throws \Twig_Error_Syntax
* @throws \phpbb\template\twig\node\definenode
*/
public function parse(\Twig_Token $token)
{

View file

@ -19,9 +19,9 @@ class event extends \Twig_TokenParser
/**
* Parses a token and returns a node.
*
* @param Twig_Token $token A Twig_Token instance
* @param \Twig_Token $token A Twig_Token instance
*
* @return Twig_NodeInterface A Twig_NodeInterface instance
* @return \Twig_NodeInterface A Twig_NodeInterface instance
*/
public function parse(\Twig_Token $token)
{

View file

@ -18,9 +18,9 @@ class includecss extends \Twig_TokenParser
/**
* Parses a token and returns a node.
*
* @param Twig_Token $token A Twig_Token instance
* @param \Twig_Token $token A Twig_Token instance
*
* @return Twig_NodeInterface A Twig_NodeInterface instance
* @return \Twig_NodeInterface A Twig_NodeInterface instance
*/
public function parse(\Twig_Token $token)
{

View file

@ -19,9 +19,9 @@ class includejs extends \Twig_TokenParser
/**
* Parses a token and returns a node.
*
* @param Twig_Token $token A Twig_Token instance
* @param \Twig_Token $token A Twig_Token instance
*
* @return Twig_NodeInterface A Twig_NodeInterface instance
* @return \Twig_NodeInterface A Twig_NodeInterface instance
*/
public function parse(\Twig_Token $token)
{

View file

@ -20,9 +20,9 @@ class includeparser extends \Twig_TokenParser_Include
/**
* Parses a token and returns a node.
*
* @param Twig_Token $token A Twig_Token instance
* @param \Twig_Token $token A Twig_Token instance
*
* @return Twig_NodeInterface A Twig_NodeInterface instance
* @return \Twig_NodeInterface A Twig_NodeInterface instance
*/
public function parse(\Twig_Token $token)
{

View file

@ -20,9 +20,9 @@ class includephp extends \Twig_TokenParser
/**
* Parses a token and returns a node.
*
* @param Twig_Token $token A Twig_Token instance
* @param \Twig_Token $token A Twig_Token instance
*
* @return Twig_NodeInterface A Twig_NodeInterface instance
* @return \Twig_NodeInterface A Twig_NodeInterface instance
*/
public function parse(\Twig_Token $token)
{

View file

@ -19,9 +19,9 @@ class php extends \Twig_TokenParser
/**
* Parses a token and returns a node.
*
* @param Twig_Token $token A Twig_Token instance
* @param \Twig_Token $token A Twig_Token instance
*
* @return Twig_NodeInterface A Twig_NodeInterface instance
* @return \Twig_NodeInterface A Twig_NodeInterface instance
*/
public function parse(\Twig_Token $token)
{

Some files were not shown because too many files have changed in this diff Show more