eID Dispatcher

Dispatcher.php

<?php
/***************************************************************
 *  Copyright notice
 *
 *  (c) 2013 Cedric Ziel - Internetdienstleistungen & EDV - Halle (Saale),
 *  Germany - http://www.cedric-ziel.com
 *  Authors: Cedric Ziel
 *  All rights reserved
 *
 *  For further information: http://www.cedric-ziel.com <info@cedric-ziel.com>
 *
 *
 *  This script is part of the TYPO3 project. The TYPO3 project is
 *  free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  The GNU General Public License can be found at
 *  http://www.gnu.org/copyleft/gpl.html.
 *
 *  This script is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/

/**
*  A custom Dispatcher for the eID mechanism in TYPO3 CMS
*
*  @author Cedric Ziel <cedric@cedric-ziel.com>
*/

use \TYPO3\CMS\Core as Core;
use \TYPO3\CMS\Extbase\Utility as Utility;
use \TYPO3\CMS\Frontend as Frontend;
use \Cziel\CzielSnippets\View as View;

/**
 * @var $TSFE \TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController
 */
$TSFE = Core\Utility\GeneralUtility::makeInstance('TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController', $TYPO3_CONF_VARS, 0, 0);
Frontend\Utility\EidUtility::initLanguage();

// Get FE User Information
$TSFE->initFEuser();
// Important: no Cache for Ajax stuff
$TSFE->set_no_cache();

//$TSFE->checkAlternativCoreMethods();
$TSFE->checkAlternativeIdMethods();
$TSFE->determineId();
$TSFE->initTemplate();
$TSFE->getConfigArray();
Core\Core\Bootstrap::getInstance()->loadConfigurationAndInitialize();

$TSFE->cObj = Core\Utility\GeneralUtility::makeInstance('TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer');
$TSFE->settingLanguage();
$TSFE->settingLocale();

/**
 * Initialize Database
 */
\TYPO3\CMS\Frontend\Utility\EidUtility::connectDB();

/**
 * @var $objectManager \TYPO3\CMS\Extbase\Object\ObjectManager
 */
$objectManager = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\CMS\Extbase\Object\ObjectManager');

/**
 * @var $objectManager \Cziel\CzielSnippets\Domain\Repository\SnippetRepository
 */
$snippetRepository = $objectManager->get('Cziel\CzielSnippets\Domain\Repository\SnippetRepository');


/**
* Creating a new Object
*/
/**
 * @var $snippet \Cziel\CzielSnippets\Domain\Model\Snippet
 */
$snippet = new \Cziel\CzielSnippets\Domain\Model\Snippet();
$snippet->setTitle('Test');
$snippet->setPid(193);
$snippetRepository->add($snippet);


/**
 * @var $persistenceManager \TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager
 */
$persistenceManager = $objectManager->get('TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager');

$persistenceManager->persistAll();

/**
 * @var $snippets \TYPO3\CMS\Extbase\Persistence\QueryResultInterface
 */
$snippets = $snippetRepository->findAll();

$configuration = array();

$jsonView = new View\JsonView();
$jsonView->setConfiguration($configuration);
$jsonView->assign('value', $snippets);

echo $jsonView->render();

JsonView.php

<?php
declare(ENCODING = 'utf-8');

/*                                                                        *
 * This script belongs to the FLOW3 framework.                            *
 *                                                                        *
 * It is free software; you can redistribute it and/or modify it under    *
 * the terms of the GNU Lesser General Public License as published by the *
 * Free Software Foundation, either version 3 of the License, or (at your *
 * option) any later version.                                             *
 *                                                                        *
 * This script is distributed in the hope that it will be useful, but     *
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHAN-    *
 * TABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser       *
 * General Public License for more details.                               *
 *                                                                        *
 * You should have received a copy of the GNU Lesser General Public       *
 * License along with the script.                                         *
 * If not, see http://www.gnu.org/licenses/lgpl.html                      *
 *                                                                        *
 * The TYPO3 project - inspiring people to share!                         *
 *                                                                        */
