add a few comment blocks
authorEileen McNaughton <eileen@fuzion.co.nz>
Wed, 21 May 2014 09:38:01 +0000 (21:38 +1200)
committerEileen McNaughton <eileen@fuzion.co.nz>
Wed, 21 May 2014 09:38:01 +0000 (21:38 +1200)
CRM/Contact/Page/AJAX.php
CRM/Contact/Page/CustomSearch.php
CRM/Contact/Page/DedupeRules.php
CRM/Contact/Page/View.php
CRM/Contact/Page/View/Summary.php
CRM/Contact/Page/View/UserDashBoard.php

index 806486b5eec253444c12b3df13dc9c4d9d44ef87..f26e4acbf8cacd5cfd643c9499a91ddde736c907 100644 (file)
@@ -1024,6 +1024,11 @@ LIMIT {$offset}, {$rowCount}
     CRM_Utils_System::civiExit();
   }
 
+  /**
+   * @param $name
+   *
+   * @return string
+   */
   static function _convertToId($name) {
     if (substr($name, 0, CRM_Core_Form::CB_PREFIX_LEN) == CRM_Core_Form::CB_PREFIX) {
       $cId = substr($name, CRM_Core_Form::CB_PREFIX_LEN);
index 472c1879c0cd0677cc60c3ea4793e897b3bc4b69..814cc0d8e8aefb112fc1ee2e803cb64b9812cfbc 100644 (file)
@@ -47,6 +47,9 @@ class CRM_Contact_Page_CustomSearch extends CRM_Core_Page {
    */
   static $_links = NULL;
 
+  /**
+   * @return array
+   */
   public static function &info() {
     $sql = "
 SELECT v.value, v.label, v.description
index 501a45576f8d8ef252294d8e248b4ae713a1ecf0..13e38c458b87128dbd0d1e101bbb20bb4bea6f01 100644 (file)
@@ -210,6 +210,9 @@ class CRM_Contact_Page_DedupeRules extends CRM_Core_Page_Basic {
     return 'civicrm/contact/deduperules';
   }
 
+  /**
+   * @param $id
+   */
   function delete($id) {
     $ruleDao = new CRM_Dedupe_DAO_Rule();
     $ruleDao->dedupe_rule_group_id = $id;
index 82bc7cbdb71080ff30fafbce09cdeba97b2aa8a9..d3be2d9b3df71a5666c48580fd5294efe1a72c7d 100644 (file)
@@ -276,6 +276,10 @@ class CRM_Contact_Page_View extends CRM_Core_Page {
     );
   }
 
+  /**
+   * @param $page
+   * @param null $contactID
+   */
   static function checkUserPermission($page, $contactID = NULL) {
     // check for permissions
     $page->_permission = NULL;
index ee94b0173a5c314abcca1b6582d9b8d4128ecdc0..9db5155104e80a06e68a799335384076752ac3ad 100644 (file)
@@ -417,9 +417,12 @@ class CRM_Contact_Page_View_Summary extends CRM_Contact_Page_View {
     }
   }
 
+  /**
+   * @return string
+   */
   function getTemplateFileName() {
     if ($this->_contactId) {
-      $contactSubtypes = $this->get('contactSubtype') ? 
+      $contactSubtypes = $this->get('contactSubtype') ?
         explode(CRM_Core_DAO::VALUE_SEPARATOR, $this->get('contactSubtype')) : array();
 
       // there could be multiple subtypes. We check templates for each of the subtype, and return the first one found.
index 135e70ddb16728c92af47642d854ea136c8bb15f..93b4cce8abd7f09a84e3f7e5269c5031869dc81d 100644 (file)
@@ -57,6 +57,9 @@ class CRM_Contact_Page_View_UserDashBoard extends CRM_Core_Page {
    */
   static $_links = NULL;
 
+  /**
+   * @throws Exception
+   */
   function __construct() {
     parent::__construct();