Fix doc blocks

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

View File

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

View File

@@ -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)
* @throws \InvalidArgumentException
*
* @return \Alchemy\Phrasea\Border\File
* @return File
*/
public static function buildFromPathfile($pathfile, \collection $collection, Application $app, $originalName = null)
{

View File

@@ -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
*/

View File

@@ -27,6 +27,7 @@ class CLI extends 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)
{

View File

@@ -42,8 +42,10 @@ interface Cache extends DoctrineCache
* Get an entry from the cache.
*
* @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
*/
public function get($key);

View File

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

View File

@@ -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)
{
@@ -571,6 +573,7 @@ class Databox implements ControllerProviderInterface
* @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)

View File

@@ -194,7 +194,7 @@ class Databoxes implements ControllerProviderInterface
*
* @param Application $app The silex application
* @param Request $request The current HTTP request
* @param integer $databox_id The requested databox
*
* @return RedirectResponse
*/
public function createDatabase(Application $app, Request $request)

View File

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

View File

@@ -85,6 +85,8 @@ class DoDownload implements ControllerProviderInterface
*
* @param Application $app
* @param Request $request
* @param String $token
*
* @return Response
*/
public function prepareDownload(Application $app, Request $request, $token)
@@ -132,6 +134,8 @@ class DoDownload implements ControllerProviderInterface
*
* @param Application $app
* @param Request $request
* @param String $token
*
* @return Response
*/
public function downloadDocuments(Application $app, Request $request, $token)
@@ -190,6 +194,8 @@ class DoDownload implements ControllerProviderInterface
*
* @param Application $app
* @param Request $request
* @param String $token
*
* @return Response
*/
public function downloadExecute(Application $app, Request $request, $token)

View File

@@ -143,7 +143,7 @@ class Order implements ControllerProviderInterface
*
* @param Application $app
* @param Request $request
* @param integer $order_id
*
* @return RedirectResponse|JsonResponse
*/
public function createOrder(Application $app, Request $request)
@@ -220,7 +220,7 @@ class Order implements ControllerProviderInterface
*
* @param Application $app
* @param Request $request
* @param integer $order_id
*
* @return Response
*/
public function displayOrders(Application $app, Request $request)

View File

@@ -105,8 +105,7 @@ class Records implements ControllerProviderInterface
*
* @param Application $app
* @param Request $request
* @param integer $sbas_id
* @param integer $record_id
*
* @return JsonResponse
*/
public function getRecord(Application $app, Request $request)
@@ -260,8 +259,7 @@ class Records implements ControllerProviderInterface
*
* @param Application $app
* @param Request $request
* @param integer $databox_id
* @param integer $record_id
*
* @return JsonResponse
*/
public function renewUrl(Application $app, Request $request)

View File

@@ -394,6 +394,8 @@ class Account implements ControllerProviderInterface
*
* @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)

View File

@@ -35,7 +35,9 @@ class Helper
/**
*
* @param Kernel $kernel
* @param Application $app
* @param Request $Request
*
* @return Helper
*/
public function __construct(Application $app, Request $Request)

View File

@@ -102,6 +102,8 @@ class Helper extends \Alchemy\Phrasea\Helper\Helper
/**
*
* @param Application $app
* @param Request $Request
*
* @return Helper
*/
public function __construct(Application $app, Request $Request)

View File

@@ -31,7 +31,9 @@ class Printer extends RecordHelper
/**
*
* @param Application $app
* @return Printer
* @param Request $Request
*
* @return Helper
*/
public function __construct(Application $app, Request $Request)
{

View File

@@ -491,8 +491,13 @@ class SearchEngineOptions
/**
*
* @param Application $app
* @param string $serialized
*
* @return SearchEngineOptions
*
* @throws \InvalidArgumentException
* @throws \RuntimeException
*/
public static function hydrate(Application $app, $serialized)
{

View File

@@ -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 Application $app
* @param string $type
* @return \Alchemy\Phrasea\Vocabulary\ControlProvider\ControlProviderInterface
* @throws \Exception when ControlProvider is not found
*
* @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);

View File

@@ -107,7 +107,9 @@ class ACL implements cache_cacheableInterface
* Constructor
*
* @param User_Interface $user
* @return ACL
* @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)
{

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)

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)

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)

