dolibarr  21.0.0-alpha
Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
Partnerships Class Reference
Inheritance diagram for Partnerships:
Inheritance graph
[legend]
Collaboration diagram for Partnerships:
Collaboration graph
[legend]

Public Member Functions

 __construct ()
 Constructor. More...
 
 get ($id)
 Get properties of a partnership object. More...
 
 index ($sortfield="t.rowid", $sortorder='ASC', $limit=100, $page=0, $sqlfilters='', $properties='')
 List partnerships. More...
 
 post ($request_data=null)
 Create partnership object. More...
 
 put ($id, $request_data=null)
 Update partnership. More...
 
 delete ($id)
 Delete partnership. More...
 
- Public Member Functions inherited from DolibarrApi
 __construct ($db, $cachedir='', $refreshCache=false)
 Constructor. More...
 

Protected Member Functions

 _cleanObjectDatas ($object)
 Clean sensible object datas. More...
 
- Protected Member Functions inherited from DolibarrApi
 _checkValForAPI ($field, $value, $object)
 Check and convert a string depending on its type/name. More...
 
 _filterObjectProperties ($object, $properties)
 Filter properties that will be returned on object. More...
 
 _checkFilters ($sqlfilters, &$error='')
 Return if a $sqlfilters parameter is valid Function no more used. More...
 

Private Member Functions

 _validate ($data)
 Validate fields before create or update object. More...
 

Additional Inherited Members

- Static Protected Member Functions inherited from DolibarrApi
static _checkAccessToResource ($resource, $resource_id=0, $dbtablename='', $feature2='', $dbt_keyfield='fk_soc', $dbt_select='rowid')
 Check access by user to a given resource. More...
 
static _forge_criteria_callback ($matches)
 Function to forge a SQL criteria from a Generic filter string. More...
 

Detailed Description

Definition at line 36 of file api_partnerships.class.php.

Constructor & Destructor Documentation

◆ __construct()

Partnerships::__construct ( )

Constructor.

@url GET /

Definition at line 49 of file api_partnerships.class.php.

Member Function Documentation

◆ _cleanObjectDatas()

Partnerships::_cleanObjectDatas (   $object)
protected

Clean sensible object datas.

Parameters
Object$objectObject to clean
Returns
Object Object with cleaned properties

Reimplemented from DolibarrApi.

Definition at line 310 of file api_partnerships.class.php.

References $object.

◆ _validate()

Partnerships::_validate (   $data)
private

Validate fields before create or update object.

Parameters
array$dataArray of data to validate
Returns
array
Exceptions
RestException

Definition at line 374 of file api_partnerships.class.php.

◆ delete()

Partnerships::delete (   $id)

Delete partnership.

Parameters
int$idPartnership ID
Returns
array
Exceptions
RestException@url DELETE partnerships/{id}

Definition at line 276 of file api_partnerships.class.php.

◆ get()

Partnerships::get (   $id)

Get properties of a partnership object.

Return an array with partnership information

Parameters
int$idID of partnership
Returns
Object Object with cleaned properties

@url GET partnerships/{id}

Exceptions
RestException403 Not allowed
RestException404 Not found

Definition at line 69 of file api_partnerships.class.php.

◆ index()

Partnerships::index (   $sortfield = "t.rowid",
  $sortorder = 'ASC',
  $limit = 100,
  $page = 0,
  $sqlfilters = '',
  $properties = '' 
)

List partnerships.

Get a list of partnerships

Parameters
string$sortfieldSort field
string$sortorderSort order
int$limitLimit for list
int$pagePage number
string$sqlfiltersOther criteria to filter answers separated by a comma. Syntax example "(t.ref:like:'SO-%') and (t.date_creation:<:'20160101')"
string$propertiesRestrict the data returned to these properties. Ignored if empty. Comma separated list of properties names
Returns
array Array of order objects
Exceptions
RestException@url GET /partnerships/

Definition at line 105 of file api_partnerships.class.php.

◆ post()

Partnerships::post (   $request_data = null)

Create partnership object.

Parameters
array$request_dataRequest datas
Returns
int ID of partnership
Exceptions
RestException@url POST partnerships/

Definition at line 189 of file api_partnerships.class.php.

◆ put()

Partnerships::put (   $id,
  $request_data = null 
)

Update partnership.

Parameters
int$idId of partnership to update
array$request_dataDatas
Returns
Object Updated object
Exceptions
RestException@url PUT partnerships/{id}

Definition at line 228 of file api_partnerships.class.php.


The documentation for this class was generated from the following file: