Dev: PHPdoc AR model properties (#833)

application/models/Assessment.php

@@ -16,7 +16,7 @@
 /**
  * Class Assessment
  *
- * @property integer $id
+ * @property integer $id Primary key
  * @property integer $sid Survey id
  * @property integer $gid Group id
  * @property string $scope

application/models/Boxes.php

@@ -4,11 +4,11 @@
  * This is the model class for table "{{boxes}}".
  *
  * The followings are the available columns in table '{{boxes}}':
- * @property integer $id
+ * @property integer $id Primary key
  * @property integer $position
  * @property string $url
  * @property string $title
- * @property string $desc
+ * @property string $desc Description
  * @property string $page
  * @property integer $usergroup UserGroup ID
  */

application/models/ExpressionError.php

@@ -15,11 +15,11 @@
 /**
  * Class ExpressionError
  *
- * @property integer $id
+ * @property integer $id Primary key
  * @property string $errortime
- * @property integer $sid
- * @property integer $gid
- * @property integer $qid
+ * @property integer $sid Survey ID
+ * @property integer $gid Group ID
+ * @property integer $qid Question ID
  * @property integer $gseq
  * @property integer $qseq
  * @property string $type

application/models/Label.php

@@ -16,7 +16,7 @@
 /**
  * Class Label
  *
- * @property integer $lid ID
+ * @property integer $lid Primary Key
  * @property string $code
  * @property string $title
  * @property integer $sortorder

application/models/Notification.php

@@ -9,12 +9,12 @@
  * @property string $entity_id survey id or user id
  * @property string $title
  * @property string $message
+ * @property string $status new, read
  * @property integer $importance 1 or 3. 3 will show popup on page load, 2 is reserved for future bell animation.
  * @property string $display_class warning, danger, success
- * @property string $status new, read
- * @property DateTime $created When the notification was created
- * @property DateTime $first_read When the notification was read
  * @property string $hash
+ * @property string $created When the notification was created
+ * @property string $first_read When the notification was read
  */
 class Notification extends LSActiveRecord
 {

application/models/Participant.php

@@ -23,13 +23,16 @@ class CPDBException extends Exception {}
  * This is the model class for table "{{participants}}".
  *
  * The followings are the available columns in table '{{participants}}':
- * @property string $participant_id
+ * @property string $participant_id Primary Key
  * @property string $firstname
  * @property string $lastname
  * @property string $email
  * @property string $language
- * @property string $blacklisted
+ * @property integer $blacklisted
  * @property integer $owner_uid
+ * @property integer $created_by
+ * @property string $created Date-time of creation
+ * @property string $modified Date-time of modification
  *
  * @property User $owner
  * @property SurveyLink[] $surveylinks

application/models/Plugin.php

@@ -19,6 +19,7 @@
  * @property integer $id
  * @property string $name
  * @property integer $active
+ * @property string $version
  *
  */
 class Plugin extends CActiveRecord {

application/models/SavedControl.php

@@ -11,6 +11,21 @@
  * See COPYRIGHT.php for copyright notices and details.
  *
  */
+
+/**
+ * Class SavedControl
+ * @property integer $scid Primary key
+ * @property integer $sid Survey id
+ * @property integer $srid
+ * @property string $identifier
+ * @property string $access_code
+ * @property string $email
+ * @property string $ip
+ * @property string $saved_thisstep
+ * @property string $status
+ * @property string $saved_date
+ * @property string $refurl
+ */
 class SavedControl extends LSActiveRecord {
 
     /** @inheritdoc */

application/models/Session.php

@@ -13,6 +13,13 @@
      *	Files Purpose: lots of common functions
 */
 
+/**
+ * Class Session
+ *
+ * @property string $id Primary Key
+ * @property integer $expire
+ * @property string $data
+ */
 class Session extends CActiveRecord
 {
 	/**

application/models/SettingGlobal.php

@@ -13,6 +13,13 @@
      *	Files Purpose: lots of common functions
 */
 
+/**
+ * Class SettingGlobal
+ *
+ * @property string $stg_name Setting name
+ * @property string $stg_value Setting value
+ *
+ */
 class SettingGlobal extends LSActiveRecord
 {
 	/**

application/models/SettingsUser.php

@@ -4,11 +4,11 @@
  * This is the model class for table "{{settings_user}}".
  *
  * The followings are the available columns in table '{{settings_user}}':
- * @property integer $uid
- * @property string $entity
- * @property string $entity_id
- * @property string $stg_name
- * @property string $stg_value
+ * @property integer $uid User id
+ * @property string $entity Entity name
+ * @property string $entity_id Entity ID
+ * @property string $stg_name Setting name
+ * @property string $stg_value Setting Value
  */
 class SettingsUser extends CActiveRecord
 {

application/models/Surveymenu.php

@@ -16,6 +16,7 @@
  * @property integer $changed_by
  * @property string $created_at
  * @property integer $created_by
+ * @property integer $active
  *
  * The followings are the available model relations:
  * @property SurveymenuEntries[] $surveymenuEntries

application/models/SurveymenuEntries.php

@@ -28,6 +28,7 @@
  * @property integer $changed_by
  * @property string $created_at
  * @property integer $created_by
+ * @property integer $active
  *
  * The followings are the available model relations:
  * @property Surveymenu $menu

application/models/Template.php

@@ -21,8 +21,22 @@ class TemplateException extends Exception {}
 /**
  * Class Template
  *
+ * @property string $name Template name
  * @property string $folder Template folder name eg: 'default'
- * @property integer $creator User ID of Template creator
+ * @property string $title
+ * @property string $creation_date
+ * @property string $author
+ * @property string $author_email
+ * @property string $author_url
+ * @property string $copyright
+ * @property string $license
+ * @property string $version
+ * @property string $view_folder
+ * @property string $files_folder
+ * @property string $description
+ * @property string $last_update
+ * @property integer $owner_id
+ * @property string $extends_template_name
  */
 class Template extends LSActiveRecord
 {

application/models/TemplateConfig.php

@@ -13,10 +13,14 @@
 */
 
 /*
- * Common methods for TemplateConfiguration and TemplateManifest
  */
 
- class TemplateConfig extends CActiveRecord
+/**
+ * Class TemplateConfig
+ * Common methods for TemplateConfiguration and TemplateManifest
+ *
+ */
+class TemplateConfig extends CActiveRecord
  {
     /** @var string $sTemplateName The template name */
     public $sTemplateName='';

application/models/TemplateConfiguration.php

@@ -18,22 +18,22 @@
  * NOTE: if you only need to access to the table, you don't need to call prepareTemplateRendering
  *
  * The followings are the available columns in table '{{template_configuration}}':
- * @property string $id
+ * @property integer $id Primary key
  * @property string $template_name
- * @property string $gsid
- * @property string $sid
+ * @property integer $sid Survey ID
+ * @property integer $gsid
+ * @property integer $uid user ID
  * @property string $files_css
  * @property string $files_js
  * @property string $files_print_css
  * @property string $options
  * @property string $cssframework_name
  * @property string $cssframework_css
  * @property string $cssframework_js
- * @property string $viewdirectory
- * @property string $filesdirectory
  * @property string $packages_to_load
+ * @property string $packages_ltr
+ * @property string $packages_rtl
  * @property string $packages_rtl
- *
  *
  * @package       LimeSurvey
  * @subpackage    Backend

application/models/Token.php

@@ -36,10 +36,10 @@
  * @property integer $tid Token ID
  * @property string $participant_id Participant ID
  * @property string $firstname Participant's first name
- * @property string $lasttname Participant's last name
+ * @property string $lastname Participant's last name
  * @property string $email Participant's e-mail address
  * @property string $emailstatus Participant's e-mail address status: OK/bounced/OptOut
- * @property string $token Participant's unique token
+ * @property string $token Participant's token
  * @property string $language Participant's language eg: en
  * @property string $blacklisted Whether participant is blacklisted: (Y/N)
  * @property string $sent