View File

@@ -6,7 +6,6 @@
*/
use Alchemy\Phrasea\Application;
use Symfony\Component\HttpFoundation\Request;
class API_V1_Log
{
@@ -84,8 +83,7 @@ class API_V1_Log
/**
*
* @param Application $app
* @param Request $request
* @param API_OAuth2_Account $account
* @param integer $log_id
*/
public function __construct(Application $app, $log_id)
{

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 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)
@@ -159,7 +163,7 @@ 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 integer $taskId
* @return \API_V1_result
*/
public function get_task(Application $app, $taskId)
@@ -181,7 +185,7 @@ 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 integer $taskId The task id
* @return \API_V1_result
*/
public function start_task(Application $app, $taskId)
@@ -204,7 +208,7 @@ 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 integer $taskId The task id
* @return \API_V1_result
*/
public function stop_task(Application $app, $taskId)
@@ -228,7 +232,7 @@ class API_V1_adapter extends API_V1_Abstract
* - autostart
*
* @param \Silex\Application $app Silex application
* @param integer $task_id the task id
* @param integer $taskId the task id
* @return \API_V1_result
* @throws \API_V1_exception_badrequest
*/
@@ -510,7 +514,7 @@ class API_V1_adapter extends API_V1_Abstract
* Get an API_V1_result containing the databoxes
*
* @param Request $request
* @param string $response_type
*
* @return API_V1_result
*/
public function get_databoxes(Request $request)
@@ -527,7 +531,7 @@ class API_V1_adapter extends API_V1_Abstract
*
* @param Request $request
* @param int $databox_id
* @param string $response_type
*
* @return API_V1_result
*/
public function get_databox_collections(Request $request, $databox_id)
@@ -550,7 +554,7 @@ class API_V1_adapter extends API_V1_Abstract
*
* @param Request $request
* @param int $databox_id
* @param string $response_type
*
* @return API_V1_result
*/
public function get_databox_status(Request $request, $databox_id)
@@ -574,7 +578,7 @@ class API_V1_adapter extends API_V1_Abstract
*
* @param Request $request
* @param int $databox_id
* @param string $response_type
*
* @return API_V1_result
*/
public function get_databox_metadatas(Request $request, $databox_id)
@@ -599,7 +603,7 @@ class API_V1_adapter extends API_V1_Abstract
*
* @param Request $request
* @param int $databox_id
* @param string $response_type
*
* @return API_V1_result
*/
public function get_databox_terms(Request $request, $databox_id)
@@ -858,8 +862,7 @@ class API_V1_adapter extends API_V1_Abstract
* Deprecated in favor of search
*
* @param Request $request
* @param int $databox_id
* @param string $response_type
*
* @return API_V1_result
*/
public function search_records(Request $request)
@@ -927,7 +930,7 @@ class API_V1_adapter extends API_V1_Abstract
* @param Request $request
* @param int $databox_id
* @param int $record_id
* @param string $response_type
*
* @return API_V1_result
*/
public function get_record_related(Request $request, $databox_id, $record_id)
@@ -963,7 +966,7 @@ class API_V1_adapter extends API_V1_Abstract
* @param Request $request
* @param int $databox_id
* @param int $record_id
* @param string $response_type
*
* @return API_V1_result
*/
public function get_record_metadatas(Request $request, $databox_id, $record_id)
@@ -987,7 +990,7 @@ class API_V1_adapter extends API_V1_Abstract
* @param Request $request
* @param int $databox_id
* @param int $record_id
* @param string $response_type
*
* @return API_V1_result
*/
public function get_record_status(Request $request, $databox_id, $record_id)
@@ -1017,7 +1020,7 @@ class API_V1_adapter extends API_V1_Abstract
* @param Request $request
* @param int $databox_id
* @param int $record_id
* @param string $response_type
*
* @return API_V1_result
*/
public function get_record_embed(Request $request, $databox_id, $record_id)
@@ -1047,7 +1050,7 @@ class API_V1_adapter extends API_V1_Abstract
* @param Request $request
* @param int $databox_id
* @param int $record_id
* @param string $response_type
*
* @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
*/
@@ -1879,9 +1879,10 @@ class API_V1_adapter extends API_V1_Abstract
* Retrieve detailled informations about one 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');

View File

@@ -100,7 +100,7 @@ class API_V1_result
*
* @param Request $request
* @param API_V1_adapter $api
* @param string $response_type One of the API_V1_result 'FORMAT_*' constants
*
* @return API_V1_result
*/
public function __construct(Request $request, API_V1_adapter $api)
@@ -249,6 +249,8 @@ class API_V1_result
* with the appropriate datas
*
* @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)

