CRM/Admin/Page/APIDoc.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26 */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2014
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * Page for displaying list of contact Subtypes
  38  */
  39 class CRM_Admin_Page_APIDoc extends CRM_Core_Page {
  40
  41   /**
  42    * @return string
  43    */
  44   function run() {
  45     CRM_Utils_System::setTitle(ts('API parameters'));
  46     return parent::run();
  47   }
  48
  49   /**
  50    * @return string
  51    */
  52   function getTemplateFileName() {
  53     return 'CRM/Core/APIDoc.tpl';
  54   }
  55
  56   /**
  57    * Get user context.
  58    *
  59    * @param null $mode
  60    *
  61    * @return string user context.
  62    */
  63   function userContext($mode = NULL) {
  64     return 'civicrm/api/doc';
  65   }
  66 }
  67