Missing PHPDOC for REST API working for thirdparties

These tags are very important for REST API. Please have a look at https://github.com/Luracast/Restler/blob/master/ANNOTATIONS.md
This commit is contained in:
jfefe 2015-05-01 16:16:31 +02:00
parent d406830e06
commit 1536cd430d

View File

@ -50,45 +50,54 @@ class Societe extends CommonObject
*/ */
protected $ismultientitymanaged = 1; protected $ismultientitymanaged = 1;
var $id; public $id;
var $name; public $name;
var $entity; public $entity;
/** /**
* Thirdparty name
* @var string
* @deprecated Use $name instead * @deprecated Use $name instead
*/ */
var $nom; public $nom;
var $firstname; public $firstname;
var $lastname; public $lastname;
var $particulier; public $particulier;
var $civility_id; public $civility_id;
var $address; public $address;
var $zip; public $zip;
var $town; public $town;
/** /**
* 0=activity ceased, 1= in activity * Thirdparty status : 0=activity ceased, 1= in activity
* @var int * @var int
*/ */
var $status; var $status;
/** /**
* Id of department * Id of department
* @var int
*/ */
var $state_id; var $state_id;
var $state_code; var $state_code;
var $state; var $state;
/** /**
* State code
* @var string
* @deprecated Use state_code instead * @deprecated Use state_code instead
*/ */
var $departement_code; var $departement_code;
/** /**
* @var string
* @deprecated Use state instead * @deprecated Use state instead
*/ */
var $departement; var $departement;
/** /**
* @var string
* @deprecated Use country instead * @deprecated Use country instead
*/ */
var $pays; var $pays;
@ -223,18 +232,22 @@ class Societe extends CommonObject
/** /**
* Date of last update * Date of last update
* @var string
*/ */
var $date_modification; var $date_modification;
/** /**
* User that made last update * User that made last update
* @var string
*/ */
var $user_modification; var $user_modification;
/** /**
* Date of creation * Date of creation
* @var string
*/ */
var $date_creation; var $date_creation;
/** /**
* User that created the thirdparty * User that created the thirdparty
* @var User
*/ */
var $user_creation; var $user_creation;
@ -282,6 +295,7 @@ class Societe extends CommonObject
var $code_compta_fournisseur; var $code_compta_fournisseur;
/** /**
* @var string
* @deprecated Note is split in public and private notes * @deprecated Note is split in public and private notes
*/ */
var $note; var $note;
@ -310,6 +324,7 @@ class Societe extends CommonObject
/** /**
* Id of sales representative to link (used for thirdparty creation). Not filled by a fetch, because we can have several sales representatives. * Id of sales representative to link (used for thirdparty creation). Not filled by a fetch, because we can have several sales representatives.
* @var int
*/ */
var $commercial_id; var $commercial_id;
var $parent; var $parent;
@ -358,6 +373,7 @@ class Societe extends CommonObject
/** /**
* To contains a clone of this when we need to save old properties of object * To contains a clone of this when we need to save old properties of object
* @var Societe
*/ */
var $oldcopy; var $oldcopy;