diff --git a/lib/Alchemy/Phrasea/Border/Checker/Filename.php b/lib/Alchemy/Phrasea/Border/Checker/Filename.php index 04ddab7c35..78d208172f 100644 --- a/lib/Alchemy/Phrasea/Border/Checker/Filename.php +++ b/lib/Alchemy/Phrasea/Border/Checker/Filename.php @@ -25,7 +25,8 @@ class Filename extends AbstractChecker /** * Constructor * - * @param boolean $sensitive Toggle case-sensitive mode, default : false + * @param Application $app + * @param array $options An array of options. available : 'sensitive' (false by default) */ public function __construct(Application $app, array $options = array()) { diff --git a/lib/Alchemy/Phrasea/Border/File.php b/lib/Alchemy/Phrasea/Border/File.php index ac5dbf4a81..f05e62a7e7 100644 --- a/lib/Alchemy/Phrasea/Border/File.php +++ b/lib/Alchemy/Phrasea/Border/File.php @@ -277,12 +277,12 @@ class File * * @param string $pathfile The path to the file * @param \collection $collection The destination collection - * @param MediaVorus $mediavorus A MediaVorus object + * @param Application $app An application * @param string $originalName An optionnal original name (if - * different from the $pathfile filename) + * different from the $pathfile filename) * @throws \InvalidArgumentException * - * @return \Alchemy\Phrasea\Border\File + * @return File */ public static function buildFromPathfile($pathfile, \collection $collection, Application $app, $originalName = null) { diff --git a/lib/Alchemy/Phrasea/Border/MetaBagInterface.php b/lib/Alchemy/Phrasea/Border/MetaBagInterface.php index c2757f3a97..40b9085877 100644 --- a/lib/Alchemy/Phrasea/Border/MetaBagInterface.php +++ b/lib/Alchemy/Phrasea/Border/MetaBagInterface.php @@ -19,7 +19,7 @@ interface MetaBagInterface * The structure of the array depends of the target databox description * structure. * - * @param \databox_descriptionStructure $metadatasStructure + * @param \databox_descriptionStructure $structure * * @return array */ diff --git a/lib/Alchemy/Phrasea/CLI.php b/lib/Alchemy/Phrasea/CLI.php index eb882f7fe7..aa3f0b5e9f 100644 --- a/lib/Alchemy/Phrasea/CLI.php +++ b/lib/Alchemy/Phrasea/CLI.php @@ -25,8 +25,9 @@ class CLI extends Application /** * Registers the autoloader and necessary components. * - * @param string $name Name for this application. - * @param string|null $version Version number for this application. + * @param string $name Name for this application. + * @param string|null $version Version number for this application. + * @param string|null $environment The environment. */ public function __construct($name, $version = null, $environment = null) { diff --git a/lib/Alchemy/Phrasea/Cache/Cache.php b/lib/Alchemy/Phrasea/Cache/Cache.php index 615f926934..996b87c393 100644 --- a/lib/Alchemy/Phrasea/Cache/Cache.php +++ b/lib/Alchemy/Phrasea/Cache/Cache.php @@ -41,10 +41,12 @@ interface Cache extends DoctrineCache /** * Get an entry from the cache. * - * @param string $key cache id The id of the cache entry to fetch. + * @param string $key cache id The id of the cache entry to fetch. + * * @return string The cached data. * @return FALSE, if no cache entry exists for the given id. - * @ throws Alchemy\Phrasea\Cache\Exception if provided key does not exist + * + * @throws Alchemy\Phrasea\Cache\Exception if provided key does not exist */ public function get($key); diff --git a/lib/Alchemy/Phrasea/Cache/RedisCache.php b/lib/Alchemy/Phrasea/Cache/RedisCache.php index bebd26c084..58efb346de 100644 --- a/lib/Alchemy/Phrasea/Cache/RedisCache.php +++ b/lib/Alchemy/Phrasea/Cache/RedisCache.php @@ -28,7 +28,7 @@ class RedisCache extends CacheProvider implements Cache /** * Sets the redis instance to use. * - * @param Redis $memcache + * @param Redis $redis */ public function setRedis(\Redis $redis) { @@ -38,7 +38,7 @@ class RedisCache extends CacheProvider implements Cache /** * Gets the memcache instance used by the cache. * - * @return Memcache + * @return Redis */ public function getRedis() { diff --git a/lib/Alchemy/Phrasea/Controller/Admin/Databox.php b/lib/Alchemy/Phrasea/Controller/Admin/Databox.php index 0faca604c0..b8c4a00d99 100644 --- a/lib/Alchemy/Phrasea/Controller/Admin/Databox.php +++ b/lib/Alchemy/Phrasea/Controller/Admin/Databox.php @@ -398,9 +398,11 @@ class Databox implements ControllerProviderInterface /** * - * @param \Silex\Application $app - * @param \Symfony\Component\HttpFoundation\Request $request - * @return \Symfony\Component\HttpFoundation\Response + * @param Application $app + * @param Request $request + * @param integer $databox_id + * + * @return Response */ public function getDatabase(Application $app, Request $request, $databox_id) { @@ -568,9 +570,10 @@ class Databox implements ControllerProviderInterface /** * Mount a collection on a databox * - * @param Application $app The silex application - * @param Request $request The current HTTP request - * @param integer $databox_id The requested databox + * @param Application $app The silex application + * @param Request $request The current HTTP request + * @param integer $databox_id The requested databox + * @param integer $collection_id The requested collection id * @return RedirectResponse */ public function mountCollection(Application $app, Request $request, $databox_id, $collection_id) diff --git a/lib/Alchemy/Phrasea/Controller/Admin/Databoxes.php b/lib/Alchemy/Phrasea/Controller/Admin/Databoxes.php index bcdc6a67f9..35f4f549d0 100644 --- a/lib/Alchemy/Phrasea/Controller/Admin/Databoxes.php +++ b/lib/Alchemy/Phrasea/Controller/Admin/Databoxes.php @@ -192,9 +192,9 @@ class Databoxes implements ControllerProviderInterface /** * Create a new databox * - * @param Application $app The silex application - * @param Request $request The current HTTP request - * @param integer $databox_id The requested databox + * @param Application $app The silex application + * @param Request $request The current HTTP request + * * @return RedirectResponse */ public function createDatabase(Application $app, Request $request) diff --git a/lib/Alchemy/Phrasea/Controller/Admin/Description.php b/lib/Alchemy/Phrasea/Controller/Admin/Description.php index 51a1e5f707..e3602135eb 100644 --- a/lib/Alchemy/Phrasea/Controller/Admin/Description.php +++ b/lib/Alchemy/Phrasea/Controller/Admin/Description.php @@ -204,7 +204,7 @@ class Description implements ControllerProviderInterface $vocabulary = VocabularyController::get($app, $request->request->get('vocabulary_' . $id)); $field->setVocabularyControl($vocabulary); $field->setVocabularyRestricted($request->request->get('vocabularyrestricted_' . $id)); - } catch (\Exception $e) { + } catch (\InvalidArgumentException $e) { } diff --git a/lib/Alchemy/Phrasea/Controller/Prod/DoDownload.php b/lib/Alchemy/Phrasea/Controller/Prod/DoDownload.php index b000fe7c6d..0cac50a205 100644 --- a/lib/Alchemy/Phrasea/Controller/Prod/DoDownload.php +++ b/lib/Alchemy/Phrasea/Controller/Prod/DoDownload.php @@ -83,8 +83,10 @@ class DoDownload implements ControllerProviderInterface /** * Prepare a set of documents for download * - * @param Application $app - * @param Request $request + * @param Application $app + * @param Request $request + * @param String $token + * * @return Response */ public function prepareDownload(Application $app, Request $request, $token) @@ -130,8 +132,10 @@ class DoDownload implements ControllerProviderInterface /** * Download a set of documents * - * @param Application $app - * @param Request $request + * @param Application $app + * @param Request $request + * @param String $token + * * @return Response */ public function downloadDocuments(Application $app, Request $request, $token) @@ -188,8 +192,10 @@ class DoDownload implements ControllerProviderInterface /** * Build a zip of downloaded documents * - * @param Application $app - * @param Request $request + * @param Application $app + * @param Request $request + * @param String $token + * * @return Response */ public function downloadExecute(Application $app, Request $request, $token) diff --git a/lib/Alchemy/Phrasea/Controller/Prod/Order.php b/lib/Alchemy/Phrasea/Controller/Prod/Order.php index c7533072ea..01600a1f62 100644 --- a/lib/Alchemy/Phrasea/Controller/Prod/Order.php +++ b/lib/Alchemy/Phrasea/Controller/Prod/Order.php @@ -141,9 +141,9 @@ class Order implements ControllerProviderInterface /** * Create a new order * - * @param Application $app - * @param Request $request - * @param integer $order_id + * @param Application $app + * @param Request $request + * * @return RedirectResponse|JsonResponse */ public function createOrder(Application $app, Request $request) @@ -218,9 +218,9 @@ class Order implements ControllerProviderInterface /** * Display list of orders * - * @param Application $app - * @param Request $request - * @param integer $order_id + * @param Application $app + * @param Request $request + * * @return Response */ public function displayOrders(Application $app, Request $request) diff --git a/lib/Alchemy/Phrasea/Controller/Prod/Records.php b/lib/Alchemy/Phrasea/Controller/Prod/Records.php index 12c9dfac7d..50bebab900 100644 --- a/lib/Alchemy/Phrasea/Controller/Prod/Records.php +++ b/lib/Alchemy/Phrasea/Controller/Prod/Records.php @@ -103,10 +103,9 @@ class Records implements ControllerProviderInterface /** * Get record detailed view * - * @param Application $app - * @param Request $request - * @param integer $sbas_id - * @param integer $record_id + * @param Application $app + * @param Request $request + * * @return JsonResponse */ public function getRecord(Application $app, Request $request) @@ -258,10 +257,9 @@ class Records implements ControllerProviderInterface /** * Renew url list of records * - * @param Application $app - * @param Request $request - * @param integer $databox_id - * @param integer $record_id + * @param Application $app + * @param Request $request + * * @return JsonResponse */ public function renewUrl(Application $app, Request $request) diff --git a/lib/Alchemy/Phrasea/Controller/Root/Account.php b/lib/Alchemy/Phrasea/Controller/Root/Account.php index c2e5afaee8..b22cc352ee 100644 --- a/lib/Alchemy/Phrasea/Controller/Root/Account.php +++ b/lib/Alchemy/Phrasea/Controller/Root/Account.php @@ -392,8 +392,10 @@ class Account implements ControllerProviderInterface /** * Display authorized applications that can access user informations * - * @param Application $app A Silex application where the controller is mounted on - * @param Request $request The current request + * @param Application $app A Silex application where the controller is mounted on + * @param Request $request The current request + * @param Integer $application_id The application id + * * @return JsonResponse */ public function grantAccess(Application $app, Request $request, $application_id) diff --git a/lib/Alchemy/Phrasea/Helper/Helper.php b/lib/Alchemy/Phrasea/Helper/Helper.php index c85c8db280..adf0232341 100644 --- a/lib/Alchemy/Phrasea/Helper/Helper.php +++ b/lib/Alchemy/Phrasea/Helper/Helper.php @@ -35,7 +35,9 @@ class Helper /** * - * @param Kernel $kernel + * @param Application $app + * @param Request $Request + * * @return Helper */ public function __construct(Application $app, Request $Request) diff --git a/lib/Alchemy/Phrasea/Helper/Record/Helper.php b/lib/Alchemy/Phrasea/Helper/Record/Helper.php index 8270000c8c..46e57d9801 100644 --- a/lib/Alchemy/Phrasea/Helper/Record/Helper.php +++ b/lib/Alchemy/Phrasea/Helper/Record/Helper.php @@ -101,7 +101,9 @@ class Helper extends \Alchemy\Phrasea\Helper\Helper /** * - * @param Application $app + * @param Application $app + * @param Request $Request + * * @return Helper */ public function __construct(Application $app, Request $Request) diff --git a/lib/Alchemy/Phrasea/Helper/Record/Printer.php b/lib/Alchemy/Phrasea/Helper/Record/Printer.php index 10fdee0ca7..dc9c30b4c2 100644 --- a/lib/Alchemy/Phrasea/Helper/Record/Printer.php +++ b/lib/Alchemy/Phrasea/Helper/Record/Printer.php @@ -30,8 +30,10 @@ class Printer extends RecordHelper /** * - * @param Application $app - * @return Printer + * @param Application $app + * @param Request $Request + * + * @return Helper */ public function __construct(Application $app, Request $Request) { diff --git a/lib/Alchemy/Phrasea/SearchEngine/SearchEngineOptions.php b/lib/Alchemy/Phrasea/SearchEngine/SearchEngineOptions.php index 03e533a597..73b333a9c7 100644 --- a/lib/Alchemy/Phrasea/SearchEngine/SearchEngineOptions.php +++ b/lib/Alchemy/Phrasea/SearchEngine/SearchEngineOptions.php @@ -491,8 +491,13 @@ class SearchEngineOptions /** * - * @param string $serialized + * @param Application $app + * @param string $serialized + * * @return SearchEngineOptions + * + * @throws \InvalidArgumentException + * @throws \RuntimeException */ public static function hydrate(Application $app, $serialized) { diff --git a/lib/Alchemy/Phrasea/Vocabulary/Controller.php b/lib/Alchemy/Phrasea/Vocabulary/Controller.php index 7039a7f857..9d463a2922 100644 --- a/lib/Alchemy/Phrasea/Vocabulary/Controller.php +++ b/lib/Alchemy/Phrasea/Vocabulary/Controller.php @@ -12,6 +12,7 @@ namespace Alchemy\Phrasea\Vocabulary; use Alchemy\Phrasea\Application; +use Alchemy\Phrasea\Vocabulary\ControlProvider\ControlProviderInterface; /** * Vocabulary Controller @@ -23,20 +24,22 @@ use Alchemy\Phrasea\Application; */ class Controller { - /** * Factory of ControlProvider * - * @param string $type - * @return \Alchemy\Phrasea\Vocabulary\ControlProvider\ControlProviderInterface - * @throws \Exception when ControlProvider is not found + * @param Application $app + * @param string $type + * + * @return ControlProviderInterface + * + * @throws \InvalidArgumentException */ public static function get(Application $app, $type) { $classname = __NAMESPACE__ . '\\ControlProvider\\' . $type . 'Provider'; if ( ! class_exists($classname)) { - throw new \Exception('Vocabulary type not found'); + throw new \InvalidArgumentException('Vocabulary type not found'); } return new $classname($app); diff --git a/lib/classes/ACL.php b/lib/classes/ACL.php index 25bff13da1..0216809a35 100644 --- a/lib/classes/ACL.php +++ b/lib/classes/ACL.php @@ -106,8 +106,10 @@ class ACL implements cache_cacheableInterface /** * Constructor * - * @param User_Interface $user - * @return ACL + * @param User_Interface $user + * @param Application $app + * + * @return \ACL */ public function __construct(User_Interface $user, Application $app) { @@ -649,8 +651,9 @@ class ACL implements cache_cacheableInterface * Return an array of base_id which are granted, with * optionnal filter by rights * - * @param Array $rights - * @return Array + * @param array $rights + * @param array|null $sbas_ids Optionnal sbas_id to restrict the query on + * @return array An array of collection */ public function get_granted_base(Array $rights = array(), array $sbas_ids = null) { diff --git a/lib/classes/API/OAuth2/Exception/Exception.php b/lib/classes/API/OAuth2/Exception/Exception.php index 5ea1d94d5e..607df0ff3c 100644 --- a/lib/classes/API/OAuth2/Exception/Exception.php +++ b/lib/classes/API/OAuth2/Exception/Exception.php @@ -104,7 +104,7 @@ class API_OAuth2_Exception_Exception extends Exception implements API_OAuth2_Exc /** * - * @param string $scope + * @param string $error * @return API_OAuth2_Exception_Exception */ public function setError($error) @@ -125,7 +125,7 @@ class API_OAuth2_Exception_Exception extends Exception implements API_OAuth2_Exc /** * - * @param string $scope + * @param string $error_description * @return API_OAuth2_Exception_Exception */ public function setError_description($error_description) @@ -146,7 +146,7 @@ class API_OAuth2_Exception_Exception extends Exception implements API_OAuth2_Exc /** * - * @param string $scope + * @param string $error_uri * @return API_OAuth2_Exception_Exception */ public function setError_uri($error_uri) diff --git a/lib/classes/API/OAuth2/Exception/Redirect.php b/lib/classes/API/OAuth2/Exception/Redirect.php index 4359884d3c..76aaf22d45 100644 --- a/lib/classes/API/OAuth2/Exception/Redirect.php +++ b/lib/classes/API/OAuth2/Exception/Redirect.php @@ -69,7 +69,7 @@ class API_OAuth2_Exception_Redirect extends API_OAuth2_Exception_Exception /** * - * @param string $redirect_uri + * @param string $state * @return API_OAuth2_Exception_Redirect */ public function setState($state) diff --git a/lib/classes/API/OAuth2/Token.php b/lib/classes/API/OAuth2/Token.php index 75d55fb42c..86454b6c24 100644 --- a/lib/classes/API/OAuth2/Token.php +++ b/lib/classes/API/OAuth2/Token.php @@ -268,8 +268,8 @@ class API_OAuth2_Token /** * - * @param appbox $appbox - * @param type $oauth_token + * @param Application $app + * @param string $oauth_token * @return API_OAuth2_Token */ public static function load_by_oauth_token(Application $app, $oauth_token) diff --git a/lib/classes/API/V1/Log.php b/lib/classes/API/V1/Log.php index dd452b4d22..82d3741474 100644 --- a/lib/classes/API/V1/Log.php +++ b/lib/classes/API/V1/Log.php @@ -6,7 +6,6 @@ */ use Alchemy\Phrasea\Application; -use Symfony\Component\HttpFoundation\Request; class API_V1_Log { @@ -83,9 +82,8 @@ class API_V1_Log /** * - * @param Application $app - * @param Request $request - * @param API_OAuth2_Account $account + * @param Application $app + * @param integer $log_id */ public function __construct(Application $app, $log_id) { diff --git a/lib/classes/API/V1/adapter.php b/lib/classes/API/V1/adapter.php index 9a73cd29c1..376a1cd490 100644 --- a/lib/classes/API/V1/adapter.php +++ b/lib/classes/API/V1/adapter.php @@ -55,8 +55,11 @@ class API_V1_adapter extends API_V1_Abstract /** * Retrieve http status error code according to the message - * @param Request $request - * @param string $error + * + * @param Request $request + * @param string $error + * @param string $message + * * @return API_V1_result ` */ public function get_error_message(Request $request, $error, $message) @@ -120,7 +123,8 @@ class API_V1_adapter extends API_V1_Abstract /** * Get a list of phraseanet tasks * - * @param \Silex\Application $app The API silex application + * @param Application $app The API silex application + * * @return \API_V1_result */ public function get_task_list(Application $app) @@ -158,8 +162,8 @@ class API_V1_adapter extends API_V1_Abstract /** * Get informations about an identified task * - * @param \Silex\Application $app The API silex application - * @param integer $task_id + * @param \Silex\Application $app The API silex application + * @param integer $taskId * @return \API_V1_result */ public function get_task(Application $app, $taskId) @@ -180,8 +184,8 @@ class API_V1_adapter extends API_V1_Abstract /** * Start a specified task * - * @param \Silex\Application $app The API silex application - * @param integer $task_id The task id + * @param \Silex\Application $app The API silex application + * @param integer $taskId The task id * @return \API_V1_result */ public function start_task(Application $app, $taskId) @@ -203,8 +207,8 @@ class API_V1_adapter extends API_V1_Abstract /** * Stop a specified task * - * @param \Silex\Application $app The API silex application - * @param integer $task_id The task id + * @param \Silex\Application $app The API silex application + * @param integer $taskId The task id * @return \API_V1_result */ public function stop_task(Application $app, $taskId) @@ -227,8 +231,8 @@ class API_V1_adapter extends API_V1_Abstract * - name * - autostart * - * @param \Silex\Application $app Silex application - * @param integer $task_id the task id + * @param \Silex\Application $app Silex application + * @param integer $taskId the task id * @return \API_V1_result * @throws \API_V1_exception_badrequest */ @@ -509,8 +513,8 @@ class API_V1_adapter extends API_V1_Abstract /** * Get an API_V1_result containing the databoxes * - * @param Request $request - * @param string $response_type + * @param Request $request + * * @return API_V1_result */ public function get_databoxes(Request $request) @@ -525,9 +529,9 @@ class API_V1_adapter extends API_V1_Abstract /** * Get an API_V1_result containing the collections of a databox * - * @param Request $request - * @param int $databox_id - * @param string $response_type + * @param Request $request + * @param int $databox_id + * * @return API_V1_result */ public function get_databox_collections(Request $request, $databox_id) @@ -548,9 +552,9 @@ class API_V1_adapter extends API_V1_Abstract /** * Get an API_V1_result containing the status of a databox * - * @param Request $request - * @param int $databox_id - * @param string $response_type + * @param Request $request + * @param int $databox_id + * * @return API_V1_result */ public function get_databox_status(Request $request, $databox_id) @@ -572,9 +576,9 @@ class API_V1_adapter extends API_V1_Abstract /** * Get an API_V1_result containing the metadatas of a databox * - * @param Request $request - * @param int $databox_id - * @param string $response_type + * @param Request $request + * @param int $databox_id + * * @return API_V1_result */ public function get_databox_metadatas(Request $request, $databox_id) @@ -597,9 +601,9 @@ class API_V1_adapter extends API_V1_Abstract /** * Get an API_V1_result containing the terms of use of a databox * - * @param Request $request - * @param int $databox_id - * @param string $response_type + * @param Request $request + * @param int $databox_id + * * @return API_V1_result */ public function get_databox_terms(Request $request, $databox_id) @@ -857,9 +861,8 @@ class API_V1_adapter extends API_V1_Abstract * * Deprecated in favor of search * - * @param Request $request - * @param int $databox_id - * @param string $response_type + * @param Request $request + * * @return API_V1_result */ public function search_records(Request $request) @@ -924,10 +927,10 @@ class API_V1_adapter extends API_V1_Abstract /** * Get an API_V1_result containing the baskets where the record is in * - * @param Request $request - * @param int $databox_id - * @param int $record_id - * @param string $response_type + * @param Request $request + * @param int $databox_id + * @param int $record_id + * * @return API_V1_result */ public function get_record_related(Request $request, $databox_id, $record_id) @@ -960,10 +963,10 @@ class API_V1_adapter extends API_V1_Abstract /** * Get an API_V1_result containing the record metadatas * - * @param Request $request - * @param int $databox_id - * @param int $record_id - * @param string $response_type + * @param Request $request + * @param int $databox_id + * @param int $record_id + * * @return API_V1_result */ public function get_record_metadatas(Request $request, $databox_id, $record_id) @@ -984,10 +987,10 @@ class API_V1_adapter extends API_V1_Abstract /** * Get an API_V1_result containing the record status * - * @param Request $request - * @param int $databox_id - * @param int $record_id - * @param string $response_type + * @param Request $request + * @param int $databox_id + * @param int $record_id + * * @return API_V1_result */ public function get_record_status(Request $request, $databox_id, $record_id) @@ -1014,10 +1017,10 @@ class API_V1_adapter extends API_V1_Abstract /** * Get an API_V1_result containing the record embed files * - * @param Request $request - * @param int $databox_id - * @param int $record_id - * @param string $response_type + * @param Request $request + * @param int $databox_id + * @param int $record_id + * * @return API_V1_result */ public function get_record_embed(Request $request, $databox_id, $record_id) @@ -1044,10 +1047,10 @@ class API_V1_adapter extends API_V1_Abstract /** * Get an API_V1_result containing the story embed files * - * @param Request $request - * @param int $databox_id - * @param int $record_id - * @param string $response_type + * @param Request $request + * @param int $databox_id + * @param int $record_id + * * @return API_V1_result */ public function get_story_embed(Request $request, $databox_id, $record_id) @@ -1483,8 +1486,6 @@ class API_V1_adapter extends API_V1_Abstract } /** - * @todo - * * @param Request $request * @param int $publication_id */ @@ -1666,7 +1667,6 @@ class API_V1_adapter extends API_V1_Abstract } /** - * @todo * @param Request $request * @param int $usr_id */ @@ -1878,10 +1878,11 @@ class API_V1_adapter extends API_V1_Abstract /** * Retrieve detailled informations about one story * - * @param record_adapter $story + * @param record_adapter $story + * * @return array */ - public function list_story(record_adapter $story, $includeChildren = true) + public function list_story(record_adapter $story) { if (!$story->is_grouping()) { throw new \API_V1_exception_notfound('Story not found'); diff --git a/lib/classes/API/V1/result.php b/lib/classes/API/V1/result.php index a9dbbf774d..b01dd4a7fc 100644 --- a/lib/classes/API/V1/result.php +++ b/lib/classes/API/V1/result.php @@ -98,9 +98,9 @@ class API_V1_result /** * API v1 Result constructor * - * @param Request $request - * @param API_V1_adapter $api - * @param string $response_type One of the API_V1_result 'FORMAT_*' constants + * @param Request $request + * @param API_V1_adapter $api + * * @return API_V1_result */ public function __construct(Request $request, API_V1_adapter $api) @@ -248,7 +248,9 @@ class API_V1_result * Set the API_V1_result http_code, error_type, error_message and error_details * with the appropriate datas * - * @param string $const + * @param string $const + * @param string $message + * * @return API_V1_result */ public function set_error_message($const, $message) @@ -298,7 +300,8 @@ class API_V1_result * Set the API_V1_result http_code, error_message and error_details * with the appropriate datas * - * @param string $const + * @param integer $code + * * @return API_V1_result */ public function set_error_code($code) diff --git a/lib/classes/Bridge/Account.php b/lib/classes/Bridge/Account.php index a4036f5989..ac97c72cd6 100644 --- a/lib/classes/Bridge/Account.php +++ b/lib/classes/Bridge/Account.php @@ -233,8 +233,8 @@ class Bridge_Account /** * - * @param appbox $appbox - * @param int $account_id + * @param Application $app + * @param integer $account_id * @return Bridge_Account */ public static function load_account(Application $app, $account_id) @@ -346,11 +346,12 @@ class Bridge_Account /** * - * @param appbox $appbox - * @param Bridge_Api $api - * @param User_Adapter $user - * @param string $dist_id - * @param string $name + * @param Application $app + * @param Bridge_Api $api + * @param User_Adapter $user + * @param string $dist_id + * @param string $name + * * @return Bridge_Account */ public static function create(Application $app, Bridge_Api $api, User_Adapter $user, $dist_id, $name) diff --git a/lib/classes/Bridge/Api.php b/lib/classes/Bridge/Api.php index a546b691be..017da86591 100644 --- a/lib/classes/Bridge/Api.php +++ b/lib/classes/Bridge/Api.php @@ -199,7 +199,7 @@ class Bridge_Api * * @param string $object * @param string $object_id - * @param Request $request + * @param array $datas * @return Bridge_Api_Interface */ public function update_element($object, $object_id, Array $datas) @@ -316,7 +316,8 @@ class Bridge_Api /** * - * @param string $element_id + * @param Bridge_Element $element + * * @return string */ public function get_element_status(Bridge_Element $element) diff --git a/lib/classes/Bridge/Api/Dailymotion.php b/lib/classes/Bridge/Api/Dailymotion.php index 0e6cccca4c..975554043c 100644 --- a/lib/classes/Bridge/Api/Dailymotion.php +++ b/lib/classes/Bridge/Api/Dailymotion.php @@ -347,9 +347,11 @@ class Bridge_Api_Dailymotion extends Bridge_Api_Abstract implements Bridge_Api_I /** * * @see http://www.dailymotion.com/doc/api/obj-video.html - * @param string $object - * @param string $object_id - * @param Request $request + * + * @param string $object + * @param string $object_id + * @param array $datas + * * @return Bridge_Api_Dailymotion */ public function update_element($object, $object_id, Array $datas) @@ -482,7 +484,8 @@ class Bridge_Api_Dailymotion extends Bridge_Api_Abstract implements Bridge_Api_I /** * - * @param string $element_id + * @param Bridge_Element $element + * * @return Array */ public function get_element_status(Bridge_Element $element) @@ -593,8 +596,9 @@ class Bridge_Api_Dailymotion extends Bridge_Api_Abstract implements Bridge_Api_I /** * - * @param string $object - * @param string $element_id + * @param string $element_id + * @param string $object + * * @return Bridge_Api_Dailymotion_Element */ public function get_element_from_id($element_id, $object) @@ -793,7 +797,7 @@ class Bridge_Api_Dailymotion extends Bridge_Api_Abstract implements Bridge_Api_I * @todo implement in bridge_api°interface * * Check if data uploaded via the current connector is conform - * @param Request $request + * @param array $datas * @param record_adapter $record * @return array */ @@ -850,7 +854,10 @@ class Bridge_Api_Dailymotion extends Bridge_Api_Abstract implements Bridge_Api_I /** * Returns dats needed for an uploaded record - * @param record_adapter $record + * + * @param Request $request + * @param record_adapter $record + * * @return array */ public function get_upload_datas(Request $request, record_adapter $record) @@ -868,7 +875,7 @@ class Bridge_Api_Dailymotion extends Bridge_Api_Abstract implements Bridge_Api_I /** * Returns datas needed for an uploaded record - * @param record_adapter $record + * @param Request $request * @return array */ public function get_update_datas(Request $request) diff --git a/lib/classes/Bridge/Api/Dailymotion/Container.php b/lib/classes/Bridge/Api/Dailymotion/Container.php index b1c99081ce..537a9a4293 100644 --- a/lib/classes/Bridge/Api/Dailymotion/Container.php +++ b/lib/classes/Bridge/Api/Dailymotion/Container.php @@ -33,8 +33,9 @@ class Bridge_Api_Dailymotion_Container implements Bridge_Api_ContainerInterface /** * * @param array $entry - * @param type $type - * @param type $thumbnail + * @param String $type + * @param String $thumbnail + * @param String $url * @return Bridge_Api_Dailymotion_Container */ public function __construct(Array $entry, $type, $thumbnail = '', $url = '') diff --git a/lib/classes/Bridge/Api/Flickr.php b/lib/classes/Bridge/Api/Flickr.php index aee2ce1eb4..8a58f80f8c 100644 --- a/lib/classes/Bridge/Api/Flickr.php +++ b/lib/classes/Bridge/Api/Flickr.php @@ -261,10 +261,9 @@ class Bridge_Api_Flickr extends Bridge_Api_Abstract implements Bridge_Api_Interf /** * - * @param string $object - * @param string $object_id - * @param Request $request - * @return Void + * @param string $object + * @param string $object_id + * @param array $datas */ public function update_element($object, $object_id, Array $datas) { @@ -742,7 +741,9 @@ class Bridge_Api_Flickr extends Bridge_Api_Abstract implements Bridge_Api_Interf /** * Returns datas needed for an uploaded record - * @param record_adapter $record + * + * @param Request $request + * * @return array */ public function get_update_datas(Request $request) @@ -757,7 +758,10 @@ class Bridge_Api_Flickr extends Bridge_Api_Abstract implements Bridge_Api_Interf /** * Returns datas needed for an uploaded record - * @param record_adapter $record + * + * @param Request $request + * @param record_adapter $record + * * @return array */ public function get_upload_datas(Request $request, record_adapter $record) diff --git a/lib/classes/Bridge/Api/Flickr/Element.php b/lib/classes/Bridge/Api/Flickr/Element.php index 887353e005..87c58c53df 100644 --- a/lib/classes/Bridge/Api/Flickr/Element.php +++ b/lib/classes/Bridge/Api/Flickr/Element.php @@ -33,9 +33,11 @@ class Bridge_Api_Flickr_Element implements Bridge_Api_ElementInterface /** * - * @param SimpleXMLElement $entry - * @param string $user_id - * @param string $type + * @param SimpleXMLElement $entry + * @param string $user_id + * @param string $type + * @param Boolean $entry_from_list + * * @return Bridge_Api_Flickr_Element */ public function __construct(SimpleXMLElement $entry, $user_id, $type, $entry_from_list = true) diff --git a/lib/classes/Bridge/Api/Youtube.php b/lib/classes/Bridge/Api/Youtube.php index d8aea98ed6..75b1c39d51 100644 --- a/lib/classes/Bridge/Api/Youtube.php +++ b/lib/classes/Bridge/Api/Youtube.php @@ -292,7 +292,7 @@ class Bridge_Api_Youtube extends Bridge_Api_Abstract implements Bridge_Api_Inter * * @param string $object * @param string $object_id - * @param Request $request + * @param array $datas * @return Bridge_Api_Youtube */ public function update_element($object, $object_id, Array $datas) @@ -435,7 +435,8 @@ class Bridge_Api_Youtube extends Bridge_Api_Abstract implements Bridge_Api_Inter /** * - * @param string $element_id + * @param Bridge_Element $element + * * @return string */ public function get_element_status(Bridge_Element $element) @@ -697,8 +698,9 @@ class Bridge_Api_Youtube extends Bridge_Api_Abstract implements Bridge_Api_Inter /** * - * @param string $object - * @param string $element_id + * @param string $element_id + * @param string $object + * * @return Bridge_Api_Youtube_Element */ public function get_element_from_id($element_id, $object) @@ -899,10 +901,11 @@ class Bridge_Api_Youtube extends Bridge_Api_Abstract implements Bridge_Api_Inter } /** - * * Check if data uploaded via the current connector is conform - * @param Request $request - * @param record_adapter $record + * + * @param array $datas + * @param record_adapter $record + * * @return array */ public function check_upload_constraints(Array $datas, record_adapter $record) @@ -961,7 +964,9 @@ class Bridge_Api_Youtube extends Bridge_Api_Abstract implements Bridge_Api_Inter /** * Returns datas needed for an uploaded record - * @param record_adapter $record + * + * @param Request $request + * * @return array */ public function get_update_datas(Request $request) @@ -979,7 +984,10 @@ class Bridge_Api_Youtube extends Bridge_Api_Abstract implements Bridge_Api_Inter /** * Returns datas needed for an uploaded record - * @param record_adapter $record + * + * @param Request $request + * @param record_adapter $record + * * @return array */ public function get_upload_datas(Request $request, record_adapter $record) diff --git a/lib/classes/DailymotionWithoutOauth2.php b/lib/classes/DailymotionWithoutOauth2.php index efd6102f28..e14d496741 100644 --- a/lib/classes/DailymotionWithoutOauth2.php +++ b/lib/classes/DailymotionWithoutOauth2.php @@ -16,8 +16,9 @@ class DailymotionWithoutOauth2 extends Dailymotion /** * Call a remote method. * - * @param $method String the method name to call. - * @param $args Array an associative array of arguments. + * @param String $method the method name to call. + * @param Array $args an associative array of arguments. + * @param String $access_token * * @return mixed the method response * @@ -69,7 +70,8 @@ class DailymotionWithoutOauth2 extends Dailymotion /** * Upload a file on the Dailymotion servers and generate an URL to be used with API methods. * - * @param $filePath String a path to the file to upload + * @param String $filePath a path to the file to upload + * @param String $oauth_token a path to the file to upload * * @return String the resulting URL */ diff --git a/lib/classes/Feed/Token.php b/lib/classes/Feed/Token.php index 9cca59fc20..4e76e26284 100644 --- a/lib/classes/Feed/Token.php +++ b/lib/classes/Feed/Token.php @@ -51,9 +51,10 @@ class Feed_Token /** * - * @param appbox $appbox - * @param string $token - * @param int $feed_id + * @param Application $app + * @param string $token + * @param int $feed_id + * * @return Feed_Token */ public function __construct(Application $app, $token, $feed_id) diff --git a/lib/classes/Feed/XML/Atom.php b/lib/classes/Feed/XML/Atom.php index 097135923b..337912cb56 100644 --- a/lib/classes/Feed/XML/Atom.php +++ b/lib/classes/Feed/XML/Atom.php @@ -166,7 +166,7 @@ class Feed_XML_Atom extends Feed_XML_Abstract implements Feed_XML_Interface /** * - * @param string $author_name + * @param string $author_email * @return Feed_XML_Atom */ public function set_author_email($author_email) @@ -179,7 +179,7 @@ class Feed_XML_Atom extends Feed_XML_Abstract implements Feed_XML_Interface /** * - * @param string $author_name + * @param string $author_url * @return Feed_XML_Atom */ public function set_author_url($author_url) diff --git a/lib/classes/Feed/XML/Cooliris.php b/lib/classes/Feed/XML/Cooliris.php index 8b170f6392..afddffbe62 100644 --- a/lib/classes/Feed/XML/Cooliris.php +++ b/lib/classes/Feed/XML/Cooliris.php @@ -114,7 +114,7 @@ class Feed_XML_Cooliris extends Feed_XML_Abstract implements Feed_XML_Interface /** * - * @param string $language + * @param string $copyright * @return Feed_XML_RSS */ public function set_copyright($copyright) @@ -210,7 +210,7 @@ class Feed_XML_Cooliris extends Feed_XML_Abstract implements Feed_XML_Interface /** * - * @param string $skipHours + * @param string $hour * @return Feed_XML_RSS */ public function set_skipHour($hour) @@ -222,7 +222,7 @@ class Feed_XML_Cooliris extends Feed_XML_Abstract implements Feed_XML_Interface /** * - * @param string $skipDays + * @param string $day * @return Feed_XML_RSS */ public function set_skipDays($day) diff --git a/lib/classes/Feed/XML/RSS.php b/lib/classes/Feed/XML/RSS.php index 9a68e6cb85..13b10dd2ff 100644 --- a/lib/classes/Feed/XML/RSS.php +++ b/lib/classes/Feed/XML/RSS.php @@ -114,7 +114,7 @@ class Feed_XML_RSS extends Feed_XML_Abstract implements Feed_XML_Interface /** * - * @param string $language + * @param string $copyright * @return Feed_XML_RSS */ public function set_copyright($copyright) @@ -210,7 +210,7 @@ class Feed_XML_RSS extends Feed_XML_Abstract implements Feed_XML_Interface /** * - * @param string $skipHours + * @param string $hour * @return Feed_XML_RSS */ public function set_skipHour($hour) @@ -222,7 +222,7 @@ class Feed_XML_RSS extends Feed_XML_Abstract implements Feed_XML_Interface /** * - * @param string $skipDays + * @param string $day * @return Feed_XML_RSS */ public function set_skipDays($day) diff --git a/lib/classes/Session/Logger.php b/lib/classes/Session/Logger.php index 408c1b94d4..d65353bbb3 100644 --- a/lib/classes/Session/Logger.php +++ b/lib/classes/Session/Logger.php @@ -46,8 +46,10 @@ class Session_Logger /** * - * @param databox $databox - * @param int $log_id + * @param Application $app + * @param databox $databox + * @param integer $log_id + * * @return Session_Logger */ public function __construct(Application $app, databox $databox, $log_id) @@ -92,9 +94,10 @@ class Session_Logger /** * - * @param databox $databox - * @param User_Adapter $user - * @param Browser $browser + * @param Application $app + * @param databox $databox + * @param Browser $browser + * * @return Session_Logger */ public static function create(Application $app, databox $databox, Browser $browser) diff --git a/lib/classes/User/Adapter.php b/lib/classes/User/Adapter.php index 75256b02d0..350dbe36c8 100644 --- a/lib/classes/User/Adapter.php +++ b/lib/classes/User/Adapter.php @@ -315,8 +315,9 @@ class User_Adapter implements User_Interface, cache_cacheableInterface /** * - * @param type $id - * @param appbox $appbox + * @param Integer $id + * @param Application $app + * * @return User_Adapter */ public function __construct($id, Application $app) @@ -480,7 +481,9 @@ class User_Adapter implements User_Interface, cache_cacheableInterface /** * Query in the cache * - * @param unknown_type $query + * @param Application $app + * @param string $query + * * @return boolean */ public static function saveQuery(Application $app, $query) @@ -520,8 +523,10 @@ class User_Adapter implements User_Interface, cache_cacheableInterface /** * - * @param string $login - * @return int + * @param Application $app + * @param string $login + * + * @return integer */ public static function get_usr_id_from_login(Application $app, $login) { diff --git a/lib/classes/ZipArchiveImproved.php b/lib/classes/ZipArchiveImproved.php index c0a33ef9d2..09750a58ee 100644 --- a/lib/classes/ZipArchiveImproved.php +++ b/lib/classes/ZipArchiveImproved.php @@ -104,6 +104,8 @@ class ZipArchiveImproved extends ZipArchive * * @param string $fileName the path to file to be added to archive * @param string [optional] $localname the name of the file in the ZIP archive + * @param integer $start + * @param integer $length * @return bool */ public function addFile($fileName, $localname = null, $start = 0, $length = 0) diff --git a/lib/classes/appbox/register.php b/lib/classes/appbox/register.php index 2bc7510cc4..444cb0f0c0 100644 --- a/lib/classes/appbox/register.php +++ b/lib/classes/appbox/register.php @@ -61,7 +61,9 @@ class appbox_register * Return an array of collection objects where provided * user is waiting for approbation * - * @param User_Interface $user + * @param Application $app + * @param User_Interface $user + * * @return array */ public function get_collection_awaiting_for_user(Application $app, User_Interface $user) diff --git a/lib/classes/cache/databox.php b/lib/classes/cache/databox.php index 9e6f41fc18..8275df3f97 100644 --- a/lib/classes/cache/databox.php +++ b/lib/classes/cache/databox.php @@ -22,8 +22,9 @@ class cache_databox protected static $refreshing = false; /** + * @param Application $app + * @param int $sbas_id * - * @param int $sbas_id * @return cache_databox */ public static function refresh(Application $app, $sbas_id) @@ -142,11 +143,10 @@ class cache_databox } /** - * - * @param int $sbas_id - * @param string $type - * @param mixed content $value - * @return Void + * @param Application $app + * @param int $sbas_id + * @param string $type + * @param mixed content $value */ public static function update(Application $app, $sbas_id, $type, $value = '') { diff --git a/lib/classes/caption/Field/Value.php b/lib/classes/caption/Field/Value.php index 611294d855..7ec0449da2 100644 --- a/lib/classes/caption/Field/Value.php +++ b/lib/classes/caption/Field/Value.php @@ -60,6 +60,7 @@ class caption_Field_Value implements cache_cacheableInterface /** * + * @param Application $app * @param databox_field $databox_field * @param record_adapter $record * @param type $id @@ -85,7 +86,7 @@ class caption_Field_Value implements cache_cacheableInterface $this->VocabularyId = $datas['vocabularyId']; return $this; - } catch (\Exception $e) { + } catch (\InvalidArgumentException $e) { } @@ -104,7 +105,7 @@ class caption_Field_Value implements cache_cacheableInterface try { $this->VocabularyType = $row['VocabularyType'] ? Vocabulary\Controller::get($this->app, $row['VocabularyType']) : null; $this->VocabularyId = $row['VocabularyId']; - } catch (\Exception $e) { + } catch (\InvalidArgumentException $e) { } diff --git a/lib/classes/caption/field.php b/lib/classes/caption/field.php index 0b7cb3c4db..59bf87886e 100644 --- a/lib/classes/caption/field.php +++ b/lib/classes/caption/field.php @@ -42,9 +42,10 @@ class caption_field implements cache_cacheableInterface /** * - * @param databox_field $databox_field - * @param record_Interface $record - * @param int $id + * @param Application $app + * @param databox_field $databox_field + * @param record_Interface $record + * * @return caption_field */ public function __construct(Application $app, databox_field $databox_field, record_Interface $record) @@ -197,8 +198,9 @@ class caption_field implements cache_cacheableInterface } /** + * @param String $custom_separator + * @param Boolean $highlightTheso * - * @param string $custom_separator * @return mixed */ public function get_serialized_values($custom_separator = false, $highlightTheso = false) diff --git a/lib/classes/caption/record.php b/lib/classes/caption/record.php index a07d57a383..79151b68d5 100644 --- a/lib/classes/caption/record.php +++ b/lib/classes/caption/record.php @@ -46,8 +46,10 @@ class caption_record implements caption_interface, cache_cacheableInterface /** * - * @param record_Interface $record - * @param databox $databox + * @param Application $app + * @param record_Interface $record + * @param databox $databox + * * @return caption_record */ public function __construct(Application $app, record_Interface $record, databox $databox) @@ -177,7 +179,9 @@ class caption_record implements caption_interface, cache_cacheableInterface /** * - * @param array $grep_fields + * @param array $grep_fields + * @param Boolean $IncludeBusiness + * * @return array */ public function get_fields(Array $grep_fields = null, $IncludeBusiness = false) @@ -233,9 +237,11 @@ class caption_record implements caption_interface, cache_cacheableInterface /** * - * @param string $highlight - * @param array $grep_fields - * @param SearchEngineInterface $searchEngine + * @param string $highlight + * @param array $grep_fields + * @param SearchEngineInterface $searchEngine + * @param Boolean $includeBusiness + * * @return array */ public function get_highlight_fields($highlight = '', Array $grep_fields = null, SearchEngineInterface $searchEngine = null, $includeBusiness = false) diff --git a/lib/classes/collection.php b/lib/classes/collection.php index eaaaf3e241..0088074c67 100644 --- a/lib/classes/collection.php +++ b/lib/classes/collection.php @@ -362,7 +362,8 @@ class collection implements cache_cacheableInterface /** * - * @param int $base_id + * @param Application $app + * @param int $base_id * @return collection */ public static function get_from_base_id(Application $app, $base_id) @@ -379,8 +380,9 @@ class collection implements cache_cacheableInterface /** * - * @param int $sbas_id - * @param int $coll_id + * @param Application $app + * @param databox $databox + * @param int $coll_id * @return collection */ public static function get_from_coll_id(Application $app, databox $databox, $coll_id) diff --git a/lib/classes/connection.php b/lib/classes/connection.php index 081c2a6658..dbc30df592 100644 --- a/lib/classes/connection.php +++ b/lib/classes/connection.php @@ -105,7 +105,9 @@ class connection /** * - * @param string $name + * @param Application $app + * @param string $name + * * @return connection_pdo */ public static function getPDOConnection(Application $app, $name = null) diff --git a/lib/classes/connection/pdo.php b/lib/classes/connection/pdo.php index 37f09c18b0..603e1ab2b5 100644 --- a/lib/classes/connection/pdo.php +++ b/lib/classes/connection/pdo.php @@ -21,13 +21,15 @@ class connection_pdo extends connection_abstract implements connection_interface /** * - * @param string $name - * @param string $hostname - * @param int $port - * @param string $user - * @param string $passwd - * @param string $dbname - * @param array $options + * @param string $name + * @param string $hostname + * @param int $port + * @param string $user + * @param string $passwd + * @param string $dbname + * @param array $options + * @param Boolean $debug + * * @return connection_pdo */ public function __construct($name, $hostname, $port, $user, $passwd, $dbname = false, $options = array(), $debug = false) diff --git a/lib/classes/databox.php b/lib/classes/databox.php index fb78eee2b8..56a0d3c05d 100644 --- a/lib/classes/databox.php +++ b/lib/classes/databox.php @@ -469,12 +469,13 @@ class databox extends base /** * - * @param string $host - * @param int $port - * @param string $user - * @param string $password - * @param string $dbname - * @param registry $registry + * @param Application $app + * @param string $host + * @param int $port + * @param string $user + * @param string $password + * @param string $dbname + * @param registry $registry * @return databox */ public static function mount(Application $app, $host, $port, $user, $password, $dbname, registry $registry) @@ -962,8 +963,6 @@ class databox extends base } /** - * - * @param $sbas_id * @return DOMDocument */ public function get_dom_thesaurus() @@ -988,8 +987,6 @@ class databox extends base } /** - * - * @param $sbas_id * @return DOMXpath */ public function get_xpath_thesaurus() @@ -1010,8 +1007,6 @@ class databox extends base } /** - * - * @param int $sbas_id * @return SimpleXMLElement */ public function get_sxml_thesaurus() @@ -1032,8 +1027,6 @@ class databox extends base } /** - * - * @param int $sbas_id * @return string */ public function get_thesaurus() @@ -1063,7 +1056,6 @@ class databox extends base } /** - * * @return string */ public function get_structure() @@ -1123,8 +1115,6 @@ class databox extends base } /** - * - * @param $sbas_id * @return DOMDocument */ public function get_dom_structure() @@ -1150,8 +1140,6 @@ class databox extends base } /** - * - * @param $sbas_id * @return DOMDocument */ public function get_dom_cterms() @@ -1197,8 +1185,6 @@ class databox extends base } /** - * - * @param $sbas_id * @return DOMXpath */ public function get_xpath_structure() diff --git a/lib/classes/databox/field.php b/lib/classes/databox/field.php index 6db5d72d05..e0eae70ce4 100644 --- a/lib/classes/databox/field.php +++ b/lib/classes/databox/field.php @@ -199,7 +199,7 @@ class databox_field implements cache_cacheableInterface try { $this->Vocabulary = Vocabulary\Controller::get($this->app, $row['VocabularyControlType']); $this->VocabularyRestriction = ! ! $row['RestrictToVocabularyControl']; - } catch (Exception $e) { + } catch (\InvalidArgumentException $e) { } @@ -244,8 +244,10 @@ class databox_field implements cache_cacheableInterface /** * - * @param \databox $databox - * @param int $id + * @param Application $app + * @param \databox $databox + * @param int $id + * * @return \databox_field */ public static function get_instance(Application $app, databox $databox, $id) @@ -562,7 +564,8 @@ class databox_field implements cache_cacheableInterface /** * - * @param boolean $bool + * @param boolean $readonly + * * @return databox_field */ public function set_readonly($readonly) @@ -590,7 +593,7 @@ class databox_field implements cache_cacheableInterface /** * - * @param boolean $bool + * @param boolean $required * @return databox_field */ public function set_required($required) @@ -602,7 +605,7 @@ class databox_field implements cache_cacheableInterface /** * - * @param boolean $bool + * @param boolean $report * @return databox_field */ public function set_report($report) @@ -626,7 +629,7 @@ class databox_field implements cache_cacheableInterface /** * - * @param string $type + * @param string $branch * @return databox_field */ public function set_tbranch($branch) @@ -638,7 +641,7 @@ class databox_field implements cache_cacheableInterface /** * - * @param string $type + * @param string $separator * @return databox_field */ public function set_separator($separator) @@ -670,7 +673,7 @@ class databox_field implements cache_cacheableInterface /** * - * @param string $type + * @param string $value * @return databox_field */ public function set_thumbtitle($value) diff --git a/lib/classes/databox/subdef.php b/lib/classes/databox/subdef.php index c982e03ef5..e9add29aa0 100644 --- a/lib/classes/databox/subdef.php +++ b/lib/classes/databox/subdef.php @@ -58,7 +58,9 @@ class databox_subdef /** * - * @param SimpleXMLElement $sd + * @param SubdefType $type + * @param SimpleXMLElement $sd + * * @return databox_subdef */ public function __construct(SubdefType $type, SimpleXMLElement $sd) diff --git a/lib/classes/databox/subdefsStructure.php b/lib/classes/databox/subdefsStructure.php index aef47d261e..980c38e7d9 100644 --- a/lib/classes/databox/subdefsStructure.php +++ b/lib/classes/databox/subdefsStructure.php @@ -177,7 +177,7 @@ class databox_subdefsStructure implements IteratorAggregate, Countable /** * - * @param string $group + * @param string $groupname * @param string $name * @param string $class * @return databox_subdefsStructure diff --git a/lib/classes/eventsmanager/notify/autoregister.php b/lib/classes/eventsmanager/notify/autoregister.php index 9f604878d7..69ab224152 100644 --- a/lib/classes/eventsmanager/notify/autoregister.php +++ b/lib/classes/eventsmanager/notify/autoregister.php @@ -184,9 +184,9 @@ class eventsmanager_notify_autoregister extends eventsmanager_notifyAbstract /** * - * @param Array $to - * @param Array $from - * @param Array $datas + * @param \User_Adapter $to + * @param \User_Adapter $registeredUser + * * @return boolean */ public function mail(\User_Adapter $to, \User_Adapter $registeredUser) diff --git a/lib/classes/media/Permalink/Adapter.php b/lib/classes/media/Permalink/Adapter.php index 61e5bb718b..2ebb590729 100644 --- a/lib/classes/media/Permalink/Adapter.php +++ b/lib/classes/media/Permalink/Adapter.php @@ -299,6 +299,7 @@ class media_Permalink_Adapter implements media_Permalink_Interface, cache_cachea /** * + * @param Application $app * @param databox $databox * @param media_subdef $media_subdef * @return media_Permalink_Adapter @@ -316,6 +317,7 @@ class media_Permalink_Adapter implements media_Permalink_Interface, cache_cachea /** * + * @param Application $app * @param databox $databox * @param media_subdef $media_subdef * @return media_Permalink_Adapter @@ -345,6 +347,7 @@ class media_Permalink_Adapter implements media_Permalink_Interface, cache_cachea /** * + * @param Application $app * @param databox $databox * @param string $token * @param int $record_id diff --git a/lib/classes/media/subdef.php b/lib/classes/media/subdef.php index 77d4b62b80..d4f568465c 100644 --- a/lib/classes/media/subdef.php +++ b/lib/classes/media/subdef.php @@ -138,9 +138,7 @@ class media_subdef extends media_abstract implements cache_cacheableInterface const TC_DATA_LIGHTVALUE = 'LightValue'; /** - * @todo the presence of file is checked on constructor, it would be better - * to check it when needed (stop disk access) - * + * @param Application $app * @param record_adapter $record * @param type $name * @param type $substitute @@ -541,8 +539,10 @@ class media_subdef extends media_abstract implements cache_cacheableInterface /** * - * @param registryInterface $registry - * @param int $angle + * @param int $angle + * @param Alchemyst $alchemyst + * @param MediaVorus $mediavorus + * * @return media_subdef */ public function rotate($angle, Alchemyst $alchemyst, MediaVorus $mediavorus) diff --git a/lib/classes/module/report.php b/lib/classes/module/report.php index e08952a99b..7c7ed3d26e 100644 --- a/lib/classes/module/report.php +++ b/lib/classes/module/report.php @@ -244,11 +244,11 @@ class module_report /** * Constructor * - * - * @name report::__construct() - * @param $arg1 the minimal date of the report - * @param $arg2 the maximal date of the report - * @param $sbas_id the id of the base where we want to connect + * @param Application $app + * @param string $d1 the minimal date of the report + * @param string $d2 the maximal date of the report + * @param integer $sbas_id the id of the base where we want to connect + * @param string $collist */ public function __construct(Application $app, $d1, $d2, $sbas_id, $collist) { @@ -810,10 +810,14 @@ class module_report } /** - * @desc build the final formated array which contains all the result, - * we construct the html code from this array - * @param array $tab pass the configcolumn parameter to this tab - * @return the formated array + * Build the final formated array which contains all the result, + * we construct the html code from this array + * + * @param array $tab pass the configcolumn parameter to this tab + * @param array $groupby + * @param array $on + * + * @return the formated array */ public function buildReport($tab = false, $groupby = false, $on = false) { diff --git a/lib/classes/module/report/activity.php b/lib/classes/module/report/activity.php index cf85712e1c..f0a1d84d8d 100644 --- a/lib/classes/module/report/activity.php +++ b/lib/classes/module/report/activity.php @@ -153,8 +153,10 @@ class module_report_activity extends module_report } /** - * @desc get all questions by user - * @param string $idUser + * Get all questions by user + * + * @param string $value + * @param string $what */ public function getAllQuestionByUser($value, $what) { @@ -545,9 +547,11 @@ class module_report_activity extends module_report } /** - * @desc get the deail of download by users - * @param bool $ext false for your appbox conn, true for external connections - * @param array $tab config for the html table + * Get the deail of download by users + * + * @param array $tab config for the html table + * @param String $on + * * @return array */ public function getDetailDownload($tab = false, $on = "") diff --git a/lib/classes/module/report/add.php b/lib/classes/module/report/add.php index 6aa68427f3..077d0249af 100644 --- a/lib/classes/module/report/add.php +++ b/lib/classes/module/report/add.php @@ -40,10 +40,11 @@ class module_report_add extends module_report /** * constructor * - * @name download::__construct() - * @param $arg1 start date of the report - * @param $arg2 end date of the report - * @param $sbas_id id of the databox + * @param Application $app + * @param string $arg1 start date of the report + * @param string $arg2 end date of the report + * @param integer $sbas_id id of the databox + * @param string $collist */ public function __construct(Application $app, $arg1, $arg2, $sbas_id, $collist) { diff --git a/lib/classes/module/report/connexion.php b/lib/classes/module/report/connexion.php index 9193c8e74b..46a3ef5907 100644 --- a/lib/classes/module/report/connexion.php +++ b/lib/classes/module/report/connexion.php @@ -37,10 +37,11 @@ class module_report_connexion extends module_report /** * constructor * - * @name connexion::__construct() - * @param $arg1 start date of the report - * @param $arg2 end date of the report - * @param $sbas_id id of the databox + * @param Application $app + * @param string $arg1 start date of the report + * @param string $arg2 end date of the report + * @param integer $sbas_id id of the databox + * @param string $collist */ public function __construct(Application $app, $arg1, $arg2, $sbas_id, $collist) { diff --git a/lib/classes/module/report/dashboard.php b/lib/classes/module/report/dashboard.php index d8ecd4ef9a..b889d97db7 100644 --- a/lib/classes/module/report/dashboard.php +++ b/lib/classes/module/report/dashboard.php @@ -70,10 +70,12 @@ class module_report_dashboard implements module_report_dashboard_componentInterf private $app; /** - * @desc Construit un dashboard selon les droits du usrid, si sbas vaut null + * Construit un dashboard selon les droits du usrid, si sbas vaut null * c'est un report sur toutes les bases, sinon sur le sbasid - * @param $usrid - * @param $sbasid + * + * @param Application $app + * @param integer $usr + * @param integer $sbasid */ public function __construct(Application $app, $usr, $sbasid = null) { @@ -289,8 +291,10 @@ class module_report_dashboard implements module_report_dashboard_componentInterf } /** - * @desc la liste des base authorisee sous forme de string - * @param $separotor + * La liste des base authorisee sous forme de string + * + * @param string $separator + * * @return string */ public function getListeBase($separator) diff --git a/lib/classes/module/report/dashboard/feed.php b/lib/classes/module/report/dashboard/feed.php index 485d43216b..0ab867014e 100644 --- a/lib/classes/module/report/dashboard/feed.php +++ b/lib/classes/module/report/dashboard/feed.php @@ -64,13 +64,14 @@ class module_report_dashboard_feed implements module_report_dashboard_componentI private $app; /** - * @desc return l'objet stockee dans le cache si i l existe sinon instancie + * return l'objet stockee dans le cache si i l existe sinon instancie * un nouveau objet dashboard_feed - * @param $sbasid - * @param $sbas_coll - * @param $dmin - * @param $dmax - * @return self + * + * @param Application $app + * @param integer $sbasid + * @param string $sbas_coll + * @param mixed $dmin + * @param mixed $dmax */ public static function getInstance(Application $app, $sbasid, $sbas_coll, $dmin, $dmax) { @@ -90,12 +91,13 @@ class module_report_dashboard_feed implements module_report_dashboard_componentI } /** - * @desc Remplis les resultats bruts pour valeures passees en param - * @param $sbasid - * @param $sbas_collection, les collection sous forme de string - * séparés par une virgule - * @param $dmin, Y-m-d - * @param $dmax, Y-m-d + * Remplis les resultats bruts pour valeures passees en param + * + * @param Application $app + * @param integer $sbasid + * @param string $sbas_collection les collection sous forme de string séparés par une virgule + * @param string $dmin Y-m-d + * @param string $dmax Y-m-d */ public function __construct(Application $app, $sbasid, $sbas_collection, $dmin, $dmax) { diff --git a/lib/classes/module/report/download.php b/lib/classes/module/report/download.php index a6f9e08643..0dc748a326 100644 --- a/lib/classes/module/report/download.php +++ b/lib/classes/module/report/download.php @@ -42,10 +42,11 @@ class module_report_download extends module_report /** * constructor * - * @name download::__construct() - * @param $arg1 start date of the report - * @param $arg2 end date of the report - * @param $sbas_id id of the databox + * @param Application $app + * @param string $arg1 start date of the report + * @param string $arg2 end date of the report + * @param integer $sbas_id id of the databox + * @param string $collist */ public function __construct(Application $app, $arg1, $arg2, $sbas_id, $collist) { diff --git a/lib/classes/module/report/edit.php b/lib/classes/module/report/edit.php index a242a417d9..c1a270a193 100644 --- a/lib/classes/module/report/edit.php +++ b/lib/classes/module/report/edit.php @@ -40,10 +40,11 @@ class module_report_edit extends module_report /** * constructor * - * @name download::__construct() - * @param $arg1 start date of the report - * @param $arg2 end date of the report - * @param $sbas_id id of the databox + * @param Application $app + * @param string $arg1 start date of the report + * @param string $arg2 end date of the report + * @param integer $sbas_id id of the databox + * @param string $collist */ public function __construct(Application $app, $arg1, $arg2, $sbas_id, $collist) { diff --git a/lib/classes/module/report/nav.php b/lib/classes/module/report/nav.php index 288efdca5b..0f4ed74689 100644 --- a/lib/classes/module/report/nav.php +++ b/lib/classes/module/report/nav.php @@ -46,10 +46,11 @@ class module_report_nav extends module_report /** * constructor * - * @name nav::__construct() - * @param $arg1 start date of the report - * @param $arg2 end date of the report - * @param $sbas_id databox id + * @param Application $app + * @param string $arg1 start date of the report + * @param string $arg2 end date of the report + * @param integer $sbas_id databox id + * @param string $collist */ public function __construct(Application $app, $arg1, $arg2, $sbas_id, $collist) { @@ -435,13 +436,6 @@ class module_report_nav extends module_report return $this->report; } - /** - * @desc report basic user informations - * @param int $val user id - * @param array $tab config for the html table - * @param string $on the field - * @return array - */ public function buildTabGrpInfo($req, array $params, $val, $tab = false, $on = false) { $this->initialize(); @@ -525,11 +519,12 @@ class module_report_nav extends module_report } /** - * @desc return basic information about a record - * @param $ses session id - * @param $bid base id - * @param $rid record id - * @param $tab config for the html table + * Return basic information about a record + * + * @param integer $bid base id + * @param integer $rid record id + * @param array $tab config for the html table + * * @return array */ public function buildTabUserWhat($bid, $rid, $tab = false) diff --git a/lib/classes/module/report/push.php b/lib/classes/module/report/push.php index 0c96d7096d..09a35b9604 100644 --- a/lib/classes/module/report/push.php +++ b/lib/classes/module/report/push.php @@ -40,10 +40,11 @@ class module_report_push extends module_report /** * constructor * - * @name download::__construct() - * @param $arg1 start date of the report - * @param $arg2 end date of the report - * @param $sbas_id id of the databox + * @param Application $app + * @param string $arg1 start date of the report + * @param string $arg2 end date of the report + * @param integer $sbas_id id of the databox + * @param string $collist */ public function __construct(Application $app, $arg1, $arg2, $sbas_id, $collist) { diff --git a/lib/classes/module/report/question.php b/lib/classes/module/report/question.php index 4438b1cc26..21a3d1977e 100644 --- a/lib/classes/module/report/question.php +++ b/lib/classes/module/report/question.php @@ -38,10 +38,11 @@ class module_report_question extends module_report /** * constructor * - * @name download::__construct() - * @param $arg1 start date of the report - * @param $arg2 end date of the report - * @param $sbas_id id of the databox + * @param Application $app + * @param string $arg1 start date of the report + * @param string $arg2 end date of the report + * @param integer $sbas_id id of the databox + * @param string $collist */ public function __construct(Application $app, $arg1, $arg2, $sbas_id, $collist) { diff --git a/lib/classes/module/report/validate.php b/lib/classes/module/report/validate.php index 7aaa4a83db..264604f298 100644 --- a/lib/classes/module/report/validate.php +++ b/lib/classes/module/report/validate.php @@ -40,10 +40,11 @@ class module_report_validate extends module_report /** * constructor * - * @name download::__construct() - * @param $arg1 start date of the report - * @param $arg2 end date of the report - * @param $sbas_id id of the databox + * @param Application $app + * @param string $arg1 start date of the report + * @param string $arg2 end date of the report + * @param integer $sbas_id id of the databox + * @param string $collist */ public function __construct(Application $app, $arg1, $arg2, $sbas_id, $collist) { diff --git a/lib/classes/p4string.php b/lib/classes/p4string.php index 2f9acf3799..7016f88ecd 100644 --- a/lib/classes/p4string.php +++ b/lib/classes/p4string.php @@ -83,7 +83,7 @@ class p4string } /** - * @deprecated + * deprecated * * @param type $s * @return type @@ -94,12 +94,11 @@ class p4string } /** - * @deprecated + * deprecated * - * @param type $s - * @param type $context - * @param type $quoted - * @return type + * @param string $s + * @param string $context + * @param string $quoted */ public static function MakeString($s, $context = 'html', $quoted = '') { diff --git a/lib/classes/patch/370a8.php b/lib/classes/patch/370a8.php index 5e2ee949ac..91dfbacd22 100644 --- a/lib/classes/patch/370a8.php +++ b/lib/classes/patch/370a8.php @@ -57,7 +57,9 @@ class patch_370a8 implements patchInterface * transform tasks 'workflow 01' to 'RecordMover' * will group tasks(01) with same period to a single task(02) * - * @param base $appbox + * @param base $appbox + * @param Application $app + * * @return boolean */ public function apply(base $appbox, Application $app) diff --git a/lib/classes/patch/370a9.php b/lib/classes/patch/370a9.php index 7661c0f168..6931cfa7d9 100644 --- a/lib/classes/patch/370a9.php +++ b/lib/classes/patch/370a9.php @@ -56,7 +56,9 @@ class patch_370a9 implements patchInterface /** * Add new border manager service to services.yml & config.yml configuration files - * @param base $appbox + * + * @param base $appbox + * @param Application $app */ public function apply(base $appbox, Application $app) { diff --git a/lib/classes/patch/371.php b/lib/classes/patch/371.php index 626d5a6a36..194a2be73e 100644 --- a/lib/classes/patch/371.php +++ b/lib/classes/patch/371.php @@ -54,7 +54,8 @@ class patch_371 implements patchInterface } /** - * @param base $databox + * @param base $databox + * @param Application $app */ public function apply(base $databox, Application $app) { diff --git a/lib/classes/patch/373.php b/lib/classes/patch/373.php index 99fca5e189..e14aae15b5 100644 --- a/lib/classes/patch/373.php +++ b/lib/classes/patch/373.php @@ -55,7 +55,8 @@ class patch_373 implements patchInterface } /** - * @param base $databox + * @param base $appbox + * @param Application $app */ public function apply(base $appbox, Application $app) { diff --git a/lib/classes/patch/380.php b/lib/classes/patch/380.php index 8f0b0f6b43..53758cc526 100644 --- a/lib/classes/patch/380.php +++ b/lib/classes/patch/380.php @@ -54,7 +54,8 @@ class patch_380 implements patchInterface } /** - * @param base $databox + * @param base $databox + * @param Application $app */ public function apply(base $databox, Application $app) { diff --git a/lib/classes/patch/3802.php b/lib/classes/patch/3802.php index cae9c51b12..fc26058dc2 100644 --- a/lib/classes/patch/3802.php +++ b/lib/classes/patch/3802.php @@ -54,7 +54,8 @@ class patch_3802 implements patchInterface } /** - * @param base $appbox + * @param base $appbox + * @param Application $app */ public function apply(base $appbox, Application $app) { diff --git a/lib/classes/patch/3803.php b/lib/classes/patch/3803.php index 3d732686c0..87cea0619d 100644 --- a/lib/classes/patch/3803.php +++ b/lib/classes/patch/3803.php @@ -55,7 +55,8 @@ class patch_3803 implements patchInterface } /** - * @param base $appbox + * @param base $appbox + * @param Application $app */ public function apply(base $appbox, Application $app) { diff --git a/lib/classes/patch/3804.php b/lib/classes/patch/3804.php index 12e30b8a3c..3ada9ceb2a 100644 --- a/lib/classes/patch/3804.php +++ b/lib/classes/patch/3804.php @@ -49,7 +49,8 @@ class patch_3804 implements patchInterface } /** - * @param base $appbox + * @param base $appbox + * @param Application $app */ public function apply(base $appbox, Application $app) { diff --git a/lib/classes/random.php b/lib/classes/random.php index f148c98cfa..7e647c1030 100644 --- a/lib/classes/random.php +++ b/lib/classes/random.php @@ -103,10 +103,12 @@ class random /** * - * @param string $type - * @param int $usr - * @param string $end_date - * @param mixed content $datas + * @param Application $app + * @param string $type + * @param int $usr + * @param DateTime $end_date + * @param mixed content $datas + * * @return boolean */ public static function getUrlToken(Application $app, $type, $usr, DateTime $end_date = null, $datas = '') @@ -226,9 +228,12 @@ class random /** * Get the validation token for one user and one validation basket * - * @param integer $userId - * @param integer $basketId - * @return string The desired token + * @param Application $app + * @param integer $userId + * @param integer $basketId + * + * @return string The token + * * @throws \Exception_NotFound */ public static function getValidationToken(Application $app, $userId, $basketId) diff --git a/lib/classes/record/adapter.php b/lib/classes/record/adapter.php index b3d68a103f..2f98796938 100644 --- a/lib/classes/record/adapter.php +++ b/lib/classes/record/adapter.php @@ -157,11 +157,11 @@ class record_adapter implements record_Interface, cache_cacheableInterface /** * - * @param $base_id - * @param $record_id - * @param $number - * @param $xml - * @param $status + * @param Application $app + * @param integer $sbas_id + * @param integer $record_id + * @param integer $number + * * @return record_adapter */ public function __construct(Application $app, $sbas_id, $record_id, $number = null) @@ -1126,9 +1126,11 @@ class record_adapter implements record_Interface, cache_cacheableInterface } /** - * * @todo move this function to caption_record - * @param array $metadatas + * + * @param array $metadatas + * @param boolean $force_readonly + * * @return record_adapter */ public function set_metadatas(Array $metadatas, $force_readonly = false) @@ -1243,7 +1245,9 @@ class record_adapter implements record_Interface, cache_cacheableInterface /** * - * @param \collection $collection + * @param Application $app + * @param \collection $collection + * * @return \record_adapter */ public static function createStory(Application $app, \collection $collection) @@ -1296,7 +1300,9 @@ class record_adapter implements record_Interface, cache_cacheableInterface /** * - * @param File $file + * @param File $file + * @param Application $app + * * @return \record_adapter */ public static function createFromFile(File $file, Application $app) @@ -1404,9 +1410,10 @@ class record_adapter implements record_Interface, cache_cacheableInterface /** * - * @param int $base_id - * @param int $record_id + * @param Application $app + * @param integer $sbas_id * @param string $sha256 + * @param integer $record_id * @return record_adapter */ public static function get_record_by_sha(Application $app, $sbas_id, $sha256, $record_id = null) @@ -1442,9 +1449,11 @@ class record_adapter implements record_Interface, cache_cacheableInterface /** * Search for a record on a databox by UUID * - * @param \databox $databox - * @param string $uuid - * @param int $record_id Restrict check on a record_id + * @param Application $app + * @param \databox $databox + * @param string $uuid + * @param int $record_id Restrict check on a record_id + * * @return \record_adapter */ public static function get_record_by_uuid(Application $app, \databox $databox, $uuid, $record_id = null) @@ -1874,10 +1883,13 @@ class record_adapter implements record_Interface, cache_cacheableInterface /** * - * @param databox $databox - * @param int $offset_start - * @param int $how_many - * @return type + * @param databox $databox + * @param integer $original_name + * @param integer $caseSensitive + * @param integer $offset_start + * @param integer $how_many + * + * @return array */ public static function get_records_by_originalname(databox $databox, $original_name, $caseSensitive = false, $offset_start = 0, $how_many = 10) { diff --git a/lib/classes/record/exportElement.php b/lib/classes/record/exportElement.php index c904dfb1cc..32f9481c22 100644 --- a/lib/classes/record/exportElement.php +++ b/lib/classes/record/exportElement.php @@ -51,10 +51,12 @@ class record_exportElement extends record_adapter /** * - * @param int $base_id - * @param int $record_id - * @param string $directory - * @param int $remain_hd + * @param Application $app + * @param integer $sbas_id + * @param integer $record_id + * @param string $directory + * @param integer $remain_hd + * * @return record_exportElement */ public function __construct(Application $app, $sbas_id, $record_id, $directory = '', $remain_hd = false) diff --git a/lib/classes/record/orderElement.php b/lib/classes/record/orderElement.php index 4905f60bcd..6251e41b04 100644 --- a/lib/classes/record/orderElement.php +++ b/lib/classes/record/orderElement.php @@ -33,10 +33,11 @@ class record_orderElement extends record_adapter /** * - * @param int $base_id - * @param int $record_id - * @param boolean $deny - * @param int $order_master_id + * @param Application $app + * @param int $sbas_id + * @param int $record_id + * @param boolean $deny + * @param int $order_master_id */ public function __construct(Application $app, $sbas_id, $record_id, $deny, $order_master_id) { diff --git a/lib/classes/record/preview.php b/lib/classes/record/preview.php index 5686d10535..17ab97c451 100644 --- a/lib/classes/record/preview.php +++ b/lib/classes/record/preview.php @@ -82,9 +82,13 @@ class record_preview extends record_adapter /** * - * @param string $env - * @param int $pos - * @param mixed content $contId + * @param Application $app + * @param string $env + * @param integer $pos + * @param mixed $contId + * @param SearchEngineInterface $search_engine + * @param string $query + * * @return record_preview */ public function __construct(Application $app, $env, $pos, $contId, SearchEngineInterface $search_engine = null, $query = '') diff --git a/lib/classes/recordutils/image.php b/lib/classes/recordutils/image.php index 0f8793b6cb..5c0fdc9a76 100644 --- a/lib/classes/recordutils/image.php +++ b/lib/classes/recordutils/image.php @@ -67,9 +67,9 @@ class recordutils_image extends recordutils /** * - * @param int $bas - * @param int $rec - * @param boolean $hd + * @param Application $app + * @param \media_subdef $subdef + * * @return string */ public static function stamp(Application $app, \media_subdef $subdef) @@ -308,7 +308,9 @@ class recordutils_image extends recordutils /** * - * @param \media_subdef $subdef + * @param Application $app + * @param \media_subdef $subdef + * * @return boolean|string */ public static function watermark(Application $app, \media_subdef $subdef) diff --git a/lib/classes/registry.php b/lib/classes/registry.php index 7bdede2f6e..a38c098494 100644 --- a/lib/classes/registry.php +++ b/lib/classes/registry.php @@ -38,7 +38,7 @@ class registry implements registryInterface /** * - * @param \Alchemy\Phrasea\Cache\Cache $cache + * @param Application $app * @return registry */ public function __construct(Application $app) @@ -129,7 +129,9 @@ class registry implements registryInterface /** * - * @param string $key + * @param string $key + * @param mixed $defaultvalue + * * @return mixed */ public function get($key, $defaultvalue = null) @@ -146,8 +148,10 @@ class registry implements registryInterface /** * - * @param string $key - * @param mixed $value + * @param string $key + * @param mixed $value + * @param string $type + * * @return registry */ public function set($key, $value, $type) diff --git a/lib/classes/set/export.php b/lib/classes/set/export.php index 0a8506a513..37fca4452b 100644 --- a/lib/classes/set/export.php +++ b/lib/classes/set/export.php @@ -39,7 +39,8 @@ class set_export extends set_abstract * * @param Application $app * @param string $lst - * @param int $sstid + * @param integer $sstid + * @param integer $storyWZid * @return set_export */ public function __construct(Application $app, $lst, $sstid, $storyWZid = null) @@ -395,8 +396,12 @@ class set_export extends set_abstract /** * - * @param Array $subdefs - * @param boolean $rename_title + * @param User_Adapter $user + * @param Filesystem $filesystem + * @param Array $subdefs + * @param boolean $rename_title + * @param boolean $includeBusinessFields + * * @return Array */ public function prepare_export(User_Adapter $user, Filesystem $filesystem, Array $subdefs, $rename_title, $includeBusinessFields) @@ -691,9 +696,11 @@ class set_export extends set_abstract /** * - * @param String $token - * @param Array $list - * @param string $zipFile + * @param Application $app + * @param String $token + * @param Array $list + * @param string $zipFile + * * @return string */ public static function build_zip(Application $app, $token, Array $list, $zipFile) @@ -848,9 +855,12 @@ class set_export extends set_abstract /** * @todo a revoir le cas anonymous * - * @param Array $list - * @param String> $type - * @param boolean $anonymous + * @param Application $app + * @param Array $list + * @param String $type + * @param boolean $anonymous + * @param string $comment + * * @return Void */ public static function log_download(Application $app, Array $list, $type, $anonymous = false, $comment = '') diff --git a/lib/classes/set/exportftp.php b/lib/classes/set/exportftp.php index a432e6865b..7ad8b58cf9 100644 --- a/lib/classes/set/exportftp.php +++ b/lib/classes/set/exportftp.php @@ -20,15 +20,17 @@ class set_exportftp extends set_export /** * - * @param Int $usr_to - * @param String $host - * @param String $login - * @param String $password - * @param Int $ssl - * @param Int $retry - * @param Int $passif - * @param String $destfolder - * @param String $makedirectory + * @param integer $usr_to + * @param String $host + * @param String $login + * @param String $password + * @param integer $ssl + * @param integer $retry + * @param integer $passif + * @param String $destfolder + * @param String $makedirectory + * @param String $logfile + * * @return boolean */ public function export_ftp($usr_to, $host, $login, $password, $ssl, $retry, $passif, $destfolder, $makedirectory, $logfile) diff --git a/lib/classes/set/order.php b/lib/classes/set/order.php index 22107d55c3..f355448836 100644 --- a/lib/classes/set/order.php +++ b/lib/classes/set/order.php @@ -72,10 +72,12 @@ class set_order extends set_abstract /** * Create a new order entry * - * @param RecordsRequest $recordsRequest - * @param integer $orderer - * @param string $usage - * @param \DateTime $deadline + * @param Application $app + * @param RecordsRequest $records + * @param \User_Adapter $orderer + * @param string $usage + * @param \DateTime $deadline + * * @return boolean */ public static function create(Application $app, RecordsRequest $records, \User_Adapter $orderer, $usage, \DateTime $deadline = null) @@ -130,10 +132,12 @@ class set_order extends set_abstract /** * List orders * - * @param appbox $appbox - * @param array $baseIds - * @param integer $offsetStart - * @param integer $perPage + * @param Application $app + * @param array $baseIds + * @param integer $offsetStart + * @param integer $perPage + * @param string $sort + * * @return array */ public static function listOrders(Application $app, array $baseIds, $offsetStart = 0, $perPage = 10, $sort = null) @@ -201,7 +205,9 @@ class set_order extends set_abstract /** * - * @param int $id + * @param Application $app + * @param int $id + * * @return set_order */ public function __construct(Application $app, $id) @@ -335,8 +341,10 @@ class set_order extends set_abstract /** * - * @param Array $elements_ids - * @param boolean $force + * @param Application $app + * @param Array $elements_ids + * @param boolean $force + * * @return set_order */ public function send_elements(Application $app, Array $elements_ids, $force) diff --git a/lib/classes/set/selection.php b/lib/classes/set/selection.php index f3b46d00f5..92e608fecc 100644 --- a/lib/classes/set/selection.php +++ b/lib/classes/set/selection.php @@ -10,6 +10,7 @@ */ use Alchemy\Phrasea\Application; +use Entities\Basket; /** * @@ -34,10 +35,10 @@ class set_selection extends set_abstract /** * - * @param \Entities\Basket $basket + * @param Basket $Basket * @return set_selection */ - public function load_basket(\Entities\Basket $Basket) + public function load_basket(Basket $Basket) { foreach ($Basket->getElements() as $basket_element) { $this->add_element($basket_element->getRecord($this->app)); @@ -48,7 +49,9 @@ class set_selection extends set_abstract /** * - * @param array $rights + * @param array $rights + * @param array $sbas_rights + * * @return set_selection */ public function grep_authorized(Array $rights = array(), Array $sbas_rights = array()) @@ -116,7 +119,9 @@ class set_selection extends set_abstract /** * - * @param array $lst + * @param array $lst + * @param Boolean $flatten_groupings + * * @return set_selection */ public function load_list(Array $lst, $flatten_groupings = false) diff --git a/lib/classes/task/abstract.php b/lib/classes/task/abstract.php index 3d2625e3ba..52d7f2a1da 100644 --- a/lib/classes/task/abstract.php +++ b/lib/classes/task/abstract.php @@ -828,9 +828,9 @@ abstract class task_abstract /** * - * @param appbox $appbox + * @param \Pimple $dependencyContainer * @param string $class_name - * @param string $settings (xml string) + * @param string $settings * @return task_abstract */ public static function create(\Pimple $dependencyContainer, $class_name, $settings = null) diff --git a/lib/classes/unicode.php b/lib/classes/unicode.php index 3d8e80dbe3..80370e4692 100644 --- a/lib/classes/unicode.php +++ b/lib/classes/unicode.php @@ -1465,10 +1465,10 @@ class unicode /** * Removes ctrl chars (tous < 32 sauf 9,10,13) * - * @staticvar null $a_in - * @staticvar null $a_out - * @param type $s - * @return type + * @param string $string + * @param string $substitution + * + * @return string */ public function substituteCtrlCharacters($string, $substitution = '_') {