namespace Cziel\CzielSnippets\View;
use TYPO3\CMS\Extbase\Mvc\Controller\ControllerContext;
use TYPO3\CMS\Extbase\Persistence\Generic\LazyLoadingProxy;
use TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager;
use TYPO3\CMS\Extbase\Reflection\ObjectAccess;

/**
 * A JSON view
 *
 * @license http://www.gnu.org/licenses/gpl.html GNU General Public License, version 3 or later
 * @scope prototype
 * @api
 */
class JsonView extends \TYPO3\CMS\Extbase\Mvc\View\AbstractView {

	/**
	 * @var \TYPO3\CMS\Extbase\Mvc\Controller\ControllerContext
	 */
	protected $controllerContext;

	/**
	 * Only variables whose name is contained in this array will be rendered
	 *
	 * @var array
	 */
	protected $variablesToRender = array('value');

	/**
	 * The rendering configuration for this JSON view which
	 * determines which properties of each variable to render.
	 *
	 * The configuration array must have the following structure:
	 *
	 * Example 1:
	 *
	 * array(
	 *        'variable1' => array(
	 *            '_only' => array('property1', 'property2', ...)
	 *        ),
	 *        'variable2' => array(
	 *            '_exclude' => array('property3', 'property4, ...)
	 *        ),
	 *        'variable3' => array(
	 *            '_exclude' => array('secretTitle'),
	 *            '_descend' => array(
	 *                'customer' => array(
	 *                    '_only' => array('firstName', 'lastName')
	 *                )
	 *            )
	 *        ),
	 *        'somearrayvalue' => array(
	 *            '_descendAll' => array(
	 *                '_only' => array('property1')
	 *            )
	 *        )
	 * )
	 *
	 * Of variable1 only property1 and property2 will be included.
	 * Of variable2 all properties except property3 and property4
	 * are used.
	 * Of variable3 all properties except secretTitle are included.
	 *
	 * If a property value is an array or object, it is not included
	 * by default. If, however, such a property is listed in a "_descend"
	 * section, the renderer will descend into this sub structure and
	 * include all its properties (of the next level).
	 *
	 * The configuration of each property in "_descend" has the same syntax
	 * like at the top level. Therefore - theoretically - infinitely nested
	 * structures can be configured.
	 *
	 * To export indexed arrays the "_descendAll" section can be used to
	 * include all array keys for the output. The configuration inside a
	 * "_descendAll" will be applied to each array element.
	 *
	 * @var array
	 */
	protected $configuration = array();

	/**
	 * @var \TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager
	 * @inject
	 */
	protected $persistenceManager;

	/**
	 * Injects the PersistenceManager.
	 *
	 * @param \TYPO3\CMS\Extbase\Persistence\PersistenceManagerInterface $persistenceManager
	 * @return void
	 */
	public function injectPersistenceManager(\TYPO3\CMS\Extbase\Persistence\PersistenceManagerInterface $persistenceManager) {
		$this->persistenceManager = $persistenceManager;
	}

	/**
	 * Specifies which variables this JsonView should render
	 * By default only the variable 'value' will be rendered
	 *
	 * @param array $variablesToRender
	 * @return void
	 * @author Bastian Waidelich <bastian@typo3.org>
	 * @api
	 */
	public function setVariablesToRender(array $variablesToRender) {
		$this->variablesToRender = $variablesToRender;
	}

	/**
	 * @param array $configuration The rendering configuration for this JSON view
	 * @return void
	 * @author Robert Lemke <robert@typo3.org>
	 */
	public function setConfiguration(array $configuration) {
		$this->configuration = $configuration;
	}

	/**
	 * Transforms the value view variable to a serializable
	 * array represantion using a YAML view configuration and JSON encodes
	 * the result.
	 *
	 * @return string The JSON encoded variables
	 * @author Sebastian Kurfürst <sebastian@typo3.org>
	 * @author Christopher Hlubek <hlubek@networkteam.com>
	 * @api
	 */
	public function render() {
		// extjs file upload forms can handle application/json
		// the RequestHandlers take care of the ContentType
		//$this->controllerContext->getResponse()->setHeader('Content-Type', 'application/json');
		$propertiesToRender = $this->renderArray();
		return json_encode($propertiesToRender);
	}

