further comment fixes
[civicrm-core.git] / CRM / Admin / Page / ContactType.php
index 2e6d793151ff7eea7f7da1518717e68bc5c9cd81..9da8ab50b3451d01b67693cec73f9464e9e62d94 100644 (file)
@@ -1,9 +1,9 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.6                                                |
+ | CiviCRM version 4.7                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014                                |
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2014
- * $Id$
- *
+ * @copyright CiviCRM LLC (c) 2004-2015
  */
 
 /**
- * Page for displaying list of contact Subtypes
+ * Page for displaying list of contact Subtypes.
  */
 class CRM_Admin_Page_ContactType extends CRM_Core_Page_Basic {
 
   public $useLivePageJS = TRUE;
 
   /**
-   * The action links that we need to display for the browse screen
+   * The action links that we need to display for the browse screen.
    *
    * @var array
-   * @static
    */
   static $_links = NULL;
 
   /**
-   * Get BAO Name
+   * Get BAO Name.
    *
-   * @return string Classname of BAO.
+   * @return string
+   *   Classname of BAO.
    */
   public function getBAOName() {
     return 'CRM_Contact_BAO_ContactType';
   }
 
   /**
-   * Get action Links
+   * Get action Links.
    *
-   * @return array (reference) of action links
+   * @return array
+   *   (reference) of action links
    */
   public function &links() {
     if (!(self::$_links)) {
@@ -92,6 +91,9 @@ class CRM_Admin_Page_ContactType extends CRM_Core_Page_Basic {
     return self::$_links;
   }
 
+  /**
+   * Run page.
+   */
   public function run() {
     $action = CRM_Utils_Request::retrieve('action', 'String', $this, FALSE, 0);
     $this->assign('action', $action);
@@ -102,6 +104,9 @@ class CRM_Admin_Page_ContactType extends CRM_Core_Page_Basic {
     return parent::run();
   }
 
+  /**
+   * Browse contact types.
+   */
   public function browse() {
     $rows = CRM_Contact_BAO_ContactType::contactTypeInfo(TRUE);
     foreach ($rows as $key => $value) {
@@ -131,18 +136,20 @@ class CRM_Admin_Page_ContactType extends CRM_Core_Page_Basic {
   }
 
   /**
-   * Get name of edit form
+   * Get name of edit form.
    *
-   * @return string Classname of edit form.
+   * @return string
+   *   Classname of edit form.
    */
   public function editForm() {
     return 'CRM_Admin_Form_ContactType';
   }
 
   /**
-   * Get edit form name
+   * Get edit form name.
    *
-   * @return string name of this page.
+   * @return string
+   *   name of this page.
    */
   public function editName() {
     return 'Contact Types';
@@ -153,9 +160,11 @@ class CRM_Admin_Page_ContactType extends CRM_Core_Page_Basic {
    *
    * @param null $mode
    *
-   * @return string user context.
+   * @return string
+   *   user context.
    */
   public function userContext($mode = NULL) {
     return 'civicrm/admin/options/subtype';
   }
+
 }