View File

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

View File

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

View File

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

View File

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

View File

@@ -263,8 +263,7 @@ 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 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 Request $request
* @param record_adapter $record
*
* @return array
*/
public function get_upload_datas(Request $request, record_adapter $record)

View File

@@ -36,6 +36,8 @@ class Bridge_Api_Flickr_Element implements Bridge_Api_ElementInterface
* @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)

View File

@@ -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 $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 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 Request $request
* @param record_adapter $record
*
* @return array
*/
public function get_upload_datas(Request $request, record_adapter $record)

View File

@@ -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
*/

View File

@@ -51,9 +51,10 @@ class Feed_Token
/**
*
* @param appbox $appbox
* @param Application $app
* @param string $token
* @param int $feed_id
*
* @return Feed_Token
*/
public function __construct(Application $app, $token, $feed_id)

View File

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

View File

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

View File

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

View File

@@ -46,8 +46,10 @@ class Session_Logger
/**
*
* @param Application $app
* @param databox $databox
* @param int $log_id
* @param integer $log_id
*
* @return Session_Logger
*/
public function __construct(Application $app, databox $databox, $log_id)
@@ -92,9 +94,10 @@ class Session_Logger
/**
*
* @param Application $app
* @param databox $databox
* @param User_Adapter $user
* @param Browser $browser
*
* @return Session_Logger
*/
public static function create(Application $app, databox $databox, Browser $browser)

View File

@@ -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 Application $app
* @param string $login
* @return int
*
* @return integer
*/
public static function get_usr_id_from_login(Application $app, $login)
{

View File

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

View File

@@ -61,7 +61,9 @@ class appbox_register
* Return an array of collection objects where provided
* user is waiting for approbation
*
* @param Application $app
* @param User_Interface $user
*
* @return array
*/
public function get_collection_awaiting_for_user(Application $app, User_Interface $user)

View File

@@ -22,8 +22,9 @@ class cache_databox
protected static $refreshing = false;
/**
*
* @param Application $app
* @param int $sbas_id
*
* @return cache_databox
*/
public static function refresh(Application $app, $sbas_id)
@@ -142,11 +143,10 @@ class cache_databox
}
/**
*
* @param Application $app
* @param int $sbas_id
* @param string $type
* @param mixed content $value
* @return Void
*/
public static function update(Application $app, $sbas_id, $type, $value = '')
{

View File

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

View File

@@ -42,9 +42,10 @@ class caption_field implements cache_cacheableInterface
/**
*
* @param Application $app
* @param databox_field $databox_field
* @param record_Interface $record
* @param int $id
*
* @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)

View File

@@ -46,8 +46,10 @@ class caption_record implements caption_interface, cache_cacheableInterface
/**
*
* @param Application $app
* @param record_Interface $record
* @param databox $databox
*
* @return caption_record
*/
public function __construct(Application $app, record_Interface $record, databox $databox)
@@ -178,6 +180,8 @@ class caption_record implements caption_interface, cache_cacheableInterface
/**
*
* @param array $grep_fields
* @param Boolean $IncludeBusiness
*
* @return array
*/
public function get_fields(Array $grep_fields = null, $IncludeBusiness = false)
@@ -236,6 +240,8 @@ class caption_record implements caption_interface, cache_cacheableInterface
* @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)

View File

