Commit 74d1fb24 authored by Stefan Neufeind's avatar Stefan Neufeind Committed by Wouter Wolters
Browse files

[TASK] Turn todos into @todo to find them easier, Part 2

Change-Id: Iedee934b91eb22f9263de60e0f26c34af61222ec
Resolves: #63619
Releases: master
Reviewed-on: http://review.typo3.org/35130


Reviewed-by: Christian Kuhn's avatarChristian Kuhn <lolli@schwarzbu.ch>
Tested-by: Christian Kuhn's avatarChristian Kuhn <lolli@schwarzbu.ch>
Reviewed-by: Wouter Wolters's avatarWouter Wolters <typo3@wouterwolters.nl>
Tested-by: Wouter Wolters's avatarWouter Wolters <typo3@wouterwolters.nl>
parent e1073f8d
......@@ -196,7 +196,7 @@ class InlineElement {
// We need that pid for ajax calls, so that they would know where the action takes place on the page structure
if (!isset($this->inlineFirstPid)) {
// If this record is not new, try to fetch the inlineView states
// @TODO: Add checking/cleaning for unused tables, records, etc. to save space in uc-field
// @todo Add checking/cleaning for unused tables, records, etc. to save space in uc-field
if (MathUtility::canBeInterpretedAsInteger($row['uid'])) {
$inlineView = unserialize($GLOBALS['BE_USER']->uc['inlineView']);
$this->inlineView = $inlineView[$table][$row['uid']];
......@@ -823,7 +823,7 @@ class InlineElement {
// Using "form_type" locally in this script
$PA['fieldTSConfig'] = $this->fObj->setTSconfig($foreign_table, array(), $foreign_selector);
$config = $PA['fieldConf']['config'];
//TODO: $disabled is not present - should be read from config?
// @todo $disabled is not present - should be read from config?
$disabled = FALSE;
if (!$disabled) {
// Create option tags:
......
......@@ -199,7 +199,7 @@ class SuggestElement {
if (isset($fieldConfig['allowed'])) {
if ($fieldConfig['allowed'] === '*') {
foreach ($GLOBALS['TCA'] as $tableName => $tableConfig) {
// TODO: Refactor function to BackendUtility
// @todo Refactor function to BackendUtility
if (empty($tableConfig['ctrl']['hideTable'])
&& ($GLOBALS['BE_USER']->isAdmin()
|| (empty($tableConfig['ctrl']['adminOnly'])
......
......@@ -106,7 +106,7 @@ class ThumbnailView {
/** @var File $filePathOrCombinedFileIdentifier */
$fileObject = ResourceFactory::getInstance()->getFileObject($filePathOrCombinedFileIdentifier);
} elseif (count($parts) <= 1 || !MathUtility::canBeInterpretedAsInteger($parts[0])) {
// TODO: Historically, the input parameter could also be an absolute path. This should be supported again to stay compatible.
// @todo Historically, the input parameter could also be an absolute path. This should be supported again to stay compatible.
// We assume the FilePath to be a relative file path (as in backwards compatibility mode)
$relativeFilePath = $filePathOrCombinedFileIdentifier;
// The incoming relative path is relative to the typo3/ directory, but we need it relative to PATH_site. This is corrected here:
......
......@@ -69,7 +69,7 @@ unset($webRoot);
/**
* We need to fake the current script to be the cli dispatcher to satisfy some GeneralUtility::getIndpEnv tests
* TODO: properly mock these tests
* @todo properly mock these tests
*/
define('PATH_thisScript', PATH_site . 'typo3/cli_dispatch.phpsh');
$_SERVER['SCRIPT_NAME'] = PATH_thisScript;
......@@ -90,7 +90,7 @@ $configurationManager = new \TYPO3\CMS\Core\Configuration\ConfigurationManager()
$GLOBALS['TYPO3_CONF_VARS'] = $configurationManager->getDefaultConfiguration();
// Avoid failing tests that rely on HTTP_HOST retrieval
// TODO: Check if we could do better mocking in these tests
// @todo Check if we could do better mocking in these tests
$GLOBALS['TYPO3_CONF_VARS']['SYS']['trustedHostsPattern'] = '.*';
\TYPO3\CMS\Core\Core\Bootstrap::getInstance()
......
......@@ -257,7 +257,7 @@ abstract class AbstractRecordCollection implements RecordCollectionInterface, Pe
* @return void
*/
public function usort($callbackFunction) {
// TODO: Implement usort() method with TCEforms in mind
// @todo Implement usort() method with TCEforms in mind
throw new \RuntimeException('This method is not yet supported.', 1322545589);
}
......@@ -272,7 +272,7 @@ abstract class AbstractRecordCollection implements RecordCollectionInterface, Pe
* @return void
*/
public function moveItemAt($currentPosition, $newPosition = 0) {
// TODO: Implement usort() method with TCEforms in mind
// @todo Implement usort() method with TCEforms in mind
throw new \RuntimeException('This method is not yet supported.', 1322545626);
}
......
......@@ -1211,7 +1211,7 @@ class DatabaseConnection {
$this->setSqlMode();
$this->checkConnectionCharset();
} else {
// @TODO: This should raise an exception. Would be useful especially to work during installation.
// @todo This should raise an exception. Would be useful especially to work during installation.
$error_msg = $this->link->connect_error;
$this->link = NULL;
GeneralUtility::sysLog(
......@@ -1771,7 +1771,7 @@ class DatabaseConnection {
* If $this->explainOutput is set, SELECT queries will be explained here. Only queries with more than one possible result row will be displayed.
* The output is either printed as raw HTML output or embedded into the TS admin panel (checkbox must be enabled!)
*
* TODO: Feature is not DBAL-compliant
* @todo Feature is not DBAL-compliant
*
* @param string $query SQL query
* @param string $from_table Table(s) from which to select. This is what comes right after "FROM ...". Required value.
......
......@@ -468,7 +468,7 @@ class RteHtmlParser extends \TYPO3\CMS\Core\Html\HtmlParser {
if ($fileOrFolderObject instanceof Resource\FileInterface) {
$fileIdentifier = $fileOrFolderObject->getIdentifier();
$fileObject = $fileOrFolderObject->getStorage()->getFile($fileIdentifier);
// TODO: if the retrieved file is a processed file, get the original file...
// @todo if the retrieved file is a processed file, get the original file...
$attribArray['data-htmlarea-file-uid'] = $fileObject->getUid();
}
} catch (Resource\Exception\ResourceDoesNotExistException $resourceDoesNotExistException) {
......
......@@ -166,7 +166,7 @@ class Package extends \TYPO3\Flow\Package\Package implements PackageInterface {
if (!empty($requiredPackageKey)) {
$composerManifest->require->$requiredPackageKey = $requiredPackageVersion;
} else {
// TODO: throw meaningful exception or fail silently?
// @todo throw meaningful exception or fail silently?
}
}
}
......@@ -176,7 +176,7 @@ class Package extends \TYPO3\Flow\Package\Package implements PackageInterface {
if (!empty($conflictingPackageKey)) {
$composerManifest->conflict->$conflictingPackageKey = $conflictingPackageVersion;
} else {
// TODO: throw meaningful exception or fail silently?
// @todo throw meaningful exception or fail silently?
}
}
}
......@@ -186,7 +186,7 @@ class Package extends \TYPO3\Flow\Package\Package implements PackageInterface {
if (!empty($suggestedPackageKey)) {
$composerManifest->suggest->$suggestedPackageKey = $suggestedPackageVersion;
} else {
// TODO: throw meaningful exception or fail silently?
// @todo throw meaningful exception or fail silently?
}
}
}
......
......@@ -191,7 +191,7 @@ class FileReference implements FileInterface {
/**
* Returns the title text to this image
*
* TODO: Possibly move this to the image domain object instead
* @todo Possibly move this to the image domain object instead
*
* @return string
*/
......@@ -202,7 +202,7 @@ class FileReference implements FileInterface {
/**
* Returns the alternative text to this image
*
* TODO: Possibly move this to the image domain object instead
* @todo Possibly move this to the image domain object instead
*
* @return string
*/
......@@ -213,7 +213,7 @@ class FileReference implements FileInterface {
/**
* Returns the description text to this file
*
* TODO: Possibly move this to the image domain object instead
* @todo Possibly move this to the image domain object instead
*
* @return string
*/
......@@ -224,7 +224,7 @@ class FileReference implements FileInterface {
/**
* Returns the link that should be active when clicking on this image
*
* TODO: Move this to the image domain object instead
* @todo Move this to the image domain object instead
*
* @return string
*/
......@@ -382,7 +382,7 @@ class FileReference implements FileInterface {
* @return bool TRUE if deletion succeeded
*/
public function delete() {
// TODO: Implement this function. This should only delete the
// @todo Implement this function. This should only delete the
// FileReference (sys_file_reference) record, not the file itself.
throw new \BadMethodCallException('Function not implemented FileReference::delete().', 1333754461);
//return $this->fileRepository->removeUsageRecord($this);
......@@ -392,12 +392,11 @@ class FileReference implements FileInterface {
* Renames the fileName in this particular usage.
*
* @param string $newName The new name
*
* @throws \BadMethodCallException
* @return FileReference
*/
public function rename($newName) {
// TODO: Implement this function. This should only rename the
// @todo Implement this function. This should only rename the
// FileReference (sys_file_reference) record, not the file itself.
throw new \BadMethodCallException('Function not implemented FileReference::rename().', 1333754473);
//return $this->fileRepository->renameUsageRecord($this, $newName);
......
......@@ -46,10 +46,10 @@ class ImageCropScaleMaskTask extends AbstractGraphicalTask {
* @return bool
*/
protected function isValidConfiguration(array $configuration) {
// TODO: Implement isValidConfiguration() method.
// @todo Implement isValidConfiguration() method.
}
public function fileNeedsProcessing() {
// TODO: Implement fileNeedsProcessing() method.
// @todo Implement fileNeedsProcessing() method.
}
}
......@@ -58,12 +58,13 @@ class ImagePreviewTask extends AbstractGraphicalTask {
* Returns TRUE if the file has to be processed at all, such as e.g. the original file does.
*
* Note: This does not indicate if the concrete ProcessedFile attached to this task has to be (re)processed.
* This check is done in ProcessedFile::isOutdated(). @todo isOutdated()/needsReprocessing()?
* This check is done in ProcessedFile::isOutdated().
* @todo isOutdated()/needsReprocessing()?
*
* @return bool
*/
public function fileNeedsProcessing() {
// TODO: Implement fileNeedsProcessing() method.
// @todo Implement fileNeedsProcessing() method.
/**
* Checks to perform:
......
......@@ -462,7 +462,7 @@ class TemplateService {
if (is_array($cc)) {
// If currentPageData was actually there, we match the result (if this wasn't done already in $TSFE->getFromCache()...)
if (!$cc['match']) {
// TODO: check if this can ever be the case - otherwise remove
// @todo check if this can ever be the case - otherwise remove
$cc = $this->matching($cc);
ksort($cc);
}
......@@ -821,7 +821,7 @@ class TemplateService {
public function addExtensionStatics($idList, $templateID, $pid, $row) {
$this->extensionStaticsProcessed = TRUE;
// @TODO: Change to use new API
// @todo Change to use new API
foreach ($GLOBALS['TYPO3_LOADED_EXT'] as $extKey => $files) {
if ((is_array($files) || $files instanceof \ArrayAccess) && ($files['ext_typoscript_constants.txt'] || $files['ext_typoscript_setup.txt'])) {
$mExtKey = str_replace('_', '', $extKey);
......
......@@ -389,7 +389,7 @@ class CommandUtility {
}
// Add path from environment
// TODO: how does this work for WIN
// @todo how does this work for WIN
if ($GLOBALS['_SERVER']['PATH']) {
$sep = (TYPO3_OS == 'WIN' ? ';' : ':');
$envPath = GeneralUtility::trimExplode($sep, $GLOBALS['_SERVER']['PATH'], TRUE);
......
......@@ -39,7 +39,7 @@ class ExtensionManagementUtility {
* the access to the cache file to read the single ext_tables.php if it was
* already read from cache
*
* @TODO : See if we can get rid of the 'load multiple times' scenario in fe
* @todo See if we can get rid of the 'load multiple times' scenario in fe
* @var bool
*/
static protected $extTablesWasReadFromCacheOnce = FALSE;
......@@ -794,7 +794,7 @@ class ExtensionManagementUtility {
list($extensionKey, $relativePath) = explode('/', substr($iconPathAndFilename, 4), 2);
$iconPathAndFilename = self::extPath($extensionKey) . $relativePath;
}
// TODO: skin support
// @todo skin support
$moduleLabels = array(
'tabs_images' => array(
'tab' => $iconPathAndFilename
......
......@@ -1115,8 +1115,8 @@ class GeneralUtility {
* errors. This function will return TRUE if current mail sending method has
* problem with recipient name in recipient/sender argument for mail().
*
* TODO: 4.3 should have additional configuration variable, which is combined
* by || with the rest in this function.
* @todo 4.3 should have additional configuration variable, which is combined
* by || with the rest in this function.
*
* @return bool TRUE if mail() does not accept recipient name
*/
......@@ -4279,7 +4279,7 @@ Connection: close
* Just prefix the function call with "&": "$objRef = &\TYPO3\CMS\Core\Utility\GeneralUtility::getUserObj('EXT:myext/class.tx_myext_myclass.php:&tx_myext_myclass');".
* This will work ONLY if you prefix the class name with "&" as well. See description of function arguments.
*
* @TODO : Deprecate the whole method in several steps:
* @todo Deprecate the whole method in several steps:
* 1. Deprecated singleton pattern,
* 2. Deprecate file prefix/ require file,
* 3. Deprecate usage without valid class name.
......
......@@ -244,7 +244,7 @@ class PathUtility {
// Replace backslashes with slashes to work with Windows paths if given
$path = trim(str_replace('\\', '/', $path));
// TODO: do we really need this? Probably only in testing context for vfs?
// @todo do we really need this? Probably only in testing context for vfs?
$protocol = '';
if (strpos($path, '://') !== FALSE) {
list($protocol, $path) = explode('://', $path);
......
......@@ -29,7 +29,7 @@ use TYPO3\CMS\Core\Utility\StringUtility;
abstract class UnitTestCase extends BaseTestCase {
/**
* TODO: make LoadedExtensionsArray serializable instead
* @todo make LoadedExtensionsArray serializable instead
*
* @var array
*/
......
......@@ -71,7 +71,7 @@ class AdodbPreparedStatement extends \TYPO3\CMS\Dbal\Database\DatabaseConnection
* @return bool TRUE on success or FALSE on failure
*/
public function prepare() {
// TODO: actually prepare the query with ADOdb, if supported by the underlying DBMS
// @todo actually prepare the query with ADOdb, if supported by the underlying DBMS
// see: http://phplens.com/lens/adodb/docs-adodb.htm#prepare
return TRUE;
}
......
......@@ -3056,8 +3056,6 @@ class DatabaseConnection extends \TYPO3\CMS\Core\Database\DatabaseConnection {
$this->checkConnectionCharset();
}
// TODO:
$output = TRUE;
} else {
GeneralUtility::sysLog('Could not connect to MySQL server ' . $cfgArray['config']['host'] . ' with user ' . $cfgArray['config']['username'] . '.', 'Core', 4);
......
......@@ -240,7 +240,7 @@ class Argument {
$this->value = $this->propertyMapper->convert($rawValue, $this->dataType, $this->propertyMappingConfiguration);
$this->validationResults = $this->propertyMapper->getMessages();
if ($this->validator !== NULL) {
// TODO: Validation API has also changed!!!
// @todo Validation API has also changed!!!
$validationMessages = $this->validator->validate($this->value);
$this->validationResults->merge($validationMessages);
}
......
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