All Data Structures Functions Variables Pages
SanitizerUtil.php
1 <?php
2  /*********************************************************************************
3  * Zurmo is a customer relationship management program developed by
4  * Zurmo, Inc. Copyright (C) 2017 Zurmo Inc.
5  *
6  * Zurmo is free software; you can redistribute it and/or modify it under
7  * the terms of the GNU Affero General Public License version 3 as published by the
8  * Free Software Foundation with the addition of the following permission added
9  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
10  * IN WHICH THE COPYRIGHT IS OWNED BY ZURMO, ZURMO DISCLAIMS THE WARRANTY
11  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
12  *
13  * Zurmo is distributed in the hope that it will be useful, but WITHOUT
14  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
15  * FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
16  * details.
17  *
18  * You should have received a copy of the GNU Affero General Public License along with
19  * this program; if not, see http://www.gnu.org/licenses or write to the Free
20  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
21  * 02110-1301 USA.
22  *
23  * You can contact Zurmo, Inc. with a mailing address at 27 North Wacker Drive
24  * Suite 370 Chicago, IL 60606. or at email address contact@zurmo.com.
25  *
26  * The interactive user interfaces in original and modified versions
27  * of this program must display Appropriate Legal Notices, as required under
28  * Section 5 of the GNU Affero General Public License version 3.
29  *
30  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
31  * these Appropriate Legal Notices must retain the display of the Zurmo
32  * logo and Zurmo copyright notice. If the display of the logo is not reasonably
33  * feasible for technical reasons, the Appropriate Legal Notices must display the words
34  * "Copyright Zurmo Inc. 2017. All rights reserved".
35  ********************************************************************************/
36 
46  abstract class SanitizerUtil
47  {
48  protected $modelClassName;
49 
50  protected $attributeName;
51 
52  protected $analysisMessages = array();
53 
54  protected $shouldSkipRow = false;
55 
56  protected $columnName;
57 
58  protected $columnMappingData = array();
59 
60  protected $mappingRuleData = array();
61 
62  protected $importSanitizeResultsUtil;
63 
64  protected $penultimateModelClassName;
65 
66  protected $penultimateAttributeName;
67 
68  protected $explicitReadWriteModelPermissions = null;
69 
78  abstract public function sanitizeValue($value);
79 
83  abstract public function analyzeByRow(RedBean_OODBBean $rowBean);
84 
88  public static function getType()
89  {
90  $type = get_called_class();
91  $type = substr($type, 0, strlen($type) - strlen('SanitizerUtil'));
92  return $type;
93  }
94 
101  public static function getLinkedMappingRuleType()
102  {
103  return null;
104  }
105 
114  {
115  return false;
116  }
117 
118  protected static function resolveMappingRuleData($columnMappingData)
119  {
120  assert('$columnMappingData == null || is_array($columnMappingData)');
121  $mappingRuleType = static::getLinkedMappingRuleType();
122 
123  if ($mappingRuleType === null || empty($mappingRuleType))
124  {
125  return array();
126  }
127 
128  $mappingRuleFormClassName = $mappingRuleType .'MappingRuleForm';
129  if (!isset($columnMappingData['mappingRulesData']) ||
130  !isset($columnMappingData['mappingRulesData'][$mappingRuleFormClassName]))
131  {
132  return array();
133  }
134  else
135  {
136  $mappingRuleData = $columnMappingData['mappingRulesData'][$mappingRuleFormClassName];
137  assert('$mappingRuleData != null');
138  return $mappingRuleData;
139  }
140  }
141 
149  public function __construct($modelClassName, $attributeName, $columnName, array $columnMappingData,
150  ImportSanitizeResultsUtil $importSanitizeResultsUtil = null,
151  $penultimateModelClassName, $penultimateAttributeName,
152  $explicitReadWriteModelPermissions = null)
153  {
154  assert('is_string($modelClassName)');
155  assert('is_string($attributeName) || $attributeName == null');
156  assert('is_string($columnName)');
157  $this->modelClassName = $modelClassName;
158  $this->attributeName = $attributeName;
159  $this->columnName = $columnName;
160  $this->columnMappingData = $columnMappingData;
161  $this->mappingRuleData = static::resolveMappingRuleData($this->columnMappingData);
162  $this->importSanitizeResultsUtil = $importSanitizeResultsUtil;
163  $this->penultimateModelClassName = $penultimateModelClassName;
164  $this->penultimateAttributeName = $penultimateAttributeName;
165  $this->explicitReadWriteModelPermissions = $explicitReadWriteModelPermissions;
167  $this->init();
168  }
169 
170  public function shouldSanitizeValue()
171  {
172  if ($this->columnMappingData["type"] == 'extraColumn')
173  {
174  return false;
175  }
176  return true;
177  }
178 
179  public function getAnalysisMessages()
180  {
181  return $this->analysisMessages;
182  }
183 
184  public function getShouldSkipRow()
185  {
186  return $this->shouldSkipRow;
187  }
188 
192  protected function init()
193  {
194  }
195 
199  protected function assertMappingRuleDataIsValid()
200  {
201  }
202  }
203 ?>
assertMappingRuleDataIsValid()
static shouldNotSaveModelOnSanitizingValueFailure()
analyzeByRow(RedBean_OODBBean $rowBean)
static getLinkedMappingRuleType()
sanitizeValue($value)
static getType()
__construct($modelClassName, $attributeName, $columnName, array $columnMappingData, ImportSanitizeResultsUtil $importSanitizeResultsUtil=null, $penultimateModelClassName, $penultimateAttributeName, $explicitReadWriteModelPermissions=null)
Generated on Wed Apr 8 2020 07:10:41