add a few comment blocks

[civicrm-core.git] / CRM / Contact / Form / Search / Custom / FullText / Membership.php

diff --git a/CRM/Contact/Form/Search/Custom/FullText/Membership.php b/CRM/Contact/Form/Search/Custom/FullText/Membership.php
index 138dd2667ecf9baf8e600a6de79cc3c9eae10402..250aeb044afada26bcf33cb4992c41a2649541b3 100644 (file)
--- a/CRM/Contact/Form/Search/Custom/FullText/Membership.php
+++ b/CRM/Contact/Form/Search/Custom/FullText/Membership.php
@@ -1,7 +1,7 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -23,7 +23,7 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  *
@@ -34,18 +34,24 @@
  */
 class CRM_Contact_Form_Search_Custom_FullText_Membership extends CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery {
 
-  function __construct() {
+  /**
+   * Class constructor.
+   */
+  public function __construct() {
     parent::__construct('Membership', ts('Memberships'));
   }
 
-  function isActive() {
+  /**
+   * @return bool
+   */
+  public function isActive() {
     $config = CRM_Core_Config::singleton();
     return in_array('CiviMember', $config->enableComponents) &&
-      CRM_Core_Permission::check('access CiviMember');
+    CRM_Core_Permission::check('access CiviMember');
   }
 
   /**
-   * {@inheritdoc}
+   * @inheritDoc
    */
   public function fillTempTable($queryText, $entityIDTableName, $toTable, $queryLimit, $detailLimit) {
     $queries = $this->prepareQueries($queryText, $entityIDTableName);
@@ -62,9 +68,10 @@ class CRM_Contact_Form_Search_Custom_FullText_Membership extends CRM_Contact_For
    *
    * @param string $queryText
    * @param string $entityIDTableName
-   * @return array list tables/queries (for runQueries)
+   * @return array
+   *   list tables/queries (for runQueries)
    */
-  function prepareQueries($queryText, $entityIDTableName) {
+  public function prepareQueries($queryText, $entityIDTableName) {
     // Note: For available full-text indices, see CRM_Core_InnoDBIndexer
 
     $contactSQL = array();
@@ -108,4 +115,4 @@ LEFT JOIN  civicrm_membership_status cms ON cms.id = cm.status_id
     CRM_Core_DAO::executeQuery($sql);
   }
 
-}
\ No newline at end of file
+}