Qual: Add phpdoc for request_data param

This commit is contained in:
MDW
2025-03-02 12:13:32 +01:00
parent 21e5457e19
commit c02293a880
28 changed files with 325 additions and 149 deletions

View File

@@ -1,5 +1,6 @@
<?php
/* Copyright (C) 2024 Florian Charlaix <fcharlaix@easya.solutions>
* Copyright (C) 2025 MDW <mdeweerd@users.noreply.github.com>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
@@ -22,13 +23,11 @@ use Luracast\Restler\RestException;
*
* @access protected
* @class DolibarrApiAccess {@requires user}
*
*/
class Webhook extends DolibarrApi
{
/**
*
* @var array $FIELDS Mandatory fields, checked when we create and update the object
* @var array Mandatory fields, checked when we create and update the object
*/
public static $FIELDS = array(
'url',
@@ -36,7 +35,7 @@ class Webhook extends DolibarrApi
);
/**
* @var Target $target {@type Target}
* @var Target {@type Target}
*/
public $target;
@@ -158,7 +157,9 @@ class Webhook extends DolibarrApi
/**
* Create target object
*
* @param array $request_data Request datas
* @param array $request_data Request data
* @phan-param ?array<string,string> $request_data
* @phpstan-param ?array<string,string> $request_data
* @return int ID of target
*/
public function post($request_data = null)
@@ -188,7 +189,9 @@ class Webhook extends DolibarrApi
* Update target
*
* @param int $id Id of target to update
* @param array $request_data Datas
* @param array $request_data Data
* @phan-param ?array<string,string> $request_data
* @phpstan-param ?array<string,string> $request_data
* @return Object|false Updated object
*
* @throws RestException 401