More documentation

Author: Jamie Snape

core/AppController.php

@@ -566,125 +566,87 @@ protected function t($text)
         return InternationalizationComponent::translate($text);
     }
 
-    /** completion eclipse */
-    /**
-     * Assetstore Model
-     *
-     * @var AssetstoreModelBase
-     */
+    /** @var ActivedownloadModel */
+    public $Activedownload;
+
+    /** @var AssetstoreModel */
     public $Assetstore;
 
-    /**
-     * Bitstream Model
-     *
-     * @var BitstreamModelBase
-     */
+    /** @var BitstreamModel */
     public $Bitstream;
 
-    /**
-     * Community Model
-     *
-     * @var CommunityModelBase
-     */
+    /** @var CommunityModel */
     public $Community;
 
-    /**
-     * Errorlog Model
-     *
-     * @var ErrorlogModelBase
-     */
+    /** @var CommunityInvitationModel */
+    public $CommunityInvitation;
+
+    /** @var object */
+    public $Component;
+
+    /** @var ErrorlogModel */
     public $Errorlog;
 
-    /**
-     * Feed Model
-     *
-     * @var FeedModelBase
-     */
+    /** @var FeedModel */
     public $Feed;
 
-    /**
-     * Feedpolicygroup Model
-     *
-     * @var FeedpolicygroupModelBase
-     */
+    /** @var FeedpolicygroupModel */
     public $Feedpolicygroup;
 
-    /**
-     * Feedpolicyuser Model
-     *
-     * @var FeedpolicyuserModelBase
-     */
+    /** @var FeedpolicyuserModel */
     public $Feedpolicyuser;
 
-    /**
-     * Folder Model
-     *
-     * @var FolderModelBase
-     */
+    /** @var FolderModel */
     public $Folder;
 
-    /**
-     * Folderpolicygroup Model
-     *
-     * @var FolderpolicygroupModelBase
-     */
+    /** @var FolderpolicygroupModel */
     public $Folderpolicygroup;
 
-    /**
-     * Folderpolicyuser Model
-     *
-     * @var FolderpolicyuserModelBase
-     */
+    /** @var FolderpolicyuserModel */
     public $Folderpolicyuser;
 
-    /**
-     * Group Model
-     *
-     * @var GroupModelBase
-     */
+    /** @var object */
+    public $Form;
+
+    /** @var GroupModel */
     public $Group;
 
-    /**
-     * Item Model
-     *
-     * @var ItemModelBase
-     */
+    /** @var ItemModel */
     public $Item;
 
-    /**
-     * Itempolicygroup Model
-     *
-     * @var ItempolicygroupModelBase
-     */
+    /** @var ItempolicygroupModel */
     public $Itempolicygroup;
 
-    /**
-     * Itempolicyuser Model
-     *
-     * @var ItempolicyuserModelBase
-     */
+    /** @var ItempolicyuserModel */
     public $Itempolicyuser;
 
-    /**
-     * ItemRevision Model
-     *
-     * @var ItemRevisionModelBase
-     */
+    /** @var ItemRevisionModel */
     public $ItemRevision;
 
-    /**
-     * User Model
-     *
-     * @var UserModelBase
-     */
-    public $User;
+    /** @var LicenseModel */
+    public $License;
 
-    /**
-     * Setting Model
-     *
-     * @var SettingModelBase
-     */
+    /** @var MetadataModel */
+    public $Metadata;
+
+    /** @var NewUserInvitationModel */
+    public $NewUserInvitation;
+
+    /** @var PendingUserModel */
+    public $PendingUser;
+
+    /** @var ProgressModel */
+    public $Progress;
+
+    /** @var SettingModel */
     public $Setting;
 
-    /** end completion eclipse */
+    /** @var TokenModel */
+    public $Token;
+
+    /** @var UserModel */
+    public $User;
+
+    /** @var UserapiModel */
+    public $Userapi;
 }

