[TASK] Clean up the phpDoc of t3lib/interfaces/
authorWouter Wolters <typo3@wouterwolters.nl>
Wed, 30 May 2012 21:42:36 +0000 (23:42 +0200)
committerGeorg Ringer <mail@ringerge.org>
Fri, 1 Jun 2012 16:59:08 +0000 (18:59 +0200)
Clean up the phpDoc of t3lib/interfaces/

So I made a patch doing mostly:

* Provide correct parameter names in phpDoc
* Provide correct data types in phpDoc
* CGLify phpDoc (remove tabs)
* CGLify method signatures (the first line of the method)

Change-Id: I9070491fd9c1ee3bc77d88d1f50cbefb106a3ed9
Resolves: #37620
Releases: 6.0
Reviewed-on: http://review.typo3.org/11756
Reviewed-by: Georg Ringer
Tested-by: Georg Ringer
17 files changed:
t3lib/interfaces/file/Service/Publishing/Publisher.php
t3lib/interfaces/interface.t3lib_browselinkshook.php
t3lib/interfaces/interface.t3lib_db_postprocessqueryhook.php
t3lib/interfaces/interface.t3lib_db_preprocessqueryhook.php
t3lib/interfaces/interface.t3lib_extfilefunctions_processdatahook.php
t3lib/interfaces/interface.t3lib_exttables_postprocessinghook.php
t3lib/interfaces/interface.t3lib_localrecordlistgettablehook.php
t3lib/interfaces/interface.t3lib_mail_maileradapter.php
t3lib/interfaces/interface.t3lib_pageselect_getpagehook.php
t3lib/interfaces/interface.t3lib_pageselect_getpageoverlayhook.php
t3lib/interfaces/interface.t3lib_pageselect_getrecordoverlayhook.php
t3lib/interfaces/interface.t3lib_singleton.php
t3lib/interfaces/interface.t3lib_spritemanager_spriteicongenerator.php
t3lib/interfaces/interface.t3lib_tceforms_dbfileiconshook.php
t3lib/interfaces/interface.t3lib_tceformsinlinehook.php
t3lib/interfaces/interface.t3lib_tcemain_checkmodifyaccesslisthook.php
t3lib/interfaces/interface.t3lib_tcemain_processuploadhook.php