@@ -362,6 +362,7 @@ class collection implements cache_cacheableInterface
/**
*
* @param Application $app
* @param int $base_id
* @return collection
*/
@@ -379,7 +380,8 @@ class collection implements cache_cacheableInterface
/**
*
* @param int $sbas_id
* @param Application $app
* @param databox $databox
* @param int $coll_id
* @return collection
*/

View File

@@ -105,7 +105,9 @@ class connection
/**
*
* @param Application $app
* @param string $name
*
* @return connection_pdo
*/
public static function getPDOConnection(Application $app, $name = null)

View File

@@ -28,6 +28,8 @@ class connection_pdo extends connection_abstract implements connection_interface
* @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)

View File

@@ -469,6 +469,7 @@ class databox extends base
/**
*
* @param Application $app
* @param string $host
* @param int $port
* @param string $user
@@ -962,8 +963,6 @@ class databox extends base
}
/**
*
* @param <type> $sbas_id
* @return DOMDocument
*/
public function get_dom_thesaurus()
@@ -988,8 +987,6 @@ class databox extends base
}
/**
*
* @param <type> $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 <type> $sbas_id
* @return DOMDocument
*/
public function get_dom_structure()
@@ -1150,8 +1140,6 @@ class databox extends base
}
/**
*
* @param <type> $sbas_id
* @return DOMDocument
*/
public function get_dom_cterms()
@@ -1197,8 +1185,6 @@ class databox extends base
}
/**
*
* @param <type> $sbas_id
* @return DOMXpath
*/
public function get_xpath_structure()

View File

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

View File

@@ -58,7 +58,9 @@ class databox_subdef
/**
*
* @param SubdefType $type
* @param SimpleXMLElement $sd
*
* @return databox_subdef
*/
public function __construct(SubdefType $type, SimpleXMLElement $sd)

View File

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

View File

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

View File

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

View File

@@ -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 Alchemyst $alchemyst
* @param MediaVorus $mediavorus
*
* @return media_subdef
*/
public function rotate($angle, Alchemyst $alchemyst, MediaVorus $mediavorus)

View File

@@ -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,9 +810,13 @@ class module_report
}
/**
* @desc build the final formated array which contains all the result,
* 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)

View File

@@ -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
* 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 = "")

View File

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

View File

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

View File

@@ -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 <int> $usrid
* @param <int> $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 <string> $separotor
* La liste des base authorisee sous forme de string
*
* @param string $separator
*
* @return string
*/
public function getListeBase($separator)

View File

