Civi/Api4/Service/Schema/Joinable/OptionValueJoinable.php

   1 <?php
   2
   3 /*
   4  +--------------------------------------------------------------------+
   5  | CiviCRM version 5                                                  |
   6  +--------------------------------------------------------------------+
   7  | Copyright CiviCRM LLC (c) 2004-2019                                |
   8  +--------------------------------------------------------------------+
   9  | This file is a part of CiviCRM.                                    |
  10  |                                                                    |
  11  | CiviCRM is free software; you can copy, modify, and distribute it  |
  12  | under the terms of the GNU Affero General Public License           |
  13  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  14  |                                                                    |
  15  | CiviCRM is distributed in the hope that it will be useful, but     |
  16  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  17  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  18  | See the GNU Affero General Public License for more details.        |
  19  |                                                                    |
  20  | You should have received a copy of the GNU Affero General Public   |
  21  | License and the CiviCRM Licensing Exception along                  |
  22  | with this program; if not, contact CiviCRM LLC                     |
  23  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  24  | GNU Affero General Public License or the licensing of CiviCRM,     |
  25  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  26  +--------------------------------------------------------------------+
  27  */
  28
  29 /**
  30  *
  31  * @package CRM
  32  * @copyright CiviCRM LLC (c) 2004-2019
  33  * $Id$
  34  *
  35  */
  36
  37
  38 namespace Civi\Api4\Service\Schema\Joinable;
  39
  40 class OptionValueJoinable extends Joinable {
  41   /**
  42    * @var string
  43    */
  44   protected $optionGroupName;
  45
  46   /**
  47    * @param string $optionGroup
  48    *   Can be either the option group name or ID
  49    * @param string|null $alias
  50    *   The join alias
  51    * @param string $keyColumn
  52    *   Which column to use to join, defaults to "value"
  53    */
  54   public function __construct($optionGroup, $alias = NULL, $keyColumn = 'value') {
  55     $this->optionGroupName = $optionGroup;
  56     $optionValueTable = 'civicrm_option_value';
  57
  58     // default join alias to option group name, e.g. activity_type
  59     if (!$alias && !is_numeric($optionGroup)) {
  60       $alias = $optionGroup;
  61     }
  62
  63     parent::__construct($optionValueTable, $keyColumn, $alias);
  64
  65     if (!is_numeric($optionGroup)) {
  66       $subSelect = 'SELECT id FROM civicrm_option_group WHERE name = "%s"';
  67       $subQuery = sprintf($subSelect, $optionGroup);
  68       $condition = sprintf('%s.option_group_id = (%s)', $alias, $subQuery);
  69     }
  70     else {
  71       $condition = sprintf('%s.option_group_id = %d', $alias, $optionGroup);
  72     }
  73
  74     $this->addCondition($condition);
  75   }
  76
  77   /**
  78    * The existing condition must also be re-aliased
  79    *
  80    * @param string $alias
  81    *
  82    * @return $this
  83    */
  84   public function setAlias($alias) {
  85     foreach ($this->conditions as $index => $condition) {
  86       $search = $this->alias . '.';
  87       $replace = $alias . '.';
  88       $this->conditions[$index] = str_replace($search, $replace, $condition);
  89     }
  90
  91     parent::setAlias($alias);
  92
  93     return $this;
  94   }
  95
  96 }