index d42429c..9fb2f87 100644 (file)
@@ -38,7 +38,6 @@ interface t3lib_file_Service_Publishing_Publisher {
        /**
         * Publishes a file to this publisher's public space
         *
-        * @abstract
         * @param t3lib_file_FileInterface $fileObject
         * @return string The URI of the published file
         */
@@ -47,7 +46,6 @@ interface t3lib_file_Service_Publishing_Publisher {
        /**
         * Publishes a collection of files, if necessary also recursively.
         *
-        * @abstract
         * @param t3lib_file_Folder $folder
         * @return void
         */
@@ -56,16 +54,14 @@ interface t3lib_file_Service_Publishing_Publisher {
        /**
         * Returns TRUE if a file has been published.
         *
-        * @abstract
         * @param t3lib_file_FileInterface $fileObject
-        * @return bool
+        * @return boolean
         */
        public function isPublished(t3lib_file_FileInterface $fileObject);
 
        /**
         * Returns the public URL of a given file. Will throw an exception if the file is not public.
         *
-        * @abstract
         * @param t3lib_file_FileInterface $fileObject
         * @return string
         */
index deb49ba..fa8766a 100644 (file)
  *  This copyright notice MUST APPEAR in all copies of the script!
  ***************************************************************/
 
-
 /**
- * interface for classes which hook into browse_links
+ * Interface for classes which hook into browse_links
  *
- * @author     Ingo Renner <ingo@typo3.org>
+ * @author Ingo Renner <ingo@typo3.org>
  * @package TYPO3
  * @subpackage t3lib
  */
 interface t3lib_browseLinksHook {
 
        /**
-        * initializes the hook object
+        * Initializes the hook object
         *
-        * @param       browse_links    parent browse_links object
-        * @param       array                   additional parameters
-        * @return      void
+        * @param browse_links Parent browse_links object
+        * @param array Additional parameters
+        * @return void
         */
        public function init($parentObject, $additionalParameters);
 
        /**
-        * adds new items to the currently allowed ones and returns them
+        * Adds new items to the currently allowed ones and returns them
         *
-        * @param       array   currently allowed items
-        * @return      array   currently allowed items plus added items
+        * @param array Currently allowed items
+        * @return array Currently allowed items plus added items
         */
        public function addAllowedItems($currentlyAllowedItems);
 
        /**
-        * modifies the menu definition and returns it
+        * Modifies the menu definition and returns it
         *
-        * @param       array   menu definition
-        * @return      array   modified menu definition
+        * @param array Menu definition
+        * @return array Modified menu definition
         */
        public function modifyMenuDefinition($menuDefinition);
 
        /**
-        * returns a new tab for the browse links wizard
+        * Returns a new tab for the browse links wizard
         *
-        * @param       string          current link selector action
-        * @return      string          a tab for the selected link action
+        * @param string Current link selector action
+        * @return string A tab for the selected link action
         */
        public function getTab($linkSelectorAction);
 
        /**
-        * checks the current URL and determines what to do
+        * Checks the current URL and determines what to do
         *
-        * @param       unknown_type            $href
-        * @param       unknown_type            $siteUrl
-        * @param       unknown_type            $info
-        * @return      unknown_type
+        * @param string $href
+        * @param string $siteUrl
+        * @param array $info
+        * @return array
         */
        public function parseCurrentUrl($href, $siteUrl, $info);
 
index 69e14fc..ebd1c13 100644 (file)
  *  This copyright notice MUST APPEAR in all copies of the script!
  ***************************************************************/
 
-
 /**
  * Interface for classes which hook into t3lib_DB and do additional processing
  * after a query has been executed.
  *
- * @author     Xavier Perseguers <typo3@perseguers.ch>
+ * @author Xavier Perseguers <typo3@perseguers.ch>
  * @package TYPO3
  * @subpackage t3lib
  */
index 306cd36..94c49a4 100644 (file)
  *  This copyright notice MUST APPEAR in all copies of the script!
  ***************************************************************/
 
-
 /**
  * Interface for classes which hook into t3lib_DB and do additional processing
  * before a query has been executed.
  *
- * @author     Xavier Perseguers <typo3@perseguers.ch>
+ * @author Xavier Perseguers <typo3@perseguers.ch>
  * @package TYPO3
  * @subpackage t3lib
  */
index eb678c5..e94522f 100644 (file)
  *  This copyright notice MUST APPEAR in all copies of the script!
  ***************************************************************/
 
-
 /**
  * Interface for classes which hook into extFileFunctions and do additional processData processing.
  *
- * @author     Xavier Perseguers <typo3@perseguers.ch>
+ * @author Xavier Perseguers <typo3@perseguers.ch>
  * @package TYPO3
  * @subpackage t3lib
  */
@@ -39,11 +38,11 @@ interface t3lib_extFileFunctions_processDataHook {
        /**
         * Post-process a file action.
         *
-        * @param       string                                          The action
-        * @param       array                                           The parameter sent to the action handler
-        * @param       array                                           The results of all calls to the action handler
-        * @param       t3lib_extFileFunctions          parent t3lib_extFileFunctions object
-        * @return      void
+        * @param string $action The action
+        * @param array $cmdArr The parameter sent to the action handler
+        * @param array $result The results of all calls to the action handler
+        * @param t3lib_extFileFunctions $parentObject Parent t3lib_extFileFunctions object
+        * @return void
         */
        public function processData_postProcessAction($action, array $cmdArr, array $result, t3lib_extFileFunctions $parentObject);
 
index 450a31b..2f40c99 100644 (file)
@@ -25,7 +25,6 @@
  *  This copyright notice MUST APPEAR in all copies of the script!
  ***************************************************************/
 
-
 /**
  * interface for classes with hook for postprocessing extTables after loading
  *
index 5f86b5f..1a8cb2d 100644 (file)
  *  This copyright notice MUST APPEAR in all copies of the script!
  ***************************************************************/
 
-
 /**
  * interface for classes which hook into localRecordList and do additional getTable processing
  *
- * @author     Ingo Renner <ingo@typo3.org>
+ * @author Ingo Renner <ingo@typo3.org>
  * @package TYPO3
  * @subpackage t3lib
  */
@@ -38,12 +37,12 @@ interface t3lib_localRecordListGetTableHook {
        /**
         * modifies the DB list query
         *
-        * @param       string                          the current database table
-        * @param       integer                         the record's page ID
-        * @param       string                          an additional WHERE clause
-        * @param       string                          comma separated list of selected fields
-        * @param       localRecordList         parent localRecordList object
-        * @return      void
+        * @param string $table The current database table
+        * @param integer $pageId The record's page ID
+        * @param string $additionalWhereClause An additional WHERE clause
+        * @param string $selectedFieldsList Comma separated list of selected fields
+        * @param localRecordList $parentObject Parent localRecordList object
+        * @return void
         */
        public function getDBlistQuery($table, $pageId, &$additionalWhereClause, &$selectedFieldsList, &$parentObject);
 
index 8bb87af..7a48ec4 100644 (file)
@@ -28,7 +28,7 @@
 /**
  * Mailer Adapter interface
  *
- * @author     Ingo Renner <ingo@typo3.org>
+ * @author Ingo Renner <ingo@typo3.org>
  * @package TYPO3
  * @subpackage t3lib
  */
@@ -37,13 +37,13 @@ interface t3lib_mail_MailerAdapter {
        /**
         * Mail sending function
         *
-        * @param       string  $to Mail recipient.
-        * @param       string  $subject Mail subject.
-        * @param       string  $messageBody Mail body.
-        * @param       array   $additionalHeaders Additional mail headers.
-        * @param       array   $additionalParameters Additional mailer parameters.
-        * @param       boolean $fakeSending Whether to fake sending or not, used in Unit Tests.
-        * @return      boolean TRUE if the mail was successfully sent, FALSE otherwise.
+        * @param string $to Mail recipient.
+        * @param string $subject Mail subject.
+        * @param string $messageBody Mail body.
+        * @param array $additionalHeaders Additional mail headers.
+        * @param array $additionalParameters Additional mailer parameters.
+        * @param boolean $fakeSending Whether to fake sending or not, used in Unit Tests.
+        * @return boolean TRUE if the mail was successfully sent, FALSE otherwise.
         */
        public function mail($to, $subject, $messageBody, $additionalHeaders = NULL, $additionalParameters = NULL, $fakeSending = FALSE);
 
index ae59bd6..4578457 100644 (file)
  *  This copyright notice MUST APPEAR in all copies of the script!
  ***************************************************************/
 
-
 /**
  * Interface for classes which hook into pageSelect and do additional getPage processing
  *
- * @author     Christian Kuhn <lolli@schwarzbu.ch>
+ * @author Christian Kuhn <lolli@schwarzbu.ch>
  * @package TYPO3
  * @subpackage t3lib
  */
-
 interface t3lib_pageSelect_getPageHook {
 
        /**
         * Modifies the DB params
         *
-        * @param       integer                         The page ID
-        * @param       boolean                         If set, the check for group access is disabled. VERY rarely used
-        * @param       t3lib_pageSelect        parent t3lib_pageSelect object
-        * @return      void
+        * @param integer $uid The page ID
+        * @param boolean $disableGroupAccessCheck If set, the check for group access is disabled. VERY rarely used
+        * @param t3lib_pageSelect $parentObject Parent t3lib_pageSelect object
+        * @return void
         */
        public function getPage_preProcess(&$uid, &$disableGroupAccessCheck, t3lib_pageSelect $parentObject);
 
index f7fbb02..24de556 100644 (file)
  *  This copyright notice MUST APPEAR in all copies of the script!
  ***************************************************************/
 
-
 /**
  * interface for classes which hook into t3lib_pageSelect
  *
- * @author     Tolleiv Nietsch <nietsch@aoemedia.de>
+ * @author Tolleiv Nietsch <nietsch@aoemedia.de>
  * @package TYPO3
  * @subpackage t3lib
  */
@@ -38,9 +37,9 @@ interface t3lib_pageSelect_getPageOverlayHook {
        /**
         * enables to preprocess the pageoverlay
         *
-        * @param array                         $pageInput      - the page record
-        * @param integer                       $lUid           - the overlay language
-        * @param t3lib_pageSelect      $parent         - the calling parent object
+        * @param array $pageInput The page record
+        * @param integer $lUid The overlay language
+        * @param t3lib_pageSelect $parent The calling parent object
         * @return void
         */
        public function getPageOverlay_preProcess(&$pageInput, &$lUid, t3lib_pageSelect $parent);
index 212918e..14e6815 100644 (file)
  *  This copyright notice MUST APPEAR in all copies of the script!
  ***************************************************************/
 
-
 /**
  * interface for classes which hook into t3lib_pageSelect
  *
- * @author     Tolleiv Nietsch <nietsch@aoemedia.de>
+ * @author Tolleiv Nietsch <nietsch@aoemedia.de>
  * @package TYPO3
  * @subpackage t3lib
  */
-
 interface t3lib_pageSelect_getRecordOverlayHook {
 
        /**
index 3e41f64..08bbaf2 100644 (file)
 /**
  * "empty" interface for singletons (marker interface pattern)
  *
- * @author     Martin Kutschker <masi@typo3.org>
+ * @author Martin Kutschker <masi@typo3.org>
  * @package TYPO3
  * @subpackage t3lib
  * @see t3lib_div::makeInstance()
  */
 interface t3lib_Singleton {
-       // deliberately empty
+       // Deliberately empty
 }
 
 ?>
\ No newline at end of file
index 3059e3c..e886c66 100644 (file)
  *  This copyright notice MUST APPEAR in all copies of the script!
  ***************************************************************/
 
-
 /**
  * Interface all handlers in t3lib_spritemanager have to implement.
  *
- * @author     Steffen Ritter <info@steffen-ritter.net>
+ * @author Steffen Ritter <info@steffen-ritter.net>
  * @package TYPO3
  * @subpackage t3lib
  */
@@ -48,7 +47,7 @@ interface t3lib_spritemanager_SpriteIconGenerator {
         * The sprite manager will call this function after the call to "generate"
         * it should return an array of all sprite-icon-names generated through the run
         *
-        * @retun array all generated/detected sprite-icon-names
+        * @retun array All generated/detected sprite-icon-names
         */
        public function getAvailableIconNames();
 }
index 88f452e..98f09b9 100644 (file)
  *  This copyright notice MUST APPEAR in all copies of the script!
  ***************************************************************/
 
-
 /**
  * Interface for classes which hook into t3lib_TCEforms and do additional dbFileIcons processing
  *
- * @author     Andy Grunwald <andreas.grunwald@wmdb.de>
+ * @author Andy Grunwald <andreas.grunwald@wmdb.de>
  * @package TYPO3
  * @subpackage t3lib
  */
@@ -38,16 +37,16 @@ interface t3lib_TCEforms_dbFileIconsHook {
        /**
         * Modifies the parameters for selector box form-field for the db/file/select elements (multiple)
         *
-        * @param       array                   $params                         An array of additional parameters, eg: "size", "info", "headers" (array with "selector" and "items"), "noBrowser", "thumbnails"
-        * @param       string                  $selector                       Alternative selector box.
-        * @param       string                  $thumbnails                     Thumbnail view of images. Only filled if there are images only. This images will be shown under the selectorbox.
-        * @param       array                   $icons                          Defined icons next to the selector box.
-        * @param       string                  $rightbox                       Thumbnail view of images. Only filled if there are other types as images. This images will be shown right next to the selectorbox.
-        * @param       string                  $fName                          Form element name
-        * @param       array                   $uidList                        The array of item-uids. Have a look at t3lib_TCEforms::dbFileIcons parameter "$itemArray"
-        * @param       array                   $additionalParams       Array with additional parameters which are be available at method call. Includes $mode, $allowed, $itemArray, $onFocus, $table, $field, $uid. For more information have a look at PHPDoc-Comment of t3lib_TCEforms::dbFileIcons
-        * @param       t3lib_TCEforms  $parentObject           parent t3lib_TCEforms object
-        * @return      void
+        * @param array $params An array of additional parameters, eg: "size", "info", "headers" (array with "selector" and "items"), "noBrowser", "thumbnails"
+        * @param string $selector Alternative selector box.
+        * @param string $thumbnails Thumbnail view of images. Only filled if there are images only. This images will be shown under the selectorbox.
+        * @param array $icons Defined icons next to the selector box.
+        * @param string $rightbox Thumbnail view of images. Only filled if there are other types as images. This images will be shown right next to the selectorbox.
+        * @param string $fName Form element name
+        * @param array $uidList The array of item-uids. Have a look at t3lib_TCEforms::dbFileIcons parameter "$itemArray"
+        * @param array $additionalParams Array with additional parameters which are be available at method call. Includes $mode, $allowed, $itemArray, $onFocus, $table, $field, $uid. For more information have a look at PHPDoc-Comment of t3lib_TCEforms::dbFileIcons
+        * @param t3lib_TCEforms $parentObject Parent t3lib_TCEforms object
+        * @return void
         */
        public function dbFileIcons_postProcess(array &$params, &$selector, &$thumbnails, array &$icons, &$rightbox, &$fName, array &$uidList, array $additionalParams, t3lib_TCEforms $parentObject);
 }
index 92d7393..474f574 100644 (file)
 /**
  * Interface for classes which hook into t3lib_TCEforms_inline.
  *
- * @author             Oliver Hader <oh@inpublica.de>
- * @package     TYPO3
- * @subpackage t3lib
+ * @author Oliver Hader <oh@inpublica.de>
+ * @package TYPO3
+ * @subpackage t3lib
  */
 interface t3lib_tceformsInlineHook {
        /**
         * Initializes this hook object.
         *
-        * @param       t3lib_TCEforms_inline           $parentObject: The calling t3lib_TCEforms_inline object.
-        * @return      void
+        * @param t3lib_TCEforms_inline $parentObject The calling t3lib_TCEforms_inline object.
+        * @return void
         */
        public function init(&$parentObject);
 
        /**
         * Pre-processing to define which control items are enabled or disabled.
         *
-        * @param       string          $parentUid: The uid of the parent (embedding) record (uid or NEW...)
-        * @param       string          $foreignTable: The table (foreign_table) we create control-icons for
-        * @param       array           $childRecord: The current record of that foreign_table
-        * @param       array           $childConfig: TCA configuration of the current field of the child record
-        * @param       boolean         $isVirtual: Defines whether the current records is only virtually shown and not physically part of the parent record
-        * @param       array           &$enabledControls: (reference) Associative array with the enabled control items
-        * @return      void
+        * @param string $parentUid The uid of the parent (embedding) record (uid or NEW...)
+        * @param string $foreignTable The table (foreign_table) we create control-icons for
+        * @param array $childRecord The current record of that foreign_table
+        * @param array $childConfig TCA configuration of the current field of the child record
+        * @param boolean $isVirtual Defines whether the current records is only virtually shown and not physically part of the parent record
+        * @param array &$enabledControls (reference) Associative array with the enabled control items
+        * @return void
         */
        public function renderForeignRecordHeaderControl_preProcess($parentUid, $foreignTable, array $childRecord, array $childConfig, $isVirtual, array &$enabledControls);
 
        /**
         * Post-processing to define which control items to show. Possibly own icons can be added here.
         *
-        * @param       string          $parentUid: The uid of the parent (embedding) record (uid or NEW...)
-        * @param       string          $foreignTable: The table (foreign_table) we create control-icons for
-        * @param       array           $childRecord: The current record of that foreign_table
-        * @param       array           $childConfig: TCA configuration of the current field of the child record
-        * @param       boolean         $isVirtual: Defines whether the current records is only virtually shown and not physically part of the parent record
-        * @param       array           &$controlItems: (reference) Associative array with the currently available control items
-        * @return      void
+        * @param string $parentUid The uid of the parent (embedding) record (uid or NEW...)
+        * @param string $foreignTable The table (foreign_table) we create control-icons for
+        * @param array $childRecord The current record of that foreign_table
+        * @param array $childConfig TCA configuration of the current field of the child record
+        * @param boolean $isVirtual Defines whether the current records is only virtually shown and not physically part of the parent record
+        * @param array &$controlItems (reference) Associative array with the currently available control items
+        * @return void
         */
        public function renderForeignRecordHeaderControl_postProcess($parentUid, $foreignTable, array $childRecord, array $childConfig, $isVirtual, array &$controlItems);
 }
index a674408..b54688a 100644 (file)
 /**
  * Interface for hook in t3lib_TCEmain::checkModifyAccessList
  *
- * @author     Oliver Hader <oliver@typo3.org>
+ * @author Oliver Hader <oliver@typo3.org>
  * @package TYPO3
  * @subpackage t3lib
  */
 interface t3lib_TCEmain_checkModifyAccessListHook {
+
        /**
         * Hook that determines whether a user has access to modify a table.
         *
-        * @param       boolean                 &$accessAllowed: Whether the user has access to modify a table
-        * @param       string                  $table: The name of the table to be modified
-        * @param       t3lib_TCEmain   $parent: The calling parent object
-        * @return      void
+        * @param boolean &$accessAllowed Whether the user has access to modify a table
+        * @param string $table The name of the table to be modified
+        * @param t3lib_TCEmain $parent The calling parent object
+        * @return void
         */
        public function checkModifyAccessList(&$accessAllowed, $table, t3lib_TCEmain $parent);
 }
index 1f7dd6f..be47f05 100644 (file)
  *  This copyright notice MUST APPEAR in all copies of the script!
  ***************************************************************/
 
-
 /**
  * Interface for classes which hook into TCEmain and do additional processing
  * after the upload of a file.
  *
- * @author     Xavier Perseguers <typo3@perseguers.ch>
+ * @author Xavier Perseguers <typo3@perseguers.ch>
  * @package TYPO3
  * @subpackage t3lib
  */
-
 interface t3lib_TCEmain_processUploadHook {
 
        /**
         * Post-process a file upload.
         *
-        * @param       string                  The uploaded file
-        * @param       t3lib_TCEmain   parent t3lib_TCEmain object
-        * @return      void
+        * @param string $filename The uploaded file
+        * @param t3lib_TCEmain $parentObject Parent t3lib_TCEmain object
+        * @return void
         */
        public function processUpload_postProcessAction(&$filename, t3lib_TCEmain $parentObject);