X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=CRM%2FContact%2FSelector%2FCustom.php;h=1bd4f4c1bc99d3f94f3067553db5afb05be05b50;hb=0479b4c8095005abb475f17c243d9ea4613db58c;hp=bb28ea8f7851a6439b9bd2aefb63566cf495c6ae;hpb=f2a84e5c7c916f6c0d4c7fce69b844b019c17dd1;p=civicrm-core.git

diff --git a/CRM/Contact/Selector/Custom.php b/CRM/Contact/Selector/Custom.php
index bb28ea8f78..1bd4f4c1bc 100644
--- a/CRM/Contact/Selector/Custom.php
+++ b/CRM/Contact/Selector/Custom.php
@@ -1,7 +1,7 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -50,7 +50,7 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector {
   static $_links = NULL;
 
   /**
-   * we use desc to remind us what that column is, name is used in the tpl
+   * We use desc to remind us what that column is, name is used in the tpl
    *
    * @var array
    * @static
@@ -65,37 +65,33 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector {
   static $_properties = array('contact_id', 'contact_type', 'display_name');
 
   /**
-   * formValues is the array returned by exportValues called on
+   * FormValues is the array returned by exportValues called on
    * the HTML_QuickForm_Controller for that page.
    *
    * @var array
-   * @access protected
    */
   public $_formValues;
 
   /**
-   * params is the array in a value used by the search query creator
+   * Params is the array in a value used by the search query creator
    *
    * @var array
-   * @access protected
    */
   public $_params;
 
   /**
-   * represent the type of selector
+   * Represent the type of selector
    *
    * @var int
-   * @access protected
    */
   protected $_action;
 
   protected $_query;
 
   /**
-   * the public visible fields to be shown to the user
+   * The public visible fields to be shown to the user
    *
    * @var array
-   * @access protected
    */
   protected $_fields;
 
@@ -110,8 +106,10 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector {
    * Class constructor
    *
    * @param $customSearchClass
-   * @param array $formValues array of form values imported
-   * @param array $params array of parameters for query
+   * @param array $formValues
+   *   Array of form values imported.
+   * @param array $params
+   *   Array of parameters for query.
    * @param null $returnProperties
    * @param \const|int $action - action of search basic or advanced.
    *
@@ -125,14 +123,14 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector {
    */
   function __construct(
     $customSearchClass,
-    $formValues        = NULL,
-    $params            = NULL,
-    $returnProperties  = NULL,
-    $action            = CRM_Core_Action::NONE,
+    $formValues = NULL,
+    $params = NULL,
+    $returnProperties = NULL,
+    $action = CRM_Core_Action::NONE,
     $includeContactIds = FALSE,
     $searchChildGroups = TRUE,
-    $searchContext     = 'search',
-    $contextMenu       = NULL
+    $searchContext = 'search',
+    $contextMenu = NULL
   ) {
     $this->_customSearchClass = $customSearchClass;
     $this->_formValues = $formValues;
@@ -143,10 +141,10 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector {
     if (!$ext->isExtensionKey($customSearchClass)) {
       if ($ext->isExtensionClass($customSearchClass)) {
         $customSearchFile = $ext->classToPath($customSearchClass);
-        require_once ($customSearchFile);
+        require_once $customSearchFile;
       }
       else {
-        require_once (str_replace('_', DIRECTORY_SEPARATOR, $customSearchClass) . '.php');
+        require_once str_replace('_', DIRECTORY_SEPARATOR, $customSearchClass) . '.php';
       }
       $this->_search = new $customSearchClass( $formValues );
     }
@@ -157,7 +155,6 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector {
       $this->_search = new $className($formValues);
     }
   }
-  //end of constructor
 
   /**
    * This method returns the links that are given for each search row.
@@ -167,10 +164,9 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector {
    * - Edit
    *
    * @return array
-   * @access public
    *
    */
-  static function &links() {
+  public static function &links() {
     list($key) = func_get_args();
     $searchContext = "&context=custom";
     $extraParams = ($key) ? "&key={$key}" : NULL;
@@ -206,18 +202,15 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector {
     }
     return self::$_links;
   }
-  //end of function
 
   /**
-   * getter for array of the parameters required for creating pager.
+   * Getter for array of the parameters required for creating pager.
    *
    * @param $action
-   * @param $params
+   * @param array $params
    *
-   * @internal param $
-   * @access public
    */
-  function getPagerParams($action, &$params) {
+  public function getPagerParams($action, &$params) {
     $params['status']    = ts('Contact %%StatusMessage%%');
     $params['csvString'] = NULL;
     $params['rowCount']  = CRM_Utils_Pager::ROWCOUNT;
@@ -225,19 +218,19 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector {
     $params['buttonTop'] = 'PagerTopButton';
     $params['buttonBottom'] = 'PagerBottomButton';
   }
-  //end of function
 
   /**
-   * returns the column headers as an array of tuples:
+   * Returns the column headers as an array of tuples:
    * (name, sortName (key to the sort array))
    *
-   * @param string $action the action being performed
-   * @param enum   $output what should the result set include (web/email/csv)
+   * @param string $action
+   *   The action being performed.
+   * @param enum $output
+   *   What should the result set include (web/email/csv).
    *
    * @return array the column headers that need to be displayed
-   * @access public
    */
-  function &getColumnHeaders($action = NULL, $output = NULL) {
+  public function &getColumnHeaders($action = NULL, $output = NULL) {
     $columns = $this->_search->columns();
     if ($output == CRM_Core_Selector_Controller::EXPORT) {
       return array_keys($columns);
@@ -266,24 +259,28 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector {
    * @param
    *
    * @return int Total number of rows
-   * @access public
    */
-  function getTotalCount($action) {
+  public function getTotalCount($action) {
     return $this->_search->count();
   }
 
   /**
-   * returns all the rows in the given offset and rowCount
+   * Returns all the rows in the given offset and rowCount
    *
-   * @param enum   $action   the action being performed
-   * @param int    $offset   the row number to start from
-   * @param int    $rowCount the number of rows to return
-   * @param string $sort     the sql string that describes the sort order
-   * @param enum   $output   what should the result set include (web/email/csv)
+   * @param enum $action
+   *   The action being performed.
+   * @param int $offset
+   *   The row number to start from.
+   * @param int $rowCount
+   *   The number of rows to return.
+   * @param string $sort
+   *   The sql string that describes the sort order.
+   * @param enum $output
+   *   What should the result set include (web/email/csv).
    *
    * @return int   the total number of rows for this action
    */
-  function &getRows($action, $offset, $rowCount, $sort, $output = NULL) {
+  public function &getRows($action, $offset, $rowCount, $sort, $output = NULL) {
 
     $includeContactIDs = FALSE;
     if (($output == CRM_Core_Selector_Controller::EXPORT ||
@@ -363,8 +360,7 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector {
         }
 
         if ($image) {
-          $row['contact_type'] = CRM_Contact_BAO_Contact_Utils::getImage($dao->contact_sub_type ?
-            $dao->contact_sub_type : $dao->contact_type, FALSE, $contactID
+          $row['contact_type'] = CRM_Contact_BAO_Contact_Utils::getImage($dao->contact_sub_type ? $dao->contact_sub_type : $dao->contact_type, FALSE, $contactID
           );
         }
         $rows[] = $row;
@@ -380,11 +376,10 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector {
    * Given the current formValues, gets the query in local
    * language
    *
-   * @param  array(
-     reference)   $formValues   submitted formValues
+   * @param array(
+  reference)   $formValues   submitted formValues
    *
    * @return array              $qill         which contains an array of strings
-   * @access public
    */
   public function getQILL() {
     return NULL;
@@ -398,33 +393,34 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector {
   }
 
   /**
-   * name of export file.
+   * Name of export file.
    *
-   * @param string $output type of output
+   * @param string $output
+   *   Type of output.
    *
    * @return string name of the file
    */
-  function getExportFileName($output = 'csv') {
+  public function getExportFileName($output = 'csv') {
     return ts('CiviCRM Custom Search');
   }
 
   /**
    * @return null
    */
-  function alphabetQuery() {
+  public function alphabetQuery() {
     return NULL;
   }
 
   /**
-   * @param $params
+   * @param array $params
    * @param $action
-   * @param $sortID
+   * @param int $sortID
    * @param null $displayRelationshipType
    * @param string $queryOperator
    *
    * @return Object
    */
-  function &contactIDQuery($params, $action, $sortID, $displayRelationshipType = NULL, $queryOperator = 'AND') {
+  public function &contactIDQuery($params, $action, $sortID, $displayRelationshipType = NULL, $queryOperator = 'AND') {
     $params = array();
     $sql = $this->_search->contactIDs($params);
 
@@ -434,7 +430,7 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector {
   /**
    * @param $rows
    */
-  function addActions(&$rows) {
+  public function addActions(&$rows) {
     $links = self::links($this->_key);
 
     $permissions = array(CRM_Core_Permission::getPermission());
@@ -459,10 +455,9 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector {
   /**
    * @param $rows
    */
-  function removeActions(&$rows) {
+  public function removeActions(&$rows) {
     foreach ($rows as $rid => & $rValue) {
       unset($rValue['action']);
     }
   }
 }
-