modules/GlobalModule.php

@@ -21,8 +21,10 @@
 require_once BASE_PATH.'/core/AppController.php';
 
 /**
- *  GlobalAction
- *  Provides global function to the controllers
+ * Provides global function to the controllers
+ *
+ * @property object $ModuleComponent
+ * @property object $ModuleForm
  */
 class MIDAS_GlobalModule extends AppController
 {

notification/GlobalNotification.php

@@ -18,7 +18,41 @@
  limitations under the License.
 =========================================================================*/
 
-/** Provides global function to the notification managers */
+/**
+ * Provides global function to the notification managers.
+ *
+ * @property ActivedownloadModel $Activedownload
+ * @property AssetstoreModel $Assetstore
+ * @property BitstreamModel $Bitstream
+ * @property CommunityModel $Community
+ * @property CommunityInvitationModel $CommunityInvitation
+ * @property object $Component
+ * @property ErrorlogModel $Errorlog
+ * @property FeedModel $Feed
+ * @property FeedpolicygroupModel $Feedpolicygroup
+ * @property FeedpolicyuserModel $Feedpolicyuser
+ * @property FolderModel $Folder
+ * @property FolderpolicygroupModel $Folderpolicygroup
+ * @property FolderpolicyuserModel $Folderpolicyuser
+ * @property object $Form
+ * @property GroupModel $Group
+ * @property ItemModel $Item
+ * @property ItempolicygroupModel $Itempolicygroup
+ * @property ItempolicyuserModel $Itempolicyuser
+ * @property ItemRevisionModel $ItemRevision
+ * @property LicenseModel $License
+ * @property MetadataModel $Metadata
+ * @property object $ModuleComponent
+ * @property object $ModuleForm
+ * @property ModuleModel $Module
+ * @property NewUserInvitationModel $NewUserInvitation
+ * @property PendingUserModel $PendingUser
+ * @property ProgressModel $Progress
+ * @property SettingModel $Setting
+ * @property TokenModel $Token
+ * @property UserModel $User
+ * @property UserapiModel $Userapi;
+ */
 class MIDAS_Notification
 {
     private $_task = array();

tests/ControllerTestCase.php

@@ -21,7 +21,37 @@
 require_once dirname(__FILE__).'/TestsBootstrap.php';
 require_once BASE_PATH.'/core/controllers/components/UtilityComponent.php';
 
-/** main controller test element */
+/**
+ * @property ActivedownloadModel $Activedownload
+ * @property AssetstoreModel $Assetstore
+ * @property BitstreamModel $Bitstream
+ * @property CommunityModel $Community
+ * @property CommunityInvitationModel $CommunityInvitation
+ * @property object $Component
+ * @property ErrorlogModel $Errorlog
+ * @property FeedModel $Feed
+ * @property FeedpolicygroupModel $Feedpolicygroup
+ * @property FeedpolicyuserModel $Feedpolicyuser
+ * @property FolderModel $Folder
+ * @property FolderpolicygroupModel $Folderpolicygroup
+ * @property FolderpolicyuserModel $Folderpolicyuser
+ * @property object $Form
+ * @property GroupModel $Group
+ * @property ItemModel $Item
+ * @property ItempolicygroupModel $Itempolicygroup
+ * @property ItempolicyuserModel $Itempolicyuser
+ * @property ItemRevisionModel $ItemRevision
+ * @property LicenseModel $License
+ * @property MetadataModel $Metadata
+ * @property ModuleModel $Module
+ * @property NewUserInvitationModel $NewUserInvitation
+ * @property PendingUserModel $PendingUser
+ * @property ProgressModel $Progress
+ * @property SettingModel $Setting
+ * @property TokenModel $Token
+ * @property UserModel $User
+ * @property UserapiModel $Userapi;
+ */
 abstract class ControllerTestCase extends Zend_Test_PHPUnit_ControllerTestCase
 {
     protected $application;