hazza/Phraseanet
1
0
Fork 0
mirror of https://github.com/alchemy-fr/Phraseanet.git synced 2025-10-14 13:33:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix doc blocks

Browse Source
This commit is contained in:
Romain Neutron
2013-01-29 18:34:50 +01:00
parent 4414892b91
commit c184278b40
89 changed files with 589 additions and 429 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
lib/classes/API/OAuth2/Exception/Exception.php
View File

@@ -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)

2
lib/classes/API/OAuth2/Exception/Redirect.php
View File

@@ -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)

4
lib/classes/API/OAuth2/Token.php
View File

@@ -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)

6
lib/classes/API/V1/Log.php
View File

@@ -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)
{

107
lib/classes/API/V1/adapter.php
View File

@@ -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');

13
lib/classes/API/V1/result.php
View File

@@ -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)