	/**
	 * Loads the configuration and transforms the value to a serializable
	 * array.
	 *
	 * @return array An array containing the values, ready to be JSON encoded
	 * @author Christopher Hlubek <hlubek@networkteam.com>
	 * @api
	 */
	protected function renderArray() {
		if (count($this->variablesToRender) === 1) {
			$variableName = current($this->variablesToRender);
			$valueToRender = isset($this->variables[$variableName]) ? $this->variables[$variableName] : NULL;
			$configuration = isset($this->configuration[$variableName]) ? $this->configuration[$variableName] : array();
		} else {
			$valueToRender = array();
			foreach ($this->variablesToRender as $variableName) {
				$valueToRender[$variableName] = isset($this->variables[$variableName]) ? $this->variables[$variableName] : NULL;
			}
			$configuration = $this->configuration;
		}
		return $this->transformValue($valueToRender, $configuration);
	}

	/**
	 * Transforms a value depending on type recursively using the
	 * supplied configuration.
	 *
	 * @param mixed $value The value to transform
	 * @param mixed $configuration Configuration for transforming the value or NULL
	 * @return array The transformed value
	 * @author Christopher Hlubek <hlubek@networkteam.com>
	 */
	protected function transformValue($value, $configuration) {
		if (is_array($value) || $value instanceof \ArrayAccess) {
			$array = array();
			foreach ($value as $key => $element) {
				if (isset($configuration['_descendAll']) && is_array($configuration['_descendAll'])) {
					$array[] = $this->transformValue($element, $configuration['_descendAll']);
				} else {
					if (isset($configuration['_only']) && is_array($configuration['_only']) && !in_array($key, $configuration['_only'])) continue;
					if (isset($configuration['_exclude']) && is_array($configuration['_exclude']) && in_array($key, $configuration['_exclude'])) continue;
					$array[$key] = $this->transformValue($element, isset($configuration[$key]) ? $configuration[$key] : array());
				}
			}
			return $array;
		} elseif (is_object($value)) {
			return $this->transformObject($value, $configuration);
		} else {
			return $value;
		}
	}

	/**
	 * Traverses the given object structure in order to transform it into an
	 * array structure.
	 *
	 * @param object $object Object to traverse
	 * @param mixed $configuration Configuration for transforming the given object or NULL
	 * @return array Object structure as an aray
	 * @author Christopher Hlubek <hlubek@networkteam.com>
	 * @author Dennis Ahrens <dennis.ahrens@fh-hannover.de>
	 */
	protected function transformObject($object, $configuration) {
		// hand over DateTime as ISO formatted string
		if ($object instanceof \DateTime) {
			return $object->format('c');
		}
		// load LayzyLoadingProxy instances
		if ($object instanceof LazyLoadingProxy) {
			$object = $object->_loadRealInstance();
		}
		$propertyNames = ObjectAccess::getGettablePropertyNames($object);
		$propertiesToRender = array();
		foreach ($propertyNames as $propertyName) {
			if (isset($configuration['_only']) && is_array($configuration['_only']) && !in_array($propertyName, $configuration['_only'])) continue;
			if (isset($configuration['_exclude']) && is_array($configuration['_exclude']) && in_array($propertyName, $configuration['_exclude'])) continue;

			$propertyValue = ObjectAccess::getProperty($object, $propertyName);

			if (!is_array($propertyValue) && !is_object($propertyValue)) {
				$propertiesToRender[$propertyName] = $propertyValue;
			} elseif (isset($configuration['_descend']) && array_key_exists($propertyName, $configuration['_descend'])) {
				$propertiesToRender[$propertyName] = $this->transformValue($propertyValue, $configuration['_descend'][$propertyName]);
			} else {
			}
		}
		if (isset($configuration['_exposeObjectIdentifier']) && $configuration['_exposeObjectIdentifier'] === TRUE) {
			// we don't use the IdentityMap like its done in FLOW3 because there are some cases objects are not registered there.
			// TODO: rethink this solution - it is really quick and dirty...
			$propertiesToRender['__identity'] = $object->getUid();
		}
		return $propertiesToRender;
	}
}