56cbf99d180e8f1b68461a00b7dd0fbb2cf1c878
[Packages/TYPO3.CMS.git] / typo3 / sysext / extbase / Classes / Property / TypeConverter / AbstractFileFolderConverter.php
1 <?php
2 namespace TYPO3\CMS\Extbase\Property\TypeConverter;
3
4 /***************************************************************
5 * Copyright notice
6 *
7 * (c) 2010-2012 Extbase Team (http://forge.typo3.org/projects/typo3v4-mvc)
8 * Extbase is a backport of TYPO3 Flow. All credits go to the TYPO3 Flow team.
9 * All rights reserved
10 *
11 * This script is part of the TYPO3 project. The TYPO3 project is
12 * free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
16 *
17 * The GNU General Public License can be found at
18 * http://www.gnu.org/copyleft/gpl.html.
19 * A copy is found in the textfile GPL.txt and important notices to the license
20 * from the author is found in LICENSE.txt distributed with these scripts.
21 *
22 *
23 * This script is distributed in the hope that it will be useful,
24 * but WITHOUT ANY WARRANTY; without even the implied warranty of
25 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26 * GNU General Public License for more details.
27 *
28 * This copyright notice MUST APPEAR in all copies of the script!
29 ***************************************************************/
30 /**
31 * Converter which transforms simple types to \TYPO3\CMS\Extbase\Domain\Model\File.
32 *
33 * @api experimental! This class is experimental and subject to change!
34 */
35 abstract class AbstractFileFolderConverter extends \TYPO3\CMS\Extbase\Property\TypeConverter\AbstractTypeConverter {
36
37 /**
38 * @var integer
39 */
40 protected $priority = 1;
41
42 /**
43 * @var string
44 */
45 protected $expectedObjectType;
46
47 /**
48 * @var \TYPO3\CMS\Core\Resource\ResourceFactory
49 */
50 protected $fileFactory;
51
52 /**
53 * @param \TYPO3\CMS\Core\Resource\ResourceFactory $fileFactory
54 */
55 public function injectFileFactory(\TYPO3\CMS\Core\Resource\ResourceFactory $fileFactory) {
56 $this->fileFactory = $fileFactory;
57 }
58
59 /**
60 * Actually convert from $source to $targetType, taking into account the fully
61 * built $convertedChildProperties and $configuration.
62 *
63 * @param string|integer $source
64 * @param string $targetType
65 * @param array $convertedChildProperties
66 * @param \TYPO3\CMS\Extbase\Property\PropertyMappingConfigurationInterface $configuration
67 * @throws \TYPO3\CMS\Extbase\Property\Exception
68 * @return \TYPO3\CMS\Extbase\Domain\Model\AbstractFileFolder
69 * @api
70 */
71 public function convertFrom($source, $targetType, array $convertedChildProperties = array(), \TYPO3\CMS\Extbase\Property\PropertyMappingConfigurationInterface $configuration = NULL) {
72 $object = $this->getObject($source);
73 if (empty($this->expectedObjectType) || !$object instanceof $this->expectedObjectType) {
74 throw new \TYPO3\CMS\Extbase\Property\Exception('Expected object of type "' . $this->expectedObjectType . '" but got ' . get_class($object), 1342895975);
75 }
76 /** @var $subject \TYPO3\CMS\Extbase\Domain\Model\AbstractFileFolder */
77 $subject = $this->objectManager->create($targetType);
78 $subject->setObject($object);
79 return $subject;
80 }
81
82 /**
83 * @param string|integer $source
84 * @return \TYPO3\CMS\Core\Resource\ResourceInterface
85 */
86 abstract protected function getObject($source);
87 }
88
89 ?>