Commit a6882a96 authored by Alexander Schnitzler's avatar Alexander Schnitzler Committed by Alexander Schnitzler
Browse files

[TASK] Cleanup Extbase for 6.1 release

* Remove whitespace after closing php tag
* Fix PhpDocComments

Releases: 6.1
Resolves: #47216
Change-Id: I8f35f9adb65c75cb11e1045bbade3d0b6708db86
Reviewed-on: https://review.typo3.org/19976
Reviewed-by: Wouter Wolters
Tested-by: Wouter Wolters
Reviewed-by: Anja Leichsenring
Tested-by: Anja Leichsenring
Reviewed-by: Alexander Schnitzler
Tested-by: Alexander Schnitzler
parent 147c8f1e
......@@ -181,7 +181,6 @@ class BackendConfigurationManager extends \TYPO3\CMS\Extbase\Configuration\Abstr
/**
* Returns a comma separated list of storagePid that are below a certain storage pid.
*
*
* @param string $storagePid Storage PID to start at; multiple PIDs possible as comma-separated list
* @param integer $recursionDepth Maximum number of levels to search, 0 to disable recursive lookup
* @return string storage PIDs
......
......@@ -27,6 +27,10 @@ namespace TYPO3\CMS\Extbase\Configuration;
*
* This copyright notice MUST APPEAR in all copies of the script!
***************************************************************/
/**
* Class ConfigurationManagerInterface
*/
interface ConfigurationManagerInterface extends \TYPO3\CMS\Core\SingletonInterface {
const CONFIGURATION_TYPE_FRAMEWORK = 'Framework';
......
......@@ -54,4 +54,4 @@ abstract class AbstractFileFolder extends \TYPO3\CMS\Extbase\DomainObject\Abstra
}
}
?>
?>
\ No newline at end of file
......@@ -418,7 +418,7 @@ class BackendUserGroup extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity {
/**
* Set the the bit for file operations are allowed.
*
* @param boolean
* @param boolean $value
* @return void
*/
public function setFileOperationAllowed($value) {
......@@ -437,7 +437,7 @@ class BackendUserGroup extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity {
/**
* Set the the bit for unzip files are allowed.
*
* @param boolean
* @param boolean $value
* @return void
*/
public function setFileUnzipAllowed($value) {
......@@ -456,7 +456,7 @@ class BackendUserGroup extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity {
/**
* Set the the bit for directory operations are allowed.
*
* @param boolean
* @param boolean $value
* @return void
*/
public function setDirectoryOperationAllowed($value) {
......@@ -475,7 +475,7 @@ class BackendUserGroup extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity {
/**
* Set the the bit for copy directories.
*
* @param boolean
* @param boolean $value
* @return void
*/
public function setDirectoryCopyAllowed($value) {
......@@ -494,7 +494,7 @@ class BackendUserGroup extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity {
/**
* Set the the bit for remove directories recursively.
*
* @param boolean
* @param boolean $value
* @return void
*/
public function setDirectoryRemoveRecursivelyAllowed($value) {
......
......@@ -278,7 +278,7 @@ class Result {
* Flatten a tree of Result objects, based on a certain property.
*
* @param string $propertyName
* @param array $result
* @param array &$result
* @param array $level
* @return void
*/
......
......@@ -490,7 +490,7 @@ class ActionController extends \TYPO3\CMS\Extbase\Mvc\Controller\AbstractControl
* display no flash message at all on errors. Override this to customize
* the flash message in your action controller.
*
* @return string|boolean The flash message or FALSE if no flash message should be set
* @return string The flash message or FALSE if no flash message should be set
* @api
*/
protected function getErrorFlashMessage() {
......
......@@ -225,7 +225,7 @@ class Argument {
/**
* Injects the Persistence Manager
*
* @param \TYPO3\CMS\Extbase\Persistence\PersistenceManagerInterface
* @param \TYPO3\CMS\Extbase\Persistence\PersistenceManagerInterface $persistenceManager
* @return void
*/
public function injectPersistenceManager(\TYPO3\CMS\Extbase\Persistence\PersistenceManagerInterface $persistenceManager) {
......@@ -385,7 +385,7 @@ class Argument {
/**
* Create and set a validator chain
*
* @param array Object names of the validators
* @param array $objectNames Object names of the validators
* @return \TYPO3\CMS\Extbase\Mvc\Controller\Argument Returns $this (used for fluent interface)
* @api
* @deprecated since Extbase 1.4.0, will be removed in Extbase 6.1
......@@ -426,8 +426,8 @@ class Argument {
/**
* Sets the value of this argument.
*
* @param mixed $rawValue: The value of this argument
* @return \TYPO3\CMS\Extbase\Mvc\Controller\Argument $this
* @param mixed $rawValue The value of this argument
* @return \TYPO3\CMS\Extbase\Mvc\Controller\Argument
* @throws \TYPO3\CMS\Extbase\Mvc\Exception\InvalidArgumentValueException if the argument is not a valid object of type $dataType
*/
public function setValue($rawValue) {
......
......@@ -249,7 +249,7 @@ class Arguments extends \ArrayObject {
* If an argument with the specified name or short name does not exist, an empty
* string is returned.
*
* @param string argument name
* @param string $argumentName argument name
* @return string long argument name or empty string
*/
protected function translateToLongArgumentName($argumentName) {
......
......@@ -224,7 +224,7 @@ class CommandController implements \TYPO3\CMS\Extbase\Mvc\Controller\CommandCont
* @see http://www.php.net/sprintf
* @param string $text Text to output
* @param array $arguments Optional arguments to use for sprintf
* @return string
* @return void
*/
protected function output($text, array $arguments = array()) {
if ($arguments !== array()) {
......
......@@ -316,7 +316,7 @@ class Request implements \TYPO3\CMS\Extbase\Mvc\RequestInterface {
*
* Note that the action name must start with a lower case letter and is case sensitive.
*
* @param string $actionName: Name of the action to execute by the controller
* @param string $actionName Name of the action to execute by the controller
*
* @return void
* @throws \TYPO3\CMS\Extbase\Mvc\Exception\InvalidActionNameException if the action name is not valid
......
......@@ -688,8 +688,8 @@ class UriBuilder {
*
* @param \TYPO3\CMS\Extbase\DomainObject\AbstractDomainObject $object
* @return array
* @todo Refactore this into convertDomainObjectsToIdentityArrays()
*/
// TODO Refactore this into convertDomainObjectsToIdentityArrays()
public function convertTransientObjectToArray(\TYPO3\CMS\Extbase\DomainObject\AbstractDomainObject $object) {
$result = array();
foreach ($object->_getProperties() as $propertyName => $propertyValue) {
......
......@@ -65,6 +65,7 @@ class ClassInfoCache {
* Gets the cache for the id
*
* @param string $id
* @return mixed
*/
public function get($id) {
if (!isset($this->level1Cache[$id])) {
......@@ -76,8 +77,8 @@ class ClassInfoCache {
/**
* sets the cache for the id
*
* @param $id
* @param $value
* @param string $id
* @param mixed $value
*/
public function set($id, $value) {
$this->level1Cache[$id] = $value;
......
......@@ -143,7 +143,7 @@ class Backend implements \TYPO3\CMS\Extbase\Persistence\Generic\BackendInterface
/**
* Injects the Reflection Service
*
* @param \TYPO3\CMS\Extbase\Reflection\ReflectionService
* @param \TYPO3\CMS\Extbase\Reflection\ReflectionService $reflectionService
* @return void
*/
public function injectReflectionService(\TYPO3\CMS\Extbase\Reflection\ReflectionService $reflectionService) {
......@@ -449,7 +449,7 @@ class Backend implements \TYPO3\CMS\Extbase\Persistence\Generic\BackendInterface
* @param \TYPO3\CMS\Extbase\Persistence\ObjectStorage $objectStorage The object storage to be persisted.
* @param \TYPO3\CMS\Extbase\DomainObject\DomainObjectInterface $parentObject The parent object. One of the properties holds the object storage.
* @param string $propertyName The name of the property holding the object storage.
* @param array $row The row array of the parent object to be persisted. It's passed by reference and gets filled with either a comma separated list of uids (csv) or the number of contained objects.
* @param array &$row The row array of the parent object to be persisted. It's passed by reference and gets filled with either a comma separated list of uids (csv) or the number of contained objects.
* @return void
*/
protected function persistObjectStorage(\TYPO3\CMS\Extbase\Persistence\ObjectStorage $objectStorage, \TYPO3\CMS\Extbase\DomainObject\DomainObjectInterface $parentObject, $propertyName, array &$row) {
......@@ -579,8 +579,8 @@ class Backend implements \TYPO3\CMS\Extbase\Persistence\Generic\BackendInterface
$parentColumnMap = $parentDataMap->getColumnMap($parentPropertyName);
if ($parentColumnMap->getTypeOfRelation() !== \TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::RELATION_HAS_MANY) {
throw new \TYPO3\CMS\Extbase\Persistence\Exception\IllegalRelationTypeException(
'Parent column relation type is ' . $parentColumnMap->getTypeOfRelation()
. ' but should be ' . \TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::RELATION_HAS_MANY,
'Parent column relation type is ' . $parentColumnMap->getTypeOfRelation() .
' but should be ' . \TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap::RELATION_HAS_MANY,
1345368105
);
}
......@@ -880,7 +880,7 @@ class Backend implements \TYPO3\CMS\Extbase\Persistence\Generic\BackendInterface
* Adds common databse fields to a row
*
* @param \TYPO3\CMS\Extbase\DomainObject\DomainObjectInterface $object
* @param array $row
* @param array &$row
* @return void
*/
protected function addCommonFieldsToRow(\TYPO3\CMS\Extbase\DomainObject\DomainObjectInterface $object, array &$row) {
......@@ -898,7 +898,7 @@ class Backend implements \TYPO3\CMS\Extbase\Persistence\Generic\BackendInterface
* Adjustes the common date fields of the given row to the current time
*
* @param \TYPO3\CMS\Extbase\DomainObject\DomainObjectInterface $object
* @param array $row The row to be updated
* @param array &$row The row to be updated
* @return void
*/
protected function addCommonDateFieldsToRow(\TYPO3\CMS\Extbase\DomainObject\DomainObjectInterface $object, array &$row) {
......@@ -931,7 +931,7 @@ class Backend implements \TYPO3\CMS\Extbase\Persistence\Generic\BackendInterface
* Deletes an object
*
* @param \TYPO3\CMS\Extbase\DomainObject\DomainObjectInterface $object The object to be removed from the storage
* @param bool $markAsDeleted Wether to just flag the row deleted (default) or really delete it
* @param boolean $markAsDeleted Wether to just flag the row deleted (default) or really delete it
* @return void
*/
protected function removeEntity(\TYPO3\CMS\Extbase\DomainObject\DomainObjectInterface $object, $markAsDeleted = TRUE) {
......
......@@ -195,7 +195,7 @@ class LazyLoadingProxy implements \Iterator, \TYPO3\CMS\Extbase\Persistence\Gene
/**
* Returns the next position of the storage array
*
* @return mixed
* @return void
*/
public function next() {
$realInstance = $this->_loadRealInstance();
......
......@@ -126,6 +126,8 @@ class LazyObjectStorage extends \TYPO3\CMS\Extbase\Persistence\ObjectStorage imp
// Delegation to the ObjectStorage methods below
/**
* @param \TYPO3\CMS\Extbase\Persistence\ObjectStorage $storage
*
* @see \TYPO3\CMS\Extbase\Persistence\ObjectStorage::addAll
*/
public function addAll($storage) {
......@@ -134,6 +136,9 @@ class LazyObjectStorage extends \TYPO3\CMS\Extbase\Persistence\ObjectStorage imp
}
/**
* @param object $object The object to add.
* @param mixed $data The data to associate with the object.
*
* @see \TYPO3\CMS\Extbase\Persistence\ObjectStorage::attach
*/
public function attach($object, $data = NULL) {
......@@ -142,6 +147,9 @@ class LazyObjectStorage extends \TYPO3\CMS\Extbase\Persistence\ObjectStorage imp
}
/**
* @param object $object The object to look for.
* @return boolean
*
* @see \TYPO3\CMS\Extbase\Persistence\ObjectStorage::contains
*/
public function contains($object) {
......@@ -171,6 +179,8 @@ class LazyObjectStorage extends \TYPO3\CMS\Extbase\Persistence\ObjectStorage imp
}
/**
* @return object The object at the current iterator position.
*
* @see \TYPO3\CMS\Extbase\Persistence\ObjectStorage::current
*/
public function current() {
......@@ -179,6 +189,8 @@ class LazyObjectStorage extends \TYPO3\CMS\Extbase\Persistence\ObjectStorage imp
}
/**
* @param object $object The object to remove.
*
* @see \TYPO3\CMS\Extbase\Persistence\ObjectStorage::detach
*/
public function detach($object) {
......@@ -187,6 +199,8 @@ class LazyObjectStorage extends \TYPO3\CMS\Extbase\Persistence\ObjectStorage imp
}
/**
* @return string The index corresponding to the position of the iterator.
*
* @see \TYPO3\CMS\Extbase\Persistence\ObjectStorage::key
*/
public function key() {
......@@ -203,6 +217,9 @@ class LazyObjectStorage extends \TYPO3\CMS\Extbase\Persistence\ObjectStorage imp
}
/**
* @param object $object The object to look for.
* @return boolean
*
* @see \TYPO3\CMS\Extbase\Persistence\ObjectStorage::offsetExists
*/
public function offsetExists($object) {
......@@ -211,6 +228,9 @@ class LazyObjectStorage extends \TYPO3\CMS\Extbase\Persistence\ObjectStorage imp
}
/**
* @param object $object The object to look for.
* @return mixed
*
* @see \TYPO3\CMS\Extbase\Persistence\ObjectStorage::offsetGet
*/
public function offsetGet($object) {
......@@ -219,6 +239,9 @@ class LazyObjectStorage extends \TYPO3\CMS\Extbase\Persistence\ObjectStorage imp
}
/**
* @param object $object The object to add.
* @param mixed $info The data to associate with the object.
*
* @see \TYPO3\CMS\Extbase\Persistence\ObjectStorage::offsetSet
*/
public function offsetSet($object, $info) {
......@@ -227,6 +250,9 @@ class LazyObjectStorage extends \TYPO3\CMS\Extbase\Persistence\ObjectStorage imp
}
/**
* @param object $object The object to remove.
* @return void
*
* @see \TYPO3\CMS\Extbase\Persistence\ObjectStorage::offsetUnset
*/
public function offsetUnset($object) {
......@@ -235,6 +261,9 @@ class LazyObjectStorage extends \TYPO3\CMS\Extbase\Persistence\ObjectStorage imp
}
/**
* @param \TYPO3\CMS\Extbase\Persistence\ObjectStorage $storage The storage containing the elements to remove.
* @return void
*
* @see \TYPO3\CMS\Extbase\Persistence\ObjectStorage::removeAll
*/
public function removeAll($storage) {
......@@ -251,6 +280,8 @@ class LazyObjectStorage extends \TYPO3\CMS\Extbase\Persistence\ObjectStorage imp
}
/**
* @return boolean
*
* @see \TYPO3\CMS\Extbase\Persistence\ObjectStorage::valid
*/
public function valid() {
......@@ -259,6 +290,8 @@ class LazyObjectStorage extends \TYPO3\CMS\Extbase\Persistence\ObjectStorage imp
}
/**
* @return array
*
* @see \TYPO3\CMS\Extbase\Persistence\ObjectStorage::toArray
*/
public function toArray() {
......
......@@ -179,7 +179,6 @@ class DataMapFactory implements \TYPO3\CMS\Core\SingletonInterface {
$columnMap = $this->setFieldEvaluations($columnMap, $columnDefinition['config']);
$dataMap->addColumnMap($columnMap);
}
// debug($dataMap);
return $dataMap;
}
......
......@@ -111,7 +111,7 @@ class DataMapper implements \TYPO3\CMS\Core\SingletonInterface {
/**
* Injects the Reflection Service
*
* @param \TYPO3\CMS\Extbase\Reflection\ReflectionService
* @param \TYPO3\CMS\Extbase\Reflection\ReflectionService $reflectionService
* @return void
*/
public function injectReflectionService(\TYPO3\CMS\Extbase\Reflection\ReflectionService $reflectionService) {
......@@ -121,7 +121,7 @@ class DataMapper implements \TYPO3\CMS\Core\SingletonInterface {
/**
* Injects the DataMap Factory
*
* @param \TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapFactory
* @param \TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapFactory $dataMapFactory
* @return void
*/
public function injectDataMapFactory(\TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapFactory $dataMapFactory) {
......@@ -323,7 +323,7 @@ class DataMapper implements \TYPO3\CMS\Core\SingletonInterface {
* @param \TYPO3\CMS\Extbase\DomainObject\DomainObjectInterface $parentObject The object instance this proxy is part of
* @param string $propertyName The name of the proxied property in it's parent
* @param mixed $fieldValue The raw field value.
* @param bool $enableLazyLoading A flag indication if the related objects should be lazy loaded
* @param boolean $enableLazyLoading A flag indication if the related objects should be lazy loaded
* @return \TYPO3\CMS\Extbase\Persistence\Generic\LazyObjectStorage|\TYPO3\CMS\Extbase\Persistence\QueryResultInterface The result
*/
public function fetchRelated(\TYPO3\CMS\Extbase\DomainObject\DomainObjectInterface $parentObject, $propertyName, $fieldValue = '', $enableLazyLoading = TRUE) {
......@@ -552,8 +552,8 @@ class DataMapper implements \TYPO3\CMS\Core\SingletonInterface {
/**
* Returns the column name for a given property name of the specified class.
*
* @param string $className
* @param string $propertyName
* @param string $className
* @return string The column name
*/
public function convertPropertyNameToColumnName($propertyName, $className = NULL) {
......
......@@ -320,10 +320,8 @@ class PersistenceManager implements \TYPO3\CMS\Extbase\Persistence\PersistenceMa
/**
* Converts the given object into an array containing the identity of the domain object.
*
* @param object $object The object to be converted
* @return array The identity array in the format array('__identity' => '...')
* @throws \TYPO3\CMS\Extbase\Persistence\Generic\Exception\NotImplementedException
* @throws \TYPO3\CMS\Extbase\Persistence\Exception\UnknownObjectException if the given object is not known to the Persistence Manager
* @param object $object The object to be converted
* @api
*/
public function convertObjectToIdentityArray($object) {
......@@ -334,10 +332,8 @@ class PersistenceManager implements \TYPO3\CMS\Extbase\Persistence\PersistenceMa
* Recursively iterates through the given array and turns objects
* into arrays containing the identity of the domain object.
*
* @param array $array The array to be iterated over
* @return array The modified array without objects
* @throws \TYPO3\CMS\Extbase\Persistence\Generic\Exception\NotImplementedException
* @throws \TYPO3\CMS\Extbase\Persistence\Exception\UnknownObjectException if array contains objects that are not known to the Persistence Manager
* @param array $array The array to be iterated over
* @api
* @see convertObjectToIdentityArray()
*/
......
......@@ -593,7 +593,6 @@ class Query implements \TYPO3\CMS\Extbase\Persistence\QueryInterface {
* It matches if the multivalued property contains no values or is NULL.
*
* @param string $propertyName The name of the multivalued property to compare against
* @return boolean
* @throws \TYPO3\CMS\Extbase\Persistence\Generic\Exception\NotImplementedException
* @throws \TYPO3\CMS\Extbase\Persistence\Exception\InvalidQueryException if used on a single-valued property
* @api
......
......@@ -395,7 +395,7 @@ class Typo3DbBackend implements \TYPO3\CMS\Extbase\Persistence\Generic\Storage\B
* Parses the query and returns the SQL statement parts.
*
* @param \TYPO3\CMS\Extbase\Persistence\QueryInterface $query The query
* @param array $parameters
* @param array &$parameters
* @return array The SQL statement parts
*/
public function parseQuery(\TYPO3\CMS\Extbase\Persistence\QueryInterface $query, array &$parameters) {
......@@ -757,10 +757,10 @@ class Typo3DbBackend implements \TYPO3\CMS\Extbase\Persistence\Generic\Storage\B
}
/**
* @param $className
* @param $tableName
* @param $propertyPath
* @param array $sql
* @param string &$className
* @param string &$tableName
* @param array &$propertyPath
* @param array &$sql
* @throws \TYPO3\CMS\Extbase\Persistence\Generic\Exception
* @throws \TYPO3\CMS\Extbase\Persistence\Generic\Exception\InvalidRelationConfigurationException
* @throws \TYPO3\CMS\Extbase\Persistence\Generic\Exception\MissingColumnMapException
......@@ -861,12 +861,11 @@ class Typo3DbBackend implements \TYPO3\CMS\Extbase\Persistence\Generic\Storage\B
* Replace query placeholders in a query part by the given
* parameters.
*
* @param string $sqlString The query part with placeholders
* @param string &$sqlString The query part with placeholders
* @param array $parameters The parameters
* @param string $tableName
*
* @throws \TYPO3\CMS\Extbase\Persistence\Generic\Exception
* @return string The query part with replaced placeholders
*/
protected function replacePlaceholders(&$sqlString, array $parameters, $tableName = 'foo') {
// TODO profile this method again
......@@ -899,7 +898,7 @@ class Typo3DbBackend implements \TYPO3\CMS\Extbase\Persistence\Generic\Storage\B
*
* @param \TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface $querySettings The TYPO3 CMS specific query settings
* @param string $tableName The table name to add the additional where clause for
* @param string $sql
* @param string &$sql
* @return void
*/
protected function addAdditionalWhereClause(\TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface $querySettings, $tableName, &$sql) {
......@@ -1028,8 +1027,8 @@ class Typo3DbBackend implements \TYPO3\CMS\Extbase\Persistence\Generic\Storage\B
if (isset($GLOBALS['TCA'][$tableName]['ctrl']['transOrigPointerField'])
&& $querySettings->getSysLanguageUid() > 0
) {
$additionalWhereClause .= ' OR (' . $tableName . '.' . $GLOBALS['TCA'][$tableName]['ctrl']['languageField'] . '=0' .
' AND ' . $tableName . '.uid NOT IN (' . 'SELECT ' . $tableName . '.' . $GLOBALS['TCA'][$tableName]['ctrl']['transOrigPointerField'] .
$additionalWhereClause .= ' OR (' . $tableName . '.' . $GLOBALS['TCA'][$tableName]['ctrl']['languageField'] .
' =0 AND ' . $tableName . '.uid NOT IN (SELECT ' . $tableName . '.' . $GLOBALS['TCA'][$tableName]['ctrl']['transOrigPointerField'] .
' FROM ' . $tableName .
' WHERE ' . $tableName . '.' . $GLOBALS['TCA'][$tableName]['ctrl']['transOrigPointerField'] . '>0' .
' AND ' . $tableName . '.' . $GLOBALS['TCA'][$tableName]['ctrl']['languageField'] . '>0';
......@@ -1309,4 +1308,4 @@ class Typo3DbBackend implements \TYPO3\CMS\Extbase\Persistence\Generic\Storage\B
}
}
?>
?>
\ No newline at end of file
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment