Commit 63268748 authored by Frank Nägler's avatar Frank Nägler Committed by Wouter Wolters
Browse files

[TASK] Use "bool" in @param notation

This patch is a follow-up patch for
https://review.typo3.org/33523/

Resolves: #62468
Releases: master
Change-Id: Ib16ab5378047b91759f3e5c38952fb57d3afb7ce
Reviewed-on: http://review.typo3.org/33527


Reviewed-by: Cedric Ziel's avatarCedric Ziel <cedric@cedric-ziel.com>
Tested-by: Cedric Ziel's avatarCedric Ziel <cedric@cedric-ziel.com>
Reviewed-by: Wouter Wolters's avatarWouter Wolters <typo3@wouterwolters.nl>
Tested-by: Wouter Wolters's avatarWouter Wolters <typo3@wouterwolters.nl>
parent cdefaadc
......@@ -143,7 +143,7 @@ abstract class AbstractService {
*
* @param string $msg Debug message
* @param int $severity Severity: 0 is info, 1 is notice, 2 is warning, 3 is fatal error, -1 is "OK" message
* @param array|boolean $dataVar dditional data you want to pass to the logger.
* @param array|bool $dataVar dditional data you want to pass to the logger.
* @return void
*/
public function devLog($msg, $severity = 0, $dataVar = FALSE) {
......
......@@ -323,7 +323,7 @@ class BasicFileUtility {
*
* @param string The input filename to check
* @param string The directory for which to return a unique filename for $theFile. $theDest MUST be a valid directory. Should be absolute.
* @param boolean If set the filename is returned with the path prepended without checking whether it already existed!
* @param bool If set the filename is returned with the path prepended without checking whether it already existed!
* @return string The destination absolute filepath (not just the name!) of a unique filename/foldername in that path.
* @see \TYPO3\CMS\Core\DataHandling\DataHandler::checkValue()
* @todo Deprecate, but still in use by the Core (DataHandler...)
......
......@@ -115,8 +115,8 @@ class SqlParser extends \TYPO3\CMS\Core\Database\SqlParser {
* Can also compile field lists for ORDER BY and GROUP BY.
*
* @param array $selectFields Array of select fields, (made with ->parseFieldList())
* @param boolean $compileComments Whether comments should be compiled
* @param boolean $functionMapping Whether function mapping should take place
* @param bool $compileComments Whether comments should be compiled
* @param bool $functionMapping Whether function mapping should take place
* @return string Select field string
* @see parseFieldList()
*/
......@@ -169,7 +169,7 @@ class SqlParser extends \TYPO3\CMS\Core\Database\SqlParser {
* Compiles a CASE ... WHEN flow-control construct based on input array (made with ->parseCaseStatement())
*
* @param array $components Array of case components, (made with ->parseCaseStatement())
* @param boolean $functionMapping Whether function mapping should take place
* @param bool $functionMapping Whether function mapping should take place
* @return string case when string
* @see parseCaseStatement()
*/
......
......@@ -192,7 +192,7 @@ class Query implements QueryInterface {
/**
* Executes the query against the database and returns the result
*
* @param $returnRawQueryResult boolean avoids the object mapping by the persistence
* @param bool $returnRawQueryResult avoids the object mapping by the persistence
* @return \TYPO3\CMS\Extbase\Persistence\QueryResultInterface|array The query result object or an array if $returnRawQueryResult is TRUE
* @api
*/
......
......@@ -129,7 +129,7 @@ interface QueryInterface {
/**
* Executes the query and returns the result.
*
* @param $returnRawQueryResult boolean avoids the object mapping by the persistence
* @param bool $returnRawQueryResult avoids the object mapping by the persistence
* @return \TYPO3\CMS\Extbase\Persistence\QueryResultInterface|array The query result object or an array if $returnRawQueryResult is TRUE
* @api
*/
......
......@@ -272,7 +272,7 @@ class IndexedPagesController extends \TYPO3\CMS\Backend\Module\AbstractFunctionM
* Render a single row of information about a indexing entry.
*
* @param array Row from query (combined phash table with sections etc).
* @param boolean Set if grouped to previous result; the icon of the element is not shown again.
* @param bool Set if grouped to previous result; the icon of the element is not shown again.
* @param array Array of index_grlist records.
* @return array Array of table rows.
* @see indexed_info()
......@@ -519,7 +519,7 @@ class IndexedPagesController extends \TYPO3\CMS\Backend\Module\AbstractFunctionM
*
* @param array Array of records selected from index_rel/index_words
* @param string Header string to show before table.
* @param boolean If set, the stopWord checkboxes will be shown in the word list. Only for admins. (because it is a global setting, not per-site).
* @param bool If set, the stopWord checkboxes will be shown in the word list. Only for admins. (because it is a global setting, not per-site).
* @param array The page record from which to load the keywords, if any.
* @return string HTML table
*/
......@@ -922,7 +922,7 @@ class IndexedPagesController extends \TYPO3\CMS\Backend\Module\AbstractFunctionM
* Removes ALL data regarding a certain list of indexed phash-row
*
* @param string List of phash integers
* @param boolean If set, page cache is cleared as well.
* @param bool If set, page cache is cleared as well.
* @return void
*/
public function removeIndexedPhashRow($phashList, $clearPageCache = 1) {
......
......@@ -338,7 +338,7 @@ class SearchFormController extends \TYPO3\CMS\Frontend\Plugin\AbstractPlugin {
*
* $defOp is the default operator. 1=OR, 0=AND
*
* @param boolean If TRUE, the default operator will be OR, not AND
* @param bool If TRUE, the default operator will be OR, not AND
* @return array Returns array with search words if any found
*/
public function getSearchWords($defOp) {
......@@ -1171,7 +1171,7 @@ class SearchFormController extends \TYPO3\CMS\Frontend\Plugin\AbstractPlugin {
/**
* Returns "DESC" or "" depending on the settings of the incoming highest/lowest result order (piVars['desc']
*
* @param boolean If TRUE, inverse the order which is defined by piVars['desc']
* @param bool If TRUE, inverse the order which is defined by piVars['desc']
* @return string " DESC" or
*/
public function isDescending($inverse = FALSE) {
......@@ -1564,7 +1564,7 @@ class SearchFormController extends \TYPO3\CMS\Frontend\Plugin\AbstractPlugin {
* Preparing template data for the result row output
*
* @param array Result row
* @param boolean If set, display only header of result (for sub-results)
* @param bool If set, display only header of result (for sub-results)
* @return array Array with data to insert in result row template
*/
public function prepareResultRowTemplateData($row, $headerOnly) {
......@@ -1792,7 +1792,7 @@ class SearchFormController extends \TYPO3\CMS\Frontend\Plugin\AbstractPlugin {
* Returns the resume for the search-result.
*
* @param array Search result row
* @param boolean If noMarkup is FALSE, then the index_fulltext table is used to select the content of the page, split it with regex to display the search words in the text.
* @param bool If noMarkup is FALSE, then the index_fulltext table is used to select the content of the page, split it with regex to display the search words in the text.
* @param integer String length
* @return string HTML string ...
*/
......
......@@ -707,7 +707,7 @@ class IndexSearchRepository {
* This means this function will work in conjunction with the preview facilities of the frontend engine/Admin Panel.
*
* @param string The table for which to get the where clause
* @param boolean If set, then you want NOT to filter out hidden records. Otherwise hidden record are filtered based on the current preview settings.
* @param bool If set, then you want NOT to filter out hidden records. Otherwise hidden record are filtered based on the current preview settings.
* @return string The part of the where clause on the form " AND [fieldname]=0 AND ...". Eg. " AND hidden=0 AND starttime < 123345567
* @see \TYPO3\CMS\Frontend\Page\PageRepository::enableFields()
*/
......
......@@ -62,7 +62,7 @@ class PluginHook {
*
* @param array Template Content (generated from result row) being processed.
* @param array Result row
* @param boolean If set, the result row is a sub-row.
* @param bool If set, the result row is a sub-row.
* @return array Template Content returned.
*/
public function prepareResultRowTemplateData_postProc($tmplContent, $row, $headerOnly) {
......
......@@ -400,7 +400,7 @@ class FileContentParser {
* Wraps the "splitLabel function" of the language object.
*
* @param string $reference: Reference/key of the label
* @param boolean $useHtmlSpecialChar: Convert special chars to HTML entities (default: FALSE)
* @param bool $useHtmlSpecialChar: Convert special chars to HTML entities (default: FALSE)
* @return string The label of the reference/key to be fetched
*/
protected function sL($reference, $useHtmlSpecialChar = FALSE) {
......
......@@ -239,7 +239,7 @@ class Indexer {
* @param string The MP variable (Mount Points), &MP=
* @param array Rootline array of only UIDs.
* @param array Array of GET variables to register with this indexing
* @param boolean If set, calculates a cHash value from the $cHash_array. Probably you will not do that since such cases are indexed through the frontend and the idea of this interface is to index non-cachable pages from the backend!
* @param bool If set, calculates a cHash value from the $cHash_array. Probably you will not do that since such cases are indexed through the frontend and the idea of this interface is to index non-cachable pages from the backend!
* @return void
*/
public function backend_initIndexer($id, $type, $sys_language_uid, $MP, $uidRL, $cHash_array = array(), $createCHash = FALSE) {
......@@ -989,7 +989,7 @@ class Indexer {
* Indexing a regular document given as $file (relative to PATH_site, local file)
*
* @param string Relative Filename, relative to PATH_site. It can also be an absolute path as long as it is inside the lockRootPath (validated with \TYPO3\CMS\Core\Utility\GeneralUtility::isAbsPath()). Finally, if $contentTmpFile is set, this value can be anything, most likely a URL
* @param boolean If set, indexing is forced (despite content hashes, mtime etc).
* @param bool If set, indexing is forced (despite content hashes, mtime etc).
* @param string Temporary file with the content to read it from (instead of $file). Used when the $file is a URL.
* @param string File extension for temporary file.
* @return void
......@@ -1281,7 +1281,7 @@ class Indexer {
* Creating metaphone based hash from input word
*
* @param string Word to convert
* @param boolean If set, returns the raw metaphone value (not hashed)
* @param bool If set, returns the raw metaphone value (not hashed)
* @return mixed Metaphone hash integer (or raw value, string)
*/
public function metaphone($word, $returnRawMetaphoneValue = FALSE) {
......
......@@ -277,7 +277,7 @@ class Lexer {
* @param string UTF-8 multibyte character string (reference)
* @param integer The length of the character (reference, return value)
* @param integer Starting position in input string
* @param boolean If set, then a hex. number is returned
* @param bool If set, then a hex. number is returned
* @return integer UNICODE codepoint
*/
public function utf8_ord(&$str, &$len, $pos = 0, $hex = FALSE) {
......
......@@ -295,7 +295,7 @@ class DeletedRecords {
* If $recursive is TRUE all records below the page uid would be undelete too
*
* @param string $recordArray: Representation of the records
* @param boolean $recursive: TRUE/FALSE
* @param bool $recursive: TRUE/FALSE
* @return boolean
*/
public function undeleteData($recordsArray, $recursive = FALSE) {
......
......@@ -25,7 +25,7 @@ class Tables {
* Get tables for menu example
*
* @param string $format: Return format (example: json)
* @param boolean $withAllOption: 0 no, 1 return tables with a "all" option
* @param bool $withAllOption: 0 no, 1 return tables with a "all" option
* @param integer $id: UID from selected page
* @param integer $depth: How many levels recursive
* @return string The tables to be displayed
......
......@@ -228,7 +228,7 @@ abstract class RteHtmlAreaApi {
/**
* Sets the plugin to require synchronous load or not
*
* @param boolean $value: the boolean value to set
* @param bool $value: the boolean value to set
* @return void
*/
public function setSynchronousLoad($value = TRUE) {
......
......@@ -1147,7 +1147,7 @@ class RteHtmlAreaBase extends \TYPO3\CMS\Backend\Rte\AbstractRte {
* @param string $label: A label to insert at the beginning of the name of the file
* @param string $fileExtension: The file extension of the file, defaulting to 'js'
* @param string $contents: The contents to write into the file if no $sourceFileName is provided
* @param boolean $concatenate Not used anymore
* @param bool $concatenate Not used anymore
* @return string The name of the file writtten to typo3temp/rtehtmlarea
*/
public function writeTemporaryFile($sourceFileName = '', $label, $fileExtension = 'js', $contents = '', $concatenate = FALSE) {
......
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