vendor/pimcore/pimcore/models/DataObject/ClassDefinition/Data/Image.php line 87

Open in your IDE?
  1. <?php
  3. /**
  4. * Pimcore
  5. *
  6. * This source file is available under two different licenses:
  7. * - GNU General Public License version 3 (GPLv3)
  8. * - Pimcore Commercial License (PCL)
  9. * Full copyright and license information is available in
  10. * LICENSE.md which is distributed with this source code.
  11. *
  12. * @copyright Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  13. * @license http://www.pimcore.org/license GPLv3 and PCL
  14. */
  16. namespace Pimcore\Model\DataObject\ClassDefinition\Data;
  18. use Pimcore\Model;
  19. use Pimcore\Model\Asset;
  20. use Pimcore\Model\DataObject\ClassDefinition\Data;
  21. use Pimcore\Model\Element;
  22. use Pimcore\Normalizer\NormalizerInterface;
  24. class Image extends Data implements ResourcePersistenceAwareInterface, QueryResourcePersistenceAwareInterface, TypeDeclarationSupportInterface, EqualComparisonInterface, VarExporterInterface, NormalizerInterface, IdRewriterInterface
  25. {
  26. use Extension\ColumnType;
  27. use ImageTrait;
  28. use Extension\QueryColumnType;
  30. /**
  31. * Static type of this element
  32. *
  33. * @internal
  34. *
  35. * @var string
  36. */
  37. public $fieldtype = 'image';
  39. /**
  40. * Type for the column to query
  41. *
  42. * @internal
  43. *
  44. * @var string
  45. */
  46. public $queryColumnType = 'int(11)';
  48. /**
  49. * Type for the column
  50. *
  51. * @internal
  52. *
  53. * @var string
  54. */
  55. public $columnType = 'int(11)';
  57. /**
  58. * @see ResourcePersistenceAwareInterface::getDataForResource
  59. *
  60. * @param mixed $data
  61. * @param null|Model\DataObject\Concrete $object
  62. * @param mixed $params
  63. *
  64. * @return int|null
  65. */
  66. public function getDataForResource($data, $object = null, $params = [])
  67. {
  68. if ($data instanceof Asset) {
  69. return $data->getId();
  70. }
  72. return null;
  73. }
  75. /**
  76. * @see ResourcePersistenceAwareInterface::getDataFromResource
  77. *
  78. * @param int $data
  79. * @param null|Model\DataObject\Concrete $object
  80. * @param mixed $params
  81. *
  82. * @return Asset|null
  83. */
  84. public function getDataFromResource($data, $object = null, $params = [])
  85. {
  86. if ((int)$data > 0) {
  87. return Asset\Image::getById($data);
  88. }
  90. return null;
  91. }
  93. /**
  94. * @see QueryResourcePersistenceAwareInterface::getDataForQueryResource
  95. *
  96. * @param Asset|null $data
  97. * @param null|Model\DataObject\Concrete $object
  98. * @param mixed $params
  99. *
  100. * @return int|null
  101. */
  102. public function getDataForQueryResource($data, $object = null, $params = [])
  103. {
  104. if ($data instanceof Asset) {
  105. return $data->getId();
  106. }
  108. return null;
  109. }
  111. /**
  112. * @see Data::getDataForEditmode
  113. *
  114. * @param Asset\Image|null $data
  115. * @param null|Model\DataObject\Concrete $object
  116. * @param array $params
  117. *
  118. * @return array|null
  119. */
  120. public function getDataForEditmode($data, $object = null, $params = [])
  121. {
  122. if ($data instanceof Asset\Image) {
  123. return $data->getObjectVars();
  124. }
  126. return $data;
  127. }
  129. /**
  130. * @param Asset $data
  131. * @param null|Model\DataObject\Concrete $object
  132. * @param mixed $params
  133. *
  134. * @return array
  135. */
  136. public function getDataForGrid($data, $object = null, $params = [])
  137. {
  138. return $this->getDataForEditmode($data, $object, $params);
  139. }
  141. /**
  142. * @see Data::getDataFromEditmode
  143. *
  144. * @param array $data
  145. * @param null|Model\DataObject\Concrete $object
  146. * @param mixed $params
  147. *
  148. * @return Asset\Image|null
  149. */
  150. public function getDataFromEditmode($data, $object = null, $params = [])
  151. {
  152. if ($data && (int)$data['id'] > 0) {
  153. return Asset\Image::getById($data['id']);
  154. }
  156. return null;
  157. }
  159. /**
  160. * @param int $data
  161. * @param null|Model\DataObject\Concrete $object
  162. * @param mixed $params
  163. *
  164. * @return Asset
  165. */
  166. public function getDataFromGridEditor($data, $object = null, $params = [])
  167. {
  168. return $this->getDataFromEditmode($data, $object, $params);
  169. }
  171. /**
  172. * @see Data::getVersionPreview
  173. *
  174. * @param Asset\Image|null $data
  175. * @param null|Model\DataObject\Concrete $object
  176. * @param mixed $params
  177. *
  178. * @return string|null
  179. */
  180. public function getVersionPreview($data, $object = null, $params = [])
  181. {
  182. if ($data instanceof Asset\Image) {
  183. return '<img src="/admin/asset/get-image-thumbnail?id=' . $data->getId() . '&width=100&height=100&aspectratio=true" />';
  184. }
  186. return null;
  187. }
  189. /**
  190. * {@inheritdoc}
  191. */
  192. public function getForCsvExport($object, $params = [])
  193. {
  194. $data = $this->getDataFromObjectParam($object, $params);
  195. if ($data instanceof Element\ElementInterface) {
  196. return $data->getRealFullPath();
  197. }
  199. return '';
  200. }
  202. /**
  203. * {@inheritdoc}
  204. */
  205. public function getDataForSearchIndex($object, $params = [])
  206. {
  207. return '';
  208. }
  210. /**
  211. * {@inheritdoc}
  212. */
  213. public function getCacheTags($data, array $tags = [])
  214. {
  215. if ($data instanceof Asset\Image) {
  216. if (!array_key_exists($data->getCacheTag(), $tags)) {
  217. $tags = $data->getCacheTags($tags);
  218. }
  219. }
  221. return $tags;
  222. }
  224. /**
  225. * @param Asset|null $data
  226. *
  227. * @return array
  228. */
  229. public function resolveDependencies($data)
  230. {
  231. $dependencies = [];
  233. if ($data instanceof Asset) {
  234. $dependencies['asset_' . $data->getId()] = [
  235. 'id' => $data->getId(),
  236. 'type' => 'asset',
  237. ];
  238. }
  240. return $dependencies;
  241. }
  243. /**
  244. * {@inheritdoc}
  245. */
  246. public function isDiffChangeAllowed($object, $params = [])
  247. {
  248. return true;
  249. }
  251. /** Generates a pretty version preview (similar to getVersionPreview) can be either html or
  252. * a image URL. See the https://github.com/pimcore/object-merger bundle documentation for details
  253. *
  254. * @param Asset\Image|null $data
  255. * @param Model\DataObject\Concrete|null $object
  256. * @param mixed $params
  257. *
  258. * @return array|string
  259. */
  260. public function getDiffVersionPreview($data, $object = null, $params = [])
  261. {
  262. $versionPreview = null;
  263. if ($data instanceof Asset\Image) {
  264. $versionPreview = '/admin/asset/get-image-thumbnail?id=' . $data->getId() . '&width=150&height=150&aspectratio=true';
  265. }
  267. if ($versionPreview) {
  268. $value = [];
  269. $value['src'] = $versionPreview;
  270. $value['type'] = 'img';
  272. return $value;
  273. } else {
  274. return '';
  275. }
  276. }
  278. /**
  279. * { @inheritdoc }
  280. */
  281. public function rewriteIds(/** mixed */ $container, /** array */ $idMapping, /** array */ $params = []) /** :mixed */
  282. {
  283. $data = $this->getDataFromObjectParam($container, $params);
  284. if ($data instanceof Asset\Image) {
  285. if (array_key_exists('asset', $idMapping) && array_key_exists($data->getId(), $idMapping['asset'])) {
  286. return Asset::getById($idMapping['asset'][$data->getId()]);
  287. }
  288. }
  290. return $data;
  291. }
  293. /**
  294. * @param Model\DataObject\ClassDefinition\Data\Image $masterDefinition
  295. */
  296. public function synchronizeWithMasterDefinition(Model\DataObject\ClassDefinition\Data $masterDefinition)
  297. {
  298. $this->uploadPath = $masterDefinition->uploadPath;
  299. }
  301. /**
  302. * {@inheritdoc}
  303. */
  304. public function isFilterable(): bool
  305. {
  306. return true;
  307. }
  309. /**
  310. * @param Asset|null $oldValue
  311. * @param Asset|null $newValue
  312. *
  313. * @return bool
  314. */
  315. public function isEqual($oldValue, $newValue): bool
  316. {
  317. $oldValue = $oldValue instanceof Asset ? $oldValue->getId() : null;
  318. $newValue = $newValue instanceof Asset ? $newValue->getId() : null;
  320. return $oldValue === $newValue;
  321. }
  323. /**
  324. * {@inheritdoc}
  325. */
  326. public function getParameterTypeDeclaration(): ?string
  327. {
  328. return '?\\' . Asset\Image::class;
  329. }
  331. /**
  332. * {@inheritdoc}
  333. */
  334. public function getReturnTypeDeclaration(): ?string
  335. {
  336. return '?\\' . Asset\Image::class;
  337. }
  339. /**
  340. * {@inheritdoc}
  341. */
  342. public function getPhpdocInputType(): ?string
  343. {
  344. return '\\' . Asset\Image::class . '|null';
  345. }
  347. /**
  348. * {@inheritdoc}
  349. */
  350. public function getPhpdocReturnType(): ?string
  351. {
  352. return '\\' . Asset\Image::class . '|null';
  353. }
  355. /**
  356. * {@inheritdoc}
  357. */
  358. public function normalize($value, $params = [])
  359. {
  360. if ($value instanceof \Pimcore\Model\Asset\Image) {
  361. return [
  362. 'type' => 'asset',
  363. 'id' => $value->getId(),
  364. ];
  365. }
  366. }
  368. /**
  369. * {@inheritdoc}
  370. */
  371. public function denormalize($value, $params = [])
  372. {
  373. if (isset($value['id'])) {
  374. return Asset\Image::getById($value['id']);
  375. }
  376. }
  377. }