@@ -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 <int> $sbasid
* @param <string> $sbas_coll
* @param <string> $dmin
* @param <string> $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 <int> $sbasid
* @param <string> $sbas_collection, les collection sous forme de string
* parés par une virgule
* @param <string> $dmin, Y-m-d
* @param <string> $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)
{

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@@ -58,6 +58,8 @@ class patch_370a8 implements patchInterface
* will group tasks(01) with same period to a single task(02)
*
* @param base $appbox
* @param Application $app
*
* @return boolean
*/
public function apply(base $appbox, Application $app)

View File

@@ -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 Application $app
*/
public function apply(base $appbox, Application $app)
{

View File

@@ -55,6 +55,7 @@ class patch_371 implements patchInterface
/**
* @param base $databox
* @param Application $app
*/
public function apply(base $databox, Application $app)
{

View File

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

View File

@@ -55,6 +55,7 @@ class patch_380 implements patchInterface
/**
* @param base $databox
* @param Application $app
*/
public function apply(base $databox, Application $app)
{

View File

@@ -55,6 +55,7 @@ class patch_3802 implements patchInterface
/**
* @param base $appbox
* @param Application $app
*/
public function apply(base $appbox, Application $app)
{

View File

@@ -56,6 +56,7 @@ class patch_3803 implements patchInterface
/**
* @param base $appbox
* @param Application $app
*/
public function apply(base $appbox, Application $app)
{

View File

@@ -50,6 +50,7 @@ class patch_3804 implements patchInterface
/**
* @param base $appbox
* @param Application $app
*/
public function apply(base $appbox, Application $app)
{

View File

@@ -103,10 +103,12 @@ class random
/**
*
* @param Application $app
* @param string $type
* @param int $usr
* @param string $end_date
* @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 Application $app
* @param integer $userId
* @param integer $basketId
* @return string The desired token
*
* @return string The token
*
* @throws \Exception_NotFound
*/
public static function getValidationToken(Application $app, $userId, $basketId)

View File

@@ -157,11 +157,11 @@ class record_adapter implements record_Interface, cache_cacheableInterface
/**
*
* @param <int> $base_id
* @param <int> $record_id
* @param <int> $number
* @param <string> $xml
* @param <string> $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 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 Application $app
* @param \collection $collection
*
* @return \record_adapter
*/
public static function createStory(Application $app, \collection $collection)
@@ -1297,6 +1301,8 @@ class record_adapter implements record_Interface, cache_cacheableInterface
/**
*
* @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 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)
@@ -1875,9 +1884,12 @@ class record_adapter implements record_Interface, cache_cacheableInterface
/**
*
* @param databox $databox
* @param int $offset_start
* @param int $how_many
* @return type
* @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)
{

View File

@@ -51,10 +51,12 @@ class record_exportElement extends record_adapter
/**
*
* @param int $base_id
* @param int $record_id
* @param Application $app
* @param integer $sbas_id
* @param integer $record_id
* @param string $directory
* @param int $remain_hd
* @param integer $remain_hd
*
* @return record_exportElement
*/
public function __construct(Application $app, $sbas_id, $record_id, $directory = '', $remain_hd = false)

View File

@@ -33,7 +33,8 @@ class record_orderElement extends record_adapter
/**
*
* @param int $base_id
* @param Application $app
* @param int $sbas_id
* @param int $record_id
* @param boolean $deny
* @param int $order_master_id

View File

@@ -82,9 +82,13 @@ class record_preview extends record_adapter
/**
*
* @param Application $app
* @param string $env
* @param int $pos
* @param mixed content $contId
* @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 = '')

View File

@@ -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 Application $app
* @param \media_subdef $subdef
*
* @return boolean|string
*/
public static function watermark(Application $app, \media_subdef $subdef)

View File

@@ -38,7 +38,7 @@ class registry implements registryInterface
/**
*
* @param \Alchemy\Phrasea\Cache\Cache $cache
* @param Application $app
* @return registry
*/
public function __construct(Application $app)
@@ -130,6 +130,8 @@ class registry implements registryInterface
/**
*
* @param string $key
* @param mixed $defaultvalue
*
* @return mixed
*/
public function get($key, $defaultvalue = null)
@@ -148,6 +150,8 @@ class registry implements registryInterface
*
* @param string $key
* @param mixed $value
* @param string $type
*
* @return registry
*/
public function set($key, $value, $type)

View File

@@ -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 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 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 Application $app
* @param Array $list
* @param String> $type
* @param String $type
* @param boolean $anonymous
* @param string $comment
*
* @return Void
*/
public static function log_download(Application $app, Array $list, $type, $anonymous = false, $comment = '')

View File

@@ -20,15 +20,17 @@ class set_exportftp extends set_export
/**
*
* @param Int $usr_to
* @param integer $usr_to
* @param String $host
* @param String $login
* @param String $password
* @param Int $ssl
* @param Int $retry
* @param Int $passif
* @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)

View File

@@ -72,10 +72,12 @@ class set_order extends set_abstract
/**
* Create a new order entry
*
* @param RecordsRequest $recordsRequest
* @param integer $orderer
* @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 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 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 Application $app
* @param Array $elements_ids
* @param boolean $force
*
* @return set_order
*/
public function send_elements(Application $app, Array $elements_ids, $force)

View File

@@ -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));
@@ -49,6 +50,8 @@ class set_selection extends set_abstract
/**
*
* @param array $rights
* @param array $sbas_rights
*
* @return set_selection
*/
public function grep_authorized(Array $rights = array(), Array $sbas_rights = array())
@@ -117,6 +120,8 @@ class set_selection extends set_abstract
/**
*
* @param array $lst
* @param Boolean $flatten_groupings
*
* @return set_selection
*/
public function load_list(Array $lst, $flatten_groupings = false)

View File

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

View File

@@ -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 = '_')
{