Inheritance diagram for Subscriptions:
Collaboration diagram for Subscriptions:
Public Member Functions | |
| __construct () | |
| Constructor. | |
| get ($id) | |
| Get properties of a subscription object. More... | |
| index ($sortfield="dateadh", $sortorder='ASC', $limit=100, $page=0, $sqlfilters='') | |
| List subscriptions. More... | |
| post ($request_data=null) | |
| Create subscription object. More... | |
| put ($id, $request_data=null) | |
| Update subscription. More... | |
| delete ($id) | |
| Delete subscription. More... | |
| _validate ($data) | |
| Validate fields before creating an object. More... | |
| Public Member Functions inherited from DolibarrApi | |
| __construct ($db, $cachedir='', $refreshCache=false) | |
| Constructor. More... | |
| _cleanObjectDatas ($object) | |
| Executed method when API is called without parameter. More... | |
| _checkFilters ($sqlfilters) | |
| Return if a $sqlfilters parameter is valid. More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from DolibarrApi | |
| static | _checkAccessToResource ($resource, $resource_id=0, $dbtablename='', $feature2='', $dbt_keyfield='fk_soc', $dbt_select='rowid') |
| Check user access to a resource. More... | |
| static | _forge_criteria_callback ($matches) |
| Function to forge a SQL criteria. More... | |
Detailed Description
Definition at line 28 of file api_subscriptions.class.php.
Member Function Documentation
◆ _validate()
| Subscriptions::_validate | ( | $data | ) |
Validate fields before creating an object.
- Parameters
-
array | null $data Data to validate
- Returns
- array
- Exceptions
-
RestException
Definition at line 244 of file api_subscriptions.class.php.
◆ delete()
| Subscriptions::delete | ( | $id | ) |
Delete subscription.
- Parameters
-
int $id ID of subscription to delete
- Returns
- array
Definition at line 212 of file api_subscriptions.class.php.
◆ get()
| Subscriptions::get | ( | $id | ) |
Get properties of a subscription object.
Return an array with subscription informations
- Parameters
-
int $id ID of subscription
- Returns
- array|mixed data without useless information
- Exceptions
-
RestException
Definition at line 59 of file api_subscriptions.class.php.
◆ index()
| Subscriptions::index | ( | $sortfield = "dateadh", |
|
$sortorder = 'ASC', |
|||
$limit = 100, |
|||
$page = 0, |
|||
$sqlfilters = '' |
|||
| ) |
List subscriptions.
Get a list of subscriptions
- Parameters
-
string $sortfield Sort field string $sortorder Sort order int $limit Limit for list int $page Page number string $sqlfilters Other criteria to filter answers separated by a comma. Syntax example "(t.ref:like:'SO-%') and (t.import_key:<:'20160101')"
- Returns
- array Array of subscription objects
- Exceptions
-
RestException
Definition at line 88 of file api_subscriptions.class.php.
◆ post()
| Subscriptions::post | ( | $request_data = null | ) |
Create subscription object.
- Parameters
-
array $request_data Request data
- Returns
- int ID of subscription
Definition at line 154 of file api_subscriptions.class.php.
◆ put()
| Subscriptions::put | ( | $id, | |
$request_data = null |
|||
| ) |
Update subscription.
- Parameters
-
int $id ID of subscription to update array $request_data Datas
- Returns
- int
Definition at line 179 of file api_subscriptions.class.php.
The documentation for this class was generated from the following file:
- htdocs/adherents/class/api_subscriptions.class.php